FBAnimationLayer Class Reference

#include <mobu-python-api.h>

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

See the C++ reference

Inheritance diagram for FBAnimationLayer:

Public Member Functions
	__reduce__ ()
	FBDelete (FBAnimationLayer arg1)
	Virtual FBDelete function. More...
	__init__ (object arg1, str arg2, object arg3)
	Constructor. More...
	AddChildLayer (FBAnimationLayer arg1, FBAnimationLayer arg2)
	Add a child to the layer. More...
object	GetChildLayer (FBAnimationLayer arg1, object arg2)
	Get the nth child layer of this layer. More...
int	GetChildCount (FBAnimationLayer arg1)
	Get the child layer count of this layer. More...
	SetParentLayer (FBAnimationLayer arg1, FBAnimationLayer arg2)
	Set the parent layer. More...
object	GetParentLayer (FBAnimationLayer arg1)
	Get the parent layer. More...
list	GetCompleteChildHierarchy (FBAnimationLayer arg1, FBComponent arg2)
	Get the all the children hierarchy of the layer, including children not directly connected to this layer. More...
int	GetLayerIndex (FBAnimationLayer arg1)
	Get the layer index. More...
	SelectLayer (FBAnimationLayer arg1, object arg2, object arg3)
	Select the layer. More...
bool	IsSelected (FBAnimationLayer arg1)
	Verify if the layer is selected. More...
Public Member Functions inherited from FBComponent
	__reduce__ ()
FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...
str	ClassName (FBComponent arg1)
	Get the class name. More...
	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...
	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...
bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...
	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...
	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...
FBObjectFlag	GetObjectFlags (FBComponent arg1)
	Get all Object Flags (concatenated). More...
bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...
bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...
bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...
bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...
bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...
int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...
bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...
object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...
	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...
	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...
	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...
	HardSelect (FBComponent arg1)
	HardSelect. More...
object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...
	__init__ (...)
	Constructor. More...
Public Member Functions inherited from FBPlug
	__reduce__ ()
bool	BeginChange (FBPlug arg1)
	Begins a change on multiple plugs. More...
str	ClassName (FBPlug arg1)
	internal System vars. More...
bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...
bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...
bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...
bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...
	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...
	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...
bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...
bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...
bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...
bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...
	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...
object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...
int	GetDstCount (FBPlug arg1)
	Get destination connection count. More...
FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...
object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...
int	GetOwnedCount (FBPlug arg1)
	Get the owned plug count. More...
object	GetOwner (FBPlug arg1)
	Get the owner of this plug. More...
object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...
int	GetSrcCount (FBPlug arg1)
	Get source connection count. More...
FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...
bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...
bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...
	MoveSrcAt (...)
bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...
bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...
bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...
	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...
bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...
	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...
bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...
int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...
bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...
	__init__ (...)
method	staticmethod (function)
Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()
	__init__ (...)

Public Attributes
FBPropertyBool	Solo
	Read Write Property: If true, the layer is soloed. More...
FBPropertyBool	Mute
	Read Write Property: If true, the layer is muted. More...
FBPropertyBool	Lock
	Read Write Property: If true, the layer is locked. More...
FBPropertyAnimatableDouble	Weight
	Read Write Property: The weight value of a layer determines how much it is present in the result animation. More...
FBPropertyLayerMode	LayerMode
	Read Write Property: Layer mode. More...
FBPropertyLayerRotationMode	LayerRotationMode
	Read Only Property: Layer rotation mode. More...
Public Attributes inherited from FBComponent
object	OwnerNamespace
ORSDK2018::FBPropertyListComponent	Components
	List: List of components. More...
ORSDK2018::FBPropertyString	Name
	Read Write Property: Unique name of object. More...
ORSDK2018::FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...
object	FullName
ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...
ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...
FBPropertyBool	Selected
	Read Write Property: Selected property. More...
Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__	(	object	arg1,
		str	arg2,
		object	arg3
	)

Constructor.

Python Docstring:

__init__( (object)arg1, (str)arg2, (object)arg3) -> None 

C++ Signature:

 FBAnimationLayer(const char * pName, int pLayerID, HIObject pObject = ((void *) 0)) 

Parameters

pName	Name of the animation layer.
pLayerID	ID to set for the new layer.
pObject	For internal use only.

See the C++ reference

__reduce__

(

)

AddChildLayer	(	FBAnimationLayer	arg1,
		FBAnimationLayer	arg2
	)

