A take is a container for animation in a scene. More...

#include <fbdata.h>

Inheritance diagram for FBTake:

[legend]

Public Member Functions
	FBTake (const char *pName, HIObject pObject=NULL)
	Constructor.

virtual void	FBDelete () override
	Deletion method.

FBTake *	CopyTake (const char *pNewTakeName)
	Copy the take.

void	CreateNewLayer ()
	Create a new layer.

void	RemoveLayer (int pLayerIndex)
	Remove a layer.

FBAnimationLayer *	GetLayer (int pLayerIndex)
	Get the layer object that have the specified ID.

FBAnimationLayer *	GetLayerByName (const char *pName)
	Get the layer object that have the specified name.

void	SetCurrentLayer (int pLayerIndex)
	Set the current layer for the take.

int	GetCurrentLayer ()
	Get the current layer for the take.

int	GetLayerCount ()
	Get the layer count.

bool	MoveCurrentLayerUp ()
	Move the current layer up, similar to using the button to move the layer in the Animation Layer tool.

bool	MoveCurrentLayerDown ()
	Move the current layer down, similar to using the button to move the layer in the Animation Layer tool.

void	DuplicateSelectedLayers ()
	Duplicate the selected layers.

void	MergeLayers (FBAnimationLayerMergeOptions pMergeOptions, bool pDeleteMergedLayers, FBMergeLayerMode pMergeMode, bool pMergeLockedProperties=false)
	Merge the selected layers.

void	PlotTakeOnSelected (FBPlotOptions *pPlotOptions)
	Plot the animation on selected models.

void	PlotTakeOnSelectedProperties (FBPlotOptions *pPlotOptions)
	Plot the animation on selected properties.

void	PlotTakeOnSelected (FBTime pPlotPeriod)
	Plot the animation on selected models.

void	PlotAllTakesOnSelected (FBTime pPlotPeriod)
	Plot the animation on selected models for all takes.

void	PlotTakeOnSelectedProperties (FBTime pPlotPeriod)
	Plot the animation on selected properties.

void	PlotAllTakesOnSelectedProperties (FBTime pPlotPeriod)
	Plot the animation on selected properties for all takes.

void	ClearAllProperties (bool pOnSelectedObjectsOnly, bool pOnLockedProperties=false)
	Clear the animation on all the properties.

void	ClearAllPropertiesOnCurrentLayer ()
	Clear all the animation on the current layer.

void	PlotTakeOnObjects (FBPlotOptions pPlotOptions, FBArrayTemplate< FBBox > *pObjectsToPlot)
	Plot the animation on given objects.

void	PlotTakeOnObjects (FBTime pPlotPeriod, FBArrayTemplate< FBBox * > *pObjectsToPlot)
	Plot the animation on given objects.

void	PlotAllTakesOnObjects (FBTime pPlotPeriod, FBArrayTemplate< FBBox * > *pObjectsToPlot)
	Plot the animation on given objects for all takes.

void	PlotTakeOnProperties (FBPlotOptions pPlotOptions, FBArrayTemplate< FBProperty > *pPropertiesToPlot)
	Plot the animation on given properties.

void	PlotTakeOnProperties (FBTime pPlotPeriod, FBArrayTemplate< FBProperty * > *pPropertiesToPlot)
	Plot the animation on given properties.

void	PlotAllTakesOnProperties (FBTime pPlotPeriod, FBArrayTemplate< FBProperty * > *pPropertiesToPlot)
	Plot the animation on given properties for all takes.

int	AddTimeMark (FBTime pTime, const char *pName=NULL)
	Add a time mark to the take.

bool	DeleteTimeMark (int pIndex)
	Delete a time mark from the take.

void	DeleteAllTimeMarks ()
	Delete all time marks from the take.

int	GetTimeMarkCount ()
	Returns the number of time marks on the take.

FBTime	GetTimeMarkTime (int pIndex)
	Returns the time associated with a time mark.

int	SetTimeMarkTime (int pIndex, FBTime pTime)
	Sets a new time for an existing time mark.

const char *	GetTimeMarkName (int pIndex)
	Returns the name associated with a time mark.

bool	SetTimeMarkName (int pIndex, const char *pName)
	Sets a new name for an existing time mark.

