FBActor Class Reference

#include <mobu-python-api.h>

Class Description

FBActor is used to link motion data to a character.

In MotionBuilder, an actor is a model used to link captured motion data to a character. Use functions in FBActor to set the body color, skeleton color, pivot color, marker size, pivot size, pivot information, etc. on an actor. These classes are under development and may change dramatically between versions. To obtain the list of actors present in a scene, you need to create an instance of class FBSystem, to obtain the current scene. The FBScene object holds the list of actors in the property Actors.

FBSystem lSystem;
FBScene* lScene = lSystem.Scene;
for( int lIdx = 0; lIdx < lScene->Actors.GetCount(); ++lIdx )
{
FBTrace( "Actor[%d]: '%s'\n", lIdx, (char*)lScene->Actors[lIdx] );
}

The current actor selected in the Character tool can be obtained via the FBApplication object.

FBApplication lApplication;
FBActor* lActor = lApplication.CurrentActor;
if( lActor )
{
FBTrace( "Current actor is: '%s'\n", (char*)lActor->Name );
}
else
{
FBTrace( "No actor currently selected\n" );
}
+ Inheritance diagram for FBActor:

Public Member Functions

 __reduce__ ()
 
 FBDelete (FBActor arg1)
 Actual Actor destructor. More...
 
 __init__ (object arg1, str arg2)
 Constructor. More...
 
 GetCurrentSkeletonState (...)
 Return the Current Skeleton State. More...
 
FBSkeletonState GetDefaultSkeletonState (FBActor arg1)
 Return the Default Skeleton State. More...
 
bool Snap (FBActor arg1, FBRecalcMarkerSetOffset arg2)
 Snap the marker set of the actor. More...
 
 UpdateValues (FBActor arg1, object arg2)
 Update Internal Values to be corresponding to the Given Evaluate Information. More...
 
 SetDefinitionScaleVector (FBActor arg1, FBSkeletonNodeId arg2, FBVector3d arg3, object arg4)
 Set Actor Scaling Definition. More...
 
 GetDefinitionScaleVector (FBActor arg1, FBSkeletonNodeId arg2, FBVector3d arg3)
 Get Actor Scaling Definition. More...
 
 SetDefinitionRotationVector (FBActor arg1, FBSkeletonNodeId arg2, FBVector3d arg3, object arg4)
 Set Actor Rotation Definition. More...
 
 SetActorTranslation (FBActor arg1, FBVector3d arg2)
 Translate Actor, similar to moving the hips of the Actor in the UI. More...
 
- Public Member Functions inherited from FBConstraint
 __reduce__ ()
 
object AnimationNodeInCreate (FBConstraint arg1, object arg2, FBModel arg3, str arg4)
 
object __copy__ (FBConstraint arg1)
 
object AnimationNodeOutCreate (FBConstraint arg1, object arg2, FBModel arg3, str arg4)
 Animation Node Creations (IN/OUT). More...
 
object Clone (FBConstraint arg1)
 Clone the constraint. More...
 
bool DeformerBind (FBConstraint arg1, FBModel arg2)
 Bind/Unbind pModel to deformation constraint. More...
 
bool DeformerUnBind (FBConstraint arg1, FBModel arg2)
 
bool Disable (FBConstraint arg1, FBModel arg2)
 Disable constraint on pModel. More...
 
 FreezeSRT (FBConstraint arg1, FBModel arg2, object arg3, object arg4, object arg5)
 Freeze current model state. More...
 
 FreezeSuggested (FBConstraint arg1)
 Suggest 'freeze'. More...
 
bool ReferenceAdd (FBConstraint arg1, object arg2, FBModel arg3)
 Add a reference to a specified group. More...
 
object ReferenceGet (FBConstraint arg1, object arg2, object arg3)
 Get a reference. More...
 
int ReferenceGetCount (FBConstraint arg1, object arg2)
 Get number of references in a specified group. More...
 
int ReferenceGroupAdd (FBConstraint arg1, str arg2, object arg3)
 Add a group of references. More...
 
int ReferenceGroupGetCount (FBConstraint arg1)
 Return the number of reference groups. More...
 
