Python Reference Guide
 
Loading...
Searching...
No Matches
FBCharacterPoseOptions Class Reference

Stores options for operations on poses. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBCharacterPoseOptions:

Public Member Functions

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

Public Attributes

FBCharacterPoseKeyingMode mCharacterPoseKeyingMode
 CharacterPoseKeyingMode (FullBody or BodyPart).

 
FBVector4< double > mMirrorPlaneEquation
 Mirror plane equation (used when mMirrorPlaneType = kFBMirrorPlaneTypeEquation).

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

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

 
FBMirrorPlaneType mMirrorPlaneType
 Mirror plane type.

 
FBModel mModelToMatch
 Model to match.

 

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.

Constructor & Destructor Documentation

◆ FBCharacterPoseOptions()

Constructor.

Member Function Documentation

◆ ClearFlag()

ClearFlag ( )

Clear all flags.

◆ GetFlag()

bool GetFlag ( FBCharacterPoseFlag  pFlag)

Get a flag value.

Parameters
pFlagFlag to get.
Returns
Value of the flag.

◆ SetFlag()

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

◆ mMirrorPlaneEquation

FBVector4< double > mMirrorPlaneEquation

Mirror plane equation (used when mMirrorPlaneType = kFBMirrorPlaneTypeEquation).

◆ mMirrorPlanePanAngle

float mMirrorPlanePanAngle

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

◆ mMirrorPlaneTiltAngle

float mMirrorPlaneTiltAngle

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

◆ mMirrorPlaneType

FBMirrorPlaneType mMirrorPlaneType

Mirror plane type.

◆ mModelToMatch

FBModel mModelToMatch

Model to match.