Open Reality Reference Guide
 
Loading...
Searching...
No Matches
FBControlSet Class Reference

Control set class. More...

#include <fbcharacter.h>

Inheritance diagram for FBControlSet:

Public Member Functions

 FBControlSet (const char *pName, HIObject pObject=NULL)
 Constructor.
 
FBModelGetReferenceModel ()
 Get the reference model associated with this Control Set.
 
const char * GetReferenceName ()
 Get the reference name associated with this Control Set.
 
int GetIKEffectorIndex (FBModel *pModel)
 Return the index of the given IK Effector model.
 
FBModelGetIKEffectorModel (FBEffectorId pEffectorIndex, int pPivotIndex=0)
 Return the IK Effector model associated to the given indices.
 
int GetIKEffectorPivotCount (FBEffectorId pEffectorIndex)
 Return the number of IK Effector pivot.
 
const char * GetIKEffectorName (FBEffectorId pEffectorIndex)
 Return the name of the IK Effector.
 
int GetFKIndex (FBModel *pModel)
 Return the index of the given FK model.
 
FBModelGetFKModel (int pIndex)
 Return the FK model associated to the given index.
 
const char * GetFKName (int pIndex)
 Return the name of FK model at the given index.
 
int GetFKCount ()
 Return the number of FK models.
 
- Public Member Functions inherited from FBComponent
 FBComponent (HIObject pObject)
 Constructor.
 
virtual ~FBComponent ()
 Destructor.
 
virtual bool FBCreate ()
 Open Reality Creation function.
 
virtual void FBDestroy ()
 Open Reality destruction function.
 
virtual void FBDelete () override
 Open Reality deletion function.
 
virtual bool SetHIObject (HIObject pObject, bool pSDKComponent) override
 Assign component to an internal pointer.
 
virtual 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.
 
void PropertyRemove (FBProperty *pProperty)
 Remove a Property from the component's Property manager.
 
void PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading.
 
FBPropertyPropertyCreate (const char *pName, FBPropertyType pType, const char *pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
 Create user or dynamic property.
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated).
 
void SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags.
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled.
 
void EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags.
 
void DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags.
 
void SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status.
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled.
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
 ProcessNamespaceHierarchy.
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
 ProcessObjectNamespace.
 
virtual const char * ClassName () override
 Get the class name.
 
virtual bool UseCustomPropertyViewSet () const
 Use the custom property viewSet or not.
 
const char * GetFullName (void)
 Get the full name.
 
void SetOwnerNamespace (FBNamespace *pOwnerNSObj)
 Set the owner Namespace object.
 
FBNamespaceGetOwnerNamespace (void)
 Get the owner Namespace object.
 
FBFileReferenceGetOwnerFileReference (void)
 Get the owner FileReference object.
 
void HardSelect ()
 HardSelect.
 
virtual bool Is (int pTypeId) override
 Returns true if object is of type TypeId.
 
virtual int GetTypeId () override
 GetTypeId( int pTypeId )
 
- Public Member Functions inherited from FBWrapperHolder
FBScriptWrapperGetWrapper ()
 Return the wrapper interface of this FBObject.
 
void AddWrapper (FBScriptWrapper *)
 
void RemoveWrapper (FBScriptWrapper *)
 

Public Attributes

FBPropertyControlSetType ControlSetType
 Read Property: the control Set Type (FKIK or IK).
 
FBPropertyBool UseAxis
 Read Write Property: is using axis.
 
FBPropertyDouble FKOpacity
 Read Write Property: Opacity value used on FK (between 0 and 100).
 
- Public Attributes inherited from FBComponent
FBPropertyManager PropertyList
 Read Only Property: Manages all of the properties for the component.
 
FBPropertyListComponent Components
 List: List of components.
 
FBPropertyListComponent Parents
 List: Parents.
 
FBPropertyBool Selected
 Read Write Property: Selected property.
 
FBPropertyString Name
 Read Write Property: Unique name of object.
 
FBPropertyString LongName
 Read Write Property: Name and namespace for object.

 
FBPropertyFolder Folder
 Read Write Property: The folder that contain this component.
 

Additional Inherited Members

- Static Public Member Functions inherited from FBComponent
static int GetInternalClassId ()
 
static void FBComponentSetName (FBComponent *pObject, const char *pName)
 
static const char * FBComponentGetName (FBComponent *pObject)
 
static void FBComponentSetLongName (FBComponent *pObject, const char *pName)
 
static const char * FBComponentGetLongName (FBComponent *pObject)
 
- Static Public Attributes inherited from FBComponent
static int TypeInfo
 Contains the Type information of the object.
 