int ReferenceGroupGetMaxCount (FBConstraint arg1, object arg2)
 Get the maximum number of items that can exist in the reference group in question. More...
 
str ReferenceGroupGetName (FBConstraint arg1, object arg2)
 Get the name of the reference group. More...
 
bool ReferenceRemove (FBConstraint arg1, object arg2, FBModel arg3)
 Remove a reference to pModel from the group at pGroupIndex. More...
 
 RemoveAllAnimationNodes (FBConstraint arg1)
 Remove animation nodes. More...
 
 RestoreModelState (FBConstraint arg1, FBModel arg2)
 Restore the saved model state onto pModel. More...
 
 SaveModelState (FBConstraint arg1, FBModel arg2, object arg3, object arg4, object arg5)
 Save current state of pModel. More...
 
 SetupAllAnimationNodes (FBConstraint arg1)
 Setup animation nodes. More...
 
 Snap (FBConstraint arg1)
 Function Property: Snap constraint. More...
 
 SnapSuggested (FBConstraint arg1)
 Suggest 'snap'. More...
 
 __init__ (...)
 Constructor. More...
 
- Public Member Functions inherited from FBBox
 __reduce__ ()
 
bool AnimationNodeDestroy (FBBox arg1, FBAnimationNode arg2)
 Destroy an animation node. More...
 
 __init__ (object arg1, str arg2)
 Constructor. More...
 
object AnimationNodeInGet (FBBox arg1)
 Get the (IN/OUT) animation node for this box. More...
 
bool AnimationNodeIsUserData (FBBox arg1, FBAnimationNode arg2)
 Is the animation node user data? More...
 
object AnimationNodeOutGet (FBBox arg1)
 
int GetOutConnectorCount (FBBox arg1)
 Get the number of animation node outputs for this box. More...
 
int GetInConnectorCount (FBBox arg1)
 Get the number of animation node inputs for this box. More...
 
object GetOutConnector (FBBox arg1, object arg2)
 Get the animation node output associated with the given index. More...
 
object GetInConnector (FBBox arg1, object arg2)
 Get the animation node input associated with the given index. More...
 
- Public Member Functions inherited from FBComponent
 __reduce__ ()
 
FBPropertyList PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
 Get list of properties which have been modified since last loading. More...
 
str ClassName (FBComponent arg1)
 Get the class name. More...
 
 DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Disable a specific Object Flags. More...
 
 EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Enable a specific Object Flags. More...
 
bool FBCreate (FBComponent arg1)
 Open Reality Creation function. More...
 
 FBDelete (FBComponent arg1)
 Open Reality deletion function. More...
 
 FBDestroy (FBComponent arg1)
 Open Reality destruction function. More...
 
FBObjectFlag GetObjectFlags (FBComponent arg1)
 Get all Object Flags (concatenated). More...
 
bool GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
 Check to see if an object status is enabled. More...
 
bool HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Check whether a specific object flag is enabled. More...
 
bool Is (FBComponent arg1, object arg2)
 Returns true if object is of type TypeId. More...
 
bool ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
 ProcessNamespaceHierarchy. More...
 
bool ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
 ProcessObjectNamespace. More...
 
int PropertyAdd (FBComponent arg1, FBProperty arg2)
 Add a property to the component's property manager. More...
 
bool PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
 Add a reference property to the component's property manager. More...
 
object PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
 Create user or dynamic property. More...
 
 PropertyRemove (FBComponent arg1, FBProperty arg2)
 Remove a Property from the component's Property manager. More...
 
 SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 SetObjectFlags. More...
 
 SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
 Enable/Disable a specific Object Status. More...
 
 HardSelect (FBComponent arg1)
 HardSelect. More...
 
object GetOwnerFileReference (FBComponent arg1)
 Get the owner FileReference object. More...
 
 __init__ (...)
 Constructor. More...
 
- Public Member Functions inherited from FBPlug
 __reduce__ ()
 
bool BeginChange (FBPlug arg1)
 Begins a change on multiple plugs. More...
 
str ClassName (FBPlug arg1)
 internal System vars. More...
 
