Kaim::BotConfig Class Reference
#include <botconfig.h>
Class Description
Class that aggregates all parameters that allow to configure the PathFinding and the PathFollowing of a Bot. Each Bot has its own instance of BotConfig.
Examples:
Inherits Kaim::RefCountBase< C, Stat >.
Shape Config | |
| KyFloat32 | m_radius |
| The Bot radius. If set to 0.0f, the Bot will use m_database generation metrics radius. In meters. More... | |
| KyFloat32 | m_height |
| The Bot height. If set to 0.0f, the Bot will use m_database generation metrics height. In meters. More... | |
Trajectory Mode | |
| TrajectoryMode | m_trajectoryMode |
| Choose Trajectory mode between Shortcut (Straight Line) and Spline (CircleArcSpline, also activate Channel computation with Path). More... | |
PathFind Config | |
| PathFinderConfig | m_pathFinderConfig |
| Configure the Bot pathfinding. More... | |
| ChannelComputerConfig | m_channelComputerConfig |
| Configure the channel computation, relevant when m_trajectoryMode = TrajectoryMode_Spline. More... | |
PathProgress Config | |
| PathProgressConfig | m_pathProgressConfig |
| Configures how the Bot progress on Path. More... | |
Trajectory Config | |
| KyFloat32 | m_maxDesiredLinearSpeed |
| The linear speed that is used by Bots unless they have to slow down (Avoidance, Arrival). More... | |
| TrajectoryFailureMode | m_trajectoryFailureMode |
| Choose between Safe or Unsafe behavior when Trajectory cannot follow the Path. More... | |
| ShortcutTrajectoryConfig | m_shortcutTrajectoryConfig |
| Trajectory configuration when TrajectoryMode = TrajectoryMode_Shortcut. More... | |
| SplineTrajectoryConfig | m_splineTrajectoryConfig |
| Trajectory configuration when TrajectoryMode = TrajectoryMode_Spline. More... | |
Trajectory Avoidance Config | |
| bool | m_enableAvoidance |
| Enable the Bot avoidance of other Bots and Obstacles. More... | |
| AvoidanceConfig | m_avoidanceConfig |
| Configure the avoidance. More... | |
Advanced Trajectory Config | |
| KyFloat32 | m_trajectoryMinimalMoveDistance |
| Advanced. More... | |
| ColliderCollectorConfig | m_colliderCollectorConfig |
| Advanced. Configure how a Bot collects potential colliders (other Bots, Obstacles) for the avoidance. More... | |
Member Data Documentation
| AvoidanceConfig Kaim::BotConfig::m_avoidanceConfig |
Configure the avoidance.
- Examples:
| ChannelComputerConfig Kaim::BotConfig::m_channelComputerConfig |
Configure the channel computation, relevant when m_trajectoryMode = TrajectoryMode_Spline.
The Channel is a structure that represents the available space around the path. It is mandatory to compute splines.
| ColliderCollectorConfig Kaim::BotConfig::m_colliderCollectorConfig |
Advanced. Configure how a Bot collects potential colliders (other Bots, Obstacles) for the avoidance.
| bool Kaim::BotConfig::m_enableAvoidance |
| KyFloat32 Kaim::BotConfig::m_height |
| KyFloat32 Kaim::BotConfig::m_maxDesiredLinearSpeed |
The linear speed that is used by Bots unless they have to slow down (Avoidance, Arrival).
In meter/second.
default value: 5.0f.
- Examples:
| PathFinderConfig Kaim::BotConfig::m_pathFinderConfig |
Configure the Bot pathfinding.
| PathProgressConfig Kaim::BotConfig::m_pathProgressConfig |
| KyFloat32 Kaim::BotConfig::m_radius |
| ShortcutTrajectoryConfig Kaim::BotConfig::m_shortcutTrajectoryConfig |
Trajectory configuration when TrajectoryMode = TrajectoryMode_Shortcut.
| SplineTrajectoryConfig Kaim::BotConfig::m_splineTrajectoryConfig |
Trajectory configuration when TrajectoryMode = TrajectoryMode_Spline.
| TrajectoryFailureMode Kaim::BotConfig::m_trajectoryFailureMode |
Choose between Safe or Unsafe behavior when Trajectory cannot follow the Path.
e.g. Bot is unexpectedly out of NavMesh, or UpperBound changed and current Trajectory is driving Bot after this new UpperBound.
default value: TrajectoryFailureMode_Safe
| KyFloat32 Kaim::BotConfig::m_trajectoryMinimalMoveDistance |
Advanced.
The Trajectory velocity computation returns zero when the distance between the bot position and the target to reach is smaller than m_trajectoryMinimalMoveDistance. This avoids to normalize epsilon-length vectors. In meters.
default value: 0.01f
| TrajectoryMode Kaim::BotConfig::m_trajectoryMode |
Choose Trajectory mode between Shortcut (Straight Line) and Spline (CircleArcSpline, also activate Channel computation with Path).
default value: TrajectoryMode_Shortcut
- Examples:
The documentation for this class was generated from the following file:
- gwnavruntime/world/botconfig.h