Infohazard.HyperNav 1.1.5
3D Navigation for Flying Characters
Loading...
Searching...
No Matches
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...
 
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...
 

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...
 

Private Attributes

int _minVertex
 (Serialized) First vertex index, which is the lower of the two. More...
 
int _maxVertex
 (Serialized) Second vertex index, which is the higher of the two. 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()

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
vertex1First vertex index.
vertex2Second vertex index.

Member Function Documentation

◆ Equals() [1/2]

bool Infohazard.HyperNav.Edge.Equals ( Edge  other)

Compare to another Edge.

Parameters
otherEdge 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
objObject 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.

Member Data Documentation

◆ _maxVertex

int Infohazard.HyperNav.Edge._maxVertex
private

(Serialized) Second vertex index, which is the higher of the two.

◆ _minVertex

int Infohazard.HyperNav.Edge._minVertex
private

(Serialized) First vertex index, which is the lower of the two.

Property Documentation

◆ 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: