KFbxConstraintPosition Class Reference

#include <kfbxconstraintposition.h>

Inherits KFbxConstraint.

Inheritance diagram for KFbxConstraintPosition:

List of all members.

---

Detailed Description

/** This constraint class contains methods for accessing the properties of a position constraint.

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

Definition at line 64 of file kfbxconstraintposition.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.
virtual void	SetOffset (KFbxVector4 pTranslation)
	Set the translation offset.
KFbxVector4	GetOffset ()
	Retrieve the constraint translation 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.
bool	RemoveConstraintSource (KFbxObject *pObject)
	Remove a source from 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 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.

virtual void SetOffset

(

KFbxVector4

pTranslation

)

[virtual]

Set the translation offset.

Parameters:

New

offset vector.

Reimplemented from KFbxConstraint.

KFbxVector4 GetOffset

(

)

Retrieve the constraint translation 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:

Object

that we want the weight.

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

Add a source to the constraint.

Parameters:

	New	source object.
	Weight	of the source object.

bool RemoveConstraintSource

(

KFbxObject *

pObject

)

Remove a source from the constraint.

Parameters:

Source

object to remove.

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.