KFbxConstraintScale Class Reference

#include <kfbxconstraintscale.h>

Inheritance diagram for KFbxConstraintScale:

[legend]

List of all members.

---

Detailed Description

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

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

Definition at line 59 of file kfbxconstraintscale.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-axis effectiveness.
bool	GetAffectX ()
	Retrieve the constraint X-axis effectiveness.
void	SetAffectY (bool pAffect)
	Set the constraint Y-axis effectiveness.
bool	GetAffectY ()
	Retrieve the constraint Y-axis effectiveness.
void	SetAffectZ (bool pAffect)
	Set the constraint Z-axis effectiveness.
bool	GetAffectZ ()
	Retrieve the constraint Z-axis effectiveness.
virtual void	SetOffset (KFbxVector4 pScale)
	Set the Scale offset.
KFbxVector4	GetOffset ()
	Retrieve the constraint scale 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 constrained object.
KFbxObject *	GetConstrainedObject ()
	Retrieve the constrained 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-axis effectiveness.

Parameters:

pAffect

State of the effectiveness on the X axis.

bool GetAffectX

(

)

Retrieve the constraint X-axis effectiveness.

Returns:

Current state flag.

void SetAffectY

(

bool

pAffect

)

Set the constraint Y-axis effectiveness.

Parameters:

pAffect

State of the effectiveness on the X axis.

bool GetAffectY

(

)

Retrieve the constraint Y-axis effectiveness.

Returns:

Current state flag.

void SetAffectZ

(

bool

pAffect

)

Set the constraint Z-axis effectiveness.

Parameters:

pAffect

State of the effectiveness on the X axis.

bool GetAffectZ

(

)

Retrieve the constraint Z-axis effectiveness.

Returns:

Current state flag.

virtual void SetOffset

(

KFbxVector4

pScale

)

[virtual]

Set the Scale offset.

Parameters:

pScale

New offset vector.

Reimplemented from KFbxConstraint.

KFbxVector4 GetOffset

(

)

Retrieve the constraint scale offset.

Returns:

Current scale offset.

void SetWeight

(

double

pWeight

)

Set the weight of the constraint.

Parameters:

pWeight

New weight value.

double GetSourceWeight

(

KFbxObject *

pObject

)

Get the weight of a source.

Parameters:

pObject

Index of the source.

void AddConstraintSource	(	KFbxObject *	pObject,
		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

Returns:

Current source at the specified index.

void SetConstrainedObject

(

KFbxObject *

pObject

)

Set the constrained object.

Parameters:

pObject

The constrained object.

KFbxObject* GetConstrainedObject

(

)

Retrieve the constrained object.

Returns:

Current constrained object.