Kaim::Path Class Reference
#include <path.h>
Class Description
The class representing a path.
Examples:
Classes | |
| class | CreateConfig |
| A class that configures the creation of a Path. More... | |
Related Functions | |
(Note that these are not member functions.) | |
| enum | PathEdgeType |
| Defines the different kind of PathEdge within a Path. More... | |
Path Creation | |
| static Ptr< Path > | CreatePath (const CreateConfig &createConfig) |
| Creates a Path instance and allocates necessary memory accordingly to the information provided through createConfig. More... | |
| void | SetNavigationProfileId (KyUInt32 navigationProfileId) |
| KyUInt32 | GetNavigationProfileId () const |
Get Counts | |
| KyUInt32 | GetNodeCount () const |
| KyUInt32 | GetEdgeCount () const |
Get Cost and Distance | |
| KyFloat32 | GetPathDistance () const |
| Retrieves the total sum of the distance covered by each segment of the path. More... | |
| KyFloat32 | GetPathCost () const |
| Retrieves the total sum of the cost calculated for each segment of the path by a RayCanGoQuery. More... | |
Get Node Data | |
| const Vec3f & | GetPathStartPosition () const |
| const Vec3f & | GetPathEndPosition () const |
| const Vec3f * | GetNodePositionBuffer () const |
| const Vec3f & | GetNodePosition (KyUInt32 nodeIdx) const |
| Vec3f & | GetNodePosition (KyUInt32 nodeIdx) |
| const WorldIntegerPos * | GetNodeIntegerPositionBuffer () const |
| const WorldIntegerPos & | GetNodeIntegerPosition (KyUInt32 nodeIdx) const |
| WorldIntegerPos & | GetNodeIntegerPosition (KyUInt32 nodeIdx) |
| const NavTrianglePtr & | GetNodeNavTrianglePtr (KyUInt32 nodeIdx) const |
| NavTrianglePtr & | GetNodeNavTrianglePtr (KyUInt32 nodeIdx) |
| const NavGraphVertexPtr & | GetNodeNavGraphVertexPtr (KyUInt32 nodeIdx) const |
| NavGraphVertexPtr & | GetNodeNavGraphVertexPtr (KyUInt32 nodeIdx) |
| bool | HasEpsilonEdges () const |
Get Edge Data | |
| const Vec3f & | GetPathEdgeStartPosition (KyUInt32 edgeIdx) const |
| const Vec3f & | GetPathEdgeEndPosition (KyUInt32 edgeIdx) const |
| const NavTrianglePtr & | GetPathEdgeStartNavTrianglePtr (KyUInt32 edgeIdx) const |
| const NavTrianglePtr & | GetPathEdgeEndNavTrianglePtr (KyUInt32 edgeIdx) const |
| const NavGraphEdgePtr & | GetEdgeNavGraphEdgePtr (KyUInt32 edgeIdx) const |
| NavGraphEdgePtr & | GetEdgeNavGraphEdgePtr (KyUInt32 edgeIdx) |
| PathEdgeType | GetPathEdgeType (KyUInt32 edgeIdx) const |
Set Node Data | |
| void | SetNodePosition (KyUInt32 nodeIdx, const Vec3f &position) |
| void | SetNodeIntegerPosition (KyUInt32 nodeIdx, const WorldIntegerPos &integerPos) |
| void | SetNodeNavTrianglePtr (KyUInt32 nodeIdx, const NavTrianglePtr &navTrianglePtr) |
| void | SetNodeNavGraphVertexPtr (KyUInt32 nodeIdx, const NavGraphVertexPtr &navGraphVertexPtr) |
| void | SetNodePosition3fAndInteger (KyUInt32 nodeIdx, const Vec3f &position, const WorldIntegerPos &integerPos) |
Set Edge Data | |
| void | SetEdgeNavGraphEdgePtr (KyUInt32 edgeIdx, const NavGraphEdgePtr &navGraphEdgePtr) |
| void | SetPathEdgeType (KyUInt32 edgeIdx, PathEdgeType edgeType) |
| void | SetPathCostAndDistance (KyFloat32 pathCost, KyFloat32 pathDistance) |
| const CellBox & | GetPathCellBox () const |
| CellBox & | GetPathCellBox () |
| void | SetPathCellBox (const CellBox &cellBox) |
| void | ComputeAllNodeIntegerPositionAndPathCellBox (const DatabaseGenMetrics &genMetrics) |
| KyUInt32 | GetByteSize () const |
Public Data Members | |
| Database * | m_database |
| The Database on which the Path has been computed. More... | |
| Ptr< ChannelArray > | m_channelArray |
| The ChannelArray maintaining Channels around the path sections laying on the NavMesh. More... | |
For internal use only | |
| void | AddRef () |
| void | Release () |
| int | GetRefCount () const |
Member Function Documentation
|
static |
Creates a Path instance and allocates necessary memory accordingly to the information provided through createConfig.
|
inline |
Retrieves the total sum of the cost calculated for each segment of the path by a RayCanGoQuery.
Note that this value is calculated when the path is created, and is not updated dynamically.
|
inline |
Retrieves the total sum of the distance covered by each segment of the path.
Note that this value is calculated when the path is created, and is not updated dynamically.
Friends And Related Function Documentation
|
related |
Defines the different kind of PathEdge within a Path.
Member Data Documentation
| Ptr<ChannelArray> Kaim::Path::m_channelArray |
The ChannelArray maintaining Channels around the path sections laying on the NavMesh.
| Database* Kaim::Path::m_database |
The documentation for this class was generated from the following files: