dtGame::GroundClampingData Class Reference

#include <groundclamper.h>

List of all members.

Public Member Functions
	GroundClampingData ()
	~GroundClampingData ()
void	SetGroundOffset (float newOffset)
	Sets the offset from the ground the actor should be clamped to.
float	GetGroundOffset () const
	Returns: The distance from the ground that the actor should be.
bool	GetAdjustRotationToGround () const
	Returns: true if the rotation should be adjusted to match the terrain.
void	SetAdjustRotationToGround (bool newAdjust)
	Sets if the rotation of the actor should be changed to match the terrain.
void	SetUseModelDimensions (bool newUse)
	Set this to true to tell the DR comp than the model dimensions are now valid. Defaults to false.
bool	UseModelDimensions () const
	Returns: true if the model dimensions are now valid.
void	SetModelDimensions (const osg::Vec3 &newDimensions)
	Sets the model dimensions of this helper. This will call SetUseModelDimensions(true) internally.
const osg::Vec3 &	GetModelDimensions () const
	Returns: the current assigned dimensions of the model for the actor being dead-reckoned
void	SetLastClampedOffset (float newClampedOffset)
	Sets the last known offset from the existing the position to the terrain.
float	GetLastClampedOffset () const
	Returns: the last known offset from the existing the position to the terrain.
void	SetLastClampedTime (double newTime)
double	GetLastClampedTime () const

---

Constructor & Destructor Documentation

dtGame::GroundClampingData::GroundClampingData

(

)

dtGame::GroundClampingData::~GroundClampingData

(

)

---

Member Function Documentation

void dtGame::GroundClampingData::SetGroundOffset

(

float

newOffset

)

[inline]

Sets the offset from the ground the actor should be clamped to.

This only matters if flying is set to false.

Parameters:

newOffset

the new offset value.

float dtGame::GroundClampingData::GetGroundOffset

(

)

const [inline]

Returns:

The distance from the ground that the actor should be.

bool dtGame::GroundClampingData::GetAdjustRotationToGround

(

)

const [inline]

Returns:

true if the rotation should be adjusted to match the terrain.

Note:

this only matters if flying is set to false.

void dtGame::GroundClampingData::SetAdjustRotationToGround

(

bool

newAdjust

)

[inline]

Sets if the rotation of the actor should be changed to match the terrain.

Parameters:

newFlying

the new value to set.

void dtGame::GroundClampingData::SetUseModelDimensions

(

bool

newUse

)

[inline]

Set this to true to tell the DR comp than the model dimensions are now valid. Defaults to false.

bool dtGame::GroundClampingData::UseModelDimensions

(

)

const [inline]

Returns:

true if the model dimensions are now valid.

void dtGame::GroundClampingData::SetModelDimensions

(

const osg::Vec3 &

newDimensions

)

[inline]

Sets the model dimensions of this helper. This will call SetUseModelDimensions(true) internally.

const osg::Vec3& dtGame::GroundClampingData::GetModelDimensions

(

)

const [inline]

Returns:

the current assigned dimensions of the model for the actor being dead-reckoned

void dtGame::GroundClampingData::SetLastClampedOffset

(

float

newClampedOffset

)

[inline]

Sets the last known offset from the existing the position to the terrain.

float dtGame::GroundClampingData::GetLastClampedOffset

(

)

const [inline]

Returns:

the last known offset from the existing the position to the terrain.

void dtGame::GroundClampingData::SetLastClampedTime

(

double

newTime

)

[inline]

double dtGame::GroundClampingData::GetLastClampedTime

(

)

const [inline]

---