deRigConstraint Class Reference

Rig Constraint. More...

#include <deRigConstraint.h>

List of all members.

Public Member Functions
Constructors and Destructors
	deRigConstraint ()
	Creates a new rig constraint.
	~deRigConstraint ()
	Cleans up the rig constraint.
Management
const decVector &	GetReferencePosition () const
	Retrieves the position of the reference coordinate frame.
void	SetReferencePosition (const decVector &position)
	Sets the position of the reference coordinate frame.
const decQuaternion &	GetReferenceOrientation () const
	Retrieves the orientation of the reference coordinate frame.
void	SetReferenceOrientation (const decQuaternion &orientation)
	Sets the orientation of the reference coordinate frame.
const decVector &	GetBoneOffset () const
	Retrieves the offset of the bone constraint position relative to the reference coordinate frame.
void	SetBoneOffset (const decVector &offset)
	Sets the offset of the bone constraint position relative to the reference coordinate frame.
const decVector &	GetLinearLowerLimits () const
	Retrieves the linear lower limits.
const decVector &	GetLinearUpperLimits () const
	Retrieves the linear upper limits.
void	SetLinearLimits (const decVector &lower, const decVector &upper)
	Sets the linear limits.
const decVector &	GetLinearSpringStiffness () const
	Retrieves the linear spring stiffness.
void	SetLinearSpringStiffness (const decVector &stiffness)
	Sets the linear spring stiffness.
const decVector &	GetAngularLowerLimits () const
	Retrieves the angular lower limits.
const decVector &	GetAngularUpperLimits () const
	Retrieves the angular upper limits.
void	SetAngularLimits (const decVector &lower, const decVector &upper)
	Sets the angular limits.
const decVector &	GetAngularSpringStiffness () const
	Retrieves the angular spring stiffness.
void	SetAngularSpringStiffness (const decVector &stiffness)
	Sets the angular spring stiffness.
float	GetLinearDamping () const
	Retrieves the linear damping.
void	SetLinearDamping (float damping)
	Sets the linear damping.
float	GetAngularDamping () const
	Retrieves the angular damping.
void	SetAngularDamping (float damping)
	Sets the angular damping.
float	GetSpringDamping () const
	Retrieves the spring damping.
void	SetSpringDamping (float damping)
	Sets the spring damping.
bool	GetIsRope () const
	Determines if this constraint is a rope.
void	SetIsRope (bool isRope)
	Sets if this constraint is a rope.
int	GetParentBone () const
	Retrieves the parent bone index.
void	SetParentBone (int bone)
	Sets the parent bone index.

---

Detailed Description

Rig Constraint.

Defines a constraint for a rig bone. The workings of this class is similar to the deColliderConstraint class with a few differences. The reference coordinate frame is defined relative to the owning bone. The parent coordinate frame is the same as the reference coordinate frame but relative to the parent bone. In addition an offset can be specified which displaces the actual bone coordinate frame relative to the reference coordinate frame. This is useful for spring constraints where the equilibrium position is not equal to the origin of the reference coordinate frame. In contrary to the deColliderConstraint the parent bone has to be a valid rig bone. Another difference is that in this class limits and spring stiffness can only be accessed using vectors instead of per degree of freedom as in the deColliderConstraint class. This has been done since the rig constraint is loaded from a file and does not require fine grained accessors and mutators.

Author:

Plüss Roland

Version:

1.0

Date:

2008

---

Constructor & Destructor Documentation

deRigConstraint::deRigConstraint

(

)

Creates a new rig constraint.

deRigConstraint::~deRigConstraint

(

)

Cleans up the rig constraint.

---

Member Function Documentation

float deRigConstraint::GetAngularDamping

(

)

const [inline]

Retrieves the angular damping.

const decVector& deRigConstraint::GetAngularLowerLimits

(

)

const [inline]

Retrieves the angular lower limits.

const decVector& deRigConstraint::GetAngularSpringStiffness

(

)

const [inline]

Retrieves the angular spring stiffness.

const decVector& deRigConstraint::GetAngularUpperLimits

(

)

const [inline]

Retrieves the angular upper limits.

const decVector& deRigConstraint::GetBoneOffset

(

)

const [inline]

Retrieves the offset of the bone constraint position relative to the reference coordinate frame.

bool deRigConstraint::GetIsRope

(

)

const [inline]

Determines if this constraint is a rope.

float deRigConstraint::GetLinearDamping

(

)

const [inline]

Retrieves the linear damping.

const decVector& deRigConstraint::GetLinearLowerLimits

(

)

const [inline]

Retrieves the linear lower limits.

const decVector& deRigConstraint::GetLinearSpringStiffness

(

)

const [inline]

Retrieves the linear spring stiffness.

const decVector& deRigConstraint::GetLinearUpperLimits

(

)

const [inline]

Retrieves the linear upper limits.

int deRigConstraint::GetParentBone

(

)

const [inline]

Retrieves the parent bone index.

const decQuaternion& deRigConstraint::GetReferenceOrientation

(

)

const [inline]

Retrieves the orientation of the reference coordinate frame.

const decVector& deRigConstraint::GetReferencePosition

(

)

const [inline]

Retrieves the position of the reference coordinate frame.

float deRigConstraint::GetSpringDamping

(

)

const [inline]

Retrieves the spring damping.

void deRigConstraint::SetAngularDamping

(

float

damping )

Sets the angular damping.

void deRigConstraint::SetAngularLimits	(	const decVector &	lower,
		const decVector &	upper
	)

Sets the angular limits.

void deRigConstraint::SetAngularSpringStiffness

(

const decVector &

stiffness )

Sets the angular spring stiffness.

void deRigConstraint::SetBoneOffset

(

const decVector &

offset )

Sets the offset of the bone constraint position relative to the reference coordinate frame.

void deRigConstraint::SetIsRope

(

bool

isRope )

Sets if this constraint is a rope.

void deRigConstraint::SetLinearDamping

(

float

damping )

Sets the linear damping.

void deRigConstraint::SetLinearLimits	(	const decVector &	lower,
		const decVector &	upper
	)

Sets the linear limits.

void deRigConstraint::SetLinearSpringStiffness

(

const decVector &

stiffness )

Sets the linear spring stiffness.

void deRigConstraint::SetParentBone

(

int

bone )

Sets the parent bone index.

void deRigConstraint::SetReferenceOrientation

(

const decQuaternion &

orientation )

Sets the orientation of the reference coordinate frame.

void deRigConstraint::SetReferencePosition

(

const decVector &

position )

Sets the position of the reference coordinate frame.

void deRigConstraint::SetSpringDamping

(

float

damping )

Sets the spring damping.

---

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

• deRigConstraint.h