FBCharacterSolver Class Reference

Search for all occurrences

---

Detailed Description

Constraint class.

Definition at line 115 of file fbcharactersolver.h.

#include <fbcharactersolver.h>

Inheritance diagram for FBCharacterSolver:

List of all members.

Public Member Functions
	FBCharacterSolver (char *pName, HIObject pObject=NULL)
	Constructor.
	IObject_Declare (Implementation)
HFBEvaluateInfo	BackgroundEvaluateInfo (HFBEvaluateInfo pSourceEvaluateInfo)
void	ResetConnectorSetup ()
virtual FBCharacterManipulatorCtrlSet *	CreateCharacterManipulatorCtrlSet (char *pName)
virtual double	GetCharacterSolverVersion ()
	Version of the solver. Needs to be overloaded in derived class.
virtual int	GetExtraFKCount ()
	Return number of extra FK model (ex.
virtual const char *	GetExtraFKNameAt (int pIndex)
	Return the specified extra FK Name (ex.
virtual FBBodyPartId	GetExtraFKBodyPartAt (int pIndex)
	Return The specified extra FK BodyPart (ex.
virtual int	GetExtraBoneCount ()
	Return number of extra Bone model (ex.
virtual const char *	GetExtraBoneNameAt (int pIndex)
	Return The specified extra Bone name (ex.
virtual FBBodyPartId	GetExtraBoneBodyPartAt (int pIndex)
	Return The specified extra Bone BodyPart (ex.
FBModel *	GetExtraBoneModelAt (int pIndex)
	Return The specified extra Bone model (ex.
FBModelMarker *	GetExtraFKModelAt (int pIndex)
	Return the specified extra FK model (ex.
void	SetExtraBoneModelAt (FBModel *pModel, int pIndex)
	Set the specified extra Bone model for a specified Extra Bone Index.
void	SetExtraFKModelAt (FBModelMarker *pModel, int pIndex)
	Set the specified extra FK model for a specified Extra FK Index (ex.
void	ExtractOffsets ()
	Extract Transforms Of Extra Bones for character stance pose information.
void	GetTransformOffset (FBVector3d &pT, FBRVector &pR, FBSVector &pS, int pIndex)
	Get the transform of the Given Extra Bone Index.
void	SetTransformOffset (FBVector3d &pT, FBRVector &pR, FBSVector &pS, int pIndex)
	Set the transform of the Given Extra Bone Index.
void	GetParentRotationOffset (FBRVector &pR, int pIndex)
	Get the Parent Rotation Offset of the Given Extra Bone Index.
void	SetParentRotationOffset (FBRVector &pR, int pIndex)
	Set the Parent Rotation Offset of the Given Extra Bone Index.
virtual void	CharacterPasteState (FBCharacter *pFromCharacter, FBCharacterPose *pPose, FBCharacterPoseOptions &pCharacterPoseOptions)
	Paste the state of a character on another one.
Public Attributes
int	mEvaluationId
	Last Evaluation Id.
FBPropertyCharacter	TargetCharacter
	Read Write Property: The character being constrained.
FBPropertyComponent	Source
	Read Write Property: Source character when doing a character retarget.

---

Constructor & Destructor Documentation

FBCharacterSolver	(	char *	pName,
		HIObject	pObject = NULL
	)

Constructor.

Parameters:

pName	Name of constraint.
pObject	For internal use only (default is NULL).

---

Member Function Documentation

IObject_Declare

(

Implementation

)

Search for all occurrences

Reimplemented from FBConstraint.

HFBEvaluateInfo BackgroundEvaluateInfo

(

HFBEvaluateInfo

pSourceEvaluateInfo

)

Search for all occurrences

void ResetConnectorSetup

(

)

Search for all occurrences

virtual FBCharacterManipulatorCtrlSet* CreateCharacterManipulatorCtrlSet

(

char *

pName

)

[virtual]

Search for all occurrences

virtual double GetCharacterSolverVersion

(

)

[inline, virtual]

Search for all occurrences

Version of the solver. Needs to be overloaded in derived class.

Definition at line 139 of file fbcharactersolver.h.

{ return 1.0; };

virtual int GetExtraFKCount

(

)

[inline, virtual]

Search for all occurrences

Return number of extra FK model (ex.

extra shoulder)

Returns:

number of extra FK.

Definition at line 144 of file fbcharactersolver.h.

{ return 0; }

virtual const char* GetExtraFKNameAt

(

int

pIndex

)

[inline, virtual]

Search for all occurrences

Return the specified extra FK Name (ex.

extra shoulder)

Parameters:

pIndex

Index of extra FK to get.

Returns:

Name corresponding to FK index.

Definition at line 149 of file fbcharactersolver.h.

{ return NULL; }

virtual FBBodyPartId GetExtraFKBodyPartAt

(

int

pIndex

)

[inline, virtual]

Search for all occurrences

Return The specified extra FK BodyPart (ex.

Left Arm )

Parameters:

pIndex

Index of extra Bone to get.

Returns:

BodyPart associated with this model.

Definition at line 154 of file fbcharactersolver.h.

{ return kFBCtrlSetPartNone; }

virtual int GetExtraBoneCount

(

)

[inline, virtual]

Search for all occurrences

Return number of extra Bone model (ex.

extra shoulder)

Returns:

number of extra Bone.

Definition at line 158 of file fbcharactersolver.h.

{ return 0; }

virtual const char* GetExtraBoneNameAt

(

int

pIndex

)

[inline, virtual]

Search for all occurrences

Return The specified extra Bone name (ex.

extra shoulder)

Parameters:

pIndex

Index of extra Bone to get.

Returns:

Name corresponding to Bone index.

Definition at line 163 of file fbcharactersolver.h.

{ return NULL; }

virtual FBBodyPartId GetExtraBoneBodyPartAt

(

int

pIndex

)

[inline, virtual]

Search for all occurrences

Return The specified extra Bone BodyPart (ex.

Left Arm )

Parameters:

pIndex

Index of extra Bone to get.

Returns:

BodyPart associated with this model.

Definition at line 168 of file fbcharactersolver.h.

{ return kFBCtrlSetPartNone; }

FBModel* GetExtraBoneModelAt

(

int

pIndex

)

Search for all occurrences

Return The specified extra Bone model (ex.

extra shoulder)

Parameters:

pIndex

Index of extra Bone to get.

Returns:

FBModel corresponding to Bone index.

FBModelMarker* GetExtraFKModelAt

(

int

pIndex

)

Search for all occurrences

Return the specified extra FK model (ex.

extra shoulder)

Parameters:

pIndex

Index of extra FK to get.

Returns:

FBModel corresponding to FK index.

void SetExtraBoneModelAt	(	FBModel *	pModel,
		int	pIndex
	)

Search for all occurrences

Set the specified extra Bone model for a specified Extra Bone Index.

(ex. extra shoulder)

Parameters:

pModel	Extra Bone Model used for characterization.
pIndex	Index of extra Bone to set.

void SetExtraFKModelAt	(	FBModelMarker *	pModel,
		int	pIndex
	)

Search for all occurrences

Set the specified extra FK model for a specified Extra FK Index (ex.

extra shoulder)

Parameters:

pModel	Extra FK Model used for character Rig
pIndex	Index of extra FK to set.

void ExtractOffsets

(

)

Search for all occurrences

Extract Transforms Of Extra Bones for character stance pose information.

void GetTransformOffset	(	FBVector3d &	pT,
		FBRVector &	pR,
		FBSVector &	pS,
		int	pIndex
	)

Search for all occurrences

Get the transform of the Given Extra Bone Index.

The transorm is the Global Transform extracted at Characterisation (in Stance Pose)

Parameters:

pT	return Global Translation in Stance Pose.
pR	return Global Rotation in Stance Pose.
pS	return Global Scaling in Stance Pose.
pIndex	Index of extra Bone to get.

void SetTransformOffset	(	FBVector3d &	pT,
		FBRVector &	pR,
		FBSVector &	pS,
		int	pIndex
	)

Search for all occurrences

Set the transform of the Given Extra Bone Index.

The transorm is the Global Transform extracted at Characterisation (in Stance Pose)

Parameters:

pT	Global Translation to set for the Stance Pose.
pR	Global Rotation to set for the Stance Pose.
pS	Global Scaling to set for the Stance Pose.
pIndex	Index of extra Bone to set.

void GetParentRotationOffset	(	FBRVector &	pR,
		int	pIndex
	)

Search for all occurrences

Get the Parent Rotation Offset of the Given Extra Bone Index.

The rotation Offset if extracted at Characterisation (in Stance Pose). You don't need this value if the parent of the bone is characterized too.

Parameters:

pR	Offset Rotation between the Bone and is parent at Stance Pose.
pIndex	Index of extra Bone to get.

void SetParentRotationOffset	(	FBRVector &	pR,
		int	pIndex
	)

Search for all occurrences

Set the Parent Rotation Offset of the Given Extra Bone Index.

The rotation Offset if extracted at Characterisation (in Stance Pose). You don't need this value if the parent of the bone is characterized too.

Parameters:

pR	Offset Rotation between the Bone and is parent at Stance Pose.
pIndex	Index of extra Bone to get.

virtual void CharacterPasteState	(	FBCharacter *	pFromCharacter,
		FBCharacterPose *	pPose,
		FBCharacterPoseOptions &	pCharacterPoseOptions
	)		[inline, virtual]

Search for all occurrences

Paste the state of a character on another one.

Parameters:

pFromCharacter	Character with the state that we want to paste.
pPose	Pose object containing the pose.
pCharacterPoseOptions	Pose options to use with this paste.

Definition at line 233 of file fbcharactersolver.h.

{}

---

Member Data Documentation

int mEvaluationId

Search for all occurrences

Last Evaluation Id.

Definition at line 129 of file fbcharactersolver.h.

FBPropertyCharacter TargetCharacter

Search for all occurrences

Read Write Property: The character being constrained.

Definition at line 130 of file fbcharactersolver.h.

FBPropertyComponent Source

Search for all occurrences

Read Write Property: Source character when doing a character retarget.

Definition at line 131 of file fbcharactersolver.h.

---

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

• fbsdk/fbcharactersolver.h