Used to access animation layer properties and modify them. More...

#include <fbdata.h>

Inheritance diagram for FBAnimationLayer:

[legend]

Public Member Functions
	FBAnimationLayer (const char *pName, int pLayerID, HIObject pObject=NULL)
	Constructor. More...

virtual void	FBDelete () override
	Virtual FBDelete function. More...

void	AddChildLayer (FBAnimationLayer *pAnimationLayer)
	Add a child to the layer. More...

FBAnimationLayer *	GetChildLayer (int pIndex)
	Get the nth child layer of this layer. More...

int	GetChildCount ()
	Get the child layer count of this layer. More...

void	GetCompleteChildHierarchy (FBArrayTemplate< FBAnimationLayer * > *pChildArray)
	Get the all the children hierarchy of the layer, including children not directly connected to this layer. More...

void	SetParentLayer (FBAnimationLayer *pParentLayer)
	Set the parent layer. More...

FBAnimationLayer *	GetParentLayer ()
	Get the parent layer. More...

int	GetLayerIndex ()
	Get the layer index. More...

void	SelectLayer (bool pValue, bool pExclusiveSelect)
	Select the layer. More...

bool	IsSelected ()
	Verify if the layer is selected. More...

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor. More...

virtual	~FBComponent ()
	Destructor. More...

virtual bool	FBCreate ()
	Open Reality Creation function. More...

virtual void	FBDestroy ()
	Open Reality destruction function. More...

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer. More...

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager. More...

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager. More...

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading. More...

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property. More...

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated). More...

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags. More...

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled. More...

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags. More...

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags. More...

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status. More...

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled. More...

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace. More...

virtual const char *	ClassName () override
	Get the class name. More...

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not. More...

const char *	GetFullName (void)
	Get the full name. More...

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object. More...

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object. More...

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object. More...

void	HardSelect ()
	HardSelect. More...

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId. More...

virtual int	GetTypeId () override
	GetTypeId( int pTypeId ) More...

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyColor	Color
	Read Write Property: The animation layer color. More...

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

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

FBPropertyBool	Lock
	Read Write Property: If true, the layer is locked. You cannot modify keyframes on a locked layer. More...

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

FBPropertyLayerMode	LayerMode
	Read Write Property: Layer mode. By default, the layer is in kFBLayerModeAdditive mode. Cannot be applied to the BaseAnimation Layer. More...

FBPropertyLayerRotationMode	LayerRotationMode
	Read Only Property: Layer rotation mode. Cannot be applied to the BaseAnimation Layer. More...

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyListComponent	Components
	List: List of components. More...

FBPropertyListComponent	Parents
	List: Parents. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

FBPropertyString	Name
	Read Write Property: Unique name of object. More...

FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component. More...

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object. More...

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component. More...

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection. More...

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection. More...

void	DisconnectAllSrc ()
	Remove all source connections. More...

void	DisconnectAllDst ()
	Remove all destination connections. More...

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index. More...

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index. More...

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B. More...

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex. More...

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc. More...

int	GetSrcCount ()
	Get source connection count. More...

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index. More...

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index. More...

int	GetDstCount ()
	Get destination connection count. More...

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index. More...

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index. More...

bool	BeginChange ()
	Begins a change on multiple plugs. More...

void	EndChange ()
	Ends a change on multiple plugs. More...

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed. More...

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status. More...

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag. More...

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed. More...

FBPlug *	GetOwner ()
	Get the owner of this plug. More...

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index. More...

int	GetOwnedCount ()
	Get the owned plug count. More...

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id. More...

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component. More...

HIObject	mObject
	Handle on the Plug. More...

bool	mSDKComponent
	bool Plug is an SDK component. More...

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object. More...

static int	TypeInfo
	TypeInfo. More...

static int	mGlobalTypeInfo
	Represente the Type Index. More...

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.

Definition at line 1539 of file fbdata.h.

Constructor & Destructor Documentation

◆ FBAnimationLayer()

FBAnimationLayer	(	const char *	pName,
		int	pLayerID,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters

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

Member Function Documentation

◆ AddChildLayer()

void 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

pAnimationLayer Layer to set as a child.

◆ FBDelete()

virtual void FBDelete ( )

overridevirtual

Virtual FBDelete function.

Reimplemented from FBComponent.

◆ GetChildCount()

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

◆ GetChildLayer()

FBAnimationLayer* GetChildLayer ( int pIndex )

Get the nth child layer of this layer.

Parameters

pIndex Index of the child layer to get.

Returns: Child animation layer located at pIndex

◆ GetCompleteChildHierarchy()

void GetCompleteChildHierarchy ( FBArrayTemplate< FBAnimationLayer * > * pChildArray )

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

Python: The 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.

◆ GetLayerIndex()

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.

◆ GetParentLayer()

FBAnimationLayer* GetParentLayer ( )

Get the parent layer.

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

◆ IsSelected()

bool IsSelected ( )

Verify if the layer is selected.

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

◆ SelectLayer()

void 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

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()

void SetParentLayer ( FBAnimationLayer * pParentLayer )

Set the parent layer.

Parameters

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

Member Data Documentation

◆ Color

FBPropertyColor Color

Read Write Property: The animation layer color.

Definition at line 1556 of file fbdata.h.

◆ LayerMode

FBPropertyLayerMode LayerMode

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

Definition at line 1561 of file fbdata.h.

◆ LayerRotationMode

FBPropertyLayerRotationMode LayerRotationMode

Read Only Property: Layer rotation mode. Cannot be applied to the BaseAnimation Layer.

Definition at line 1562 of file fbdata.h.

◆ Lock

FBPropertyBool Lock

Read Write Property: If true, the layer is locked. You cannot modify keyframes on a locked layer.

Definition at line 1559 of file fbdata.h.

◆ Mute

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.

Definition at line 1558 of file fbdata.h.

◆ Solo

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.

Definition at line 1557 of file fbdata.h.

◆ Weight

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.

Definition at line 1560 of file fbdata.h.

The documentation for this class was generated from the following file:

fbdata.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBAnimationLayer()

Member Function Documentation

◆ AddChildLayer()

◆ FBDelete()

◆ GetChildCount()

◆ GetChildLayer()

◆ GetCompleteChildHierarchy()

◆ GetLayerIndex()

◆ GetParentLayer()

◆ IsSelected()

◆ SelectLayer()

◆ SetParentLayer()

Member Data Documentation

◆ Color

◆ LayerMode

◆ LayerRotationMode

◆ Lock

◆ Mute

◆ Solo

◆ Weight