Public Member Functions | Protected Member Functions

FbxConstraintParent Class Reference

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


Search for all occurrences

Detailed Description

The parent constraint creates a parent-to-child relationship between any two objects, from any two hierarchies.

It creates the same relationship as the parent-to-child relationships found in hierarchies. You can use this constraint to connect objects without changing hierarchies.

Definition at line 27 of file fbxconstraintparent.h.

#include <fbxconstraintparent.h>

Inheritance diagram for FbxConstraintParent:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void SetTranslationOffset (FbxObject *pObject, FbxVector4 pTranslation)
 Set the translation offset of the specified constraint source.
FbxVector4 GetTranslationOffset (const FbxObject *pObject) const
 Retrieve the translation offset of the specified constraint source.
virtual void SetRotationOffset (const FbxObject *pObject, FbxVector4 pRotation)
 Set the rotation offset of the specified constraint source.
FbxVector4 GetRotationOffset (const FbxObject *pObject) const
 Retrieve the rotation offset of the specified constraint source.
void AddConstraintSource (FbxObject *pObject, double pWeight=100)
 Add a constraint 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< FbxBoolAffectTranslationX
 This property handles whether to affect the translation of the constrained object along X axis.
FbxPropertyT< FbxBoolAffectTranslationY
 This property handles whether to affect the translation of the constrained object along Y axis.
FbxPropertyT< FbxBoolAffectTranslationZ
 This property handles whether to affect the translation of the constrained object along Z axis.
FbxPropertyT< FbxBoolAffectRotationX
 This property handles whether to affect the rotation of the constrained object around X axis.
FbxPropertyT< FbxBoolAffectRotationY
 This property handles whether to affect the rotation of the constrained object around Y axis.
FbxPropertyT< FbxBoolAffectRotationZ
 This property handles whether to affect the rotation of the constrained object around Z axis.
FbxPropertyT< FbxBoolAffectScalingX
 This property handles whether to affect the scaling of the constrained object along X axis.
FbxPropertyT< FbxBoolAffectScalingY
 This property handles whether to affect the scaling of the constrained object along Y axis.
FbxPropertyT< FbxBoolAffectScalingZ
 This property handles whether to affect the scaling of the constrained object along Z axis.
FbxPropertyT< FbxReferenceConstraintSources
 This property used to access constraint sources.
FbxPropertyT< FbxReferenceConstrainedObject
 This property used to access constrained object.

Member Function Documentation

void SetTranslationOffset ( FbxObject pObject,
FbxVector4  pTranslation 
)

Set the translation offset of the specified constraint source.

Parameters:
pObjectThe specified constraint source.
pTranslationThe new offset vector.
FbxVector4 GetTranslationOffset ( const FbxObject pObject) const

Retrieve the translation offset of the specified constraint source.

Parameters:
pObjectThe specified constraint source.
Returns:
The current translation offset.
virtual void SetRotationOffset ( const FbxObject pObject,
FbxVector4  pRotation 
) [virtual]

Set the rotation offset of the specified constraint source.

Parameters:
pObjectThe specified constraint source.
pRotationThe new offset vector.
FbxVector4 GetRotationOffset ( const FbxObject pObject) const

Retrieve the rotation offset of the specified constraint source.

Parameters:
pObjectThe specified constraint source.
Returns:
The current translation offset.
void AddConstraintSource ( FbxObject pObject,
double  pWeight = 100 
)

Add a constraint source to the constraint.

Parameters:
pObjectNew constraint source.
pWeightWeight of the constraint source.
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 constraint source.
Returns:
The constraint 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 the translation of the constrained object along X axis.

Default value is true.

Definition at line 40 of file fbxconstraintparent.h.

This property handles whether to affect the translation of the constrained object along Y axis.

Default value is true.

Definition at line 46 of file fbxconstraintparent.h.

This property handles whether to affect the translation of the constrained object along Z axis.

Default value is true.

Definition at line 52 of file fbxconstraintparent.h.

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

Default value is true.

Definition at line 58 of file fbxconstraintparent.h.

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

Default value is true.

Definition at line 64 of file fbxconstraintparent.h.

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

Default value is true.

Definition at line 70 of file fbxconstraintparent.h.

This property handles whether to affect the scaling of the constrained object along X axis.

Default value is true.

Definition at line 76 of file fbxconstraintparent.h.

This property handles whether to affect the scaling of the constrained object along Y axis.

Default value is true.

Definition at line 82 of file fbxconstraintparent.h.

This property handles whether to affect the scaling of the constrained object along Z axis.

Default value is true.

Definition at line 88 of file fbxconstraintparent.h.

This property used to access constraint sources.

A constrained object is an object whose position, orientation, and so on is driven by one or more constraint sources.

Definition at line 93 of file fbxconstraintparent.h.

This property used to access constrained object.

A constrained object is an object whose position, orientation, and so on is driven by one or more constraint sources.

Definition at line 98 of file fbxconstraintparent.h.


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

FbxConstraintParent FbxConstraintParent FbxConstraintParent FbxConstraintParent FbxConstraintParent FbxConstraintParent FbxConstraintParent FbxConstraintParent FbxConstraintParent FbxConstraintParent
FbxConstraintParent FbxConstraintParent FbxConstraintParent FbxConstraintParent FbxConstraintParent FbxConstraintParent FbxConstraintParent FbxConstraintParent FbxConstraintParent FbxConstraintParent