Public Member Functions | Public Attributes

FBActor Class Reference

This reference page is linked to from the following overview topics: MotionBuilder 2014, Character animation, Motion Capture Devices.


Search for all occurrences

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" );
       }

Definition at line 897 of file fbcharacter.h.

#include <fbcharacter.h>

Inheritance diagram for FBActor:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBActor (const char *pName, HIObject pObject=NULL)
 Constructor.
virtual void FBDelete ()
 Actual Actor destructor.
virtual bool Snap (FBRecalcMarkerSetOffset pRecalcOffset)
 Snap the marker set of the actor.
void UpdateValues (FBEvaluateInfo *pEvalInfo)
 Update Internal Values to be corresponding to the Given Evaluate Information.
void SetDefinitionScaleVector (FBSkeletonNodeId pSkeletonId, FBVector3d pScaleVector, bool pSymmetricUpdate=true)
 Set Actor Scaling Definition.
void GetDefinitionScaleVector (FBSkeletonNodeId pSkeletonId, FBVector3d &pScaleVector)
 Get Actor Scaling Definition.
void SetDefinitionRotationVector (FBSkeletonNodeId pSkeletonId, FBVector3d pRotationVector, bool pSymmetricUpdate=true)
 Set Actor Rotation Definition.
void SetActorTranslation (FBVector3d pTranslationVector)
 Translate Actor, similar to moving the hips of the Actor in the UI.
FBSkeletonStateGetDefaultSkeletonState ()
 Return the Default Skeleton State.
FBSkeletonStateGetCurrentSkeletonState (bool pResetOrientation=false)
 Return the Current Skeleton State.
FBModelGetLeftGloveReferenceModel ()
 Get the reference model associated with left hand.
void SetLeftGloveReferenceModel (FBModel *pReferenceModel)
 Set a model to be the left glove reference.
FBModelGetRightGloveReferenceModel ()
 Get the reference model associated with right hand.
void 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.
FBPropertyColor BodyColor
 Read Write Property: The color of the body of the actor.
FBPropertyColor SkeletonColor
 Read Write Property: The color of the skeleton of the actor.
FBPropertyColor PivotColor
 Read Write Property: The color of the pivot points of the actor.
FBPropertyDouble MarkerSetSize
 Read Write Property: The size of the markers of the actor.
FBPropertyDouble PivotSize
 Read Write Property: The size of the pivot points of the actor.
FBPropertyVector3d HipsPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d LeftHipPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d LeftKneePosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d LeftAnklePosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d LeftFootPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d RightHipPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d RightKneePosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d RightAnklePosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d RightFootPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d WaistPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d ChestPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d LeftCollarPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d LeftShoulderPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d LeftElbowPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d LeftWristPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d RightCollarPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d RightShoulderPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d RightElbowPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d RightWristPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d NeckPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyVector3d HeadPosition
 Read Write Property: Body part pivot of the actor.
FBPropertyBool Visibility
 Read Write Property: Show or Hide the Actor Body.
FBPropertyAnimatableDouble LeftHandIndexIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandIndexMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandIndexRing
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandIndexPinky
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandMiddleIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandMiddleMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandMiddleRing
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandMiddlePinky
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandRingIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandRingMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandRingRing
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandRingPinky
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandPinkyIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandPinkyMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandPinkyRing
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble LeftHandPinkyPinky
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandIndexIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandIndexMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandIndexRing
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandIndexPinky
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandMiddleIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandMiddleMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandMiddleRing
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandMiddlePinky
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandRingIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandRingMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandRingRing
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandRingPinky
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandPinkyIndex
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandPinkyMiddle
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandPinkyRing
 Read Write Property: Used to set blending coefficients.
FBPropertyAnimatableDouble RightHandPinkyPinky
 Read Write Property: Used to set blending coefficients.
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.
FBPropertyAnimatableBool HumanFingerLimits
 Read Write Property: Enables/Disables human finger limits during actor solve.

