Used to access animation layer properties and modify them. More...
#include <pyfbsdk_generated.h>
Public Member Functions | |
FBAnimationLayer (str pName, int pLayerID) | |
Constructor. | |
AddChildLayer (FBAnimationLayer pAnimationLayer) | |
Add a child to the layer. | |
FBDelete () | |
Virtual FBDelete function. | |
int | GetChildCount () |
Get the child layer count of this layer. | |
FBAnimationLayer | GetChildLayer (int pIndex) |
Get the nth child layer of this layer. | |
GetCompleteChildHierarchy (FBArrayTemplate< FBAnimationLayer > pChildArray) | |
Get the all the children hierarchy of the layer, including children not directly connected to this layer. | |
int | GetLayerIndex () |
Get the layer index. | |
FBAnimationLayer | GetParentLayer () |
Get the parent layer. | |
bool | IsSelected () |
Verify if the layer is selected. | |
SelectLayer (bool pValue, bool pExclusiveSelect) | |
Select the layer. | |
SetParentLayer (FBAnimationLayer pParentLayer) | |
Set the parent layer. | |
![]() | |
FBComponent () | |
Constructor. | |
str | ClassName () |
Get the class name. | |
DisableObjectFlags (FBObjectFlag pFlags) | |
Disable a specific Object Flags. | |
EnableObjectFlags (FBObjectFlag pFlags) | |
Enable a specific Object Flags. | |
bool | FBCreate () |
Open Reality Creation function. | |
FBDelete () | |
Open Reality deletion function. | |
FBDestroy () | |
Open Reality destruction function. | |
FBObjectFlag | GetObjectFlags () |
Get all Object Flags (concatenated). | |
bool | GetObjectStatus (FBObjectStatus pStatus) |
Check to see if an object status is enabled. | |
FBFileReference | GetOwnerFileReference (p0) |
Get the owner FileReference object. | |
HardSelect () | |
HardSelect. | |
bool | HasObjectFlags (FBObjectFlag pFlags) |
Check whether a specific object flag is enabled. | |
bool | Is (int pTypeId) |
Returns true if object is of type TypeId. | |
bool | ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
ProcessNamespaceHierarchy. | |
bool | ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
ProcessObjectNamespace. | |
int | PropertyAdd (FBProperty pProperty) |
Add a property to the component's property manager. | |
bool | PropertyAddReferenceProperty (FBProperty pReferenceProperty) |
Add a reference property to the component's property manager. | |
FBProperty | PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None) |
Create user or dynamic property. | |
PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags) | |
Get list of properties which have been modified since last loading. | |
PropertyRemove (FBProperty pProperty) | |
Remove a Property from the component's Property manager. | |
SetObjectFlags (FBObjectFlag pFlags) | |
SetObjectFlags. | |
SetObjectStatus (FBObjectStatus pStatus, bool pValue) | |
Enable/Disable a specific Object Status. | |
Public Attributes | |
FBColor | Color |
Read Write Property: The animation layer color. | |
FBLayerMode | LayerMode |
Read Write Property: Layer mode. By default, the layer is in kFBLayerModeAdditive mode. Cannot be applied to the BaseAnimation Layer. | |
FBLayerRotationMode | LayerRotationMode |
Read Only Property: Layer rotation mode. Cannot be applied to the BaseAnimation Layer. | |
bool | Lock |
Read Write Property: If true, the layer is locked. You cannot modify keyframes on a locked layer. | |
bool | 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. | |
bool | 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. | |
FBAnimatableDouble | 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. | |
![]() | |
FBListComponent | Components |
List: List of components. | |
str | LongName |
Read Write Property: Name and namespace for object. | |
str | Name |
Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py. | |
FBListComponent | Parents |
List: Parents. | |
FBManager | PropertyList |
Read Only Property: Manages all of the properties for the component. | |
bool | Selected |
Read Write Property: Selected property. | |
int | TypeInfo |
Contains the Type information of the object. | |
![]() | |
str | ClassGroupName |
ClassGroupName of the object. | |
int | TypeInfo |
TypeInfo. | |
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.
FBAnimationLayer | ( | str | pName, |
int | pLayerID | ||
) |
Constructor.
pName | Name of the animation layer. |
pLayerID | ID to set for the new layer. |
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.
pAnimationLayer | Layer to set as a child. |
FBDelete | ( | ) |
Virtual FBDelete function.
int GetChildCount | ( | ) |
Get the child layer count of this layer.
The count will only includes direct child of the layer.
FBAnimationLayer GetChildLayer | ( | int | pIndex | ) |
Get the nth child layer of this layer.
pIndex | Index of the child layer to get. |
GetCompleteChildHierarchy | ( | FBArrayTemplate< FBAnimationLayer > | pChildArray | ) |
Get the all the children hierarchy of the layer, including children not directly connected to this layer.
pChildArray | Array of child layers, will be filled by the function. |
int GetLayerIndex | ( | ) |
Get the layer index.
FBAnimationLayer GetParentLayer | ( | ) |
Get the parent layer.
bool IsSelected | ( | ) |
Verify if the layer is selected.
Select the layer.
This is the equivalent of selecting the layer in the UI in the Animation Layer Editor tool
pValue | True if the layer will be selected, false otherwise. |
pExclusiveSelect | If pValue is true, passing true will deselect all the other layers, creating an exclusive selection, it will also set the layer as the current layer. |
SetParentLayer | ( | FBAnimationLayer | pParentLayer | ) |
Set the parent layer.
pParentLayer | A pointer to the parent layer or NULL if you want to unparent the layer. |
FBColor Color |
Read Write Property: The animation layer color.
FBLayerMode LayerMode |
Read Write Property: Layer mode. By default, the layer is in kFBLayerModeAdditive mode. Cannot be applied to the BaseAnimation Layer.
FBLayerRotationMode LayerRotationMode |
Read Only Property: Layer rotation mode. Cannot be applied to the BaseAnimation Layer.
bool Lock |
Read Write Property: If true, the layer is locked. You cannot modify keyframes on a locked layer.
bool 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.
bool 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.
FBAnimatableDouble 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.