Python Reference Guide
 
Loading...
Searching...
No Matches
FBControlSet Class Reference

Control set class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBControlSet:

Public Member Functions

 FBControlSet (str pName)
 Constructor.
 
int GetFKIndex (FBModel pModel)
 Return the index of the given FK model.
 
FBModel GetFKModel (int pIndex)
 Return the FK model associated to the given index.
 
str GetFKName (int pIndex)
 Return the name of FK model at the given index.
 
int GetIKEffectorIndex (FBModel pModel)
 Return the index of the given IK Effector model.
 
FBModel GetIKEffectorModel (FBEffectorId pEffectorIndex, int pPivotIndex=0)
 Return the IK Effector model associated to the given indices.
 
str GetIKEffectorName (FBEffectorId pEffectorIndex)
 Return the name of the IK Effector.
 
int GetIKEffectorPivotCount (FBEffectorId pEffectorIndex)
 Return the number of IK Effector pivot.
 
FBModel GetReferenceModel ()
 Get the reference model associated with this Control Set.
 
str GetReferenceName ()
 Get the reference name associated with this Control Set.
 
- 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.
 

Public Attributes

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

 
bool UseAxis
 Read Write Property: is using axis.

 
- 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

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 FK model.

Parameters
pModelFK Model to obtain index.
Returns
The index of the given FK model in the internal array or -1 if the model is not an FK model.

◆ GetFKModel()

FBModel GetFKModel ( int  pIndex)

Return the FK model associated to the given index.

The index is from the internal array and is not guaranteed to be matching the FBBodyNodeId enum values.

Parameters
pIndexIndex associated to the FK model.
Returns
The FK model at the specified index or nullptr (None in Python) if no model is found.

◆ GetFKName()

str GetFKName ( int  pIndex)

Return the name of FK model at the given index.

The index is from the internal array and is not guaranteed to be matching the FBBodyNodeId enum values.

Parameters
pIndexIndex to obtain name.
Returns
The name of FK model or nullptr (Empty string in Python) if the index is invalid.

◆ GetIKEffectorIndex()

int GetIKEffectorIndex ( FBModel  pModel)

Return the index of the given IK Effector model.

Parameters
pModelIK Effector model to obtain index.
Returns
The index of the given IK Effector model (matches the FBEffectorId enum values) or -1 if the model is not an IK Effector.

◆ GetIKEffectorModel()

FBModel GetIKEffectorModel ( FBEffectorId  pEffectorIndex,
int  pPivotIndex = 0 
)

Return the IK Effector model associated to the given indices.

Parameters
pEffectorIndexIndex of the IK Effector.
pPivotIndexIndex of the IK Effector pivot.
Returns
The IK Effector model at the specified indices or nullptr (None in Python) if no model is found.

◆ GetIKEffectorName()

str GetIKEffectorName ( FBEffectorId  pEffectorIndex)

Return the name of the IK Effector.

Parameters
pEffectorIndexIndex of the IK Effector.
Returns
The name of the IK Effector or nullptr (Empty string in Python) if the index is invalid.

◆ GetIKEffectorPivotCount()

int GetIKEffectorPivotCount ( FBEffectorId  pEffectorIndex)

Return the number of IK Effector pivot.

Parameters
pEffectorIndexIndex of the IK Effector.
Returns
The number of IK Effector pivot or 0 if the index is invalid.

◆ 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.