CEL

Public API Reference

Public Member Functions
iCelHPath Struct Reference

Hierarchical path between two points. More...

#include <tools/celhpf.h>

Inheritance diagram for iCelHPath:
iBase

List of all members.

Public Member Functions

virtual iMapNodeCurrent ()=0
 Get current node.
virtual csList
< csSimpleRenderMesh > * 
GetDebugMeshes ()=0
 Render path.
virtual float GetDistance () const =0
 Distance to goal.
virtual iMapNodeGetFirst ()=0
 Get first node.
virtual iMapNodeGetLast ()=0
 Get last node.
virtual bool HasNext () const =0
 Check if the path can be transversed forward from the current position.
virtual bool HasPrevious () const =0
 Check if the path can be transversed backward from the current position.
virtual void Invert ()=0
 Invert path.
virtual iMapNodeNext ()=0
 Get next node.
virtual iMapNodePrevious ()=0
 Get previous node.
virtual void Restart ()=0
 Restart path.

Detailed Description

Hierarchical path between two points.

Definition at line 43 of file celhpf.h.


Member Function Documentation

virtual iMapNode* iCelHPath::Current ( ) [pure virtual]

Get current node.

virtual csList<csSimpleRenderMesh>* iCelHPath::GetDebugMeshes ( ) [pure virtual]

Render path.

Remarks:
The user is responsible for freeing the returned pointer.
virtual float iCelHPath::GetDistance ( ) const [pure virtual]

Distance to goal.

virtual iMapNode* iCelHPath::GetFirst ( ) [pure virtual]

Get first node.

virtual iMapNode* iCelHPath::GetLast ( ) [pure virtual]

Get last node.

virtual bool iCelHPath::HasNext ( ) const [pure virtual]

Check if the path can be transversed forward from the current position.

virtual bool iCelHPath::HasPrevious ( ) const [pure virtual]

Check if the path can be transversed backward from the current position.

virtual void iCelHPath::Invert ( ) [pure virtual]

Invert path.

virtual iMapNode* iCelHPath::Next ( ) [pure virtual]

Get next node.

virtual iMapNode* iCelHPath::Previous ( ) [pure virtual]

Get previous node.

virtual void iCelHPath::Restart ( ) [pure virtual]

Restart path.


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

Generated for CEL: Crystal Entity Layer 2.0 by doxygen 1.7.6.1