FBActor Class Reference

FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor FBActor
Inheritance diagram for FBActor:
Inheritance graph
[legend]

List of all members.


Detailed Description

Actor class.

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

Public Member Functions

  FBActor (str pName)
  Constructor.
  FBDelete ()
  Actual Actor destructor.
FBSkeletonState  GetCurrentSkeletonState ()
  Return the Current Skeleton State.
FBSkeletonState  GetDefaultSkeletonState ()
  Return the Default Skeleton State.
  GetDefinitionScaleVector (FBSkeletonNodeId pSkeletonId, FBVector3d pScaleVector)
  Get Actor Scaling Definition.
  SetActorTranslation (FBVector3d pTranslationVector)
  Translate Actor, similar to moving the hips of the Actor in the UI.
  SetDefinitionRotationVector (FBSkeletonNodeId pSkeletonId, FBVector3d pRotationVector, bool pSymmetricUpdate=True)
  Set Actor Rotation Definition.
  SetDefinitionScaleVector (FBSkeletonNodeId pSkeletonId, FBVector3d pScaleVector, bool pSymmetricUpdate=True)
  Set Actor Scaling Definition.
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.

Public Attributes

bool  Active
  Read Write Property: Is actor snap active?.
FBColor  BodyColor
  Read Write Property: The color of the body of the actor.
FBVector3d  ChestPosition
  Read Write Property: Body part pivot of the actor.
FBAnimatableDouble  FKFingerMultiplier
  Read Write Property: Used to augment the amount of FK propagation for unmarkered intermediate finger phalanges.
FBAnimatableDouble  FKFingerTipMultiplier
  Read Write Property: Used to augment the amount of FK propagation for unmarkered finger tip phalanges.
FBAnimatableDouble  FKThumbTipMultiplier
  Read Write Property: Used to augment the amount of FK propagation for unmarkered thumb tip phalanges.
FBVector3d  HeadPosition
  Read Write Property: Body part pivot of the actor.
FBVector3d  HipsPosition
  Read Write Property: Body part pivot of the actor.
FBAnimatableBool  HumanFingerLimits
  Read Write Property: Enables/Disables human finger limits during actor solve.
FBVector3d  LeftAnklePosition
  Read Write Property: Body part pivot of the actor.
FBVector3d  LeftCollarPosition
  Read Write Property: Body part pivot of the actor.
FBVector3d  LeftElbowPosition
  Read Write Property: Body part pivot of the actor.
FBVector3d  LeftFootPosition
  Read Write Property: Body part pivot of the actor.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBVector3d  LeftHipPosition
  Read Write Property: Body part pivot of the actor.
FBVector3d  LeftKneePosition
  Read Write Property: Body part pivot of the actor.
FBVector3d  LeftShoulderPosition
  Read Write Property: Body part pivot of the actor.
FBVector3d  LeftWristPosition
  Read Write Property: Body part pivot of the actor.
bool  Locked
  Read Write Property: Is actor locked?.
FBMarkerSet  MarkerSet
  Read Write Property: Associated marker set.
float  MarkerSetSize
  Read Write Property: The size of the markers of the actor.
FBVector3d  NeckPosition
  Read Write Property: Body part pivot of the actor.
FBMarkerSet  OutputMarkerSet
  Read Write Property: Associated output marker set.
FBColor  PivotColor
  Read Write Property: The color of the pivot points of the actor.
float  PivotSize
  Read Write Property: The size of the pivot points of the actor.
FBVector3d  RightAnklePosition
  Read Write Property: Body part pivot of the actor.
FBVector3d  RightCollarPosition
  Read Write Property: Body part pivot of the actor.
FBVector3d  RightElbowPosition
  Read Write Property: Body part pivot of the actor.
FBVector3d  RightFootPosition
  Read Write Property: Body part pivot of the actor.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBAnimatableDouble  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.
FBVector3d  RightHipPosition
  Read Write Property: Body part pivot of the actor.
