Python Reference Guide
FBControlSet Class Reference

Control set class. More...

Inheritance diagram for FBControlSet:

Public Member Functions

 FBControlSet (str pName)
 Constructor. More...
 
int GetFKIndex (FBModel pModel)
 Return The Index of the Given Model. More...
 
FBModel GetFKModel (int pIndex)
 Return the object associated to the given Index. More...
 
str GetFKName (int pIndex)
 return the name of FK Effector at the given index More...
 
int GetIKEffectorIndex (FBModel pModel)
 Return the Index of the Given Model. More...
 
FBModel GetIKEffectorModel (FBEffectorId pEffectorIndex, int pPivotIndex=0)
 Return the object associated to the given Index. More...
 
str GetIKEffectorName (FBEffectorId pEffectorIndex)
 return the name of IK Effector More...
 
int GetIKEffectorPivotCount (FBEffectorId pEffectorIndex)
 return the number of IK Effector Slot More...
 
FBModel GetReferenceModel ()
 Get the reference model associated with this Control Set. More...
 
str GetReferenceName ()
 Get the reference name associated with this Control Set. More...
 
- Public Member Functions inherited from FBComponent
 FBComponent ()
 Constructor. More...
 
str ClassName ()
 Get the class name. More...
 
 DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags. More...
 
 EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags. More...
 
bool FBCreate ()
 Open Reality Creation function. More...
 
 FBDelete ()
 Open Reality deletion function. More...
 
 FBDestroy ()
 Open Reality destruction function. More...
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated). More...
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled. More...
 
FBFileReference GetOwnerFileReference (p0)
 Get the owner FileReference object. More...
 
 HardSelect ()
 HardSelect. More...
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled. More...
 
bool Is (int pTypeId)
 Returns true if object is of type TypeId. More...
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessNamespaceHierarchy. More...
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessObjectNamespace. More...
 
int PropertyAdd (FBProperty pProperty)
 Add a property to the component's property manager. More...
 
bool PropertyAddReferenceProperty (FBProperty pReferenceProperty)
 Add a reference property to the component's property manager. More...
 
FBProperty PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
 Create user or dynamic property. More...
 
 PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading. More...
 
 PropertyRemove (FBProperty pProperty)
 Remove a Property from the component's Property manager. More...
 
 SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags. More...
 
 SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status. More...
 

Public Attributes

FBControlSetType ControlSetType
 Read Property: the control Set Type (FKIK or IK).
More...
 
bool UseAxis
 Read Write Property: is using axis.
More...
 
- Public Attributes inherited from FBComponent
FBListComponent Components
 List: List of components.
More...
 
str LongName
 Read Write Property: Name and namespace for object.
More...
 
str Name
 Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py. More...
 
FBListComponent Parents
 List: Parents.
More...
 
FBManager PropertyList
 Read Only Property: Manages all of the properties for the component.
More...
 
bool Selected
 Read Write Property: Selected property.
More...
 
int TypeInfo
 Contains the Type information of the object.
More...
 
- Public Attributes inherited from FBPlug
str ClassGroupName
 ClassGroupName of the object.
More...
 
int TypeInfo
 TypeInfo.
More...
 

Detailed Description

Control set class.


These classes are under development and may change dramatically between versions.

Constructor & Destructor Documentation

◆ FBControlSet()

FBControlSet ( str  pName)

Constructor.

Parameters
pNameName of new control set.

Member Function Documentation

◆ GetFKIndex()

int GetFKIndex ( FBModel  pModel)

Return The Index of the Given Model.

Parameters
pModelGiven Model to obtain Index
Returns
The Index of the Given Model.

◆ GetFKModel()

FBModel GetFKModel ( int  pIndex)

Return the object associated to the given Index.

Parameters
pIndexGiven Index to obtain Model
Returns
return the model at the specified Index.

◆ GetFKName()

str GetFKName ( int  pIndex)

return the name of FK Effector at the given index

Parameters
pIndexGiven Index
Returns
return the name of IK Effector Slot

◆ GetIKEffectorIndex()

int GetIKEffectorIndex ( FBModel  pModel)

Return the Index of the Given Model.

Parameters
pModelGiven Model to Obtain Index
Returns
The Index of the Given Model.

◆ GetIKEffectorModel()

FBModel GetIKEffectorModel ( FBEffectorId  pEffectorIndex,
int  pPivotIndex = 0 
)

Return the object associated to the given Index.

Parameters
pEffectorIndexGiven Index to obtain Model
pPivotIndexIndex of effector pivot
Returns
return the model at the specified Index.

◆ GetIKEffectorName()

str GetIKEffectorName ( FBEffectorId  pEffectorIndex)

return the name of IK Effector

Parameters
pEffectorIndexGiven Index to obtain Name
Returns
the name of IK Effector

◆ GetIKEffectorPivotCount()

int GetIKEffectorPivotCount ( FBEffectorId  pEffectorIndex)

return the number of IK Effector Slot

Returns
return the number of IK Effector Slot

◆ GetReferenceModel()

FBModel GetReferenceModel ( )

Get the reference model associated with this Control Set.

Returns
The reference model associated with the Control Set.

◆ GetReferenceName()

str GetReferenceName ( )

Get the reference name associated with this Control Set.

Returns
The reference name associated with the Control Set.

Member Data Documentation

◆ ControlSetType

FBControlSetType ControlSetType

Read Property: the control Set Type (FKIK or IK).

◆ UseAxis

bool UseAxis

Read Write Property: is using axis.