bool ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
 Add a destination connection. More...
 
bool ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
 Add a destination connection. More...
 
bool ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
 Add a source connection. More...
 
bool ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
 Add a source connection. More...
 
 DisconnectAllDst (FBPlug arg1)
 Remove all destination connections. More...
 
 DisconnectAllSrc (FBPlug arg1)
 Remove all source connections. More...
 
bool DisconnectDst (FBPlug arg1, FBPlug arg2)
 Remove a destination connection. More...
 
bool DisconnectDstAt (FBPlug arg1, object arg2)
 Remove a destination connection at a specified index. More...
 
bool DisconnectSrc (FBPlug arg1, FBPlug arg2)
 Remove a source connection. More...
 
bool DisconnectSrcAt (FBPlug arg1, object arg2)
 Remove a source connection at a specified index. More...
 
 EndChange (FBPlug arg1)
 Ends a change on multiple plugs. More...
 
object GetDst (FBPlug arg1, object arg2)
 Get a destination connection's plug at specified index. More...
 
int GetDstCount (FBPlug arg1)
 Get destination connection count. More...
 
FBConnectionType GetDstType (FBPlug arg1, object arg2)
 Get a destination connection's type at specified index. More...
 
object GetOwned (FBPlug arg1, object arg2)
 Get the owned plug at specified index. More...
 
int GetOwnedCount (FBPlug arg1)
 Get the owned plug count. More...
 
object GetOwner (FBPlug arg1)
 Get the owner of this plug. More...
 
object GetSrc (FBPlug arg1, object arg2)
 Get a source connection's plug at specified index. More...
 
int GetSrcCount (FBPlug arg1)
 Get source connection count. More...
 
FBConnectionType GetSrcType (FBPlug arg1, object arg2)
 Get a source connection's type at specified index. More...
 
bool Is (FBPlug arg1, object arg2)
 Is( int pTypeId ) More...
 
bool IsSDKComponent (FBPlug arg1)
 Return whether or not item is an SDK component. More...
 
 MoveSrcAt (...)
 
bool ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
 Replace a destination connection at a specified index. More...
 
bool ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
 Replace a source connection at a specified index. More...
 
bool SwapSrc (FBPlug arg1, object arg2, object arg3)
 Swap source connection at index A with source connection at index B. More...
 
 SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
 Set the plug's self modification flag. More...
 
bool GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
 Tell if the plug's self has changed. More...
 
 SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
 Set the plug's owned property/object's modification flag. More...
 
bool GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
 Tell if the plug's content has changed. More...
 
int GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
 Get plug's modified src/dst property/object connection added/removed List. More...
 
bool RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
 Revert the plug's modification to original status. More...
 
 __init__ (...)
 
method staticmethod (function)
 
- Public Member Functions inherited from FBPythonWrapper
 __reduce__ ()
 
 __init__ (...)
 

Public Attributes

FBPropertyColor BodyColor
 Read Write Property: The color of the body of the actor. More...
 
FBPropertyVector3d ChestPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d HeadPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d HipsPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d LeftAnklePosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d LeftCollarPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d LeftElbowPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d LeftFootPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d LeftHipPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d LeftKneePosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d LeftShoulderPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d LeftWristPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyMarkerSet MarkerSet
 Read Write Property: Associated marker set. More...
 
FBPropertyDouble MarkerSetSize
 Read Write Property: The size of the markers of the actor. More...
 
FBPropertyVector3d NeckPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyMarkerSet OutputMarkerSet
 Read Write Property: Associated output marker set. More...
 
FBPropertyColor PivotColor
 Read Write Property: The color of the pivot points of the actor. More...
 
FBPropertyDouble PivotSize
 Read Write Property: The size of the pivot points of the actor. More...
 
FBPropertyVector3d RightAnklePosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d RightCollarPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d RightElbowPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d RightFootPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d RightHipPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d RightKneePosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d RightShoulderPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyVector3d RightWristPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyColor SkeletonColor
 Read Write Property: The color of the skeleton of the actor. More...
 
FBPropertyVector3d WaistPosition
 Read Write Property: Body part pivot of the actor. More...
 
