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 57 of file kfbxconstraintscale.h.

Properties
KFbxTypedProperty< fbxBool1 >	AffectX
KFbxTypedProperty< fbxBool1 >	AffectY
KFbxTypedProperty< fbxBool1 >	AffectZ
KFbxTypedProperty< fbxDouble3 >	Scaling
KFbxTypedProperty< fbxReference >	ConstraintSources
KFbxTypedProperty< fbxReference >	ConstrainedObject
Public Member Functions
void	SetLock (bool pLock)
	Set the constraint lock.
bool	GetLock () const
	Retrieve the constraint lock state.
void	SetAffectX (bool pAffect)
	Set the constraint X-axis effectiveness.
bool	GetAffectX () const
	Retrieve the constraint X-axis effectiveness.
void	SetAffectY (bool pAffect)
	Set the constraint Y-axis effectiveness.
bool	GetAffectY () const
	Retrieve the constraint Y-axis effectiveness.
void	SetAffectZ (bool pAffect)
	Set the constraint Z-axis effectiveness.
bool	GetAffectZ () const
	Retrieve the constraint Z-axis effectiveness.
virtual void	SetOffset (KFbxVector4 pScale)
	Set the Scale offset.
KFbxVector4	GetOffset () const
	Retrieve the constraint scale offset.
void	SetWeight (double pWeight)
	Set the weight of the constraint.
void	AddConstraintSource (KFbxObject *pObject, double pWeight=100)
	Add a source to the constraint.
int	GetConstraintSourceCount () const
	Retrieve the constraint source count.
KFbxObject *	GetConstraintSource (int pIndex) const
	Retrieve a constraint source object.
void	SetConstrainedObject (KFbxObject *pObject)
	Set the constrained object.
KFbxObject *	GetConstrainedObject () const
	Retrieve the constrained object.

---

Member Function Documentation

void SetLock

(

bool

pLock

)

Set the constraint lock.

Parameters:

pLock

State of the lock flag.

bool GetLock

(

)

const

Retrieve the constraint lock state.

Returns:

Current lock flag.

void SetAffectX

(

bool

pAffect

)

Set the constraint X-axis effectiveness.

Parameters:

pAffect

State of the effectiveness on the X axis.

bool GetAffectX

(

)

const

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

(

)

const

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

(

)

const

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

(

)

const

Retrieve the constraint scale offset.

Returns:

Current scale offset.

void SetWeight

(

double

pWeight

)

Set the weight of the constraint.

Parameters:

pWeight

New weight value.

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

(

)

const [virtual]

Retrieve the constraint source count.

Returns:

Current constraint source count.

Reimplemented from KFbxConstraint.

KFbxObject* GetConstraintSource

(

int

pIndex

)

const [virtual]

Retrieve a constraint source object.

Parameters:

pIndex

Index of the source

Returns:

Current source at the specified index.

Reimplemented from KFbxConstraint.

void SetConstrainedObject

(

KFbxObject *

pObject

)

Set the constrained object.

Parameters:

pObject

The constrained object.

KFbxObject* GetConstrainedObject

(

)

const [virtual]

Retrieve the constrained object.

Returns:

Current constrained object.

Reimplemented from KFbxConstraint.

---

Member Data Documentation

KFbxTypedProperty<fbxBool1> AffectX

Definition at line 66 of file kfbxconstraintscale.h.

KFbxTypedProperty<fbxBool1> AffectY

Definition at line 67 of file kfbxconstraintscale.h.

KFbxTypedProperty<fbxBool1> AffectZ

Definition at line 68 of file kfbxconstraintscale.h.

KFbxTypedProperty<fbxDouble3> Scaling

Definition at line 70 of file kfbxconstraintscale.h.

KFbxTypedProperty<fbxReference> ConstraintSources

Definition at line 72 of file kfbxconstraintscale.h.

KFbxTypedProperty<fbxReference> ConstrainedObject

Definition at line 73 of file kfbxconstraintscale.h.