KFbxConstraintAim Class Reference

#include <kfbxconstraintaim.h>

Inheritance diagram for KFbxConstraintAim:

[legend]

List of all members.

---

Detailed Description

An aim constraint governs an object's orientation so that the object points to other objects.

For example, you can use the aim constraint to point a light at an object or group of objects.

Definition at line 57 of file kfbxconstraintaim.h.

Properties
KFbxTypedProperty< fbxDouble3 >	RotationOffset
	This property handles the rotation offset value.
KFbxTypedProperty< fbxReference >	AimAtObjects
	This property provides access to the object or objects which are the targets.
KFbxTypedProperty< fbxReference >	ConstrainedObject
	This property provides access to the object being aimed.
KFbxTypedProperty< fbxEnum >	WorldUpType
	This property handles world up type.
KFbxTypedProperty< fbxReference >	WorldUpObject
	This property handles world up object.
KFbxTypedProperty< fbxDouble3 >	WorldUpVector
	This property handles world up vector.
KFbxTypedProperty< fbxDouble3 >	UpVector
	This property handles up vector.
KFbxTypedProperty< fbxDouble3 >	AimVector
	This property enables you set a specific axis for the constrained object to orient towards.
KFbxTypedProperty< fbxBool1 >	AffectX
	This property handles whether to affect the rotation around X axis.
KFbxTypedProperty< fbxBool1 >	AffectY
	This property handles whether to affect the rotation around Y axis.
KFbxTypedProperty< fbxBool1 >	AffectZ
	This property handles whether to affect the rotation around Z axis.
Public Types
enum	EAimConstraintWorldUpType {    eAimAtSceneUp,    eAimAtObjectUp,    eAimAtObjectRotationUp,    eAimAtVector,    eAimAtNone,    eAimAtCount }
	Constraint world up type, which has the same meaning with Maya eAimAtSceneUp eAimAtObjectUp eAimAtObjectRotationUp eAimAtVector eAimAtNone eAimAtCount. More...
Public Member Functions
void	SetLock (bool pLock)
	Set the constraint lock state.
bool	GetLock ()
	Retrieve the constraint lock state.
void	SetWeight (double pWeight)
	Set the weight of the constraint.
virtual void	SetOffset (KFbxVector4 pRotation)
	Set the rotation offset.
KFbxVector4	GetOffset () const
	Retrieve the constraint rotation offset.
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.
void	SetWorldUpType (EAimConstraintWorldUpType pType)
	Set the world up type.
EAimConstraintWorldUpType	GetWorldUpType () const
	Retrieve the world up type.
void	SetWorldUpObject (KFbxObject *pObject)
	Set the world up object.
KFbxObject *	GetWorldUpObject () const
	Retrieve the world up object.
K_DEPRECATED void	SetWorldUpVector (KFbxVector4 pVector)
	This method is deprecated and should be replaced with WorldUpVector.Set(value).
K_DEPRECATED KFbxVector4	GetWorldUpVector () const
	This method is deprecated and should be replaced with value = WorldUpVector.Get().
K_DEPRECATED void	SetUpVector (KFbxVector4 pVector)
	This method is deprecated and should be replaced with UpVector.Set(value).
K_DEPRECATED KFbxVector4	GetUpVector () const
	This method is deprecated and should be replaced with value = UpVector.Get().
K_DEPRECATED void	SetAimVector (KFbxVector4 pVector)
	This method is deprecated and should be replaced with AimVector.Set(value).
K_DEPRECATED KFbxVector4	GetAimVector () const
	This method is deprecated and should be replaced with value = AimVector.Get().
K_DEPRECATED void	SetAffectX (bool pAffect)
	This method is deprecated and should be replaced with AffectX.Set(value).
K_DEPRECATED bool	GetAffectX ()
	This method is deprecated and should be replaced with value = AffectX.Get().
K_DEPRECATED void	SetAffectY (bool pAffect)
	This method is deprecated and should be replaced with AffectY.Set(value).
K_DEPRECATED bool	GetAffectY () const
	This method is deprecated and should be replaced with value = AffectY.Get().
K_DEPRECATED void	SetAffectZ (bool pAffect)
	This method is deprecated and should be replaced with AffectZ.Set(value).
K_DEPRECATED bool	GetAffectZ () const
	This method is deprecated and should be replaced with value = AffectZ.Get().

---

Member Enumeration Documentation

enum EAimConstraintWorldUpType

Constraint world up type, which has the same meaning with Maya

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

Enumerator:

eAimAtSceneUp
eAimAtObjectUp
eAimAtObjectRotationUp
eAimAtVector
eAimAtNone
eAimAtCount

Definition at line 135 of file kfbxconstraintaim.h.

---

Member Function Documentation

void SetLock