FBPropertyAnimatableDouble LeftHandIndexIndex
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandIndexMiddle
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandIndexRing
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandIndexPinky
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandMiddleIndex
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandMiddleMiddle
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandMiddleRing
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandMiddlePinky
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandRingIndex
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandRingMiddle
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandRingRing
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandRingPinky
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandPinkyIndex
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandPinkyMiddle
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandPinkyRing
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble LeftHandPinkyPinky
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandIndexIndex
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandIndexMiddle
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandIndexRing
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandIndexPinky
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandMiddleIndex
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandMiddleMiddle
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandMiddleRing
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandMiddlePinky
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandRingIndex
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandRingMiddle
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandRingRing
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandRingPinky
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandPinkyIndex
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandPinkyMiddle
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandPinkyRing
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble RightHandPinkyPinky
 Read Write Property: Used to set blending coefficients. More...
 
FBPropertyAnimatableDouble FKFingerMultiplier
 Read Write Property: Used to augment the amount of FK propagation for unmarkered intermediate finger phalanges. More...
 
FBPropertyAnimatableDouble FKFingerTipMultiplier
 Read Write Property: Used to augment the amount of FK propagation for unmarkered finger tip phalanges. More...
 
FBPropertyAnimatableDouble FKThumbTipMultiplier
 Read Write Property: Used to augment the amount of FK propagation for unmarkered thumb tip phalanges. More...
 
FBPropertyAnimatableBool HumanFingerLimits
 Read Write Property: Enables/Disables human finger limits during actor solve. More...
 
FBPropertyBool Visibility
 Read Write Property: Show or Hide the Actor Body. More...
 
FBPropertyBool SkeletonVisibility
 Read Write Property: Show or Hide the Skeleton. More...
 
FBPropertyBool PivotPointsVisibility
 Read Write Property: Show or Hide the Pivot Points. More...
 
object HeadOffsetT
 
object HeadOffsetR
 
object NeckOffsetT
 
object NeckOffsetR
 
object ChestOffsetT
 
object ChestOffsetR
 
object LeftCollarOffsetT
 
object LeftCollarOffsetR
 
object RightCollarOffsetT
 
object RightCollarOffsetR
 
object LeftShoulderOffsetT
 
object LeftShoulderOffsetR
 
object RightShoulderOffsetT
 
object RightShoulderOffsetR
 
object LeftElbowOffsetT
 
object LeftElbowOffsetR
 
object RightElbowOffsetT
 
object RightElbowOffsetR
 
object LeftWristOffsetT
 
object LeftWristOffsetR
 
object RightWristOffsetT
 
object RightWristOffsetR
 
object WaistOffsetT
 
object WaistOffsetR
 
object HipsOffsetT
 
object HipsOffsetR
 
object LeftHipOffsetT
 
object LeftHipOffsetR
 
object RightHipOffsetT
 
object RightIndexAOffsetR
 
object RightIndexBOffsetT
 
object RightIndexBOffsetR
 
object RightIndexCOffsetT
 
object RightIndexCOffsetR
 
object RightMiddleAOffsetT
 
object RightMiddleAOffsetR
 
object RightMiddleBOffsetT
 
object RightMiddleBOffsetR
 
object RightMiddleCOffsetT
 
object RightMiddleCOffsetR
 
object RightRingAOffsetT
 
object RightRingAOffsetR
 
object RightRingBOffsetT
 
object RightRingBOffsetR
 
object RightRingCOffsetT
 
object RightRingCOffsetR
 
object RightPinkyAOffsetT
 
object RightPinkyAOffsetR
 
object RightPinkyBOffsetT
 
object RightPinkyBOffsetR
 
object RightPinkyCOffsetT
 
object RightPinkyCOffsetR
 
object ManipulateOffsets
 
FBPropertyBool IKManip
 Read Write Property: Access to the IK Manip mode. More...
 
object RightHipOffsetR
 
object LeftKneeOffsetT
 
object LeftKneeOffsetR
 
object RightKneeOffsetT
 
object RightKneeOffsetR
 
object LeftAnkleOffsetT
 
