CEL

Public API Reference

iCelGraph Struct Reference

Interface for the CEL Graph. More...

#include <tools/celgraph.h>

Inheritance diagram for iCelGraph:

List of all members.

Public Member Functions

virtual size_t AddEdge (iCelNode *from, iCelNode *to, bool state, float weight)=0
 Adds an edge to the graph, using a weight different then the euclidean distance between the two nodes.
virtual void AddEdge (iCelNode *from, iCelNode *to, bool state)=0
 Adds an edge to the graph.
virtual bool AddEdgeByNames (const char *from, const char *to, bool state)=0
 Adds an edge to the graph.
virtual size_t AddNode (iCelNode *node)=0
 Adds a node to the graph.
virtual iCelNodeCreateEmptyNode (size_t &index)=0
 Creates an empty node and adds it to the graph.
virtual iCelNodeCreateNode (const char *name, csVector3 &pos)=0
 Create a node for this graph.
virtual iCelNodeGetClosest (csVector3 position)=0
 Gets the closest node to position.
virtual iCelNodeGetNode (size_t idx)=0
 Get a node by index.
virtual size_t GetNodeCount ()=0
 Get Number of Nodes.
virtual iObjectQueryObject ()=0
 Query the underlying iObject.
virtual iCelNodeRandomPath (iCelNode *from, int distance, iCelPath *path)=0
 Gets the shortest path from node from to node to.
virtual void RemoveEdge (iCelNode *from, size_t idx)=0
 Removes an edge from the graph.
virtual void RemoveNode (size_t idx)=0
 Removes a node from the graph.
virtual bool ShortestPath (iCelNode *from, iCelNode *goal, iCelPath *path)=0
 Gets the shortest path from node from to node to.
virtual bool ShortestPath2 (iCelNode *from, iCelNode *goal, iCelPath *path)=0
 Gets the shortest path from node from to node to.

Detailed Description

Interface for the CEL Graph.

Definition at line 258 of file celgraph.h.


Member Function Documentation

virtual size_t iCelGraph::AddEdge ( iCelNode from,
iCelNode to,
bool  state,
float  weight 
) [pure virtual]

Adds an edge to the graph, using a weight different then the euclidean distance between the two nodes.

virtual void iCelGraph::AddEdge ( iCelNode from,
iCelNode to,
bool  state 
) [pure virtual]

Adds an edge to the graph.

virtual bool iCelGraph::AddEdgeByNames ( const char *  from,
const char *  to,
bool  state 
) [pure virtual]

Adds an edge to the graph.

virtual size_t iCelGraph::AddNode ( iCelNode node  )  [pure virtual]

Adds a node to the graph.

virtual iCelNode* iCelGraph::CreateEmptyNode ( size_t &  index  )  [pure virtual]

Creates an empty node and adds it to the graph.

virtual iCelNode* iCelGraph::CreateNode ( const char *  name,
csVector3 pos 
) [pure virtual]

Create a node for this graph.

The node will be added to the graph.

virtual iCelNode* iCelGraph::GetClosest ( csVector3  position  )  [pure virtual]

Gets the closest node to position.

virtual iCelNode* iCelGraph::GetNode ( size_t  idx  )  [pure virtual]

Get a node by index.

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

Get Number of Nodes.

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

Query the underlying iObject.

virtual iCelNode* iCelGraph::RandomPath ( iCelNode from,
int  distance,
iCelPath path 
) [pure virtual]

Gets the shortest path from node from to node to.

virtual void iCelGraph::RemoveEdge ( iCelNode from,
size_t  idx 
) [pure virtual]

Removes an edge from the graph.

virtual void iCelGraph::RemoveNode ( size_t  idx  )  [pure virtual]

Removes a node from the graph.

virtual bool iCelGraph::ShortestPath ( iCelNode from,
iCelNode goal,
iCelPath path 
) [pure virtual]

Gets the shortest path from node from to node to.

virtual bool iCelGraph::ShortestPath2 ( iCelNode from,
iCelNode goal,
iCelPath path 
) [pure virtual]

Gets the shortest path from node from to node to.


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

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1