Add a child to the layer.

Python Docstring:

AddChildLayer( (FBAnimationLayer)arg1, (FBAnimationLayer)arg2) -> None 

C++ Signature:

void AddChildLayer(ORSDK2018::FBAnimationLayer * pAnimationLayer) 

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

Parameters

pAnimationLayer

Layer to set as a child.

See the C++ reference

FBDelete

(

FBAnimationLayer

arg1

)

Virtual FBDelete function.

Python Docstring:

FBDelete( (FBAnimationLayer)arg1) -> None 

C++ Signature:

void FBDelete() 

See the C++ reference

int GetChildCount

(

FBAnimationLayer

arg1

)

Get the child layer count of this layer.

Python Docstring:

GetChildCount( (FBAnimationLayer)arg1) -> int 

C++ Signature:

int GetChildCount() 

The count will only includes direct child of the layer.

Returns

Child layer count, or -1 if unsuccessful

See the C++ reference

object GetChildLayer	(	FBAnimationLayer	arg1,
		object	arg2
	)

Get the nth child layer of this layer.

Python Docstring:

GetChildLayer( (FBAnimationLayer)arg1, (object)arg2) -> object 

C++ Signature:

ORSDK2018::FBAnimationLayer * GetChildLayer(int pIndex) 

Parameters

pIndex

Index of the child layer to get.

Returns

Child animation layer located at pIndex

See the C++ reference

list GetCompleteChildHierarchy	(	FBAnimationLayer	arg1,
		FBComponent	arg2
	)

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

Python Docstring:

GetCompleteChildHierarchy( (FBAnimationLayer)arg1, (FBComponent)arg2) -> list 

C++ Signature:

void GetCompleteChildHierarchy(ORSDK2018::FBArrayTemplate< ORSDK2018::FBAnimationLayer * > * pChildArray) 

PythonThe function takes no parameter and returns a Python list. ex : lArray = lAnimationLayer.GetCompleteChildHierarchy()

Parameters

pChildArray

Array of child layers, will be filled by the function.

See the C++ reference

int GetLayerIndex

(

FBAnimationLayer

arg1

)

Get the layer index.

Python Docstring:

GetLayerIndex( (FBAnimationLayer)arg1) -> int 

C++ Signature:

int GetLayerIndex() 

Returns

The layer index in the current layer hierarchy. This value will change if the hierarchy is modified. Return -1 if unsuccessful.

See the C++ reference

object GetParentLayer

(

FBAnimationLayer

arg1

)

Get the parent layer.

Python Docstring:

GetParentLayer( (FBAnimationLayer)arg1) -> object 

C++ Signature:

ORSDK2018::FBAnimationLayer * GetParentLayer() 

Returns

A pointer to the parent layer or NULL if the layer doesn't have a parent.

See the C++ reference

bool IsSelected

(

FBAnimationLayer

arg1

)

Verify if the layer is selected.

Python Docstring:

IsSelected( (FBAnimationLayer)arg1) -> bool 

C++ Signature:

bool IsSelected() 

Returns

True if the layer is selected, false otherwise.

See the C++ reference

SelectLayer	(	FBAnimationLayer	arg1,
		object	arg2,
		object	arg3
	)

Select the layer.

Python Docstring:

SelectLayer( (FBAnimationLayer)arg1, (object)arg2, (object)arg3) -> None 

C++ Signature:

void SelectLayer(bool pValue, bool pExclusiveSelect) 

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

Parameters

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.

See the C++ reference

SetParentLayer	(	FBAnimationLayer	arg1,
		FBAnimationLayer	arg2
	)

Set the parent layer.

Python Docstring:

SetParentLayer( (FBAnimationLayer)arg1, (FBAnimationLayer)arg2) -> None 

C++ Signature:

void SetParentLayer(ORSDK2018::FBAnimationLayer * pParentLayer) 

Parameters

pParentLayer

A pointer to the parent layer or NULL if you want to unparent the layer.

See the C++ reference

Member Data Documentation

FBPropertyLayerMode LayerMode

Read Write Property: Layer mode.

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

See the C++ reference

FBPropertyLayerRotationMode LayerRotationMode

Read Only Property: Layer rotation mode.

Cannot be applied to the BaseAnimation Layer.

See the C++ reference

FBPropertyBool Lock

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

You cannot modify keyframes on a locked layer.

See the C++ reference

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

See the C++ reference

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

See the C++ reference

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

See the C++ reference