object LeftAnkleOffsetR
 
object RightAnkleOffsetT
 
object RightAnkleOffsetR
 
object LeftFootOffsetT
 
object LeftFootOffsetR
 
object RightFootOffsetT
 
object RightFootOffsetR
 
object LeftThumbAOffsetT
 
object LeftThumbAOffsetR
 
object LeftThumbBOffsetT
 
object LeftThumbBOffsetR
 
object LeftThumbCOffsetT
 
object LeftThumbCOffsetR
 
object LeftIndexAOffsetT
 
object LeftIndexAOffsetR
 
object LeftIndexBOffsetT
 
object LeftIndexBOffsetR
 
object LeftIndexCOffsetT
 
object LeftIndexCOffsetR
 
object LeftMiddleAOffsetT
 
object LeftMiddleAOffsetR
 
object LeftMiddleBOffsetT
 
object LeftMiddleBOffsetR
 
object LeftMiddleCOffsetT
 
object LeftMiddleCOffsetR
 
object LeftRingAOffsetT
 
object LeftRingAOffsetR
 
object LeftRingBOffsetT
 
object LeftRingBOffsetR
 
object LeftRingCOffsetT
 
object LeftRingCOffsetR
 
object LeftPinkyAOffsetT
 
object LeftPinkyAOffsetR
 
object LeftPinkyBOffsetT
 
object LeftPinkyBOffsetR
 
object LeftPinkyCOffsetT
 
object LeftPinkyCOffsetR
 
object RightThumbAOffsetT
 
object RightThumbAOffsetR
 
object RightThumbBOffsetT
 
object RightThumbBOffsetR
 
object RightThumbCOffsetT
 
object RightThumbCOffsetR
 
object RightIndexAOffsetT
 
- Public Attributes inherited from FBConstraint
FBPropertyBool Active
 Read Write Property: Active state. More...
 
FBPropertyBool Deformer
 Read Write Property: Is a deformer constraint? More...
 
ORSDK2018::FBPropertyString Description
 Read Write Property: Long description of constraint. More...
 
FBPropertyBool HasLayout
 Read Write Property: Does the constraint have a layout? More...
 
FBPropertyBool Lock
 Read Write Property: Lock state. More...
 
FBPropertyAnimatableDouble Weight
 Read Write Property: Weight of constraint. More...
 
- Public Attributes inherited from FBBox
FBPropertyBool Animatable
 Read Write Property: Is the box animatable. More...
 
FBPropertyBool Live
 Read Write Property: Is live? More...
 
FBPropertyBool RecordMode
 Read Write Property: Is recording? More...
 
const char * UniqueName
 internal Unique name. More...
 
- Public Attributes inherited from FBComponent
object OwnerNamespace
 
ORSDK2018::FBPropertyListComponent Components
 List: List of components. More...
 
ORSDK2018::FBPropertyString Name
 Read Write Property: Unique name of object. More...
 
ORSDK2018::FBPropertyString LongName
 Read Write Property: Name and namespace for object. More...
 
object FullName
 
ORSDK2018::FBPropertyListComponent Parents
 List: Parents. More...
 
ORSDK2018::FBPropertyManager PropertyList
 Read Only Property: Manages all of the properties for the component. More...
 
FBPropertyBool Selected
 Read Write Property: Selected property. More...
 
- Public Attributes inherited from FBPythonWrapper
object OnUnbind
 

Member Function Documentation

__init__ ( object  arg1,
str  arg2 
)

Constructor.

Python Docstring:

__init__( (object)arg1, (str)arg2) -> None 

C++ Signature:

 FBActor(const char * pName, HIObject pObject = ((void *) 0)) 
Parameters
pNameName of new actor.
pObjectFor internal use only. This parameter does not need to be specified by the developer.
__reduce__ ( )
FBDelete ( FBActor  arg1)

Actual Actor destructor.

Python Docstring:

FBDelete( (FBActor)arg1) -> None 

C++ Signature:

void FBDelete() 

This method is used to delete the actual actor object represented by an instance of FBActor.

GetCurrentSkeletonState (   ...)

