deAnimatorRuleTouchGround Class Reference

Animator Rule Touch Ground. More...

#include <deAnimatorRuleTouchGround.h>

Inheritance diagram for deAnimatorRuleTouchGround:
deAnimatorRule

List of all members.

Public Member Functions

Constructors and Destructors
 deAnimatorRuleTouchGround ()
 Creates a new animator rule.
 ~deAnimatorRuleTouchGround ()
 Cleans up the animator rule.
Management
const decVectorGetPlanePosition () const
 Retrieves the plane position.
void SetPlanePosition (const decVector &position)
 Sets the plane position.
const decVectorGetPlaneNormal () const
 Retrieves the plane normal.
void SetPlaneNormal (const decVector &normal)
 Sets the plane normal.
deTouchSensorGetTouchSensor () const
 Retrieves the touch sensor or NULL if not used.
void SetTouchSensor (deTouchSensor *touchSensor)
 Sets the touch sensor or NULL if not used.
int GetTouchSensorShape () const
 Retrieves the touch sensor shape.
void SetTouchSensorShape (int shape)
 Sets the touch sensor shape.
deColliderGetCollider () const
 Retrieves the collider or NULL if using a ray test.
void SetCollider (deCollider *collider)
 Sets the collider or NULL if using a ray test.
bool GetAdjustOrientation () const
 Determines if bones are oriented on the ground plane.
void SetAdjustOrientation (bool adjust)
 Sets if bones are oriented on the ground plane.
const decQuaternionGetMinimumOrientation () const
 Retrieves the minimum orientation.
void SetMinimumOrientation (const decQuaternion &orientation)
 Sets the minimum orientation.
const decQuaternionGetMaximumOrientation () const
 Retrieves the maximum orientation.
void SetMaximumOrientation (const decQuaternion &orientation)
 Sets the maximum orientation.
deAnimatorControllerTargetGetTargetPlanePosition ()
 Retrieves the plane position target.
deAnimatorControllerTargetGetTargetPlaneNormal ()
 Retrieves the plane normal target.
Visiting
virtual void Visit (deAnimatorRuleVisitor *visitor)
 Visits the rule.

Detailed Description

Animator Rule Touch Ground.

Aligns a bone with the ground. For this a ground plane is defined using a position and a normal. The bones are then projected to this plane. If a shape is defined the bones are tested using this shape against the plane otherwise using a ray test.

Author:
Plüss Roland
Version:
1.0
Date:
2009

Constructor & Destructor Documentation

deAnimatorRuleTouchGround::deAnimatorRuleTouchGround (  )

Creates a new animator rule.

deAnimatorRuleTouchGround::~deAnimatorRuleTouchGround (  )

Cleans up the animator rule.


Member Function Documentation

bool deAnimatorRuleTouchGround::GetAdjustOrientation (  ) const [inline]

Determines if bones are oriented on the ground plane.

deCollider* deAnimatorRuleTouchGround::GetCollider (  ) const [inline]

Retrieves the collider or NULL if using a ray test.

const decQuaternion& deAnimatorRuleTouchGround::GetMaximumOrientation (  ) const [inline]

Retrieves the maximum orientation.

const decQuaternion& deAnimatorRuleTouchGround::GetMinimumOrientation (  ) const [inline]

Retrieves the minimum orientation.

const decVector& deAnimatorRuleTouchGround::GetPlaneNormal (  ) const [inline]

Retrieves the plane normal.

const decVector& deAnimatorRuleTouchGround::GetPlanePosition (  ) const [inline]

Retrieves the plane position.

deAnimatorControllerTarget& deAnimatorRuleTouchGround::GetTargetPlaneNormal (  ) [inline]

Retrieves the plane normal target.

deAnimatorControllerTarget& deAnimatorRuleTouchGround::GetTargetPlanePosition (  ) [inline]

Retrieves the plane position target.

deTouchSensor* deAnimatorRuleTouchGround::GetTouchSensor (  ) const [inline]

Retrieves the touch sensor or NULL if not used.

int deAnimatorRuleTouchGround::GetTouchSensorShape (  ) const [inline]

Retrieves the touch sensor shape.

void deAnimatorRuleTouchGround::SetAdjustOrientation ( bool  adjust )

Sets if bones are oriented on the ground plane.

void deAnimatorRuleTouchGround::SetCollider ( deCollider collider )

Sets the collider or NULL if using a ray test.

void deAnimatorRuleTouchGround::SetMaximumOrientation ( const decQuaternion orientation )

Sets the maximum orientation.

void deAnimatorRuleTouchGround::SetMinimumOrientation ( const decQuaternion orientation )

Sets the minimum orientation.

void deAnimatorRuleTouchGround::SetPlaneNormal ( const decVector normal )

Sets the plane normal.

void deAnimatorRuleTouchGround::SetPlanePosition ( const decVector position )

Sets the plane position.

void deAnimatorRuleTouchGround::SetTouchSensor ( deTouchSensor touchSensor )

Sets the touch sensor or NULL if not used.

void deAnimatorRuleTouchGround::SetTouchSensorShape ( int  shape )

Sets the touch sensor shape.

virtual void deAnimatorRuleTouchGround::Visit ( deAnimatorRuleVisitor visitor ) [virtual]

Visits the rule.

Reimplemented from deAnimatorRule.


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