FBConstraintManager Class Reference

Constraint manager. More...

#include <pyfbsdk.h>

Inheritance diagram for FBConstraintManager:

Public Member Functions
FBConstraint	TypeCreateConstraint (int pTypeIndex)
	Create a constraint by index.
FBConstraint	TypeCreateConstraint (str pName)
	Create a constraint by name.
int	TypeGetCount ()
	Get the number of registered constraint types.
str	TypeGetName (int pTypeIndex)
	Get the name of a registered type of constraint.
Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.
bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Additional Inherited Members
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

Constraint manager.

See sample: FBConstraintManager.py.

Member Function Documentation

TypeCreateConstraint() [1/2]

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

pTypeIndex

Index of constraint type, must in range [0, TypeGetCount() ).

Returns

The newly created constraint, or NULL if pIndex is out of range.

TypeCreateConstraint() [2/2]

FBConstraint TypeCreateConstraint

(

str

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

pName

the name of the constraint to be created.

Returns

The newly created constraint, or NULL if pName doesn't match any registered constraints.

TypeGetCount()

int TypeGetCount

(

)

Get the number of registered constraint types.

Returns

Number of registered constraint types.

TypeGetName()

str TypeGetName

(

int

pTypeIndex

)

Get the name of a registered type of constraint.

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

Parameters

pTypeIndex

Index of a constraint type.

Returns

Name of constraint type.