A* Pathfinding Project  4.0.2
The A* Pathfinding Project for Unity 3D
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Events Macros Groups Pages
Public Member Functions | Public Attributes | Properties | Private Attributes | List of all members
RichPath Class Reference

Public Member Functions

void Clear ()
 
RichPathPart GetCurrentPart ()
 
void Initialize (Seeker s, Path p, bool mergePartEndpoints, bool simplificationMode)
 Use this for initialization.
 
void NextPart ()
 

Public Attributes

Seeker seeker
 
ITransform transform
 Transforms points from path space to world space.
 

Properties

bool CompletedAllParts [get]
 True if we have completed (called NextPart for) the last part in the path.
 
bool IsLastPart [get]
 True if we are traversing the last part of the path.
 

Private Attributes

int currentPart
 
readonly List< RichPathPart > parts = new List<RichPathPart>()
 

Member Function Documentation

void Clear ( )
RichPathPart GetCurrentPart ( )
void Initialize ( Seeker  s,
Path  p,
bool  mergePartEndpoints,
bool  simplificationMode 
)

Use this for initialization.

Parameters
sOptionally provide in order to take tag penalties into account. May be null if you do not use a Seeker\
pPath to follow
mergePartEndpointsIf true, then adjacent parts that the path is split up in will try to use the same start/end points. For example when using a link on a navmesh graph Instead of first following the path to the center of the node where the link is and then follow the link, the path will be adjusted to go to the exact point where the link starts which usually makes more sense.
simplificationModeThe path can optionally be simplified. This can be a bit expensive for long paths.
void NextPart ( )

Member Data Documentation

int currentPart
private
readonly List<RichPathPart> parts = new List<RichPathPart>()
private
Seeker seeker
ITransform transform

Transforms points from path space to world space.

If null the identity transform will be used.

This is used when the world position of the agent does not match the corresponding position on the graph. This is the case in the example scene called 'Moving'.

See Also
Pathfinding.Examples.LocalSpaceRichAI

Property Documentation

bool CompletedAllParts
get

True if we have completed (called NextPart for) the last part in the path.

bool IsLastPart
get

True if we are traversing the last part of the path.

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