(

bool

pLock

)

[inline]

Set the constraint lock state.

Parameters:

pLock

The new state of the lock flag.

Definition at line 148 of file kfbxconstraintaim.h.

bool GetLock

(

)

[inline]

Retrieve the constraint lock state.

Returns:

The current value of the lock flag.

Definition at line 153 of file kfbxconstraintaim.h.

void SetWeight

(

double

pWeight

)

Set the weight of the constraint.

Parameters:

pWeight

The new weight value.

virtual void SetOffset

(

KFbxVector4

pRotation

)

[virtual]

Set the rotation offset.

Parameters:

pRotation

The new rotation offset vector.

Reimplemented from KFbxConstraint.

KFbxVector4 GetOffset

(

)

const

Retrieve the constraint rotation offset.

Returns:

The current rotation offset vector.

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

The specified index.

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.

void SetWorldUpType

(

EAimConstraintWorldUpType

pType

)

Set the world up type.

Parameters:

pType

The world up type.

EAimConstraintWorldUpType GetWorldUpType

(

)

const

Retrieve the world up type.

Returns:

Current world up type.

void SetWorldUpObject

(

KFbxObject *

pObject

)

Set the world up object.

Parameters:

pObject

The new world up object.

KFbxObject* GetWorldUpObject

(

)

const

Retrieve the world up object.

Returns:

The current world up object.

K_DEPRECATED void SetWorldUpVector

(

KFbxVector4

pVector

)

This method is deprecated and should be replaced with WorldUpVector.Set(value).

K_DEPRECATED KFbxVector4 GetWorldUpVector

(

)

const

This method is deprecated and should be replaced with value = WorldUpVector.Get().

K_DEPRECATED void SetUpVector

(

KFbxVector4

pVector

)

This method is deprecated and should be replaced with UpVector.Set(value).

K_DEPRECATED KFbxVector4 GetUpVector

(

)

const

This method is deprecated and should be replaced with value = UpVector.Get().

K_DEPRECATED void SetAimVector

(

KFbxVector4

pVector

)

This method is deprecated and should be replaced with AimVector.Set(value).

K_DEPRECATED KFbxVector4 GetAimVector

(

)

const

This method is deprecated and should be replaced with value = AimVector.Get().

K_DEPRECATED void SetAffectX

(

bool

pAffect

)

[inline]

This method is deprecated and should be replaced with AffectX.Set(value).

Definition at line 243 of file kfbxconstraintaim.h.

K_DEPRECATED bool GetAffectX

(

)

[inline]

This method is deprecated and should be replaced with value = AffectX.Get().

Definition at line 247 of file kfbxconstraintaim.h.

K_DEPRECATED void SetAffectY

(

bool

pAffect

)

[inline]

This method is deprecated and should be replaced with AffectY.Set(value).

Definition at line 251 of file kfbxconstraintaim.h.

K_DEPRECATED bool GetAffectY

(

)

const [inline]

This method is deprecated and should be replaced with value = AffectY.Get().

Definition at line 255 of file kfbxconstraintaim.h.

K_DEPRECATED void SetAffectZ

(

bool

pAffect

)

[inline]

This method is deprecated and should be replaced with AffectZ.Set(value).

Definition at line 259 of file kfbxconstraintaim.h.

K_DEPRECATED bool GetAffectZ

(

)

const [inline]

This method is deprecated and should be replaced with value = AffectZ.Get().

Definition at line 263 of file kfbxconstraintaim.h.

---

Member Data Documentation

KFbxTypedProperty<fbxDouble3> RotationOffset

This property handles the rotation offset value.

Default value is (0, 0, 0).

Definition at line 70 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxReference> AimAtObjects

This property provides access to the object or objects which are the targets.

Definition at line 74 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxReference> ConstrainedObject

This property provides access to the object being aimed.

Definition at line 78 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxEnum> WorldUpType

This property handles world up type.

Definition at line 82 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxReference> WorldUpObject

This property handles world up object.

Definition at line 86 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxDouble3> WorldUpVector

This property handles world up vector.

Default value is (0, 1, 0).

Definition at line 92 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxDouble3> UpVector

This property handles up vector.

Default value is (0, 1, 0).

Definition at line 98 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxDouble3> AimVector

This property enables you set a specific axis for the constrained object to orient towards.

Default value is (1, 0, 0).

Definition at line 104 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxBool1> AffectX

This property handles whether to affect the rotation around X axis.

Default value is true.

Definition at line 110 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxBool1> AffectY

This property handles whether to affect the rotation around Y axis.

Default value is true.

Definition at line 116 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxBool1> AffectZ

This property handles whether to affect the rotation around Z axis.

Default value is true.

Definition at line 122 of file kfbxconstraintaim.h.