FBTimeMarkAction	GetTimeMarkAction (int pIndex)
	Returns the action associated with a time mark.

bool	SetTimeMarkAction (int pIndex, FBTimeMarkAction pAction)
	Sets a new action for an existing time mark.

FBColor	GetTimeMarkColor (int pIndex)
	Returns the color associated with a time mark.

bool	SetTimeMarkColor (int pIndex, FBColor pColor)
	Sets a new color for an existing time mark.

bool	GetTimeMarkLock (int pIndex)
	Returns the lock status associated with a time mark.

bool	SetTimeMarkLock (int pIndex, bool pLock)
	Sets a new lock status for an existing time mark.

bool	SetAllTimeMarkLock (bool pLock)
	Sets the new lock status for all existing time marks.

void	SetLayerRealSelection (bool pValue)
	Set real selection for layer.

bool	GetLayerRealSelection ()
	Real selection for layer.

int	GetNextTimeMarkIndex ()
	Returns the next time mark index, based on the current local time.

int	GetPreviousTimeMarkIndex ()
	Returns the previous time mark index, based on the current local time.

bool	OffsetAnimation (FBTime &pOffsetTime, FBTime pStartTime=FBTime::MinusInfinity, FBTime pStopTime=FBTime::Infinity, bool pInclusive=true, int pLayerID=-1, bool pOnLockedProperties=false)
	Offset the animation (FCurve keys) of this take object within a time range by a given offset time.

bool	OffsetAnimationOnObjects (FBArrayTemplate< FBBox * > *pObjects, FBTime &pOffsetTime, FBTime pStartTime=FBTime::MinusInfinity, FBTime pStopTime=FBTime::Infinity, bool pInclusive=true, int pLayerID=-1, bool pOnLockedProperties=false)
	Offset the animation (FCurve keys) of this take object on given objects within a time range by a given offset time.

bool	OffsetAnimationOnProperties (FBArrayTemplate< FBProperty * > *pProperties, FBTime &pOffsetTime, FBTime pStartTime=FBTime::MinusInfinity, FBTime pStopTime=FBTime::Infinity, bool pInclusive=true, int pLayerID=-1, bool pOnLockedProperties=false, FBPropertyComponents pPropertyComponents=kFBPropertyComponentAll)
	Offset the animation (FCurve keys) of this take object on given properties within a time range by a given offset time.

bool	DeleteAnimation (FBTime pStartTime=FBTime::MinusInfinity, FBTime pStopTime=FBTime::Infinity, bool pInclusive=true, int pLayerID=-1, bool pOnLockedProperties=false)
	Delete animation (FCurve keys) of this take object within a time range.

bool	DeleteAnimationOnObjects (FBArrayTemplate< FBBox * > *pObjects, FBTime pStartTime=FBTime::MinusInfinity, FBTime pStopTime=FBTime::Infinity, bool pInclusive=true, int pLayerID=-1, bool pOnLockedProperties=false)
	Delete animation (FCurve keys) of this take object on given objects within a time range.

bool	DeleteAnimationOnProperties (FBArrayTemplate< FBProperty * > *pProperties, FBTime pStartTime=FBTime::MinusInfinity, FBTime pStopTime=FBTime::Infinity, bool pInclusive=true, int pLayerID=-1, bool pOnLockedProperties=false, FBPropertyComponents pPropertyComponents=kFBPropertyComponentAll)
	Delete animation (FCurve keys) of this take object on given properties within a time range.

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

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

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

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

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

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

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

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

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

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

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

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

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

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

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

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

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

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

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

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

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

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

void	HardSelect ()
	HardSelect.

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

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

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

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyTimeSpan	ReferenceTimeSpan
	Read Write Property: Reference time span.

FBPropertyTimeSpan	LocalTimeSpan
	Read Write Property: Local time span.

FBPropertyString	Comments
	Read Write Property: Take comments.

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

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

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

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

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.

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

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

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

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

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

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

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

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

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

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

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

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

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

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

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

int	GetSrcCount ()
	Get source connection count.

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

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

int	GetDstCount ()
	Get destination connection count.

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

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

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

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

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

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

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

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

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

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

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

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

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

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

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.

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.

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.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

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

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

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

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

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