FBVector3d  RightKneePosition
  Read Write Property: Body part pivot of the actor.
FBVector3d  RightShoulderPosition
  Read Write Property: Body part pivot of the actor.
FBVector3d  RightWristPosition
  Read Write Property: Body part pivot of the actor.
FBColor  SkeletonColor
  Read Write Property: The color of the skeleton of the actor.
FBVector3d  WaistPosition
  Read Write Property: Body part pivot of the actor.

Constructor & Destructor Documentation

FBActor ( str  pName  ) 

Constructor.

Parameters:
pName  Name of new actor.

Member Function Documentation

FBDelete (  ) 

Actual Actor destructor.

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

See sample: DeleteHierarchy.py.

Reimplemented from FBComponent.

FBSkeletonState GetCurrentSkeletonState (  ) 

Return the Current Skeleton State.

Returns:
Current Skeleton State

FBSkeletonState GetDefaultSkeletonState (  ) 

Return the Default Skeleton State.

Returns:
Default Skeleton State

GetDefinitionScaleVector ( FBSkeletonNodeId  pSkeletonId,
FBVector3d  pScaleVector  
)

Get Actor Scaling Definition.

Parameters:
pSkeletonId  Skeleton Node Id
pScaleVector  Actor Scaling Definition for the given ID

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

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

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

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:
pEvalInfo  Evaluate Info of the Values

Member Data Documentation

bool Active

Read Write Property: Is actor snap active?.

Reimplemented from FBConstraint.

FBColor BodyColor

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

FBVector3d ChestPosition

Read Write Property: Body part pivot of the actor.

FBAnimatableDouble FKFingerMultiplier

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

FBAnimatableDouble FKFingerTipMultiplier

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

FBAnimatableDouble FKThumbTipMultiplier

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

FBVector3d HeadPosition

Read Write Property: Body part pivot of the actor.

FBVector3d HipsPosition

Read Write Property: Body part pivot of the actor.

FBAnimatableBool HumanFingerLimits

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

FBVector3d LeftAnklePosition

Read Write Property: Body part pivot of the actor.

FBVector3d LeftCollarPosition

Read Write Property: Body part pivot of the actor.

FBVector3d LeftElbowPosition

Read Write Property: Body part pivot of the actor.

FBVector3d LeftFootPosition

Read Write Property: Body part pivot of the actor.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

FBVector3d LeftHipPosition

Read Write Property: Body part pivot of the actor.

FBVector3d LeftKneePosition

Read Write Property: Body part pivot of the actor.

FBVector3d LeftShoulderPosition

Read Write Property: Body part pivot of the actor.

FBVector3d LeftWristPosition

Read Write Property: Body part pivot of the actor.

bool Locked

Read Write Property: Is actor locked?.

FBMarkerSet MarkerSet

Read Write Property: Associated marker set.

float MarkerSetSize

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

FBVector3d NeckPosition

Read Write Property: Body part pivot of the actor.

FBMarkerSet OutputMarkerSet

Read Write Property: Associated output marker set.

FBColor PivotColor

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

float PivotSize

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

FBVector3d RightAnklePosition

Read Write Property: Body part pivot of the actor.

FBVector3d RightCollarPosition

Read Write Property: Body part pivot of the actor.

FBVector3d RightElbowPosition

Read Write Property: Body part pivot of the actor.

FBVector3d RightFootPosition

Read Write Property: Body part pivot of the actor.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

FBVector3d RightHipPosition

Read Write Property: Body part pivot of the actor.

FBVector3d RightKneePosition

Read Write Property: Body part pivot of the actor.

FBVector3d RightShoulderPosition

Read Write Property: Body part pivot of the actor.

FBVector3d RightWristPosition

Read Write Property: Body part pivot of the actor.

FBColor SkeletonColor

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

FBVector3d WaistPosition

Read Write Property: Body part pivot of the actor.


Generated on Tue Feb 9 19:34:09 2010 for Python Reference Guide by  doxygen 1.5.3