Kaim::CollisionData Class Reference

Kaim::CollisionData Class Reference
+ Related help topics:

#include <collisiondata.h>

Class Description

The CollisionData class represents Collision Data that will be added to a CollisionWorld.

Collision Data is comprised of IndexedMeshes (classical Triangle Meshes representing 3D structures) and HeightFields (2D uniform grid of altitudes). The CollisionData class offers a mechanism for loading data from .ColData files created by the Autodesk Navigation Generation framework. It should not be used directly, but rather added to a CollisionWorld.

Inherits Kaim::WorldElement.

Public Member Functions

KyResult Load (const char *fileName, FileOpenerBase *fileOpener=nullptr)
 Load data from .ColData files created by the Autodesk Navigation Generation framework. More...
 

Main API Functions

bool IsAddedToWorld () const
 
WorldGetWorld () const
 
KyUInt32 GetVisualDebugId () const
 
void * GetUserData () const
 
void SetUserData (void *userData)
 

Visual Debug

void SetCurrentVisualDebugLOD (VisualDebugLOD lod)
 Set the visual debug level of details to use for this WorldElement instance. More...
 
VisualDebugLOD GetCurrentVisualDebugLOD () const
 
VisualDebugLOD GetPreviousVisualDebugLod () const
 
void SendVisualDebug (VisualDebugServer &server)
 
void ForceSendAllVisualDebug ()
 Call this when something impacts all your visual debug data. More...
 

For internal use only

virtual void DoSendVisualDebug (VisualDebugServer &, VisualDebugSendChangeEvent)
 
void SendForMaxLevelOfDetail (VisualDebugServer &server, const Vec3f &shapePosition)
 
void RegisterToVisualDebug ()
 
void UnRegisterFromVisualDebug ()
 
KyUInt32 GetIndexInCollection () const
 
void SetIndexInCollection (KyUInt32 indexInCollection)
 

Member Function Documentation

void Kaim::WorldElement::ForceSendAllVisualDebug ( )
inlineinherited

Call this when something impacts all your visual debug data.

It will set the event to VisualDebugSendChangeEvent_ForceSendAll. (called internally when connecting with a VisualDebug client).

KyResult Kaim::CollisionData::Load ( const char *  fileName,
FileOpenerBase fileOpener = nullptr 
)

Load data from .ColData files created by the Autodesk Navigation Generation framework.

Must be called before adding the NavData to its associated CollisionWorld.

void Kaim::WorldElement::SetCurrentVisualDebugLOD ( VisualDebugLOD  lod)
inlineinherited

Set the visual debug level of details to use for this WorldElement instance.

Generally, setting this to VisualDebugLOD_Minimal, sends almost nothing but position and status, whereas setting it to VisualDebugLOD_Maximal sends all available debug information including spatialization and some internal algorithm results.


The documentation for this class was generated from the following files:
  • gwnavruntime/collision/collisiondata.h
  • gwnavruntime/collision/collisiondata.cpp