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 31 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.
FbxObject GetConstraintSource (int pIndex) const
  Retrieve a constraint source object.
void  SetConstrainedObject (FbxObject *pObject)
  Set the constrained object.
FbxObject GetConstrainedObject () const
  Retrieve the constrained object.

Protected Member Functions

  FbxConstraintParent (FbxManager &pManager, char const *pName)
virtual bool  ConstructProperties (bool pForceSet)
virtual EType  GetConstraintType () const
  Access the type of the constraint.

Properties

FbxPropertyT< FbxBool AffectTranslationX
  This property handles whether to affect the translation of the constrained object along X axis.
FbxPropertyT< FbxBool AffectTranslationY
  This property handles whether to affect the translation of the constrained object along Y axis.
FbxPropertyT< FbxBool AffectTranslationZ
  This property handles whether to affect the translation of the constrained object along Z axis.
FbxPropertyT< FbxBool AffectRotationX
  This property handles whether to affect the rotation of the constrained object around X axis.
FbxPropertyT< FbxBool AffectRotationY
  This property handles whether to affect the rotation of the constrained object around Y axis.
FbxPropertyT< FbxBool AffectRotationZ
  This property handles whether to affect the rotation of the constrained object around Z axis.
FbxPropertyT< FbxBool AffectScalingX
  This property handles whether to affect the scaling of the constrained object along X axis.
FbxPropertyT< FbxBool AffectScalingY
  This property handles whether to affect the scaling of the constrained object along Y axis.
FbxPropertyT< FbxBool AffectScalingZ
  This property handles whether to affect the scaling of the constrained object along Z axis.
FbxPropertyT< FbxReference ConstraintSources
  This property used to access constraint sources.
FbxPropertyT< FbxReference ConstrainedObject
  This property used to access constrained object.

Constructor & Destructor Documentation

FbxConstraintParent ( FbxManager pManager,
char const *  pName 
) [protected]

Member Function Documentation

void SetTranslationOffset ( FbxObject pObject,
FbxVector4  pTranslation 
)

Set the translation offset of the specified constraint source.

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

Retrieve the translation offset of the specified constraint source.

Parameters:
pObject The 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:
pObject The specified constraint source.
pRotation The new offset vector.
FbxVector4 GetRotationOffset ( const FbxObject pObject ) const

Retrieve the rotation offset of the specified constraint source.

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

Add a constraint source to the constraint.

Parameters:
pObject New constraint source.
pWeight Weight 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:
pIndex Index of the constraint source.
Returns:
The constraint source at the specified index.

Reimplemented from FbxConstraint.

void SetConstrainedObject ( FbxObject pObject )

Set the constrained object.

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

Retrieve the constrained object.

Returns:
Current constrained object.

Reimplemented from FbxConstraint.

virtual bool ConstructProperties ( bool  pForceSet ) [protected, virtual]
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 44 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 50 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 56 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 62 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 68 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 74 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 80 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 86 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 92 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 97 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 102 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