- Protected Member Functions inherited from FBPlug
bool IsSDKComponent ()
 Return whether or not item is an SDK component.
 
bool ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection.
 
bool ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection.
 
bool ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection.
 
bool ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection.
 
bool DisconnectDst (FBPlug *pDst)
 Remove a destination connection.
 
bool DisconnectSrc (FBPlug *pSrc)
 Remove a source connection.
 
void DisconnectAllSrc ()
 Remove all source connections.
 
void DisconnectAllDst ()
 Remove all destination connections.
 
bool DisconnectDstAt (int pIndex)
 Remove a destination connection at a specified index.
 
bool DisconnectSrcAt (int pIndex)
 Remove a source connection at a specified index.
 
bool ReplaceDstAt (int pIndex, FBPlug *pDst)
 Replace a destination connection at a specified index.
 
bool ReplaceSrcAt (int pIndex, FBPlug *pSrc)
 Replace a source connection at a specified index.
 
bool SwapSrc (int pIndexA, int pIndexB)
 Swap source connection at index A with source connection at index B.
 
bool MoveSrcAt (int pIndex, int pAtIndex)
 Move source connection at pIndex to pAtIndex.
 
bool MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc)
 Move source connection pSrc to the position of pAtSrc.
 
int GetSrcCount ()
 Get source connection count.
 
FBPlugGetSrc (int pIndex)
 Get a source connection's plug at specified index.
 
FBConnectionType GetSrcType (int pIndex)
 Get a source connection's type at specified index.
 
int GetDstCount ()
 Get destination connection count.
 
FBPlugGetDst (int pIndex)
 Get a destination connection's plug at specified index.
 
FBConnectionType GetDstType (int pIndex)
 Get a destination connection's type at specified index.
 
bool BeginChange ()
 Begins a change on multiple plugs.
 
void EndChange ()
 Ends a change on multiple plugs.
 
void SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's self modification flag.
 
bool GetSelfModified (FBPlugModificationFlag pFlag)
 Tell if the plug's self has changed.
 
void SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's owned property/object's modification flag.
 
bool GetContentModified (FBPlugModificationFlag pFlag)
 Tell if the plug's content has changed.
 
int GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
 Get plug's modified src/dst property/object connection added/removed List.
 
bool RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
 Revert the plug's modification to original status.
 
void SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
 Set the plug's status flag.
 
bool GetStatusFlag (FBPlugStatusFlag pStatus) const
 Tell if the plug's status has changed.
 
FBPlugGetOwner ()
 Get the owner of this plug.
 
FBPlugGetOwned (int pIndex)
 Get the owned plug at specified index.
 
int GetOwnedCount ()
 Get the owned plug count.
 
virtual const char * ClassName ()
 internal System vars.
 
virtual bool Is (int pTypeId)
 Is( int pTypeId )
 
virtual int GetTypeId ()
 GetTypeId( int pTypeId )
 
virtual bool PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
 PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.
 
virtual bool PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
 PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.
 
virtual bool PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
 PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.
 
virtual void FBDelete ()
 Actual destructor for a FBPlug.
 
- Static Protected Member Functions inherited from FBPlug
static int GetInternalClassId ()
 Internal class Id.
 
- Protected Attributes inherited from FBPlug
bool mAllocated
 Contain the Allocation State of the Component.
 
HIObject mObject
 Handle on the Plug.
 
bool mSDKComponent
 bool Plug is an SDK component.

 
- Static Protected Attributes inherited from FBPlug
static const char * ClassGroupName
 ClassGroupName of the object.
 
static int TypeInfo
 TypeInfo.
 
static int mGlobalTypeInfo
 Represente the Type Index.
 

Detailed Description

Control set class.

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

Definition at line 764 of file fbcharacter.h.

Constructor & Destructor Documentation

◆ FBControlSet()

FBControlSet ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

Parameters
pNameName of new control set.
pObjectFor internal use only. This parameter does not need to be specified by the developer.

Member Function Documentation

◆ GetFKCount()

int GetFKCount ( )

Return the number of FK models.

Returns
The number of FK models.

◆ 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()

const char * 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()

const char * 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()

const char * GetReferenceName ( )

Get the reference name associated with this Control Set.

Returns
The reference name associated with the Control Set.

Member Data Documentation

◆ ControlSetType

FBPropertyControlSetType ControlSetType

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

Definition at line 838 of file fbcharacter.h.

◆ FKOpacity

FBPropertyDouble FKOpacity

Read Write Property: Opacity value used on FK (between 0 and 100).

Definition at line 840 of file fbcharacter.h.

◆ UseAxis

FBPropertyBool UseAxis

Read Write Property: is using axis.

Definition at line 839 of file fbcharacter.h.


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