Return the Current Skeleton State.

Python Docstring:

GetCurrentSkeletonState( (FBActor)arg1) -> FBSkeletonState

GetCurrentSkeletonState( (FBActor)arg1, (object)arg2) -> FBSkeletonState 

C++ Signature:

ORSDK2018::FBSkeletonState * GetCurrentSkeletonState(bool pResetOrientation = false) 
Parameters
pResetOrientationWhen set to true, all rotations in the state will be reset to characterization values.
Returns
Current Skeleton State
Note
Usage of this function can be found in script sample /bin/config/Scripts/Samples/Character/CharacterMarkerSetFromActor.py
FBSkeletonState GetDefaultSkeletonState ( FBActor  arg1)

Return the Default Skeleton State.

Python Docstring:

GetDefaultSkeletonState( (FBActor)arg1) -> FBSkeletonState 

C++ Signature:

ORSDK2018::FBSkeletonState * GetDefaultSkeletonState() 
Returns
Default Skeleton State
GetDefinitionScaleVector ( FBActor  arg1,
FBSkeletonNodeId  arg2,
FBVector3d  arg3 
)

Get Actor Scaling Definition.

Python Docstring:

GetDefinitionScaleVector( (FBActor)arg1, (FBSkeletonNodeId)arg2, (FBVector3d)arg3) -> None 

C++ Signature:

void GetDefinitionScaleVector(FBSkeletonNodeId pSkeletonId, FBVector3d & pScaleVector) 
Parameters
pSkeletonIdSkeleton Node Id
Return values
pScaleVectorActor Scaling Definition for the given ID
SetActorTranslation ( FBActor  arg1,
FBVector3d  arg2 
)

Translate Actor, similar to moving the hips of the Actor in the UI.

Python Docstring:

SetActorTranslation( (FBActor)arg1, (FBVector3d)arg2) -> None 

C++ Signature:

void SetActorTranslation(FBVector3d pTranslationVector) 
Parameters
pTranslationVectorWill move the entire Actor to pTranslationVector coordinate
SetDefinitionRotationVector ( FBActor  arg1,
FBSkeletonNodeId  arg2,
FBVector3d  arg3,
object  arg4 
)

Set Actor Rotation Definition.

Python Docstring:

SetDefinitionRotationVector( (FBActor)arg1, (FBSkeletonNodeId)arg2, (FBVector3d)arg3 [, (object)arg4]) -> None 

C++ Signature:

void SetDefinitionRotationVector(FBSkeletonNodeId pSkeletonId, FBVector3d pRotationVector, bool pSymmetricUpdate = true) 
Parameters
pSkeletonIdSkeleton Node Id
pRotationVectorActor Rotation value for the given ID
pSymmetricUpdateUpdate right and left part at the same time
SetDefinitionScaleVector ( FBActor  arg1,
FBSkeletonNodeId  arg2,
FBVector3d  arg3,
object  arg4 
)

Set Actor Scaling Definition.

Python Docstring:

SetDefinitionScaleVector( (FBActor)arg1, (FBSkeletonNodeId)arg2, (FBVector3d)arg3 [, (object)arg4]) -> None 

C++ Signature:

void SetDefinitionScaleVector(FBSkeletonNodeId pSkeletonId, FBVector3d pScaleVector, bool pSymmetricUpdate = true) 
Parameters
pSkeletonIdSkeleton Node Id
pScaleVectorActor Scaling value for the given ID
pSymmetricUpdateUpdate right and left part at the same time
bool Snap ( FBActor  arg1,
FBRecalcMarkerSetOffset  arg2 
)

Snap the marker set of the actor.

Python Docstring:

Snap( (FBActor)arg1, (FBRecalcMarkerSetOffset)arg2) -> bool 

C++ Signature:

bool Snap(FBRecalcMarkerSetOffset pRecalcOffset) 
Returns
True if the operation completed successfully.
UpdateValues ( FBActor  arg1,
object  arg2 
)

Update Internal Values to be corresponding to the Given Evaluate Information.

Python Docstring:

UpdateValues( (FBActor)arg1, (object)arg2) -> None 

