FBActor Class Reference


Detailed 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" );
       }
Examples
Samples/Character/CharacterMarkerSetFromActor.py
Inheritance diagram for FBActor:

List of all members.

Public Member Functions

 __init__ (str pName, object pObject=None)
 Constructor.
 FBDelete ()
 Actual Actor destructor.
bool Snap (FBRecalcMarkerSetOffset pRecalcOffset)
 Snap the marker set of the actor.
 UpdateValues (FBEvaluateInfo pEvalInfo)
 Update Internal Values to be corresponding to the Given Evaluate Information.
 SetDefinitionScaleVector (FBSkeletonNodeId pSkeletonId, FBVector3 pScaleVector, bool pSymmetricUpdate=True)
 Set Actor Scaling Definition.
 GetDefinitionScaleVector (FBSkeletonNodeId pSkeletonId, FBVector3 pScaleVector)
 Get Actor Scaling Definition.
 SetDefinitionRotationVector (FBSkeletonNodeId pSkeletonId, FBVector3 pRotationVector, bool pSymmetricUpdate=True)
 Set Actor Rotation Definition.
 SetActorTranslation (FBVector3 pTranslationVector)
 Translate Actor, similar to moving the hips of the Actor in the UI.
FBSkeletonState GetDefaultSkeletonState ()
 Return the Default Skeleton State.
FBSkeletonState GetCurrentSkeletonState (bool pResetOrientation=False)
 Return the Current Skeleton State.
FBModel GetLeftGloveReferenceModel ()
 Get the reference model associated with left hand.
 SetLeftGloveReferenceModel (FBModel pReferenceModel)
 Set a model to be the left glove reference.
FBModel GetRightGloveReferenceModel ()
 Get the reference model associated with right hand.
 SetRightGloveReferenceModel (FBModel pReferenceModel)
 Set a model to be the right glove reference.

Public Attributes

FBPropertyMarkerSet MarkerSet
 Read Write Property: Associated marker set.
FBPropertyMarkerSet OutputMarkerSet
 Read Write Property: Associated output marker set.
FBPropertyBase BodyColor
 Read Write Property: The color of the body of the actor.
FBPropertyBase SkeletonColor
 Read Write Property: The color of the skeleton of the actor.
FBPropertyBase PivotColor
 Read Write Property: The color of the pivot points of the actor.
FBPropertyBase MarkerSetSize
 Read Write Property: The size of the markers of the actor.
FBPropertyBase PivotSize
 Read Write Property: The size of the pivot points of the actor.
FBPropertyBase HipsPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase LeftHipPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase LeftKneePosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase LeftAnklePosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase LeftFootPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase RightHipPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase RightKneePosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase RightAnklePosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase RightFootPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase WaistPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase ChestPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase LeftCollarPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase LeftShoulderPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase LeftElbowPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase LeftWristPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase RightCollarPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase RightShoulderPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase RightElbowPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase RightWristPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase NeckPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase HeadPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBase Visibility
 Read Write Property: Show or Hide the Actor Body.
FBPropertyBaseAnimatable LeftHandIndexIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandIndexMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandIndexRing
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandIndexPinky
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandMiddleIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandMiddleMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandMiddleRing
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandMiddlePinky
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandRingIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandRingMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandRingRing
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandRingPinky
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandPinkyIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandPinkyMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandPinkyRing
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable LeftHandPinkyPinky
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandIndexIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandIndexMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandIndexRing
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandIndexPinky
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandMiddleIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandMiddleMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandMiddleRing
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandMiddlePinky
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandRingIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandRingMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandRingRing
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandRingPinky
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandPinkyIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandPinkyMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandPinkyRing
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable RightHandPinkyPinky
 Read Write Property: Used to set blending coefficients.
FBPropertyBaseAnimatable FKFingerMultiplier
 Read Write Property: Used to augment the amount of FK propagation for unmarkered intermediate finger phalanges.
FBPropertyBaseAnimatable FKFingerTipMultiplier
 Read Write Property: Used to augment the amount of FK propagation for unmarkered finger tip phalanges.
FBPropertyBaseAnimatable FKThumbTipMultiplier
 Read Write Property: Used to augment the amount of FK propagation for unmarkered thumb tip phalanges.
