Public Member Functions | Protected Member Functions

FbxConstraintRotation Class Reference

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


Search for all occurrences

Detailed Description

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

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

Definition at line 26 of file fbxconstraintrotation.h.

#include <fbxconstraintrotation.h>

Inheritance diagram for FbxConstraintRotation:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void AddConstraintSource (FbxObject *pObject, double pWeight=100)
 Add a source to the constraint.
int GetConstraintSourceCount () const
 Retrieve the constraint source count.
FbxObjectGetConstraintSource (int pIndex) const
 Retrieve a constraint source object.
void SetConstrainedObject (FbxObject *pObject)
 Set the constrained object.
FbxObjectGetConstrainedObject () const
 Retrieve the constrained object.

Protected Member Functions

virtual void ConstructProperties (bool pForceSet)
 Optional property constructor override, automatically called by default constructor.
virtual EType GetConstraintType () const
 Access the type of the constraint.

Properties

FbxPropertyT< FbxBoolAffectX
 This property handles whether to affect x axis.
FbxPropertyT< FbxBoolAffectY
 This property handles whether to affect y axis.
FbxPropertyT< FbxBoolAffectZ
 This property handles whether to affect z axis.
FbxPropertyT< FbxDouble3Rotation
 This property handles rotation offset.
FbxPropertyT< FbxReferenceConstraintSources
 This property handles constraint source objects.
FbxPropertyT< FbxReferenceConstrainedObject
 This property handles constraint target objects.

Member Function Documentation

void AddConstraintSource ( FbxObject pObject,
double  pWeight = 100 
)

Add a source to the constraint.

Parameters:
pObjectNew source object.
pWeightWeight of the source object.
int GetConstraintSourceCount ( ) const [virtual]

Retrieve the constraint source count.

Returns:
Current constraint source count.

Reimplemented from FbxConstraint.

FbxObject* GetConstraintSource ( int  pIndex) const [virtual]

Retrieve a constraint source object.

Parameters:
pIndexIndex of the source object
Returns:
Current source at the specified index.

Reimplemented from FbxConstraint.

void SetConstrainedObject ( FbxObject pObject)

Set the constrained object.

Parameters:
pObjectThe constrained object.
FbxObject* GetConstrainedObject ( ) const [virtual]

Retrieve the constrained object.

Returns:
Current constrained object.

Reimplemented from FbxConstraint.

virtual void ConstructProperties ( bool  pForceSet) [protected, virtual]

Optional property constructor override, automatically called by default constructor.

Parameters:
pForceSetIf the property value must be set regardless of default value.
Remarks:
If your object have properties, they must be initialized in this function.

Reimplemented from FbxConstraint.

virtual EType GetConstraintType ( ) const [protected, virtual]

Access the type of the constraint.

Returns:
This type of the constraint.

Reimplemented from FbxConstraint.


Member Data Documentation

This property handles whether to affect x axis.

Default value is true.

Definition at line 38 of file fbxconstraintrotation.h.

This property handles whether to affect y axis.

Default value is true.

Definition at line 42 of file fbxconstraintrotation.h.

This property handles whether to affect z axis.

Default value is true.

Definition at line 47 of file fbxconstraintrotation.h.

This property handles rotation offset.

Default value is (0, 0, 0).

Definition at line 52 of file fbxconstraintrotation.h.

This property handles constraint source objects.

Definition at line 56 of file fbxconstraintrotation.h.

This property handles constraint target objects.

Definition at line 60 of file fbxconstraintrotation.h.


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

FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation
FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation FbxConstraintRotation