C++ Signature:

void UpdateValues(ORSDK2018::FBEvaluateInfo * pEvalInfo) 
Parameters
pEvalInfoEvaluate Info of the Values

Member Data Documentation

FBPropertyColor BodyColor

Read Write Property: The color of the body of the actor.

object ChestOffsetR
object ChestOffsetT
FBPropertyVector3d ChestPosition

Read Write Property: Body part pivot of the actor.

FBPropertyAnimatableDouble FKFingerMultiplier

Read Write Property: Used to augment the amount of FK propagation for unmarkered intermediate finger phalanges.

FBPropertyAnimatableDouble FKFingerTipMultiplier

Read Write Property: Used to augment the amount of FK propagation for unmarkered finger tip phalanges.

FBPropertyAnimatableDouble FKThumbTipMultiplier

Read Write Property: Used to augment the amount of FK propagation for unmarkered thumb tip phalanges.

object HeadOffsetR
object HeadOffsetT
FBPropertyVector3d HeadPosition

Read Write Property: Body part pivot of the actor.

object HipsOffsetR
object HipsOffsetT
FBPropertyVector3d HipsPosition

Read Write Property: Body part pivot of the actor.

FBPropertyAnimatableBool HumanFingerLimits

Read Write Property: Enables/Disables human finger limits during actor solve.

FBPropertyBool IKManip

Read Write Property: Access to the IK Manip mode.

The IKManip property is shared for all actors.

object LeftAnkleOffsetR
object LeftAnkleOffsetT
FBPropertyVector3d LeftAnklePosition

Read Write Property: Body part pivot of the actor.

object LeftCollarOffsetR
object LeftCollarOffsetT
FBPropertyVector3d LeftCollarPosition

Read Write Property: Body part pivot of the actor.

object LeftElbowOffsetR
object LeftElbowOffsetT
FBPropertyVector3d LeftElbowPosition

Read Write Property: Body part pivot of the actor.

object LeftFootOffsetR
object LeftFootOffsetT
FBPropertyVector3d LeftFootPosition

Read Write Property: Body part pivot of the actor.

FBPropertyAnimatableDouble LeftHandIndexIndex

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandIndexMiddle

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandIndexPinky

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandIndexRing

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandMiddleIndex

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandMiddleMiddle

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandMiddlePinky

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandMiddleRing

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandPinkyIndex

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandPinkyMiddle

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandPinkyPinky

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandPinkyRing

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandRingIndex

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandRingMiddle

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandRingPinky

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble LeftHandRingRing

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

object LeftHipOffsetR
object LeftHipOffsetT
FBPropertyVector3d LeftHipPosition

Read Write Property: Body part pivot of the actor.

object LeftIndexAOffsetR
object LeftIndexAOffsetT
object LeftIndexBOffsetR
object LeftIndexBOffsetT
object LeftIndexCOffsetR
object LeftIndexCOffsetT
object LeftKneeOffsetR
object LeftKneeOffsetT
FBPropertyVector3d LeftKneePosition

Read Write Property: Body part pivot of the actor.

object LeftMiddleAOffsetR
object LeftMiddleAOffsetT
object LeftMiddleBOffsetR
object LeftMiddleBOffsetT
object LeftMiddleCOffsetR
object LeftMiddleCOffsetT
object LeftPinkyAOffsetR
object LeftPinkyAOffsetT
object LeftPinkyBOffsetR
object LeftPinkyBOffsetT
object LeftPinkyCOffsetR
object LeftPinkyCOffsetT
object LeftRingAOffsetR
object LeftRingAOffsetT
object LeftRingBOffsetR
object LeftRingBOffsetT
object LeftRingCOffsetR
object LeftRingCOffsetT
object LeftShoulderOffsetR
object LeftShoulderOffsetT
FBPropertyVector3d LeftShoulderPosition

Read Write Property: Body part pivot of the actor.

object LeftThumbAOffsetR
object LeftThumbAOffsetT
object LeftThumbBOffsetR
object LeftThumbBOffsetT
object LeftThumbCOffsetR
object LeftThumbCOffsetT
object LeftWristOffsetR
object LeftWristOffsetT
FBPropertyVector3d LeftWristPosition

