Class PathProgress

A helper class to track the path progress of the SimpleAgent.

Inheritance
System.Object
PathProgress
Namespace: AlchemyBow.Navigation.Simple.Elements
Assembly: AlchemyBow.Navigation.dll
Syntax
public sealed class PathProgress

Constructors

| Improve this Doc View Source

PathProgress(Int32, Vector3[], Int32, IImmutableFace[])

Creates an instance of the PathProgress class.

Declaration
public PathProgress(int currentPoint, Vector3[] pointPath, int currentFace, IImmutableFace[] facePath)
Parameters
Type Name Description
System.Int32 currentPoint

The index of the current waypoint.
UnityEngine.Vector3[] pointPath

The path of waypoints.
System.Int32 currentFace

The index of the current face.
IImmutableFace[] facePath

The path of faces.

Fields

| Improve this Doc View Source

currentFace

The index of the current face.

Declaration
public int currentFace
Field Value
Type Description
System.Int32

The index of the current face.
| Improve this Doc View Source

currentPoint

The index of the current waypoint.

Declaration
public int currentPoint
Field Value
Type Description
System.Int32

The index of the current waypoint.
| Improve this Doc View Source

facePath

The faces.

Declaration
public readonly IImmutableFace[] facePath
Field Value
Type Description
IImmutableFace[]

The faces.
| Improve this Doc View Source

facesCount

The number of faces.

Declaration
public readonly int facesCount
Field Value
Type Description
System.Int32

The number of faces.
| Improve this Doc View Source

pointPath

The waypoints.

Declaration
public readonly Vector3[] pointPath
Field Value
Type Description
UnityEngine.Vector3[]

The waypoints.
| Improve this Doc View Source

pointsCount

The number of waypoints.

Declaration
public readonly int pointsCount
Field Value
Type Description
System.Int32

The number of waypoints.

Properties

| Improve this Doc View Source

CurrentFace

Gets the current face.

Declaration
public IImmutableFace CurrentFace { get; }
Property Value
Type Description
IImmutableFace

The current face.
| Improve this Doc View Source

CurrentPoint

Gets the current waypoint.

Declaration
public Vector3 CurrentPoint { get; }
Property Value
Type Description
UnityEngine.Vector3

The current waypoint.
| Improve this Doc View Source

HasNextFace

Determines whether there is the next face.

Declaration
public bool HasNextFace { get; }
Property Value
Type Description
System.Boolean

true if there is the next face; otherwise, false.
| Improve this Doc View Source

HasNextPoint

Determines whether there is the next waypoint.

Declaration
public bool HasNextPoint { get; }
Property Value
Type Description
System.Boolean

true if there is the next waypoint; otherwise, false.
| Improve this Doc View Source

IsFinished

Determines whether the agent has reached the last waypoint.

Declaration
public bool IsFinished { get; }
Property Value
Type Description
System.Boolean

true if the agent has reached the last waypoint; otherwise, false.
| Improve this Doc View Source

NextFace

Gets the next face.

Declaration
public IImmutableFace NextFace { get; }
Property Value
Type Description
IImmutableFace

The next face.

Methods

| Improve this Doc View Source

IsCurrentPointOnCurrentOrNextFaces()

Determines whether the current point is on the current face or on any of the following.

Declaration
public bool IsCurrentPointOnCurrentOrNextFaces()
Returns
Type Description
System.Boolean

true if the current point is in the current face or in any of the following; otherwise, false.