FBCharacterPoseOptions Class Reference

This reference page is linked to from the following overview topics: FBPose - Poses.

---

Search for all occurrences

---

Detailed Description

Stores options for operations on poses.

This class exposes the object used to store the options for operations on object poses. Before using a FBCharacterPoseOptions, you need to specify the various members of the object. Here are the default values of a FBCharacterPoseOptions object: mCharacterPoseKeyingMode = kFBCharacterPoseKeyingModeFullBody mModelToMatch = NULL mMirrorPlaneType = kFBMirrorPlaneTypeAuto mMirrorPlaneEquation = 1.0, 0.0, 0.0, 0.0 mMirrorPlaneTiltAngle = 90.0 mMirrorPlanePanAngle = 0.0 Flag = kFBCharacterPoseNoFlag You need to change at least the Flag value by using SetFlag() to set how the pose will be pasted; see the FBCharacterPoseFlag enum for the various options.

Definition at line 117 of file fbcharacterpose.h.

#include <fbcharacterpose.h>

List of all members.

Public Member Functions
	FBCharacterPoseOptions ()
	Constructor.
void	SetFlag (FBCharacterPoseFlag pFlag, bool pValue)
	Set a flag value.
bool	GetFlag (FBCharacterPoseFlag pFlag)
	Get a flag value.
void	ClearFlag ()
	Clear all flags.
Public Attributes
FBModel *	mModelToMatch
	Model to match.
FBCharacterPoseKeyingMode	mCharacterPoseKeyingMode
	CharacterPoseKeyingMode (FullBody or BodyPart).
FBMirrorPlaneType	mMirrorPlaneType
	Mirror plane type.
FBVector4< double >	mMirrorPlaneEquation
	Mirror plane equation (used when mMirrorPlaneType = kFBMirrorPlaneTypeEquation).
double	mMirrorPlaneTiltAngle
	Mirror plane tilt angle in degrees (used when mMirrorPlaneType = kFBMirrorPlaneTypeUser).
double	mMirrorPlanePanAngle
	Mirror plane pan angle in degrees (used when mMirrorPlaneType = kFBMirrorPlaneTypeUser).

---

Constructor & Destructor Documentation

FBCharacterPoseOptions

(

)

Constructor.

---

Member Function Documentation

void SetFlag	(	FBCharacterPoseFlag	pFlag,
		bool	pValue
	)

Search for all occurrences

Set a flag value.

Parameters:

pFlag	Flag to set.
pValue	Value to set.

bool GetFlag

(

FBCharacterPoseFlag

pFlag

)

Search for all occurrences

Get a flag value.

Parameters:

pFlag

Flag to get.

Returns:

Value of the flag.

void ClearFlag

(

)

Search for all occurrences

Clear all flags.

---

Member Data Documentation

FBModel* mModelToMatch

Search for all occurrences

Model to match.

When pasting a pose and matching T/R, the pose is pasted so that the T/R of this model does not change.

Definition at line 124 of file fbcharacterpose.h.

FBCharacterPoseKeyingMode mCharacterPoseKeyingMode

Search for all occurrences

CharacterPoseKeyingMode (FullBody or BodyPart).

Definition at line 127 of file fbcharacterpose.h.

FBMirrorPlaneType mMirrorPlaneType

Search for all occurrences

Mirror plane type.

Definition at line 130 of file fbcharacterpose.h.

FBVector4<double> mMirrorPlaneEquation

Search for all occurrences

Mirror plane equation (used when mMirrorPlaneType = kFBMirrorPlaneTypeEquation).

It is a vector defining four scalars (a,b,c,d) for the equation of a plane (ax + by + cz + d = 0). (a,b,c) represents the normal of the plane. (d) represents the offset from the origin in the direction of the normal. Example: (1,0,0,0) defines the plane YZ intersecting with the origin.

Definition at line 138 of file fbcharacterpose.h.

double mMirrorPlaneTiltAngle

Search for all occurrences

Mirror plane tilt angle in degrees (used when mMirrorPlaneType = kFBMirrorPlaneTypeUser).

Definition at line 141 of file fbcharacterpose.h.

double mMirrorPlanePanAngle

Search for all occurrences

Mirror plane pan angle in degrees (used when mMirrorPlaneType = kFBMirrorPlaneTypeUser).

Definition at line 144 of file fbcharacterpose.h.

---

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

• fbsdk/fbcharacterpose.h