Kaim::World Class Reference
#include <world.h>
Class Description
This class is a runtime container for Gameware Navigation WorldElements such as NavData, Bots, BoxObstacles, TagVolumes...
Examples:
Inherits Kaim::RefCountBaseNTS< C, Stat >.
Main API Functions | |
| World (KyUInt32 databaseCount=1) | |
| virtual | ~World () |
| void | SetUserData (void *userData) |
| void * | GetUserData () |
Update | |
| void | Update (KyFloat32 simulationTimeInSeconds=0.016f) |
| KyUInt32 | GetUpdateCount () const |
| WorldStatistics * | GetWorldStatistics () |
VisualDebug | |
VisualDebugging is only enabled with KY_BUILD_DEBUG_and KY_BUILD_RELEASE With KY_BUILD_SHIPPING, functions related to VisualDebugging are replaced by empty inlined functions for convenience, However, it can still be judicious to guard your own code that uses VisualDebugging with a check against KY_BUILD_SHIPPING. | |
| KyResult | StartVisualDebug (const VisualDebugServerConfig &visualDebugServerConfig) |
| void | StopVisualDebug () |
| VisualDebugServer * | GetVisualDebugServer () |
| VisualDebugRegistry * | GetElementRegistry () |
| DisplayListManager * | GetDisplayListManager () |
| VisualDebugAttributesManager * | GetAttributesManager () |
WorldElement Getters | |
| KyUInt32 | GetDatabasesCount () const |
| Database * | GetDatabase (KyUInt32 index) |
| KyUInt32 | GetPointsOfInterestCount () const |
| PointOfInterest * | GetPointOfInterest (KyUInt32 index) |
| KyUInt32 | GetCylinderObstaclesCount () const |
| CylinderObstacle * | GetCylinderObstacle (KyUInt32 index) |
| KyUInt32 | GetBoxObstaclesCount () const |
| BoxObstacle * | GetBoxObstacle (KyUInt32 index) |
| KyUInt32 | GetTagVolumesCount () const |
| KyUInt32 | GetTagVolumesToBeIntegratedCount () const |
| KyUInt32 | GetTagVolumesIntegratedCount () const |
| KyUInt32 | GetTagVolumesToBeRemovedCount () const |
| TagVolume * | GetTagVolumesToBeIntegrated (KyUInt32 index) |
| TagVolume * | GetTagVolumesIntegrated (KyUInt32 index) |
| TagVolume * | GetTagVolumesToBeRemoved (KyUInt32 index) |
| KyUInt32 | GetQueryQueueArraysCount () const |
| QueryQueueArray * | GetQueryQueueArray (KyUInt32 index) |
| KyUInt32 | GetQueryPendingOperationCount () const |
NavigationProfile | |
| KyUInt32 | AddNavigationProfile (Ptr< BaseNavigationProfile > navigationProfile) |
| Ptr< BaseNavigationProfile > | GetNavigationProfile (KyUInt32 profileId) |
Async Queries | |
| void | SetAsyncQueryDispatcher (IAsyncQueryDispatcher *asyncQueryDispatcher) |
| IAsyncQueryDispatcher * | GetAsyncQueryDispatcher () |
| void | PushAsyncQuery (IQuery *query, AsyncQueryDispatchId asyncQueryDispatchId=AsyncQueryDispatchId_Default, Bot *bot=0) |
| void | CancelAsyncQuery (IQuery *query) |
| void | ProcessQueuesOutsideWorldUpdate () |
| void | SetWorldUpdateThreadId (ThreadId threadId) |
| ThreadId | GetWorldUpdateThreadId () const |
RemoveAll... | |
| void | RemoveAndCancellAll () |
| void | RemoveAllBots () |
| void | RemoveAllPointsOfInterest () |
| void | RemoveAllCylinderObstacles () |
| void | RemoveAllBoxObstacles () |
| void | RemoveAllTagVolumes () |
| void | ClearDatabase (KyUInt32 databaseIndex) |
Specific optimization to the ShortcutTrajectory | |
Theses functions are only useful for bots with ShortcutTrajectory. It allows to skip ProgressOnPath and ShortcutTrajectory computations that are usually done each frame. Note that on some events the bot can be updated more often than the given number. For instance, if changes occur on the Path or to be sure not to miss its current target. | |
| KyUInt32 | GetNumberOfFramesForShortcutTrajectoryPeriodicUpdate () const |
| void | SetNumberOfFramesForShortcutTrajectoryPeriodicUpdate (KyUInt32 numberOfFrames) |
For internal use only | |
| void * | m_userData |
| KyArray< Ptr< BaseNavigationProfile > > | m_navigationProfiles |
| KyUInt32 | m_updateCount |
| KyUInt32 | m_nbFramesForShortcutTrajectoryPeriodicUpdate |
| KyUInt32 | m_databaseCount |
| KyArray< Ptr< Database >, MemStat_WorldFwk > | m_databases |
| Ptr< DatabaseBinding > | m_allDatabaseBinding |
| Ptr< CollisionWorld > | m_collisionWorld |
| TrackedCollection< Ptr< PointOfInterest >, MemStat_PointOfInterest > | m_pointsOfInterests |
| TrackedCollection< Ptr< CylinderObstacle >, MemStat_CylinderObstacle > | m_cylinderObstacles |
| TrackedCollection< Ptr< BoxObstacle >, MemStat_BoxObstacle > | m_boxObstacles |
| TrackedCollection< Ptr< QueryQueueArray >, MemStat_QuerySystem > | m_queryQueueArrays |
| TrackedCollection< Ptr< TagVolume >, MemStat_TagVolume > | m_tagVolumesToBeIntegrated |
| TrackedCollection< Ptr< TagVolume >, MemStat_TagVolume > | m_tagVolumesIntegrated |
| TrackedCollection< Ptr< TagVolume >, MemStat_TagVolume > | m_tagVolumesToBeRemoved |
| WorldElementSpatializer * | m_worldElementSpatializer |
| Ptr< BaseNavigationProfile > | m_defaultNavigationProfile |
| Ptr< BotConfig > | m_defaultPathFollowerConfig |
| VisualDebugServerConfig | m_visualDebugServerConfig |
| VisualDebugServer * | m_visualDebugServer |
| bool | m_wasConnected |
| DisplayListManager * | m_displayListManager |
| VisualDebugRegistry * | m_visualDebugRegistry |
| VisualDebugAttributesManager * | m_visualDebugAttributesManager |
| WorldStatistics * | m_statistics |
| DatabaseUpdateManager * | m_databaseUpdateManager |
| AvoidanceWorkspace | m_avoidanceWorkspace |
| Ptr< IAsyncQueryDispatcher > | m_asyncQueryDispatcher |
| bool | m_isInWorldUpdate |
| ThreadId | m_worldUpdateThreadId |
Constructor & Destructor Documentation
|
explicit |
- Parameters
-
databaseCount The number of databases added to this world, must be greater than or equal to 1.
Member Function Documentation
| KyUInt32 Kaim::World::AddNavigationProfile | ( | Ptr< BaseNavigationProfile > | navigationProfile | ) |
If TraverseLogic of the NavigationProfile has obsolete functions, navigationProfile won't be added and AddNavigationProfile returns KyUInt32MAXVAL.
- Examples:
|
inline |
Get the attributesManager that is required when creating an attribute group.
|
inline |
- Precondition
- index must be valid, we don't check it there.
|
inline |
- Precondition
- index must be valid, we don't check it there.
- Precondition
- index must be valid, we don't check it there.
- Examples:
|
inline |
Get the DisplayListManager that is required when creating a ScopedDisplayList.
- Examples:
|
inline |
Returns the registry in this World of instances of WorldElement that can be visually debugged in Gameware Navigation Lab.
|
inline |
Gives the number of frames between two updates of the PathFollowing for each bot.
|
inline |
- Precondition
- index must be valid, we don't check it there.
|
inline |
- Precondition
- index must be valid, we don't check it there.
- Precondition
- index must be valid, we don't check it there.
- Precondition
- index must be valid, we don't check it there.
- Precondition
- index must be valid, we don't check it there.
|
inline |
Retrieves the number of times Update() has been called.
|
inline |
Returns statistics on CPU consumption during Update() and its steps.
With KY_BUILD_SHIPPING, it returns KY_NULL;
| void Kaim::World::PushAsyncQuery | ( | IQuery * | query, |
| AsyncQueryDispatchId | asyncQueryDispatchId = AsyncQueryDispatchId_Default, |
||
| Bot * | bot = 0 |
||
| ) |
Pushes an IQuery in the right QueryQueue accordingly to World's IAsyncQueryDispatcher.
| void Kaim::World::RemoveAndCancellAll | ( | ) |
Remove all Bots, PointOfInterest, CylinderObstacles, BoxObstacles, TagVolumes, and NavData; and cancel all queries.
| void Kaim::World::SetAsyncQueryDispatcher | ( | IAsyncQueryDispatcher * | asyncQueryDispatcher | ) |
Set a new IAsyncQueryDispatcher instance to be used by this World:
- first: calls IAsyncQueryDispatcher::RemoveQueryQueuesFromWorld() on the current World's IAsyncQueryDispatcher,
- then: replaces World's IAsyncQueryDispatcher,
finally: calls IAsyncQueryDispatcher::AddQueryQueuesToWorld() on the new World's IAsyncQueryDispatcher.
Passing NULL does nothing.
|
inline |
Set the number of frames between two updates of the PathFollowing for all bots with TrajectoryMode_Shortcut.
Default value is 1 in order to get an update each frame.
If 0 is passed, it is defaulted to 1.
For instance, by setting a value of 5, UpdateBotPathFollowing will call the ProgressOnPathComputer and the Trajectory one frame on 5, this will make UpdateBotPathFollowing being around 3 times faster since the number of RayCanGo used to maintained the TargetOnPathStatus is exactly divided by 5, but some other components are already skipping some frames, hence their cost is not divided by 5.
| KyResult Kaim::World::StartVisualDebug | ( | const VisualDebugServerConfig & | visualDebugServerConfig | ) |
Starts the visual debug server. You can start it at any time.
- Examples:
| void Kaim::World::Update | ( | KyFloat32 | simulationTimeInSeconds = 0.016f | ) |
Updates the World.
It is possible to use Gameware Navigation as a NavMesh/NavGraph Query toolbox without calling World::Update(). But to easily support Bots, obstacles, DynamicNavMesh, etc., a World::Update() call is required every frame.
- Examples:
The documentation for this class was generated from the following file:
- gwnavruntime/world/world.h