A take is a container for animation in a scene.

A take stores data about animation for objects. The transport controls (FBPlayerControl) act on the current take.

In the UI transport controls, a take's start and end determine when the Timeline indicator starts and stops.

You get the current take with FBSystem::CurrentTake, as in the following Python sample:

for myTake in FBSystem().Scene.Takes:

print myTake.Name

FBSystem

Provides access to the underlying system, and the MotionBuilder scene.

Definition fbsystem.h:157

FBSystem::Scene

FBPropertyScene Scene

Read Only Property: Scene.

Definition fbsystem.h:197

To create a take and have it accessible in the Transport control you could use CopyTake (called Duplicate in the UI):

Python sample code:

from pyfbsdk import *

newTake = FBSystem().CurrentTake.CopyTake("my new take name")

FBSystem::CurrentTake

FBPropertyTake CurrentTake

Read Write Property: Current take.

Definition fbsystem.h:195

C++ sample code:

FBTake* lTake = FBSystem::ThenOne().CurrentTake->CopyTake( "my new take" );

FBTake

A take is a container for animation in a scene.

Definition fbdata.h:1727

FBTake::CopyTake

FBTake * CopyTake(const char *pNewTakeName)

Copy the take.

Or simply create a new empty take like the following:

Python sample code:

from pyfbsdk import *    
newTake = FBTake("my new take name")
FBSystem().Scene.Takes.append(newTake)

C++ sample code:

FBSystem::TheOne()::Scene.Takes.Add( new FBTake( "my new take" ));

FBSystem::TheOne

static FBSystem & TheOne()

Get the global FBSystem object.

Definition at line 1727 of file fbdata.h.

Constructor & Destructor Documentation

◆ FBTake()