Constructor & Destructor Documentation

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

Constructor.

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

Member Function Documentation

virtual void FBDelete ( ) [virtual]

Actual Actor destructor.

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

Reimplemented from FBComponent.

virtual bool Snap ( FBRecalcMarkerSetOffset  pRecalcOffset) [virtual]

Snap the marker set of the actor.

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

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

Parameters:
pEvalInfoEvaluate Info of the Values
void SetDefinitionScaleVector ( FBSkeletonNodeId  pSkeletonId,
FBVector3d  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
void GetDefinitionScaleVector ( FBSkeletonNodeId  pSkeletonId,
FBVector3d pScaleVector 
)

Get Actor Scaling Definition.

Parameters:
pSkeletonIdSkeleton Node Id
Return values:
pScaleVectorActor Scaling Definition for the given ID
void SetDefinitionRotationVector ( FBSkeletonNodeId  pSkeletonId,
FBVector3d  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
void SetActorTranslation ( FBVector3d  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.
void 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.
void 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.

Definition at line 914 of file fbcharacter.h.

FBPropertyMarkerSet OutputMarkerSet

Read Write Property: Associated output marker set.

Definition at line 915 of file fbcharacter.h.

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

Definition at line 917 of file fbcharacter.h.

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

Definition at line 918 of file fbcharacter.h.

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

Definition at line 919 of file fbcharacter.h.

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

Definition at line 920 of file fbcharacter.h.

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

Definition at line 921 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 923 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 924 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 925 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 926 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 927 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 928 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 929 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 930 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 931 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 932 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 933 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 934 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 935 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 936 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 937 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 938 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 939 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 940 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 941 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 942 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 943 of file fbcharacter.h.

Read Write Property: Show or Hide the Actor Body.

Definition at line 944 of file fbcharacter.h.

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.

Definition at line 946 of file fbcharacter.h.

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.

Definition at line 947 of file fbcharacter.h.

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.

Definition at line 948 of file fbcharacter.h.

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.

Definition at line 949 of file fbcharacter.h.

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.

Definition at line 951 of file fbcharacter.h.

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.

Definition at line 952 of file fbcharacter.h.

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.

Definition at line 953 of file fbcharacter.h.

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.

Definition at line 954 of file fbcharacter.h.

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.

Definition at line 956 of file fbcharacter.h.

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.

Definition at line 957 of file fbcharacter.h.

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.

Definition at line 958 of file fbcharacter.h.

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.

Definition at line 959 of file fbcharacter.h.

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.

Definition at line 961 of file fbcharacter.h.

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.

Definition at line 962 of file fbcharacter.h.

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.

Definition at line 963 of file fbcharacter.h.

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.

Definition at line 964 of file fbcharacter.h.

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.

Definition at line 966 of file fbcharacter.h.

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.

Definition at line 967 of file fbcharacter.h.

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.

Definition at line 968 of file fbcharacter.h.

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.

Definition at line 969 of file fbcharacter.h.

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.

Definition at line 971 of file fbcharacter.h.

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.

Definition at line 972 of file fbcharacter.h.

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.

Definition at line 973 of file fbcharacter.h.

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.

Definition at line 974 of file fbcharacter.h.

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.

Definition at line 976 of file fbcharacter.h.

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.

Definition at line 977 of file fbcharacter.h.

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.

Definition at line 978 of file fbcharacter.h.

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.

Definition at line 979 of file fbcharacter.h.

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.

Definition at line 981 of file fbcharacter.h.

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.

Definition at line 982 of file fbcharacter.h.

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.

Definition at line 983 of file fbcharacter.h.

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.

Definition at line 984 of file fbcharacter.h.

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

Definition at line 986 of file fbcharacter.h.

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

Definition at line 987 of file fbcharacter.h.

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

Definition at line 988 of file fbcharacter.h.

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

Definition at line 989 of file fbcharacter.h.


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

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