FBActor Class Reference

#include
<fbcharacter.h>

Inheritance diagram for FBActor:

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

Definition at line 809 of file fbcharacter.h.


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.
FBPropertyBool	Active
	Read Write Property: Is actor snap active?.
FBPropertyBool	Locked
	Read Write Property: Is actor locked?.
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.
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	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	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	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	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	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	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	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.
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	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	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	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	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	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	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	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	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	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	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	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.
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	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	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	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	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 828 of file fbcharacter.h.

FBPropertyMarkerSet OutputMarkerSet

Read Write Property: Associated output marker set.

Definition at line 829 of file fbcharacter.h.

FBPropertyBool Active

Read Write Property: Is actor snap active?.

Reimplemented from FBConstraint.

Definition at line 830 of file fbcharacter.h.

FBPropertyBool Locked

Read Write Property: Is actor locked?.

Definition at line 831 of file fbcharacter.h.

FBPropertyColor BodyColor

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

Definition at line 833 of file fbcharacter.h.

FBPropertyColor SkeletonColor

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

Definition at line 834 of file fbcharacter.h.

FBPropertyColor PivotColor

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

Definition at line 835 of file fbcharacter.h.

FBPropertyDouble MarkerSetSize

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

Definition at line 836 of file fbcharacter.h.

FBPropertyDouble PivotSize

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

Definition at line 837 of file fbcharacter.h.

FBPropertyVector3d HipsPosition

Read Write Property: Body part pivot of the actor.

Definition at line 839 of file fbcharacter.h.

FBPropertyVector3d LeftHipPosition

Read Write Property: Body part pivot of the actor.

Definition at line 840 of file fbcharacter.h.

FBPropertyVector3d LeftKneePosition

Read Write Property: Body part pivot of the actor.

Definition at line 841 of file fbcharacter.h.

FBPropertyVector3d LeftAnklePosition

Read Write Property: Body part pivot of the actor.

Definition at line 842 of file fbcharacter.h.

FBPropertyVector3d LeftFootPosition

Read Write Property: Body part pivot of the actor.

Definition at line 843 of file fbcharacter.h.

FBPropertyVector3d RightHipPosition

Read Write Property: Body part pivot of the actor.

Definition at line 844 of file fbcharacter.h.

FBPropertyVector3d RightKneePosition

Read Write Property: Body part pivot of the actor.

Definition at line 845 of file fbcharacter.h.

FBPropertyVector3d RightAnklePosition

Read Write Property: Body part pivot of the actor.

Definition at line 846 of file fbcharacter.h.

FBPropertyVector3d RightFootPosition

Read Write Property: Body part pivot of the actor.

Definition at line 847 of file fbcharacter.h.

FBPropertyVector3d WaistPosition

Read Write Property: Body part pivot of the actor.

Definition at line 848 of file fbcharacter.h.

FBPropertyVector3d ChestPosition

Read Write Property: Body part pivot of the actor.

Definition at line 849 of file fbcharacter.h.

FBPropertyVector3d LeftCollarPosition

Read Write Property: Body part pivot of the actor.

Definition at line 850 of file fbcharacter.h.

FBPropertyVector3d LeftShoulderPosition

Read Write Property: Body part pivot of the actor.

Definition at line 851 of file fbcharacter.h.

FBPropertyVector3d LeftElbowPosition

Read Write Property: Body part pivot of the actor.

Definition at line 852 of file fbcharacter.h.

FBPropertyVector3d LeftWristPosition

Read Write Property: Body part pivot of the actor.

Definition at line 853 of file fbcharacter.h.

FBPropertyVector3d RightCollarPosition

Read Write Property: Body part pivot of the actor.

Definition at line 854 of file fbcharacter.h.

FBPropertyVector3d RightShoulderPosition

Read Write Property: Body part pivot of the actor.

Definition at line 855 of file fbcharacter.h.

FBPropertyVector3d RightElbowPosition

Read Write Property: Body part pivot of the actor.

Definition at line 856 of file fbcharacter.h.

FBPropertyVector3d RightWristPosition

Read Write Property: Body part pivot of the actor.

Definition at line 857 of file fbcharacter.h.

FBPropertyVector3d NeckPosition

Read Write Property: Body part pivot of the actor.

Definition at line 858 of file fbcharacter.h.

FBPropertyVector3d HeadPosition

Read Write Property: Body part pivot of the actor.

Definition at line 859 of file fbcharacter.h.

FBPropertyAnimatableDouble LeftHandIndexIndex