Kaim::WorldElement Class Reference

Kaim::WorldElement Class Referenceabstract

#include <worldelement.h>

Class Description

Base internal class used to represent elements that can be added to a World, such as instances of Database, Bot, BoxObstacle, CylinderObstacle, TagVolume...

Inherits Kaim::RefCountBase< C, Stat >.

Inherited by Kaim::Bot, Kaim::BoxObstacle, Kaim::CollisionData, Kaim::CylinderObstacle, Kaim::Database, Kaim::NavData, Kaim::PointOfInterest, Kaim::QueryQueueArray, and Kaim::TagVolume.

Main API Functions

 WorldElement (World *world=0)
 
virtual ~WorldElement ()
 
virtual WorldElementType GetType () const =0
 
virtual const char * GetTypeName () const =0
 
bool IsAddedToWorld () const
 
WorldGetWorld () const
 
KyUInt32 GetVisualDebugId () const
 
void * GetUserData () const
 
void SetUserData (void *userData)
 

Visual Debug

void SetCurrentVisualDebugLOD (VisualDebugLOD lod)
 
VisualDebugLOD GetCurrentVisualDebugLOD () const
 
VisualDebugLOD GetPreviousVisualDebugLod () const
 
void SendVisualDebug (VisualDebugServer &server)
 
void ForceSendAllVisualDebug ()
 

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 ( )

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).

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

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 file: