Kaim::BoxObstacleInitConfig Class Reference

Kaim::BoxObstacleInitConfig Class Reference

#include <boxobstacle.h>

Class Description

Class used to provide BoxObstacle initialization parameters.

+ Examples:

Public Member Functions

 BoxObstacleInitConfig ()
 
void SetDefaults ()
 

Public Data Members

Worldm_world
 
Ptr< DatabaseBindingm_databaseBinding
 
DynamicNavTag m_navTag
 
Vec3f m_localCenter
 
Vec3f m_localHalfExtents
 
Vec3f m_startPosition
 
void * m_userData
 
BoxObstacleRotationMode m_rotationMode
 
BoxObstacleUpAxis m_upAxis
 

Member Function Documentation

void Kaim::BoxObstacleInitConfig::SetDefaults ( )
inline

Sets all members to their default value.

Member Data Documentation

Ptr<DatabaseBinding> Kaim::BoxObstacleInitConfig::m_databaseBinding

Defines the Databases in which the BoxObstacle will be spatialized.

If let to KY_NULL, World's default DatabaseBinding will be used (spatializes on all Databases).

Vec3f Kaim::BoxObstacleInitConfig::m_localCenter

Defines the local AABBox center relatively to rotation axis.

This should be let to Vec3f::Zero(): your physics engine should provide the velocity of your box center.

When not using physics engine and facing an obstacle rotating around a static axis (like a door), you can set it to ease the BoxObstacleUpdateConfig computation.

DynamicNavTag Kaim::BoxObstacleInitConfig::m_navTag

This DynamicNavTag will be used to set up the TagVolume NavTag when the BoxObstacle will trigger it.

+ Examples:
BoxObstacleUpAxis Kaim::BoxObstacleInitConfig::m_upAxis

Used only for BoxObstacles that are yaw-rotating.

It defines the local axis direction around which the BoxObstacle's yaw rotation is applied.

World* Kaim::BoxObstacleInitConfig::m_world

Mandatory: you must provide a World when calling BoxObstacle::Init.

+ Examples:

The documentation for this class was generated from the following file: