Public Member Functions | Public Attributes

FBActor Class Reference

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


Search for all occurrences

Detailed Description

FBActor is used to link motion data to a character.

In MotionBuilder, a actor is a model used to link captured optical or magnetic motion data to a character. Use functions in FBActor to set the actor's body color, skeleton color, pivot color, marker size, pivot size, pivot information, and so on.

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;
       HFBScene 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;
       HFBActor lActor = lApplication.CurrentActor;
       if( lActor )
       {
           FBTrace( "Current actor is: '%s'\n", (char*)lActor->Name );
       }
       else
       {
           FBTrace( "No actor currently selected\n" );
       }

Definition at line 813 of file fbcharacter.h.

#include <fbcharacter.h>

Inheritance diagram for FBActor:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  FBActor (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 (HFBEvaluateInfo 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.
HFBSkeletonState  GetDefaultSkeletonState ()
  Return the Default Skeleton State.
HFBSkeletonState  GetCurrentSkeletonState ()
  Return the Current Skeleton State.
HFBModel  GetLeftGloveReferenceModel ()
  Get the reference model associated with left hand.
void  SetLeftGloveReferenceModel (HFBModel pReferenceModel)
  Set a model to be the left glove reference.
HFBModel  GetRightGloveReferenceModel ()
  Get the reference model associated with right hand.
void  SetRightGloveReferenceModel (HFBModel 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 ( char *  pName,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pName Name of new actor.
pObject For 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 ( HFBEvaluateInfo  pEvalInfo )

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

Parameters:
pEvalInfo Evaluate Info of the Values
void SetDefinitionScaleVector ( FBSkeletonNodeId  pSkeletonId,
FBVector3d  pScaleVector,
bool  pSymmetricUpdate = true 
)

Set Actor Scaling Definition.

Parameters:
pSkeletonId Skeleton Node Id
pScaleVector Actor Scaling value for the given ID
pSymmetricUpdate Update right and left part at the same time
void GetDefinitionScaleVector ( FBSkeletonNodeId  pSkeletonId,
FBVector3d pScaleVector 
)

Get Actor Scaling Definition.

Parameters:
pSkeletonId Skeleton Node Id
Return values:
pScaleVector Actor Scaling Definition for the given ID
void SetDefinitionRotationVector ( FBSkeletonNodeId  pSkeletonId,
FBVector3d  pRotationVector,
bool  pSymmetricUpdate = true 
)

Set Actor Rotation Definition.

Parameters:
pSkeletonId Skeleton Node Id
pRotationVector Actor Rotation value for the given ID
pSymmetricUpdate Update 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:
pTranslationVector Will move the entire Actor to pTranslationVector coordinate
HFBSkeletonState GetDefaultSkeletonState ( )

Return the Default Skeleton State.

Returns:
Default Skeleton State
HFBSkeletonState GetCurrentSkeletonState ( )

Return the Current Skeleton State.

Returns:
Current Skeleton State
HFBModel GetLeftGloveReferenceModel ( )

Get the reference model associated with left hand.

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

Set a model to be the left glove reference.

Parameters:
pReferenceModel Model to be the left glove reference.
HFBModel GetRightGloveReferenceModel ( )

Get the reference model associated with right hand.

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

Set a model to be the right glove reference.

Parameters:
pReferenceModel Model to be the right glove reference.

Member Data Documentation

FBPropertyMarkerSet MarkerSet

Read Write Property: Associated marker set.

Definition at line 830 of file fbcharacter.h.

FBPropertyMarkerSet OutputMarkerSet

Read Write Property: Associated output marker set.

Definition at line 831 of file fbcharacter.h.

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

Definition at line 833 of file fbcharacter.h.

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

Definition at line 834 of file fbcharacter.h.

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

Definition at line 835 of file fbcharacter.h.

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

Definition at line 836 of file fbcharacter.h.

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

Definition at line 837 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 839 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 840 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 841 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 842 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 843 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 844 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 845 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 846 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 847 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 848 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 849 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 850 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 851 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 852 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 853 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 854 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 855 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 856 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 857 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 858 of file fbcharacter.h.

Read Write Property: Body part pivot of the actor.

Definition at line 859 of file fbcharacter.h.

Read Write Property: Show or Hide the Actor Body.

Definition at line 860 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 862 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 863 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 864 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 865 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 867 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 868 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 869 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 870 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 872 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 873 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 874 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 875 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 877 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 878 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 879 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 880 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 882 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 883 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 884 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 885 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 887 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 888 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 889 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 890 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 892 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 893 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 894 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 895 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 897 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 898 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 899 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 900 of file fbcharacter.h.

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

Definition at line 902 of file fbcharacter.h.

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

Definition at line 903 of file fbcharacter.h.

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

Definition at line 904 of file fbcharacter.h.

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

Definition at line 905 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