FBCharacterPoseOptions Class Reference
 
 
 
FBCharacterPoseOptions Class Reference

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


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

Public Member Functions

def  __reduce__ ()
def  __init__ ()
def  ClearFlag ()
def  GetFlag ()
def  SetFlag ()

Public Attributes

FBCharacterPoseKeyingMode  mCharacterPoseKeyingMode
FBVector4< double >  mMirrorPlaneEquation
double  mMirrorPlanePanAngle
double  mMirrorPlaneTiltAngle
FBMirrorPlaneType  mMirrorPlaneType
FBModel mModelToMatch

Member Function Documentation

def __reduce__ ( )
def __init__ ( )

Python Docstring:

__init__( (object)arg1) -> None 

C++ Signature:

 FBCharacterPoseOptions() 

Constructor.

def ClearFlag ( )

Python Docstring:

ClearFlag( (FBCharacterPoseOptions)arg1) -> None 

C++ Signature:

void ClearFlag() 

Clear all flags.

def GetFlag ( )

Python Docstring:

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

C++ Signature:

bool GetFlag(FBCharacterPoseFlag pFlag) 

Get a flag value.

Parameters:
pFlag Flag to get.
Returns:
Value of the flag.
def SetFlag ( )

Python Docstring:

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

C++ Signature:

void SetFlag(FBCharacterPoseFlag pFlag, bool pValue) 

Set a flag value.

Parameters:
pFlag Flag to set.
pValue Value to set.

Member Data Documentation

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.

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

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

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.