FBPropertyBaseAnimatable HumanFingerLimits
 Read Write Property: Enables/Disables human finger limits during actor solve.

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)

Constructor.

Parameters:
pNameName of new actor.
pObjectFor internal use only. This parameter does not need to be specified by the developer.
Examples
Samples/Character/CharacterMarkerSetFromActor.py

Reimplemented from FBConstraint.

FBDelete ( )

Actual Actor destructor.

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

Examples
Tasks/DeleteHierarchy.py

Reimplemented from FBComponent.

bool Snap ( FBRecalcMarkerSetOffset  pRecalcOffset)

Snap the marker set of the actor.

Returns:
True if the operation completed successfully.
UpdateValues ( FBEvaluateInfo  pEvalInfo)

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

Parameters:
pEvalInfoEvaluate Info of the Values
SetDefinitionScaleVector ( FBSkeletonNodeId  pSkeletonId,
FBVector3  pScaleVector,
bool  pSymmetricUpdate = True 
)

Set Actor Scaling Definition.

Parameters:
pSkeletonIdSkeleton Node Id
pScaleVectorActor Scaling value for the given ID
pSymmetricUpdateUpdate right and left part at the same time
GetDefinitionScaleVector ( FBSkeletonNodeId  pSkeletonId,
FBVector3  pScaleVector 
)

Get Actor Scaling Definition.

Parameters:
pSkeletonIdSkeleton Node Id
Return values:
pScaleVectorActor Scaling Definition for the given ID
SetDefinitionRotationVector ( FBSkeletonNodeId  pSkeletonId,
FBVector3  pRotationVector,
bool  pSymmetricUpdate = True 
)

Set Actor Rotation Definition.

Parameters:
pSkeletonIdSkeleton Node Id
pRotationVectorActor Rotation value for the given ID
pSymmetricUpdateUpdate right and left part at the same time
SetActorTranslation ( FBVector3  pTranslationVector)

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

Parameters:
pTranslationVectorWill move the entire Actor to pTranslationVector coordinate
FBSkeletonState GetDefaultSkeletonState ( )

Return the Default Skeleton State.

Returns:
Default Skeleton State
FBSkeletonState GetCurrentSkeletonState ( bool  pResetOrientation = False)

Return the Current Skeleton State.

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
FBModel GetLeftGloveReferenceModel ( )

Get the reference model associated with left hand.

Returns:
The reference model associated with the left hand.
SetLeftGloveReferenceModel ( FBModel  pReferenceModel)

Set a model to be the left glove reference.

Parameters:
pReferenceModelModel to be the left glove reference.
FBModel GetRightGloveReferenceModel ( )

Get the reference model associated with right hand.

Returns:
The reference model associated with the right hand.
SetRightGloveReferenceModel ( FBModel  pReferenceModel)

Set a model to be the right glove reference.

Parameters:
pReferenceModelModel to be the right glove reference.

Member Data Documentation

FBPropertyMarkerSet MarkerSet

Read Write Property: Associated marker set.

FBPropertyMarkerSet OutputMarkerSet

Read Write Property: Associated output marker set.

FBPropertyBase BodyColor

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

FBPropertyBase SkeletonColor

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

FBPropertyBase PivotColor

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

FBPropertyBase MarkerSetSize

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

FBPropertyBase PivotSize

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

FBPropertyBase HipsPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase LeftHipPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase LeftKneePosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase LeftAnklePosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase LeftFootPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase RightHipPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase RightKneePosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase RightAnklePosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase RightFootPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase WaistPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase ChestPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase LeftCollarPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase LeftShoulderPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase LeftElbowPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase LeftWristPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase RightCollarPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase RightShoulderPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase RightElbowPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase RightWristPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase NeckPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase HeadPosition

Read Write Property: Body part pivot of the actor.

FBPropertyBase Visibility

Read Write Property: Show or Hide the Actor Body.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

FBPropertyBaseAnimatable FKFingerMultiplier

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

FBPropertyBaseAnimatable FKFingerTipMultiplier

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

FBPropertyBaseAnimatable FKThumbTipMultiplier

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

FBPropertyBaseAnimatable HumanFingerLimits

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


FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor
FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor