Open Reality Reference Guide
FBCharacterPoseOptions Class Reference

Stores options for operations on poses. More...

#include <fbcharacterpose.h>

Public Member Functions

 FBCharacterPoseOptions ()
 Constructor. More...
 
void SetFlag (FBCharacterPoseFlag pFlag, bool pValue)
 Set a flag value. More...
 
bool GetFlag (FBCharacterPoseFlag pFlag) const
 Get a flag value. More...
 
void ClearFlag ()
 Clear all flags. More...
 

Public Attributes

FBModelmModelToMatch
 Model to match. More...
 
FBCharacterPoseKeyingMode mCharacterPoseKeyingMode
 CharacterPoseKeyingMode (FullBody or BodyPart). More...
 
FBMirrorPlaneType mMirrorPlaneType
 Mirror plane type. More...
 
FBVector4< double > mMirrorPlaneEquation
 Mirror plane equation (used when mMirrorPlaneType = kFBMirrorPlaneTypeEquation). More...
 
double mMirrorPlaneTiltAngle
 Mirror plane tilt angle in degrees (used when mMirrorPlaneType = kFBMirrorPlaneTypeUser). More...
 
double mMirrorPlanePanAngle
 Mirror plane pan angle in degrees (used when mMirrorPlaneType = kFBMirrorPlaneTypeUser). More...
 

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 118 of file fbcharacterpose.h.

Constructor & Destructor Documentation

◆ FBCharacterPoseOptions()

Constructor.

Member Function Documentation

◆ ClearFlag()

void ClearFlag ( )

Clear all flags.

◆ GetFlag()

bool GetFlag ( FBCharacterPoseFlag  pFlag) const

Get a flag value.

Parameters
pFlagFlag to get.
Returns
Value of the flag.

◆ SetFlag()

void SetFlag ( FBCharacterPoseFlag  pFlag,
bool  pValue 
)

Set a flag value.

Parameters
pFlagFlag to set.
pValueValue to set.

Member Data Documentation

◆ mCharacterPoseKeyingMode

FBCharacterPoseKeyingMode mCharacterPoseKeyingMode

CharacterPoseKeyingMode (FullBody or BodyPart).

Definition at line 128 of file fbcharacterpose.h.

◆ mMirrorPlaneEquation

FBVector4<double> mMirrorPlaneEquation

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 139 of file fbcharacterpose.h.

◆ mMirrorPlanePanAngle

double mMirrorPlanePanAngle

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

Definition at line 145 of file fbcharacterpose.h.

◆ mMirrorPlaneTiltAngle

double mMirrorPlaneTiltAngle

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

Definition at line 142 of file fbcharacterpose.h.

◆ mMirrorPlaneType

FBMirrorPlaneType mMirrorPlaneType

Mirror plane type.

Definition at line 131 of file fbcharacterpose.h.

◆ mModelToMatch

FBModel* mModelToMatch

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 125 of file fbcharacterpose.h.


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