FbxConstraint Class Reference
 
 
 
FbxConstraint Class Reference

This reference page is linked to from the following overview topics: Supported Scene Elements, FBX SDK 2014, FBX Nodes, List of Python Fbx classes, Transformation Data.


#include <fbxconstraint.h>


Class Description

Base class for weighted animation constraints.

Constraints are primarily used to impose limits on properties of objects (e.g. position, orientation, scale) and to automate animation processes. A constrained object is an object with properties constrained by one or more weighted constraint sources.

Definition at line 27 of file fbxconstraint.h.

Inheritance diagram for FbxConstraint:
FbxObject FbxEmitter FbxCharacter FbxConstraintAim FbxConstraintCustom FbxConstraintParent FbxConstraintPosition FbxConstraintRotation FbxConstraintScale FbxConstraintSingleChainIK

List of all members.

Public Types

enum   EType {
  eUnknown, ePosition, eRotation, eScale,
  eParent, eSingleChainIK, eAim, eCharacter,
  eCustom
}
  Constraint attribute types. More...

Public Member Functions

virtual EType  GetConstraintType () const
  Access the type of the constraint.
virtual FbxObject GetConstrainedObject () const
  Retrieve the constrained object.
virtual int  GetConstraintSourceCount () const
  Retrieve the count of constraint source.
virtual FbxObject GetConstraintSource (int) const
  Retrieve a constraint source with the specified index.
double  GetSourceWeight (const FbxObject *pObject) const
  Get the weight associated with a constraint source.

Properties

FbxPropertyT< FbxDouble Weight
  This property represents the degree of influence of a constraint from 0.0 (no influence) to 100.0 (full influence).
FbxPropertyT< FbxBool Active
  This property controls whether the constraint is applied or not.
FbxPropertyT< FbxBool Lock
  This property handles the lock state of the constraint.

Member Enumeration Documentation

enum EType

Constraint attribute types.

Enumerator:
eUnknown 
ePosition 

Invalid constraint.

eRotation 

Position constraint (referred to as a point constraint in Maya).

eScale 

Rotation constraint (referred to as an orient constraint in Maya).

eParent 

Scale constraint.

eSingleChainIK 

Parent constraint.

eAim 

Single chain IK constraint.

eCharacter 

Aim constraint.

eCustom 

Character constraint.

User defined constraints.

Definition at line 60 of file fbxconstraint.h.


Member Function Documentation

virtual EType GetConstraintType ( ) const [inline, virtual]

Access the type of the constraint.

Returns:
This type of the constraint.

Definition at line 76 of file fbxconstraint.h.

{ return eUnknown; }
virtual FbxObject* GetConstrainedObject ( ) const [inline, virtual]

Retrieve the constrained object.

Returns:
The constrained object.

Reimplemented in FbxConstraintAim, FbxConstraintParent, FbxConstraintPosition, FbxConstraintRotation, and FbxConstraintScale.

Definition at line 81 of file fbxconstraint.h.

{ return NULL; }
virtual int GetConstraintSourceCount ( ) const [inline, virtual]

Retrieve the count of constraint source.

Returns:
The count of constraint source.

Reimplemented in FbxConstraintAim, FbxConstraintParent, FbxConstraintPosition, FbxConstraintRotation, and FbxConstraintScale.

Definition at line 86 of file fbxconstraint.h.

{ return 0; }
virtual FbxObject* GetConstraintSource ( int  ) const [inline, virtual]

Retrieve a constraint source with the specified index.

Parameters:
pIndex The specified index.
Returns:
The constraint source at the specified index.

Reimplemented in FbxConstraintAim, FbxConstraintParent, FbxConstraintPosition, FbxConstraintRotation, and FbxConstraintScale.

Definition at line 92 of file fbxconstraint.h.

{ return NULL; }
double GetSourceWeight ( const FbxObject pObject ) const

Get the weight associated with a constraint source.

Parameters:
pObject The given constraint source.
Returns:
The weight of the constraint source.

Member Data Documentation

This property represents the degree of influence of a constraint from 0.0 (no influence) to 100.0 (full influence).

Default value is 100.0.

Definition at line 40 of file fbxconstraint.h.

This property controls whether the constraint is applied or not.

If the value is false the constraint will have no effect. The default value is true.

Default value is true.

Definition at line 47 of file fbxconstraint.h.

This property handles the lock state of the constraint.

When enabled, the constrained object cannot be moved away from its constrained location when the constraint is active.

Default value is false.

Definition at line 55 of file fbxconstraint.h.


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