Public Member Functions | Static Public Member Functions

FBConstraintManager Class Reference

This reference page is linked to from the following overview topics: MotionBuilder 2014.


Search for all occurrences

Detailed Description

Constraint manager.

Definition at line 705 of file fbconstraint.h.

#include <fbconstraint.h>

Inheritance diagram for FBConstraintManager:
Inheritance graph
[legend]

List of all members.

Public Member Functions

K_DEPRECATED_2014 FBConstraintManager ()
 Constructor.
const char * TypeGetName (int pTypeIndex) const
 Get the name of a registered type of constraint.
int TypeGetCount () const
 Get the number of registered constraint types.
FBConstraintTypeCreateConstraint (int pTypeIndex)
 Create a constraint by index.
FBConstraintTypeCreateConstraint (const char *pName)
 Create a constraint by name.

Static Public Member Functions

static FBConstraintManagerTheOne ()
 Get the global FBConstraintManager object.

Constructor & Destructor Documentation

K_DEPRECATED_2014 FBConstraintManager ( )

Constructor.

Deprecated:
This public constructor to be protected in the future. Use TheOne() function instead.

Member Function Documentation

static FBConstraintManager& TheOne ( ) [static]

Get the global FBConstraintManager object.

Returns:
the global object.
const char* TypeGetName ( int  pTypeIndex) const

Get the name of a registered type of constraint.

This will search in the registry for a constraint at the index pTypeIndex.

Parameters:
pTypeIndexIndex of a constraint type.
Returns:
Name of constraint type.
int TypeGetCount ( ) const

Get the number of registered constraint types.

Returns:
Number of registered constraint types.
FBConstraint* TypeCreateConstraint ( int  pTypeIndex)

Create a constraint by index.

Given the index in the registry, this function create an instance of this constraint. The newly created constraint will be automatically added to the scene.

Parameters:
pTypeIndexIndex of constraint type, must in range [0, TypeGetCount() ).
Returns:
The newly created constraint, or NULL if pIndex is out of range.
FBConstraint* TypeCreateConstraint ( const char *  pName)

Create a constraint by name.

Given the constraint type name in the registry, this function create an instance of this constraint. The newly created constraint will be automatically added to the scene.

Parameters:
pNamethe name of the constraint to be created.
Returns:
The newly created constraint, or NULL if pName doesn't match any registered constraints.

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

FBConstraintManager FBConstraintManager FBConstraintManager FBConstraintManager FBConstraintManager FBConstraintManager FBConstraintManager FBConstraintManager FBConstraintManager FBConstraintManager
FBConstraintManager FBConstraintManager FBConstraintManager FBConstraintManager FBConstraintManager FBConstraintManager FBConstraintManager FBConstraintManager FBConstraintManager FBConstraintManager