FBTake	(	const char *	pName,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters

pName	Name of take.
pObject	For internal use only (default is NULL).

Member Function Documentation

◆ AddTimeMark()

int AddTimeMark	(	FBTime	pTime,
		const char *	pName = `NULL`
	)

Add a time mark to the take.

It doesn't allow creating a time mark at the same time of another time mark. Note: Internally, the time marks are stored in time order. Adding a time mark before other existing time marks will modify the index of these other time marks.

Parameters

pTime	Time where to add the time mark on the take.
pName	Name of the time mark to add.

Returns: The index of the time mark added if the operation is successful, -1 otherwise.

◆ ClearAllProperties()

void ClearAllProperties	(	bool	pOnSelectedObjectsOnly,
		bool	pOnLockedProperties = `false`
	)

Clear the animation on all the properties.

Parameters

pOnSelectedObjectsOnly	Specify if clear will be performed on all objects or only on the one that are currently selected.
pOnLockedProperties	Specify if clear will be performed on locked properties as well.

◆ ClearAllPropertiesOnCurrentLayer()

void ClearAllPropertiesOnCurrentLayer ( )

Clear all the animation on the current layer.

◆ CopyTake()

FBTake * CopyTake ( const char * pNewTakeName )

Copy the take.

Will create a copy of the current take, with the current take data. This is analogous to creating a new take, and copying the current take data into it. The Layers data and the TimeWarp date will be copied. The newly created take will be set as the current take. The newly created take is automatically added to the scene and available in the Transport control.

Parameters

pNewTakeName The name for the new take.

Returns: Handle to the newly created take.

◆ CreateNewLayer()

void CreateNewLayer ( )

Create a new layer.

◆ DeleteAllTimeMarks()

void DeleteAllTimeMarks ( )

Delete all time marks from the take.

◆ DeleteAnimation()

bool DeleteAnimation	(	FBTime	pStartTime = `FBTime::MinusInfinity`,
		FBTime	pStopTime = `FBTime::Infinity`,
		bool	pInclusive = `true`,
		int	pLayerID = `-1`,
		bool	pOnLockedProperties = `false`
	)

Delete animation (FCurve keys) of this take object within a time range.

Parameters

pStartTime	Start of time range.
pStopTime	End of time range.
pInclusive	`True` to include within the time range the keys at pStartTime and pStopTime, `false` otherwise.
pLayerID	The animation layer ID being affected by the delete operation, -1 to delete the animation of all animations layers.
pOnLockedProperties	`True` to delete animation on locked properties, `false` to skip deleting animation on locked properties.

Returns: True if the delete operation is successful (at least one FCurve has been modified), false otherwise (e.g. no keys found within the time range, invalid layer ID, etc.).

◆ DeleteAnimationOnObjects()

bool DeleteAnimationOnObjects	(	FBArrayTemplate< FBBox * > *	pObjects,
		FBTime	pStartTime = `FBTime::MinusInfinity`,
		FBTime	pStopTime = `FBTime::Infinity`,
		bool	pInclusive = `true`,
		int	pLayerID = `-1`,
		bool	pOnLockedProperties = `false`
	)

Delete animation (FCurve keys) of this take object on given objects within a time range.

Parameters

pObjects	Objects affected by the delete operation.
pStartTime	Start of time range.
pStopTime	End of time range.
pInclusive	`True` to include within the time range the keys at pStartTime and pStopTime, `false` otherwise.
pLayerID	The animation layer ID being affected by the delete operation, -1 to delete the animation of all animations layers.
pOnLockedProperties	`True` to delete animation on locked properties, `false` to skip deleting animation on locked properties.

Returns: True if the delete operation is successful (at least one FCurve has been modified), false otherwise (e.g. no keys found within the time range, invalid layer ID, etc.).

◆ DeleteAnimationOnProperties()

bool DeleteAnimationOnProperties	(	FBArrayTemplate< FBProperty * > *	pProperties,
		FBTime	pStartTime = `FBTime::MinusInfinity`,
		FBTime	pStopTime = `FBTime::Infinity`,
		bool	pInclusive = `true`,
		int	pLayerID = `-1`,
		bool	pOnLockedProperties = `false`,
		FBPropertyComponents	pPropertyComponents = `kFBPropertyComponentAll`
	)

Delete animation (FCurve keys) of this take object on given properties within a time range.

Parameters

pProperties	Properties affected by the delete operation.
pStartTime	Start of time range.
pStopTime	End of time range.
pInclusive	`True` to include within the time range the keys at pStartTime and pStopTime, `false` otherwise.
pLayerID	The animation layer ID being affected by the delete operation, -1 to delete the animation of all animations layers.
pOnLockedProperties	`True` to delete animation on locked properties, `false` to skip deleting animation on locked properties.
pPropertyComponents	The component bit field considered when performing the delete operation, for properties having such components. By default, all components are considered. If a property don't have any component, this parameter is not affecting that property.

Returns: True if the delete operation is successful (at least one FCurve has been modified), false otherwise (e.g. no keys found within the time range, invalid layer ID, etc.).

◆ DeleteTimeMark()

bool DeleteTimeMark ( int pIndex )

Delete a time mark from the take.

Note: Internally, the time marks are stored in time order. Deleting a time mark will modify the index of time marks laying after the deleted time mark.

Parameters

pIndex Index of the time mark to delete.

Returns: True if the operation is successful, false otherwise.

◆ DuplicateSelectedLayers()

void DuplicateSelectedLayers ( )

Duplicate the selected layers.

This is equivalent of doing a copy-paste.

◆ FBDelete()

virtual void FBDelete ( )

overridevirtual

Deletion method.

Using this method to delete the take insure that the destruction process follows the same path as if the GUI had been used.

Reimplemented from FBComponent.

◆ GetCurrentLayer()

int GetCurrentLayer ( )

Get the current layer for the take.

Returns: The current layer index.

◆ GetLayer()

FBAnimationLayer * GetLayer ( int pLayerIndex )

Get the layer object that have the specified ID.

Parameters

pLayerIndex The index of the layer that will be returned.

Returns: Layer with the specified ID.

◆ GetLayerByName()

FBAnimationLayer * GetLayerByName ( const char * pName )

Get the layer object that have the specified name.

Parameters

pName The name of the animation layer to get.

Returns: Layer with the specified name or NULL if no layer has been found.

◆ GetLayerCount()

int GetLayerCount ( )

Get the layer count.

Returns: The layer count.

◆ GetLayerRealSelection()

bool GetLayerRealSelection ( )

Real selection for layer.

Check the SetLayerRealSelection function for more information about this.

Returns: True if selecting a layer will also select the FBComponent of that layer.

◆ GetNextTimeMarkIndex()

int GetNextTimeMarkIndex ( )

Returns the next time mark index, based on the current local time.

Returns: The next time mark index, -1 if any next time mark is available.

◆ GetPreviousTimeMarkIndex()

int GetPreviousTimeMarkIndex ( )

Returns the previous time mark index, based on the current local time.

Returns: The previous time mark index, -1 if any previous time mark is available.

◆ GetTimeMarkAction()

FBTimeMarkAction GetTimeMarkAction ( int pIndex )

Returns the action associated with a time mark.

Parameters

pIndex Index of the time mark.

Returns: The action associated with the time mark.

◆ GetTimeMarkColor()

FBColor GetTimeMarkColor ( int pIndex )

Returns the color associated with a time mark.

Parameters

pIndex Index of the time mark.

Returns: The color associated with the time mark.

◆ GetTimeMarkCount()

int GetTimeMarkCount ( )

Returns the number of time marks on the take.

Returns: The number of time marks on the take.

◆ GetTimeMarkLock()

bool GetTimeMarkLock ( int pIndex )

Returns the lock status associated with a time mark.

Parameters

pIndex Index of the time mark.

Returns: The lock status associated with the time mark.

◆ GetTimeMarkName()

const char * GetTimeMarkName ( int pIndex )

Returns the name associated with a time mark.

Parameters

pIndex Index of the time mark.

Returns: The name associated with the time mark.

◆ GetTimeMarkTime()

FBTime GetTimeMarkTime ( int pIndex )

Returns the time associated with a time mark.

Parameters

pIndex Index of the time mark.

Returns: The time associated with the time mark.

◆ MergeLayers()

void MergeLayers	(	FBAnimationLayerMergeOptions	pMergeOptions,
		bool	pDeleteMergedLayers,
		FBMergeLayerMode	pMergeMode,
		bool	pMergeLockedProperties = `false`
	)

Merge the selected layers.

This is equivalent of pressing the merge button in the Animation Layer editor.

Parameters

pMergeOptions	Indicate which objects, layers and properties (selected or all) should be merged.
pDeleteMergedLayers	The source layer will be deleted after the merge if no animation is left on those layers, or if those layers are not parent of another layer.
pMergeMode	Set the layer mode of the resulting layer, if possible (the BaseAnimation layer cannot be modified).
pMergeLockedProperties	The properties will be merged even if they are locked.

◆ MoveCurrentLayerDown()

bool MoveCurrentLayerDown ( )

Move the current layer down, similar to using the button to move the layer in the Animation Layer tool.

Use the SetCurrentLayer to specify the current layer.

Returns: True if successful.

◆ MoveCurrentLayerUp()

bool MoveCurrentLayerUp ( )

Move the current layer up, similar to using the button to move the layer in the Animation Layer tool.

Use the SetCurrentLayer to specify the current layer.

Returns: True if successful.

◆ OffsetAnimation()

bool OffsetAnimation	(	FBTime &	pOffsetTime,
		FBTime	pStartTime = `FBTime::MinusInfinity`,
		FBTime	pStopTime = `FBTime::Infinity`,
		bool	pInclusive = `true`,
		int	pLayerID = `-1`,
		bool	pOnLockedProperties = `false`
	)

Offset the animation (FCurve keys) of this take object within a time range by a given offset time.

Non-moving FCurve keys that are situated in the target range are deleted automatically, to preserve the animation being offset.

Parameters

pOffsetTime	The offset time to apply.
pStartTime	Start of time range.
pStopTime	End of time range.
pInclusive	`True` to include within the time range the keys at pStartTime and pStopTime, `false` otherwise.
pLayerID	The animation layer ID being affected by the offset operation, -1 to offset the animation of all animations layers.
pOnLockedProperties	`True` to offset animation on locked properties, `false` to skip offsetting animation on locked properties.

Returns: True if the offset operation is successful (at least one FCurve has been modified), false otherwise (e.g. no keys found within the time range, invalid layer ID, etc.).

◆ OffsetAnimationOnObjects()

bool OffsetAnimationOnObjects	(	FBArrayTemplate< FBBox * > *	pObjects,
		FBTime &	pOffsetTime,
		FBTime	pStartTime = `FBTime::MinusInfinity`,
		FBTime	pStopTime = `FBTime::Infinity`,
		bool	pInclusive = `true`,
		int	pLayerID = `-1`,
		bool	pOnLockedProperties = `false`
	)

Offset the animation (FCurve keys) of this take object on given objects within a time range by a given offset time.

Non-moving FCurve keys that are situated in the target range are deleted automatically, to preserve the animation being offset.

Parameters

pObjects	Objects affected by the offset operation.
pOffsetTime	The offset time to apply.
pStartTime	Start of time range.
pStopTime	End of time range.
pInclusive	`True` to include within the time range the keys at pStartTime and pStopTime, `false` otherwise.
pLayerID	The animation layer ID being affected by the offset operation, -1 to offset the animation of all animations layers.
pOnLockedProperties	`True` to offset animation on locked properties, `false` to skip offsetting animation on locked properties.

Returns: True if the offset operation is successful (at least one FCurve has been modified), false otherwise (e.g. no keys found within the time range, invalid layer ID, etc.).

◆ OffsetAnimationOnProperties()

bool OffsetAnimationOnProperties	(	FBArrayTemplate< FBProperty * > *	pProperties,
		FBTime &	pOffsetTime,
		FBTime	pStartTime = `FBTime::MinusInfinity`,
		FBTime	pStopTime = `FBTime::Infinity`,
		bool	pInclusive = `true`,
		int	pLayerID = `-1`,
		bool	pOnLockedProperties = `false`,
		FBPropertyComponents	pPropertyComponents = `kFBPropertyComponentAll`
	)

Offset the animation (FCurve keys) of this take object on given properties within a time range by a given offset time.

Non-moving FCurve keys that are situated in the target range are deleted automatically, to preserve the animation being offset.

Parameters

pProperties	Properties affected by the offset operation.
pOffsetTime	The offset time to apply.
pStartTime	Start of time range.
pStopTime	End of time range.
pInclusive	`True` to include within the time range the keys at pStartTime and pStopTime, `false` otherwise.
pLayerID	The animation layer ID being affected by the offset operation, -1 to offset the animation of all animations layers.
pOnLockedProperties	`True` to offset animation on locked properties, `false` to skip offsetting animation on locked properties.
pPropertyComponents	The component bit field considered when performing the offset operation, for properties having such components. By default, all components are considered. If a property don't have any component, this parameter is not affecting that property.

Returns: True if the offset operation is successful (at least one FCurve has been modified), false otherwise (e.g. no keys found within the time range, invalid layer ID, etc.).

◆ PlotAllTakesOnObjects()

void PlotAllTakesOnObjects	(	FBTime	pPlotPeriod,
		FBArrayTemplate< FBBox * > *	pObjectsToPlot
	)

Plot the animation on given objects for all takes.

This method will plot the animation of all takes to the specified objects. Although the method supports boxes, the most common use case it to specify FBModels that have been cast to boxes.

Parameters

pPlotPeriod	Period for the plot.
pObjectsToPlot	Objects to plot.

◆ PlotAllTakesOnProperties()

void PlotAllTakesOnProperties	(	FBTime	pPlotPeriod,
		FBArrayTemplate< FBProperty * > *	pPropertiesToPlot
	)

Plot the animation on given properties for all takes.

Will plot the animation for all takes on the given properties in the scene.

Parameters

pPlotPeriod	Period for the plot.
pPropertiesToPlot	Properties to plot.

◆ PlotAllTakesOnSelected()

void PlotAllTakesOnSelected ( FBTime pPlotPeriod )

Plot the animation on selected models for all takes.

Will plot the animation for all takes on the selected models in the scene.

Parameters

pPlotPeriod Period for the plot.

◆ PlotAllTakesOnSelectedProperties()

void PlotAllTakesOnSelectedProperties ( FBTime pPlotPeriod )

Plot the animation on selected properties for all takes.

Will plot the animation for all takes on the selected properties in the scene.

Parameters

pPlotPeriod Period for the plot.

◆ PlotTakeOnObjects() [1/2]

void PlotTakeOnObjects	(	FBPlotOptions *	pPlotOptions,
		FBArrayTemplate< FBBox * > *	pObjectsToPlot
	)

Plot the animation on given objects.

This method will plot the animation of the take to the specified objects. Although the method supports boxes, the most common use case it to specify FBModels that have been cast to boxes.

Parameters

pPlotOptions	Option parameters for plotting
pObjectsToPlot	Objects to plot.

◆ PlotTakeOnObjects() [2/2]

void PlotTakeOnObjects	(	FBTime	pPlotPeriod,
		FBArrayTemplate< FBBox * > *	pObjectsToPlot
	)

Plot the animation on given objects.

This method will plot the animation of the take to the specified objects. Although the method supports boxes, the most common use case it to specify FBModels that have been cast to boxes.

Parameters

pPlotPeriod	Period for the plot.
pObjectsToPlot	Objects to plot.

◆ PlotTakeOnProperties() [1/2]

void PlotTakeOnProperties	(	FBPlotOptions *	pPlotOptions,
		FBArrayTemplate< FBProperty * > *	pPropertiesToPlot
	)

Plot the animation on given properties.

Will plot the animation of the take in question on the given properties in the scene.

Parameters

pPlotOptions	Option parameters for plotting.
pPropertiesToPlot	Properties to plot.

◆ PlotTakeOnProperties() [2/2]

void PlotTakeOnProperties	(	FBTime	pPlotPeriod,
		FBArrayTemplate< FBProperty * > *	pPropertiesToPlot
	)

Plot the animation on given properties.

Will plot the animation of the take in question on the given properties in the scene.

Parameters

pPlotPeriod	Period for the plot.
pPropertiesToPlot	Properties to plot.

◆ PlotTakeOnSelected() [1/2]

void PlotTakeOnSelected ( FBPlotOptions * pPlotOptions )

Plot the animation on selected models.

Will plot the animation of the take in question on the selected models in the scene.

Parameters

pPlotOptions Option parameters for plotting

◆ PlotTakeOnSelected() [2/2]

void PlotTakeOnSelected ( FBTime pPlotPeriod )

Plot the animation on selected models.

Will plot the animation of the take in question on the selected models in the scene.

Parameters

pPlotPeriod Period for the plot.

◆ PlotTakeOnSelectedProperties() [1/2]

void PlotTakeOnSelectedProperties ( FBPlotOptions * pPlotOptions )

Plot the animation on selected properties.

Will plot the animation of the take in question on the selected properties in the scene.

Parameters

pPlotOptions Option parameters for plotting

◆ PlotTakeOnSelectedProperties() [2/2]

void PlotTakeOnSelectedProperties ( FBTime pPlotPeriod )

Plot the animation on selected properties.

Will plot the animation of the take in question on the selected properties in the scene.

Parameters

pPlotPeriod Period for the plot.

◆ RemoveLayer()

void RemoveLayer ( int pLayerIndex )

Remove a layer.

Parameters

pLayerIndex Layer with at the specified index will be removed.

◆ SetAllTimeMarkLock()

bool SetAllTimeMarkLock ( bool pLock )

Sets the new lock status for all existing time marks.

Parameters

pLock The new lock status for all the time marks.

Returns: True if the operation is successful, false otherwise.

◆ SetCurrentLayer()

void SetCurrentLayer ( int pLayerIndex )

Set the current layer for the take.

Note that this will not deselect the other layers.

Parameters

pLayerIndex The layer index to be set as the current one.

◆ SetLayerRealSelection()

void SetLayerRealSelection ( bool pValue )

Set real selection for layer.

This method is used to specify if using the SelectLayer method of the FBAnimationLayer object will also select the FBComponent object. In previous version of MotionBuilder, an animation layer was always selected, causing the layer to be displayed in the property editor. Also, when parsing the selected objects in the SDK, a layer would always be there. Setting this value to false will prevent this.

Parameters

pValue True if future layer selection will also select the FBComponent object.

◆ SetTimeMarkAction()

bool SetTimeMarkAction	(	int	pIndex,
		FBTimeMarkAction	pAction
	)

Sets a new action for an existing time mark.

Parameters

pIndex	Index of the time mark.
pAction	The new action for the time mark.

Returns: True if the operation is successful, false otherwise.

◆ SetTimeMarkColor()

bool SetTimeMarkColor	(	int	pIndex,
		FBColor	pColor
	)

Sets a new color for an existing time mark.

Parameters

pIndex	Index of the time mark.
pColor	The new color for the time mark.

Returns: True if the operation is successful, false otherwise.

◆ SetTimeMarkLock()

bool SetTimeMarkLock	(	int	pIndex,
		bool	pLock
	)

Sets a new lock status for an existing time mark.

Parameters

pIndex	Index of the time mark.
pLock	The new lock status for the time mark.

Returns: True if the operation is successful, false otherwise.

◆ SetTimeMarkName()

bool SetTimeMarkName	(	int	pIndex,
		const char *	pName
	)

Sets a new name for an existing time mark.

Parameters

pIndex	Index of the time mark.
pName	The new name for the time mark.

Returns: True if the operation is successful, false otherwise.

◆ SetTimeMarkTime()

int SetTimeMarkTime	(	int	pIndex,
		FBTime	pTime
	)

Sets a new time for an existing time mark.

Note: Internally, the time marks are stored in time order. Modifying the time of a time mark may modify the index of all time marks.

Parameters

pIndex	Index of the time mark.
pTime	The new time for the time mark.

Returns: The new index of the modified time mark.

Member Data Documentation

◆ Comments

FBPropertyString Comments

Read Write Property: Take comments.

Definition at line 1884 of file fbdata.h.

◆ LocalTimeSpan

FBPropertyTimeSpan LocalTimeSpan

Read Write Property: Local time span.

Definition at line 1883 of file fbdata.h.

◆ ReferenceTimeSpan

FBPropertyTimeSpan ReferenceTimeSpan

Read Write Property: Reference time span.

Definition at line 1882 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

◆ FBTake()

Member Function Documentation

◆ AddTimeMark()

◆ ClearAllProperties()

◆ ClearAllPropertiesOnCurrentLayer()

◆ CopyTake()

◆ CreateNewLayer()

◆ DeleteAllTimeMarks()

◆ DeleteAnimation()

◆ DeleteAnimationOnObjects()

◆ DeleteAnimationOnProperties()

◆ DeleteTimeMark()

◆ DuplicateSelectedLayers()

◆ FBDelete()

◆ GetCurrentLayer()

◆ GetLayer()

◆ GetLayerByName()

◆ GetLayerCount()

◆ GetLayerRealSelection()

◆ GetNextTimeMarkIndex()

◆ GetPreviousTimeMarkIndex()

◆ GetTimeMarkAction()

◆ GetTimeMarkColor()

◆ GetTimeMarkCount()

◆ GetTimeMarkLock()

◆ GetTimeMarkName()

◆ GetTimeMarkTime()

◆ MergeLayers()

◆ MoveCurrentLayerDown()

◆ MoveCurrentLayerUp()

◆ OffsetAnimation()

◆ OffsetAnimationOnObjects()

◆ OffsetAnimationOnProperties()

◆ PlotAllTakesOnObjects()

◆ PlotAllTakesOnProperties()

◆ PlotAllTakesOnSelected()

◆ PlotAllTakesOnSelectedProperties()

◆ PlotTakeOnObjects() [1/2]

◆ PlotTakeOnObjects() [2/2]

◆ PlotTakeOnProperties() [1/2]

◆ PlotTakeOnProperties() [2/2]

◆ PlotTakeOnSelected() [1/2]

◆ PlotTakeOnSelected() [2/2]

◆ PlotTakeOnSelectedProperties() [1/2]

◆ PlotTakeOnSelectedProperties() [2/2]

◆ RemoveLayer()

◆ SetAllTimeMarkLock()

◆ SetCurrentLayer()

◆ SetLayerRealSelection()

◆ SetTimeMarkAction()

◆ SetTimeMarkColor()

◆ SetTimeMarkLock()

◆ SetTimeMarkName()

◆ SetTimeMarkTime()

Member Data Documentation

◆ Comments

◆ LocalTimeSpan

◆ ReferenceTimeSpan