FbxConstraintPosition Class Reference
 
 
 
FbxConstraintPosition Class Reference

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


#include <fbxconstraintposition.h>


Class Description

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

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

Examples:

UserProperties/main.cxx.

Definition at line 26 of file fbxconstraintposition.h.

Inheritance diagram for FbxConstraintPosition:
FbxConstraint FbxObject FbxEmitter

List of all members.

Public Member Functions

void  AddConstraintSource (FbxObject *pObject, double pWeight=100)
  Add a source to the constraint.
bool  RemoveConstraintSource (FbxObject *pObject)
  Remove a source from 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.

Properties

FbxPropertyT< FbxBool AffectX
  This property handles whether to affect x axis.
FbxPropertyT< FbxBool AffectY
  This property handles whether to affect y axis.
FbxPropertyT< FbxBool AffectZ
  This property handles whether to affect z axis.
FbxPropertyT< FbxDouble3 Translation
  This property handles translation offset.
FbxPropertyT< FbxReference ConstraintSources
  This property handles constraint source objects.
FbxPropertyT< FbxReference ConstrainedObject
  This property handles constraint target objects.

Member Function Documentation

void AddConstraintSource ( FbxObject pObject,
double  pWeight = 100 
)

Add a source to the constraint.

Parameters:
pObject New source object.
pWeight Weight of the source object.
Examples:
UserProperties/main.cxx.
bool RemoveConstraintSource ( FbxObject pObject )

Remove a source from the constraint.

Parameters:
pObject Source object to remove.
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 source
Returns:
Current source at the specified index.

Reimplemented from FbxConstraint.

void SetConstrainedObject ( FbxObject pObject )

Set the constrained object.

Parameters:
pObject The constrained object.
Examples:
UserProperties/main.cxx.
FbxObject* GetConstrainedObject ( ) const [virtual]

Retrieve the constrained object.

Returns:
Current constrained object.

Reimplemented from FbxConstraint.


Member Data Documentation

This property handles whether to affect x axis.

Default value is true.

Examples:
UserProperties/main.cxx.

Definition at line 40 of file fbxconstraintposition.h.

This property handles whether to affect y axis.

Default value is true.

Examples:
UserProperties/main.cxx.

Definition at line 46 of file fbxconstraintposition.h.

This property handles whether to affect z axis.

Default value is true.

Examples:
UserProperties/main.cxx.

Definition at line 52 of file fbxconstraintposition.h.

This property handles translation offset.

Default value is (0, 0, 0).

Examples:
UserProperties/main.cxx.

Definition at line 58 of file fbxconstraintposition.h.

This property handles constraint source objects.

Definition at line 62 of file fbxconstraintposition.h.

This property handles constraint target objects.

Definition at line 66 of file fbxconstraintposition.h.


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