KFbxConstraintAim Class Reference

#include <kfbxconstraintaim.h>

Inheritance diagram for KFbxConstraintAim:

[legend]

List of all members.

---

Detailed Description

This constraint class contains methods for accessing the properties of an aim constraint.

A aim constraint lets you constrain an object based on the properties of one or more aim objects.

Definition at line 59 of file kfbxconstraintaim.h.

Public Types
enum	EAimConstraintWoldUpType
	Contraint world up type. More...
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	SetWeight (double pWeight)
	Set the weight of the constraint.
virtual void	SetOffset (KFbxVector4 pRotation)
	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.
KFbxObject *	GetConstraintSource (int pIndex)
	Retrieve a constraint source object.
void	SetConstrainedObject (KFbxObject *pObject)
	Set the constrained object.
KFbxObject *	GetConstrainedObject ()
	Retrieve the constrained object.
void	SetWorldUpType (EAimConstraintWoldUpType pType)
	Set the world up type.
EAimConstraintWoldUpType	GetWorldUpType ()
	Retrieve the world up type.
void	SetWorldUpObject (KFbxObject *pObject)
	Set the world up object.
KFbxObject *	GetWorldUpObject ()
	Retrieve the world up object.
void	SetWorldUpVector (KFbxVector4 pVector)
	Set the world up vector.
KFbxVector4	GetWorldUpVector ()
	Retrieve the world up vector.
void	SetUpVector (KFbxVector4 pVector)
	Set the up vector.
KFbxVector4	GetUpVector ()
	Retrieve the up vector.
void	SetAimVector (KFbxVector4 pVector)
	Set the aim vector.
KFbxVector4	GetAimVector ()
	Retrieve the aim vector.
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.

---

Member Enumeration Documentation

enum EAimConstraintWoldUpType

Contraint world up type.

• eAimAtSceneUp
• eAimAtObjectUp
• eAimAtObjectRotationUp
• eAimAtVector
• eAimAtNone
• eAimAtCount

Definition at line 140 of file kfbxconstraintaim.h.

---

Member Function Documentation

void SetLock

(

bool

pLock

)

[inline]

Set the constraint lock.

Parameters:

pLock

State of the lock flag.

Definition at line 153 of file kfbxconstraintaim.h.

bool GetLock

(

)

[inline]

Retrieve the constraint lock state.

Returns:

Current lock flag.

Definition at line 158 of file kfbxconstraintaim.h.

void SetActive

(

bool

pActive

)

[inline]

Set the constraint active.

Parameters:

pActive

State of the active flag.

Definition at line 163 of file kfbxconstraintaim.h.

bool GetActive

(

)

[inline]

Retrieve the constraint active state.

Returns:

Current active flag.

Definition at line 168 of file kfbxconstraintaim.h.

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 from KFbxConstraint.

KFbxVector4 GetOffset

(

)

Retrieve the constraint rotation offset.

Returns:

Current rotation offset.

double GetSourceWeight

(

KFbxObject *

pObject

)

Get the weight of a source.

Parameters:

pObject

Source object.

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

The specified index.

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.

void SetWorldUpType

(

EAimConstraintWoldUpType

pType

)

Set the world up type.

Parameters:

pType

The world up type.

EAimConstraintWoldUpType GetWorldUpType

(

)

Retrieve the world up type.

Returns:

Current world up type.

void SetWorldUpObject

(

KFbxObject *

pObject

)

Set the world up object.

Parameters:

pObject

The world up object.

KFbxObject* GetWorldUpObject

(

)

Retrieve the world up object.

Returns:

Current world up object.

void SetWorldUpVector

(

KFbxVector4

pVector

)

Set the world up vector.

Parameters:

pVector

The world up vector.

KFbxVector4 GetWorldUpVector

(

)

Retrieve the world up vector.

Returns:

Current world up vector.

void SetUpVector

(

KFbxVector4

pVector

)

Set the up vector.

Parameters:

pVector

The up vector.

KFbxVector4 GetUpVector

(

)

Retrieve the up vector.

Returns:

Current up vector.

void SetAimVector

(

KFbxVector4

pVector

)

Set the aim vector.

Parameters:

pVector

The up vector.

KFbxVector4 GetAimVector

(

)

Retrieve the aim vector.

Returns:

Current up vector.

void SetAffectX

(

bool

pAffect

)

[inline]

Set the constraint X-axis effectiveness.

Parameters:

pAffect

State of the effectiveness on the X axis.

Definition at line 270 of file kfbxconstraintaim.h.

bool GetAffectX

(

)

[inline]

Retrieve the constraint X-axis effectiveness.

Returns:

Current state flag.

Definition at line 275 of file kfbxconstraintaim.h.

void SetAffectY

(

bool

pAffect

)

[inline]

Set the constraint Y-axis effectiveness.

Parameters:

pAffect

State of the effectiveness on the X axis.

Definition at line 280 of file kfbxconstraintaim.h.

bool GetAffectY

(

)

[inline]

Retrieve the constraint Y-axis effectiveness.

Returns:

Current state flag.

Definition at line 285 of file kfbxconstraintaim.h.

void SetAffectZ

(

bool

pAffect

)

[inline]

Set the constraint Z-axis effectiveness.

Parameters:

pAffect

State of the effectiveness on the X axis.

Definition at line 290 of file kfbxconstraintaim.h.

bool GetAffectZ

(

)

[inline]

Retrieve the constraint Z-axis effectiveness.

Returns:

Current state flag.

Definition at line 295 of file kfbxconstraintaim.h.