FBCharacterPoseOptions Class Reference


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.

List of all members.

Public Member Functions

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

Public Attributes

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

Member Function Documentation

__init__ ( )
SetFlag ( FBCharacterPoseFlag  pFlag,
bool  pValue 
)

Set a flag value.

Parameters:
pFlag Flag to set.
pValue Value to set.
bool GetFlag ( FBCharacterPoseFlag  pFlag )

Get a flag value.

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

Clear all flags.


Member Data Documentation

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.

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 tilt angle in degrees (used when mMirrorPlaneType = kFBMirrorPlaneTypeUser).

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


FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions
FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions FBCharacterPoseOptions