KFbxConstraintAim Class Reference

This reference page is linked to from the following overview topics: List of Python FBX classes.

---

Search for all occurrences

---

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.

#include <kfbxconstraintaim.h>

Inheritance diagram for KFbxConstraintAim:

List of all members.

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.
Protected Member Functions
	KFbxConstraintAim (KFbxSdkManager &pManager, char const *pName)
virtual bool	ConstructProperties (bool pForceSet)
virtual EConstraintType	GetConstraintType () const
	Access the type of the constraint.
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.

---

Member Enumeration Documentation

enum EAimConstraintWorldUpType

Search for all occurrences

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

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

Enumerator:

eAimAtSceneUp	Search for all occurrences
eAimAtObjectUp	Search for all occurrences
eAimAtObjectRotationUp	Search for all occurrences
eAimAtVector	Search for all occurrences
eAimAtNone	Search for all occurrences
eAimAtCount	Search for all occurrences

Definition at line 135 of file kfbxconstraintaim.h.

    {
        eAimAtSceneUp,
        eAimAtObjectUp,
        eAimAtObjectRotationUp,
        eAimAtVector,
        eAimAtNone,
        eAimAtCount
    } EAimConstraintWorldUpType;

---

Constructor & Destructor Documentation

KFbxConstraintAim	(	KFbxSdkManager &	pManager,
		char const *	pName
	)		[protected]

---

Member Function Documentation

void SetLock

(

bool

pLock

)

[inline]

Search for all occurrences

Set the constraint lock state.

Parameters:

pLock

The new state of the lock flag.

Definition at line 148 of file kfbxconstraintaim.h.

{ Lock.Set(pLock); }

bool GetLock

(

)

[inline]

Search for all occurrences

Retrieve the constraint lock state.

Returns:

The current value of the lock flag.

Definition at line 153 of file kfbxconstraintaim.h.

{ return Lock.Get(); }

void SetWeight

(

double

pWeight

)

Search for all occurrences

Set the weight of the constraint.

Parameters:

pWeight

The new weight value.

virtual void SetOffset

(

KFbxVector4

pRotation

)

[virtual]

Search for all occurrences

Set the rotation offset.

Parameters:

pRotation

The new rotation offset vector.

Reimplemented from KFbxConstraint.

KFbxVector4 GetOffset

(

)

const

Search for all occurrences

Retrieve the constraint rotation offset.

Returns:

The current rotation offset vector.

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

Search for all occurrences

Add a source to the constraint.

Parameters:

pObject	New source object.
pWeight	Weight of the source object.

int GetConstraintSourceCount

(

)

const [virtual]

Search for all occurrences

Retrieve the constraint source count.

Returns:

Current constraint source count.

Reimplemented from KFbxConstraint.

KFbxObject* GetConstraintSource

(

int

pIndex

)

const [virtual]

Search for all occurrences

Retrieve a constraint source object.

Parameters:

pIndex

The specified index.

Returns:

Current source at the specified index.

Reimplemented from KFbxConstraint.

void SetConstrainedObject

(

KFbxObject *

pObject

)

Search for all occurrences

Set the constrained object.

Parameters:

pObject

The constrained object.

KFbxObject* GetConstrainedObject

(

)

const [virtual]

Search for all occurrences

Retrieve the constrained object.

Returns:

Current constrained object.

Reimplemented from KFbxConstraint.

void SetWorldUpType

(

EAimConstraintWorldUpType

pType

)

Search for all occurrences

Set the world up type.

Parameters:

pType

The world up type.

EAimConstraintWorldUpType GetWorldUpType

(

)

const

Search for all occurrences

Retrieve the world up type.

Returns:

Current world up type.

void SetWorldUpObject

(

KFbxObject *

pObject

)

Search for all occurrences

Set the world up object.

Parameters:

pObject

The new world up object.

KFbxObject* GetWorldUpObject

(

)

const

Search for all occurrences

Retrieve the world up object.

Returns:

The current world up object.

virtual bool ConstructProperties

(

bool

pForceSet

)

[protected, virtual]

Search for all occurrences

Reimplemented from KFbxConstraint.

virtual EConstraintType GetConstraintType

(

)

const [protected, virtual]

Search for all occurrences

Access the type of the constraint.

Returns:

This type of the constraint.

Reimplemented from KFbxConstraint.

---

Member Data Documentation

KFbxTypedProperty<fbxDouble3> RotationOffset

Search for all occurrences

This property handles the rotation offset value.

Default value is (0, 0, 0).

Definition at line 70 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxReference> AimAtObjects

Search for all occurrences

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

Definition at line 74 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxReference> ConstrainedObject

Search for all occurrences

This property provides access to the object being aimed.

Definition at line 78 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxEnum> WorldUpType

Search for all occurrences

This property handles world up type.

Definition at line 82 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxReference> WorldUpObject

Search for all occurrences

This property handles world up object.

Definition at line 86 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxDouble3> WorldUpVector

Search for all occurrences

This property handles world up vector.

Default value is (0, 1, 0).

Definition at line 92 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxDouble3> UpVector

Search for all occurrences

This property handles up vector.

Default value is (0, 1, 0).

Definition at line 98 of file kfbxconstraintaim.h.

KFbxTypedProperty<fbxDouble3> AimVector

Search for all occurrences

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

Search for all occurrences

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

Search for all occurrences

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

Search for all occurrences

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

Default value is true.

Definition at line 122 of file kfbxconstraintaim.h.

---

The documentation for this class was generated from the following file:

• fbxfilesdk/kfbxplugins/kfbxconstraintaim.h