Read Write Property: Body part pivot of the actor.

object ManipulateOffsets
FBPropertyMarkerSet MarkerSet

Read Write Property: Associated marker set.

FBPropertyDouble MarkerSetSize

Read Write Property: The size of the markers of the actor.

object NeckOffsetR
object NeckOffsetT
FBPropertyVector3d NeckPosition

Read Write Property: Body part pivot of the actor.

FBPropertyMarkerSet OutputMarkerSet

Read Write Property: Associated output marker set.

FBPropertyColor PivotColor

Read Write Property: The color of the pivot points of the actor.

FBPropertyBool PivotPointsVisibility

Read Write Property: Show or Hide the Pivot Points.

FBPropertyDouble PivotSize

Read Write Property: The size of the pivot points of the actor.

object RightAnkleOffsetR
object RightAnkleOffsetT
FBPropertyVector3d RightAnklePosition

Read Write Property: Body part pivot of the actor.

object RightCollarOffsetR
object RightCollarOffsetT
FBPropertyVector3d RightCollarPosition

Read Write Property: Body part pivot of the actor.

object RightElbowOffsetR
object RightElbowOffsetT
FBPropertyVector3d RightElbowPosition

Read Write Property: Body part pivot of the actor.

object RightFootOffsetR
object RightFootOffsetT
FBPropertyVector3d RightFootPosition

Read Write Property: Body part pivot of the actor.

FBPropertyAnimatableDouble RightHandIndexIndex

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandIndexMiddle

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandIndexPinky

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandIndexRing

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandMiddleIndex

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandMiddleMiddle

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandMiddlePinky

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandMiddleRing

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandPinkyIndex

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandPinkyMiddle

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandPinkyPinky

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandPinkyRing

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandRingIndex

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandRingMiddle

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandRingPinky

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

FBPropertyAnimatableDouble RightHandRingRing

Read Write Property: Used to set blending coefficients.

Each of the 4 fingers can be a blend of the 4 finger. This is not available for thumbs.

object RightHipOffsetR
object RightHipOffsetT
FBPropertyVector3d RightHipPosition

Read Write Property: Body part pivot of the actor.

object RightIndexAOffsetR
object RightIndexAOffsetT
object RightIndexBOffsetR
object RightIndexBOffsetT
object RightIndexCOffsetR
object RightIndexCOffsetT
object RightKneeOffsetR
object RightKneeOffsetT
FBPropertyVector3d RightKneePosition

Read Write Property: Body part pivot of the actor.

object RightMiddleAOffsetR
object RightMiddleAOffsetT
object RightMiddleBOffsetR
object RightMiddleBOffsetT
object RightMiddleCOffsetR
object RightMiddleCOffsetT
object RightPinkyAOffsetR
object RightPinkyAOffsetT
object RightPinkyBOffsetR
object RightPinkyBOffsetT
object RightPinkyCOffsetR
object RightPinkyCOffsetT
object RightRingAOffsetR
object RightRingAOffsetT
object RightRingBOffsetR
object RightRingBOffsetT
object RightRingCOffsetR
object RightRingCOffsetT
object RightShoulderOffsetR
object RightShoulderOffsetT
FBPropertyVector3d RightShoulderPosition

Read Write Property: Body part pivot of the actor.

object RightThumbAOffsetR
object RightThumbAOffsetT
object RightThumbBOffsetR
object RightThumbBOffsetT
object RightThumbCOffsetR
object RightThumbCOffsetT
object RightWristOffsetR
object RightWristOffsetT
FBPropertyVector3d RightWristPosition

Read Write Property: Body part pivot of the actor.

FBPropertyColor SkeletonColor

Read Write Property: The color of the skeleton of the actor.

FBPropertyBool SkeletonVisibility

Read Write Property: Show or Hide the Skeleton.

FBPropertyBool Visibility

Read Write Property: Show or Hide the Actor Body.

object WaistOffsetR
object WaistOffsetT
FBPropertyVector3d WaistPosition

Read Write Property: Body part pivot of the actor.