KFbxConstraintParent Class Reference

#include <kfbxconstraintparent.h>

Inherits KFbxConstraint.

Inheritance diagram for KFbxConstraintParent:

List of all members.

---

Detailed Description

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

A parent constraint lets you constrain the translation, scaling, rotation of an object based on one or more parent objects.

Definition at line 64 of file kfbxconstraintparent.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	SetAffectTranslationX (bool pAffect)
	Set the constraint X-axe translation effectiveness.
bool	GetAffectTranslationX ()
	Retrieve the constraint X-axe translation effectiveness.
void	SetAffectTranslationY (bool pAffect)
	Set the constraint Y-axe translation effectiveness.
bool	GetAffectTranslationY ()
	Retrieve the constraint Y-axe translation effectiveness.
void	SetAffectTranslationZ (bool pAffect)
	Set the constraint Z-axe translation effectiveness.
bool	GetAffectTranslationZ ()
	Retrieve the constraint Z-axe translation effectiveness.
void	SetAffectRotationX (bool pAffect)
	Set the constraint X-axe rotation effectiveness.
bool	GetAffectRotationX ()
	Retrieve the constraint X-axe rotation effectiveness.
void	SetAffectRotationY (bool pAffect)
	Set the constraint Y-axe rotation effectiveness.
bool	GetAffectRotationY ()
	Retrieve the constraint Y-axe rotation effectiveness.
void	SetAffectRotationZ (bool pAffect)
	Set the constraint Z-axe rotation effectiveness.
bool	GetAffectRotationZ ()
	Retrieve the constraint Z-axe rotation effectiveness.
void	SetTranslationOffset (KFbxObject *pObject, KFbxVector4 pTranslation)
	Set the translation offset.
KFbxVector4	GetTranslationOffset (KFbxObject *pObject)
	Retrieve the constraint translation offset.
virtual void	SetRotationOffset (KFbxObject *pObject, KFbxVector4 pRotation)
	Set the rotation offset.
KFbxVector4	GetRotationOffset (KFbxObject *pObject)
	Retrieve the constraint rotation offset.
void	SetWeight (double pWeight)
	Set the weight of the constraint.
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.
KFbxObject *	GetConstraintSource (int pIndex)
	Retrieve a constraint source object.
void	SetConstrainedObject (KFbxObject *pObject)
	Set the constrainted object.
KFbxObject *	GetConstrainedObject ()
	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:

pLock

State of the active flag.

bool GetActive

(

)

Retrieve the constraint active state.

Returns:

Current active flag.

void SetAffectTranslationX

(

bool

pAffect

)

Set the constraint X-axe translation effectiveness.

Parameters:

pAffect

State of the translation effectivness on the X axe.

bool GetAffectTranslationX

(

)

Retrieve the constraint X-axe translation effectiveness.

Returns:

Current state flag.

void SetAffectTranslationY

(

bool

pAffect

)

Set the constraint Y-axe translation effectiveness.

Parameters:

pAffect

State of the translation effectivness on the Y axe.

bool GetAffectTranslationY

(

)

Retrieve the constraint Y-axe translation effectiveness.

Returns:

Current state flag.

void SetAffectTranslationZ

(

bool

pAffect

)

Set the constraint Z-axe translation effectiveness.

Parameters:

pAffect

State of the translation effectivness on the Z axe.

bool GetAffectTranslationZ

(

)

Retrieve the constraint Z-axe translation effectiveness.

Returns:

Current state flag.

void SetAffectRotationX

(

bool

pAffect

)

Set the constraint X-axe rotation effectiveness.

Parameters:

pAffect

State of the rotation effectivness on the X axe.

bool GetAffectRotationX

(

)

Retrieve the constraint X-axe rotation effectiveness.

Returns:

Current state flag.

void SetAffectRotationY

(

bool

pAffect

)

Set the constraint Y-axe rotation effectiveness.

Parameters:

pAffect

State of the rotation effectivness on the Y axe.

bool GetAffectRotationY

(

)

Retrieve the constraint Y-axe rotation effectiveness.

Returns:

Current state flag.

void SetAffectRotationZ

(

bool

pAffect

)

Set the constraint Z-axe rotation effectiveness.

Parameters:

pAffect

State of the rotation effectivness on the Z axe.

bool GetAffectRotationZ

(

)

Retrieve the constraint Z-axe rotation effectiveness.

Returns:

Current state flag.

void SetTranslationOffset	(	KFbxObject *	pObject,
		KFbxVector4	pTranslation
	)

Set the translation offset.

Parameters:

	Source	object.
	New	offset vector.

KFbxVector4 GetTranslationOffset

(

KFbxObject *

pObject

)

Retrieve the constraint translation offset.

Parameters:

Object

that we want the offset.

Returns:

Current translation offset.

virtual void SetRotationOffset	(	KFbxObject *	pObject,
		KFbxVector4	pRotation
	)			[virtual]

Set the rotation offset.

Parameters:

	Source	object.
	New	offset vector.

KFbxVector4 GetRotationOffset

(

KFbxObject *

pObject

)

Retrieve the constraint rotation offset.

Parameters:

Object

that we want the offset.

Returns:

Current translation offset.

void SetWeight

(

double

pWeight

)

Set the weight of the constraint.

Parameters:

New

weight value.

double GetSourceWeight

(

KFbxObject *

pObject

)

Get the weight of a source.

Parameters:

Index

of the source.

void AddConstraintSource	(	KFbxObject *	pObject,
		double	pWeight = 100
	)

Add a source to the constraint.

Parameters:

	New	source object.
	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.

Returns:

Current source at the specified index.

void SetConstrainedObject

(

KFbxObject *

pObject

)

Set the constrainted object.

Parameters:

The

constrained object.

KFbxObject* GetConstrainedObject

(

)

Retrieve the constrainted object.

Returns:

Current constrained object.