KFbxConstraintRotation
#include<kfbxconstraintrotation.h>

Inheritance diagram for KFbxConstraintRotation:

Inheritance graph
[legend]

List of all members.

Detailed Description

This constraint class contains methods for accessing the properties of a rotation constraint.

A rotation constraint lets you constrain the rotation of an object based on the rotation of one or more sources.

Definition at line63of filekfbxconstraintrotation.h.


Public Member Functions

void SetLock(bool pLock)
 Set the constraint lock.
bool GetLock()
 Retrieve the constraint lock state.
void SetActive(bool pActive)
 Set the constraint active.
bool GetActive()
 Retrieve the constraint active state.
void SetAffectX(bool pAffect)
 Set the constraint X-axe effectiveness.
bool GetAffectX()
 Retrieve the constraint X-axe effectiveness.
void SetAffectY(bool pAffect)
 Set the constraint Y-axe effectiveness.
bool GetAffectY()
 Retrieve the constraint Y-axe effectiveness.
void SetAffectZ(bool pAffect)
 Set the constraint Z-axe effectiveness.
bool GetAffectZ()
 Retrieve the constraint Z-axe effectiveness.
void SetWeight(double pWeight)
 Set the weight of the constraint.
virtual void SetOffset(KFbxVector4pRotation)
 Set the rotation offset.
KFbxVector4 GetOffset()
 Retrieve the constraint rotation offset.
double GetSourceWeight(KFbxObject*pObject)
 Get the weight of a source.
void AddConstraintSource(KFbxObject*pObject, double pWeight=100)
 Add a source to the constraint.
int GetConstraintSourceCount()
 Retrieve the constraint source count.
KFbxObjectGetConstraintSource(int pIndex)
 Retrieve a constraint source object.
void SetConstrainedObject(KFbxObject*pObject)
 Set the constrainted object.
KFbxObjectGetConstrainedObject()
 Retrieve the constrainted object.

Member Function Documentation

void SetLock(bool pLock ) 

Set the constraint lock.

Parameters:
pLock State of the lock flag.

bool GetLock( ) 

Retrieve the constraint lock state.

Returns:
Current lock flag.

void SetActive(bool pActive ) 

Set the constraint active.

Parameters:
pActive State of the active flag.

bool GetActive( ) 

Retrieve the constraint active state.

Returns:
Current active flag.

void SetAffectX(bool pAffect ) 

Set the constraint X-axe effectiveness.

Parameters:
pAffect State of the effectivness on the X axe.

bool GetAffectX( ) 

Retrieve the constraint X-axe effectiveness.

Returns:
Current state flag.

void SetAffectY(bool pAffect ) 

Set the constraint Y-axe effectiveness.

Parameters:
pAffect State of the effectivness on the X axe.

bool GetAffectY( ) 

Retrieve the constraint Y-axe effectiveness.

Returns:
Current state flag.

void SetAffectZ(bool pAffect ) 

Set the constraint Z-axe effectiveness.

Parameters:
pAffect State of the effectivness on the X axe.

bool GetAffectZ( ) 

Retrieve the constraint Z-axe effectiveness.

Returns:
Current state flag.

void SetWeight(double pWeight ) 

Set the weight of the constraint.

Parameters:
pWeight New weight value.

virtual void SetOffset(KFbxVector4 pRotation ) [virtual]

Set the rotation offset.

Parameters:
pRotation New offset vector.

Reimplemented fromKFbxConstraint.

KFbxVector4GetOffset( ) 

Retrieve the constraint rotation offset.

Returns:
Current rotation offset.

double GetSourceWeight(KFbxObjectpObject ) 

Get the weight of a source.

Parameters:
pObject Source object

void AddConstraintSource(KFbxObjectpObject,
double pWeight=100 
)

Add a source to the constraint.

Parameters:
pObject New source object.
pWeight Weight of the source object.

int GetConstraintSourceCount( ) 

Retrieve the constraint source count.

Returns:
Current constraint source count.

KFbxObject* GetConstraintSource(int pIndex ) 

Retrieve a constraint source object.

Parameters:
pIndex Index of the source object
Returns:
Current source at the specified index.

void SetConstrainedObject(KFbxObjectpObject ) 

Set the constrainted object.

Parameters:
pObject The constrained object.

KFbxObject* GetConstrainedObject( ) 

Retrieve the constrainted object.

Returns:
Current constrained object.