#include <worldelement.h>
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=nullptr) | |
| virtual | ~WorldElement () |
| virtual WorldElementType | GetType () const =0 |
| virtual const char * | GetTypeName () const =0 |
| bool | IsAddedToWorld () const |
| World * | GetWorld () 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) |
|
inline |
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).
|
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.