FBAnimationLayer Class Reference


Detailed Description

Used to access animation layer properties and modify them.

Changing the various properties of the layers will modify how the animation will be interpreted. For example, muting a layer will mute all the animation contained on the layer. You can access the animation layer object from the take, usign the FBTake.GetLayer() and FBTake.GetLayerByName(). See the FBTake class for more details.

Examples
BasicOperations/AnimationLayers.py, BasicOperations/MergeAnimationLayers.py
Inheritance diagram for FBAnimationLayer:

List of all members.

Public Member Functions

 __init__ (str pName, int pLayerID, object pObject=None)
 Constructor.
 FBDelete ()
 Virtual FBDelete function.
 AddChildLayer (FBAnimationLayer pAnimationLayer)
 Add a child to the layer.
FBAnimationLayer GetChildLayer (int pIndex)
 Get the nth child layer of this layer.
int GetChildCount ()
 Get the child layer count of this layer.
 GetCompleteChildHierarchy (tuple pChildArray)
 Get the all the children hierarchy of the layer, including children not directly connected to this layer.
 SetParentLayer (FBAnimationLayer pParentLayer)
 Set the parent layer.
FBAnimationLayer GetParentLayer ()
 Get the parent layer.
int GetLayerIndex ()
 Get the layer index.
 SelectLayer (bool pValue, bool pExclusiveSelect)
 Select the layer.
bool IsSelected ()
 Verify if the layer is selected.

Public Attributes

FBPropertyBase Solo
 Read Write Property: If true, the layer is soloed.
FBPropertyBase Mute
 Read Write Property: If true, the layer is muted.
FBPropertyBase Lock
 Read Write Property: If true, the layer is locked.
FBPropertyBaseAnimatable Weight
 Read Write Property: The weight value of a layer determines how much it is present in the result animation.
FBPropertyLayerMode LayerMode
 Read Write Property: Layer mode.
FBPropertyLayerRotationMode LayerRotationMode
 Read Only Property: Layer rotation mode.

Member Function Documentation

__init__ ( str  pName,
int  pLayerID,
object  pObject = None 
)

Constructor.

Parameters:
pNameName of the animation layer.
pLayerIDID to set for the new layer.
pObjectFor internal use only.
Examples
BasicOperations/AnimationLayers.py, BasicOperations/MergeAnimationLayers.py
FBDelete ( )

Virtual FBDelete function.

Examples
Tasks/DeleteHierarchy.py

Reimplemented from FBComponent.

AddChildLayer ( FBAnimationLayer  pAnimationLayer)

Add a child to the layer.

Layer ID of the new child layer might change after parenting depending where the child layer was originally located.

Parameters:
pAnimationLayerLayer to set as a child.
FBAnimationLayer GetChildLayer ( int  pIndex)

Get the nth child layer of this layer.

Parameters:
pIndexIndex of the child layer to get.
Returns:
Child animation layer located at pIndex
int GetChildCount ( )

Get the child layer count of this layer.

The count will only includes direct child of the layer.

Returns:
Child layer count, or -1 if unsuccessful
GetCompleteChildHierarchy ( tuple  pChildArray)

Get the all the children hierarchy of the layer, including children not directly connected to this layer.

The function takes no parameter and returns a Python list. ex : lArray = lAnimationLayer.GetCompleteChildHierarchy()
Parameters:
pChildArrayArray of child layers, will be filled by the function.
SetParentLayer ( FBAnimationLayer  pParentLayer)

Set the parent layer.

Parameters:
pParentLayerA pointer to the parent layer or NULL if you want to unparent the layer.
FBAnimationLayer GetParentLayer ( )

Get the parent layer.

Returns:
A pointer to the parent layer or NULL if the layer doesn't have a parent.
int GetLayerIndex ( )

Get the layer index.

Returns:
The layer index in the current layer hierarchy. This value will change if the hierarchy is modified. Return -1 if unsuccessful.
SelectLayer ( bool  pValue,
bool  pExclusiveSelect 
)

Select the layer.

This is the equivalent of selecting the layer in the UI in the Animation Layer Editor tool

Parameters:
pValueTrue if the layer will be selected, false otherwise.
pExclusiveSelectIf pValue is true, passing true will deselect all the other layers, creating an exclusive selection.
bool IsSelected ( )

Verify if the layer is selected.

Returns:
True if the layer is selected, false otherwise.

Member Data Documentation

FBPropertyBase Solo

Read Write Property: If true, the layer is soloed.

When you solo a layer, you mute other layers that are at the same level in the hierarchy, as well as the children of those layers. Cannot be applied to the BaseAnimation Layer.

FBPropertyBase Mute

Read Write Property: If true, the layer is muted.

A muted layer is not included in the result animation. Cannot be applied to the BaseAnimation Layer.

FBPropertyBase Lock

Read Write Property: If true, the layer is locked.

You cannot modify keyframes on a locked layer.

FBPropertyBaseAnimatable Weight

Read Write Property: The weight value of a layer determines how much it is present in the result animation.

Takes a value from 0 (the layer is not present) to 100. The weighting of a parent layer is factored into the weighting of its child layers, if any. BaseAnimation Layer always has a Weight of 100.

FBPropertyLayerMode LayerMode

Read Write Property: Layer mode.

By default, the layer is in kFBLayerModeAdditive mode. Cannot be applied to the BaseAnimation Layer.

FBPropertyLayerRotationMode LayerRotationMode

Read Only Property: Layer rotation mode.

Cannot be applied to the BaseAnimation Layer.


FBAnimationLayer FBAnimationLayer FBAnimationLayer FBAnimationLayer FBAnimationLayer FBAnimationLayer FBAnimationLayer FBAnimationLayer FBAnimationLayer FBAnimationLayer
FBAnimationLayer FBAnimationLayer FBAnimationLayer FBAnimationLayer FBAnimationLayer FBAnimationLayer FBAnimationLayer FBAnimationLayer FBAnimationLayer FBAnimationLayer