CEL

Public API Reference

iCelPath Struct Reference

Interface for CEL Path. More...

#include <tools/celgraph.h>

Inheritance diagram for iCelPath:

List of all members.

Public Member Functions

virtual void AddNode (iMapNode *node)=0
 Adds a new node at the end of the path.
virtual void Clear ()=0
 Clears path.
virtual iMapNodeCurrent ()=0
 Get current node in path.
virtual csVector3 CurrentPosition ()=0
 Get currents node position.
virtual iSectorCurrentSector ()=0
 Get currents node sector.
virtual iMapNodeGetFirst ()=0
 Get First node in path.
virtual iMapNodeGetLast ()=0
 Get last node in path.
virtual size_t GetNodeCount ()=0
 Get number of nodes in the path.
virtual bool HasNext ()=0
 Checks if there are more nodes ahead in the path.
virtual bool HasPrevious ()=0
 Checks if there are more nodes back in the path.
virtual void InsertNode (size_t pos, iMapNode *node)=0
 Adds a new node in position pos.
virtual void Invert ()=0
 Invert nodes in the path.
virtual iMapNodeNext ()=0
 Get next node in path.
virtual iMapNodePrevious ()=0
 Get previous node in path.
virtual iObjectQueryObject ()=0
 Query the underlying iObject.
virtual void Restart ()=0
 Restarts path.

Detailed Description

Interface for CEL Path.

Definition at line 169 of file celgraph.h.


Member Function Documentation

virtual void iCelPath::AddNode ( iMapNode node  )  [pure virtual]

Adds a new node at the end of the path.

virtual void iCelPath::Clear (  )  [pure virtual]

Clears path.

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

Get current node in path.

virtual csVector3 iCelPath::CurrentPosition (  )  [pure virtual]

Get currents node position.

virtual iSector* iCelPath::CurrentSector (  )  [pure virtual]

Get currents node sector.

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

Get First node in path.

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

Get last node in path.

virtual size_t iCelPath::GetNodeCount (  )  [pure virtual]

Get number of nodes in the path.

virtual bool iCelPath::HasNext (  )  [pure virtual]

Checks if there are more nodes ahead in the path.

virtual bool iCelPath::HasPrevious (  )  [pure virtual]

Checks if there are more nodes back in the path.

virtual void iCelPath::InsertNode ( size_t  pos,
iMapNode node 
) [pure virtual]

Adds a new node in position pos.

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

Invert nodes in the path.

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

Get next node in path.

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

Get previous node in path.

virtual iObject* iCelPath::QueryObject (  )  [pure virtual]

Query the underlying iObject.

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

Restarts path.


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

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1