Class Vertex

The wrapper class for a Vector3 point.

Inheritance
System.Object
UsageTrackingObject<Edge>
Vertex
Implements
System.IComparable<Vertex>
Inherited Members
Namespace: AlchemyBow.Navigation.Surfaces
Assembly: AlchemyBow.Navigation.dll
Syntax
public class Vertex : UsageTrackingObject<Edge>, IComparable<Vertex>

Constructors

| Improve this Doc View Source

Vertex(Vector3)

Creates an instance of the Vertex class.

Declaration
public Vertex(Vector3 value)
Parameters
Type Name Description
UnityEngine.Vector3 value

A point in 3d space.

Fields

| Improve this Doc View Source

magnitude

The cached magnitude of the vector.

Declaration
public readonly float magnitude
Field Value
Type Description
System.Single

The cached magnitude of the vector.
| Improve this Doc View Source

value

The vertex value.

Declaration
public readonly Vector3 value
Field Value
Type Description
UnityEngine.Vector3

The vertex value.

Methods

| Improve this Doc View Source

CompareTo(Vertex)

Compares the current instance with another instance of the Vertex class based on cached magnitude.

Declaration
public int CompareTo(Vertex other)
Parameters
Type Name Description
Vertex other

The other instance to compare with this instance.
Returns
Type Description
System.Int32

An integer that indicates whether the current instance precedes, follows, or occurs in the same position in the magnitude order.
| Improve this Doc View Source

CreateMagnitudeStub(Single)

Creates a fake instance of the Vertex class with specific magnitude.

Declaration
public static Vertex CreateMagnitudeStub(float magnitude)
Parameters
Type Name Description
System.Single magnitude

The specific magnitude.
Returns
Type Description
Vertex

A fake instance of the Vertex class with specific magnitude.

Implements

System.IComparable<T>