DeactivationState Class Reference

#include <rimPhysicsDeactivationState.h>

List of all members.

Public Member Functions

 DeactivationState ()
 Create a default deactivation state component with no deactivation profile.
 DeactivationState (const DeactivationProfile &deactivationProfile)
 Create a deactivation state component the specified deactivation profile.
 ~DeactivationState ()
 Destroy a deactivation state component, including it's deactivation profile.
bool getIsActive () const
 Get whether or not the object is active.
bool setIsActive (bool newIsActive)
 Artificially set whether or not the object is currently active.
bool getIsLocked () const
 Get whether or not the activity state of the object is read-only.
void setIsLocked (bool newIsLocked)
 Set whether or not the activity state of the object is read-only.
const DeactivationProfilegetDeactivationProfile () const
 Get the deactivation profile for this deactivation state.
bool hasDeactivationProfile () const
 Return whether or not this deactivation state object has its own deactivation profile.
void setDeactivationProfile (const DeactivationProfile &newProfile)
 Set the deactivation profile for this deactivation state.

Private Attributes

bool isActive
 Whether or not the object is active.
const DeactivationProfiledeactivationProfile
 The deactivation profile for this deactivation component.
bool isLocked
 Whether or not the object's activity can be modified.
Vector3 averageLinearVelocity
 The average linear velocity of the object.
Vector3 averageAngularVelocity
 The average angular velocitiy of the object.
Real timeInactive
 The time that the object has been inactive.
Real velocityAge
 The time since the object's velocities have been updated from scratch.

Friends

class DeactivatorStandard


Constructor & Destructor Documentation

DeactivationState::DeactivationState (  )  [inline]

Create a default deactivation state component with no deactivation profile.

DeactivationState::DeactivationState ( const DeactivationProfile deactivationProfile  )  [inline]

Create a deactivation state component the specified deactivation profile.

DeactivationState::~DeactivationState (  )  [inline]

Destroy a deactivation state component, including it's deactivation profile.


Member Function Documentation

bool DeactivationState::getIsActive (  )  const [inline]

Get whether or not the object is active.

bool DeactivationState::setIsActive ( bool  newIsActive  )  [inline]

Artificially set whether or not the object is currently active.

The method returns TRUE if the activity change was successful (this happens when the object's activity state is not locked), or FALSE if the activity state was locked. The lock must be released before the activity state can be changed.

Parameters:
newIsActive - whether or not the object should be marked as active.
Returns:
whether or not the activity of the object was able to be changed.

bool DeactivationState::getIsLocked (  )  const [inline]

Get whether or not the activity state of the object is read-only.

void DeactivationState::setIsLocked ( bool  newIsLocked  )  [inline]

Set whether or not the activity state of the object is read-only.

const DeactivationProfile* DeactivationState::getDeactivationProfile (  )  const [inline]

Get the deactivation profile for this deactivation state.

bool DeactivationState::hasDeactivationProfile (  )  const [inline]

Return whether or not this deactivation state object has its own deactivation profile.

void DeactivationState::setDeactivationProfile ( const DeactivationProfile newProfile  )  [inline]

Set the deactivation profile for this deactivation state.


Friends And Related Function Documentation

friend class DeactivatorStandard [friend]


Member Data Documentation

bool DeactivationState::isActive [private]

Whether or not the object is active.

const DeactivationProfile* DeactivationState::deactivationProfile [private]

The deactivation profile for this deactivation component.

bool DeactivationState::isLocked [private]

Whether or not the object's activity can be modified.

Vector3 DeactivationState::averageLinearVelocity [private]

The average linear velocity of the object.

Vector3 DeactivationState::averageAngularVelocity [private]

The average angular velocitiy of the object.

Real DeactivationState::timeInactive [private]

The time that the object has been inactive.

Real DeactivationState::velocityAge [private]

The time since the object's velocities have been updated from scratch.


The documentation for this class was generated from the following file:
Generated on Tue Aug 26 00:03:20 2008 for Rim Physics by  doxygen 1.5.4