Infohazard.HyperNav.Edge Struct Reference

Represents the indices of an edge (two connected vertices) in an indexed mesh. More...

Public Member Functions
	Edge (int vertex1, int vertex2)
	Construct a new Edge with the given indices. More...
	Edge (int2 vertices)
	Construct a new Edge with the given indices. More...
int2	ToInt2 ()
	Convert to int2. More...
override bool	Equals (object obj)
	Compare to another object. More...
bool	Equals (Edge other)
	Compare to another Edge. More...
override int	GetHashCode ()
	Get integer for use with hash table. More...

Static Public Member Functions
static bool	operator== (Edge a, Edge b)
	Equality operator. More...
static bool	operator!= (Edge a, Edge b)
	Inequality operator. More...

Static Public Attributes
static readonly Edge	InvalidEdge = new() { _minVertex = -1, _maxVertex = -1 }
	Invalid Edge. More...

Properties
int	Vertex1 [get]
	First vertex index, which is the lower of the two. More...
int	Vertex2 [get]
	Second vertex index, which is the higher of the two. More...
bool	IsValid [get]
	Whether the Edge is valid. More...

Detailed Description

Represents the indices of an edge (two connected vertices) in an indexed mesh.

The same Edge will be created regardless of the order in which indices are fed to the constructor.

Constructor & Destructor Documentation

Edge() [1/2]

Infohazard.HyperNav.Edge.Edge	(	int	vertex1,
		int	vertex2
	)

Construct a new Edge with the given indices.

The order of the indices doesn't matter; the same Edge is constructed either way. The indices cannot be the same.

Parameters

vertex1	First vertex index.
vertex2	Second vertex index.

Edge() [2/2]

Infohazard.HyperNav.Edge.Edge

(

int2

vertices

)

Construct a new Edge with the given indices.

Parameters

vertices

Vertex indices.

Member Function Documentation

Equals() [1/2]

bool Infohazard.HyperNav.Edge.Equals

(

Edge

other

)

Compare to another Edge.

Parameters

other

Edge to compare to.

Returns

Whether the two edges are equal.

Equals() [2/2]

override bool Infohazard.HyperNav.Edge.Equals

(

object

obj

)

Compare to another object.

Parameters

obj	Object to compare to.

Returns

Whether the two objects are equal.

GetHashCode()

override int Infohazard.HyperNav.Edge.GetHashCode

(

)

Get integer for use with hash table.

Returns

Integer hash code.

operator!=()

static bool Infohazard.HyperNav.Edge.operator!= ( Edge  a, Edge  b  )

static

Inequality operator.

Parameters

a	First edge to compare.
b	Second edge to compare.

Returns

Whether the edges are not equal.

operator==()

static bool Infohazard.HyperNav.Edge.operator== ( Edge  a, Edge  b  )

static

Equality operator.

Parameters

a	First edge to compare.
b	Second edge to compare.

Returns

Whether the edges are equal.

ToInt2()

int2 Infohazard.HyperNav.Edge.ToInt2

(

)

Convert to int2.

Returns

Edge as int2.

Member Data Documentation

InvalidEdge

readonly Edge Infohazard.HyperNav.Edge.InvalidEdge = new() { _minVertex = -1, _maxVertex = -1 }

static

Invalid Edge.

Property Documentation

IsValid

bool Infohazard.HyperNav.Edge.IsValid

get

Whether the Edge is valid.

Vertex1

int Infohazard.HyperNav.Edge.Vertex1

get

First vertex index, which is the lower of the two.

Vertex2

int Infohazard.HyperNav.Edge.Vertex2

get

Second vertex index, which is the higher of the two.

---

The documentation for this struct was generated from the following file:

• Runtime/Utility/Edge.cs