FBCharacterPoseOptions Class Reference

FBCharacterPoseOptions Class Reference
+ Related help topics:

#include <mobu-python-api.h>

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

+ Inheritance diagram for FBCharacterPoseOptions:

Public Member Functions

 __reduce__ ()
 
 __init__ (object arg1)
 Constructor. More...
 
 ClearFlag (FBCharacterPoseOptions arg1)
 Clear all flags. More...
 
bool GetFlag (FBCharacterPoseOptions arg1, FBCharacterPoseFlag arg2)
 Get a flag value. More...
 
 SetFlag (FBCharacterPoseOptions arg1, FBCharacterPoseFlag arg2, object arg3)
 Set a flag value. More...
 

Public Attributes

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

Member Function Documentation

__init__ ( object  arg1)

Constructor.

Python Docstring:

__init__( (object)arg1) -> None 

C++ Signature:

 FBCharacterPoseOptions() 
__reduce__ ( )
ClearFlag ( FBCharacterPoseOptions  arg1)

Clear all flags.

Python Docstring:

ClearFlag( (FBCharacterPoseOptions)arg1) -> None 

C++ Signature:

void ClearFlag() 
bool GetFlag ( FBCharacterPoseOptions  arg1,
FBCharacterPoseFlag  arg2 
)

Get a flag value.

Python Docstring:

GetFlag( (FBCharacterPoseOptions)arg1, (FBCharacterPoseFlag)arg2) -> bool 

C++ Signature:

bool GetFlag(FBCharacterPoseFlag pFlag) 
Parameters
pFlagFlag to get.
Returns
Value of the flag.
SetFlag ( FBCharacterPoseOptions  arg1,
FBCharacterPoseFlag  arg2,
object  arg3 
)

Set a flag value.

Python Docstring:

SetFlag( (FBCharacterPoseOptions)arg1, (FBCharacterPoseFlag)arg2, (object)arg3) -> None 

C++ Signature:

void SetFlag(FBCharacterPoseFlag pFlag, bool pValue) 
Parameters
pFlagFlag to set.
pValueValue to set.

Member Data Documentation

FBCharacterPoseKeyingMode mCharacterPoseKeyingMode

CharacterPoseKeyingMode (FullBody or BodyPart).

ORSDK2018::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.

double mMirrorPlanePanAngle

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

double mMirrorPlaneTiltAngle

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

FBMirrorPlaneType mMirrorPlaneType

Mirror plane type.

ORSDK2018::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.