This reference page is linked to from the following overview topics: FBX SDK 2011, FBX Objects, Animation data structures, Migrating to the new data structures for animation, Animation classes and their interrelationships, Using blend modes to control how a layer blends, List of Python FBX classes.
The animation layer is a collection of animation curve nodes.
Its purpose is to store a variable number of KFbxAnimCurveNodes. The class provides different states flags (bool properties), an animatable weight, and the blending mode flag to indicate how the data on this layer is interacting with the data of the other layers during the evaluation.
Animation/main.cxx, Common/AnimationUtility.cxx, Common/AnimationUtility.h, ExportScene01/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, ExportScene04/main.cxx, ImportScene/DisplayAnimation.cxx, Instances/main.cxx, Pivot/main.cxx, UIExamples/CubeCreator/SDK_Utility.cxx, UIExamples/CubeCreator/SDK_Utility.h, UserProperties/main.cxx, ViewScene/DrawScene.cxx, ViewScene/main.cxx, ViewScene/SetCamera.cxx, and ViewScene/SetCamera.h.
Definition at line 55 of file kfbxanimlayer.h.
#include <kfbxanimlayer.h>
Public Types |
|
enum | EBlendMode { eBlendModeAdditive, eBlendModeOverride, eBlendModeOverridePassthrough } |
Blend mode between animation layers. More... |
|
enum | ERotationAccumulationMode { eRotAccuModeByLayer, eRotAccuModeByChannel } |
Rotation accumulation mode of animation layer. More... |
|
enum | EScaleAccumulationMode { eScaleAccuModeMultiply, eScaleAccuModeAdditive } |
Scale accumulation mode of animation layer. More... |
|
Public Member Functions |
|
void | Reset () |
Reset this object properties to their
default value. |
|
Public Attributes |
|
KFbxTypedProperty< fbxDouble1 > | Weight |
This property stores the weight factor.
|
|
KFbxTypedProperty< fbxBool1 > | Mute |
This property stores the mute state.
|
|
KFbxTypedProperty< fbxBool1 > | Solo |
This property stores the solo state.
|
|
KFbxTypedProperty< fbxBool1 > | Lock |
This property stores the lock state.
|
|
KFbxTypedProperty< fbxDouble3 > | Color |
This property stores the display color.
|
|
KFbxTypedProperty< fbxEnum > | BlendMode |
This property stores the blend mode.
|
|
KFbxTypedProperty< fbxEnum > | RotationAccumulationMode |
This property stores the rotation
accumulation mode. |
|
KFbxTypedProperty< fbxEnum > | ScaleAccumulationMode |
This property stores the scale accumulation
mode. |
|
Protected Member Functions |
|
KFbxAnimLayer (KFbxSdkManager &pManager, char const *pName, KError *pError=0) | |
virtual KFbxAnimLayer * | GetAnimLayer () |
Friends |
|
class | KFbxObject |
BlendMode bypass functions. |
|
This section provides
methods to bypass the current layer blend mode by data type.When
the state is true , the evaluators that are processing
the layer will need to consider that, for the given data type, the
blend mode is forced to be Overwrite. If the state is left to its
default false value, then the layer blend mode
applies.
|
|
void | SetBlendModeBypass (EFbxType pType, bool pState) |
Set the bypass flag for the given data type.
|
|
bool | GetBlendModeBypass (EFbxType pType) |
Get the current state of the bypass flag for
the given data type. |
|
CurveNode Management |
|
KFbxAnimCurveNode * | CreateCurveNode (KFbxProperty &pProperty) |
Create a
KFbxAnimCurveNode based on the property data type. |
enum EBlendMode |
Blend mode between animation layers.
Definition at line 163 of file kfbxanimlayer.h.
Rotation accumulation mode of animation layer.
Definition at line 180 of file kfbxanimlayer.h.
Scale accumulation mode of animation layer.
Definition at line 190 of file kfbxanimlayer.h.
KFbxAnimLayer | ( | KFbxSdkManager & | pManager, |
char const * | pName, | ||
KError * | pError = 0 |
||
) | [protected] |
void Reset | ( | ) |
Reset this object properties to their default value.
void SetBlendModeBypass | ( | EFbxType | pType, |
bool | pState | ||
) |
Set the bypass flag for the given data type.
pType | The fbxType identifier. |
pState | The new state of the bypass flag. |
bool GetBlendModeBypass | ( | EFbxType | pType | ) |
Get the current state of the bypass flag for the given data type.
pType | The fbxType identifier. |
false
in any other case.KFbxAnimCurveNode* CreateCurveNode | ( | KFbxProperty & | pProperty | ) |
Create a KFbxAnimCurveNode based on the property data type.
pProperty | The property that the created KFbxAnimCurveNode will be connected to. |
virtual KFbxAnimLayer* GetAnimLayer | ( | ) | [protected, virtual] |
friend class KFbxObject [friend] |
Reimplemented from KFbxPlug.
Definition at line 232 of file kfbxanimlayer.h.
This property stores the weight factor.
The weight factor is the percentage of influence this layer has during the evaluation.
Default value is 100.0
Definition at line 72 of file kfbxanimlayer.h.
This property stores the mute state.
The mute state indicates that this layer should be excluded from the evaluation.
Default value is false
Definition at line 79 of file kfbxanimlayer.h.
This property stores the solo state.
The solo state indicates that this layer is the only one that should be processed during the evaluation.
Default value is false
Definition at line 87 of file kfbxanimlayer.h.
This property stores the lock state.
The lock state indicates that this layer has been "locked" from editing operations and should no longer receive keyframes.
Default value is false
Definition at line 95 of file kfbxanimlayer.h.
This property stores the display color.
This color can be used by applications if they display a graphical representation of the layer. The FBX SDK does not use it but guarantees that the value is saved to the FBX file and retrieved from it.
Default value is (0.8, 0.8, 0.8)
Definition at line 104 of file kfbxanimlayer.h.
This property stores the blend mode.
The blend mode is used to specify how this layer influences the animation evaluation. See the EBlendMode enumeration for the description of the modes.
Default value is eModeAdditive
Definition at line 112 of file kfbxanimlayer.h.
This property stores the rotation accumulation mode.
This option indicate how the rotation curves on this layer combine with any preceding layers that share the same attributes. See the ERotationAccumulationMode enumeration for the description of the modes.
Default value is eRotAccuModeByLayer
Definition at line 121 of file kfbxanimlayer.h.
This property stores the scale accumulation mode.
This option indicate how the scale curves on this layer combine with any preceding layers that share the same attributes. See the EScaleAccumulationMode enumeration for the description of the modes.
Default value is eScaleAccuModeMultiply
Definition at line 130 of file kfbxanimlayer.h.