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

#include <pyfbsdk_generated.h>

Inheritance diagram for FBTake:

[legend]

Public Member Functions
	FBTake (str pName)
	Constructor.

int	AddTimeMark (FBTime pTime, str pName=None)
	Add a time mark to the take.

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

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

FBTake	CopyTake (str pNewTakeName)
	Copy the take.

	CreateNewLayer ()
	Create a new layer.

	DeleteAllTimeMarks ()
	Delete all time marks from the take.

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< FB > pProperties, FBTime pStartTime=FBTime::MinusInfinity, FBTime pStopTime=FBTime::Infinity, bool pInclusive=True, int pLayerID=-1, bool pOnLockedProperties=False, FBComponents pPropertyComponents=kFBPropertyComponentAll)
	Delete animation (FCurve keys) of this take object on given properties within a time range.

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

	DuplicateSelectedLayers ()
	Duplicate the selected layers.

	FBDelete ()
	Deletion method.

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

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

FBAnimationLayer	GetLayerByName (str pName)
	Get the layer object that have the specified name.

int	GetLayerCount ()
	Get the layer count.

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.

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

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

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

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

str	GetTimeMarkName (int pIndex)
	Returns the name associated with a time mark.

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

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

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

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

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< FB > pProperties, FBTime pOffsetTime, FBTime pStartTime=FBTime::MinusInfinity, FBTime pStopTime=FBTime::Infinity, bool pInclusive=True, int pLayerID=-1, bool pOnLockedProperties=False, FBComponents pPropertyComponents=kFBPropertyComponentAll)
	Offset the animation (FCurve keys) of this take object on given properties within a time range by a given offset time.

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

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

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

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

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

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

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

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

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

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

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

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

	RemoveLayer (int pLayerIndex)
	Remove a layer.

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

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

	SetLayerRealSelection (bool pValue)
	Set real selection for layer.

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

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

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

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

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

Public Member Functions inherited from FBComponent
	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
str	Comments
	Read Write Property: Take comments.

FBTimeSpan	LocalTimeSpan
	Read Write Property: Local time span.

FBTimeSpan	ReferenceTimeSpan
	Read Write Property: Reference time span.

Public Attributes inherited from FBComponent
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.

Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.

int	TypeInfo
	TypeInfo.

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

FBScene::Takes

FBListTake Takes

List: Takes for scene.

Definition: pyfbsdk_generated.h:16911

FBSystem

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

Definition: pyfbsdk_generated.h:18771

FBSystem::Scene

FBScene Scene

Read Only Property: Scene.

Definition: pyfbsdk_generated.h:18884

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

FBTake CurrentTake

Read Write Property: Current take. See samples: GoToNextTake.py,

Definition: pyfbsdk_generated.h:18843

FBTake::CopyTake

FBTake CopyTake(str pNewTakeName)

Copy the take.

pyfbsdk

Python module pyfbsk.

Definition: pyfbsdk.h:90

C++ sample code:

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

FBTake

A take is a container for animation in a scene.

Definition: pyfbsdk_generated.h:18994

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" ));

See samples: MergePreviewAnimationLayers.py, ExportAnimationLibrary.py, GoToNextTake.py, GoToPreviousTake.py, MirrorPoseOverTime.py, MultiLayerKeying.py, RenameFirstTakeOnMultipleFiles.py, SaveOneTakePerFile.py, TimeCodeKeying.py.

Constructor & Destructor Documentation

◆ FBTake()

FBTake ( str pName )

Constructor.

Parameters

pName Name of take.

Member Function Documentation

◆ AddTimeMark()

int AddTimeMark	(	FBTime	pTime,
		str	pName = `None`
	)

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

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

ClearAllPropertiesOnCurrentLayer ( )

Clear all the animation on the current layer.

◆ CopyTake()

FBTake CopyTake ( str 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()

CreateNewLayer ( )

Create a new layer.

◆ DeleteAllTimeMarks()

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< FB >	pProperties,
		FBTime	pStartTime = `FBTime::MinusInfinity`,
		FBTime	pStopTime = `FBTime::Infinity`,
		bool	pInclusive = `True`,
		int	pLayerID = `-1`,
		bool	pOnLockedProperties = `False`,
		FBComponents	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()

DuplicateSelectedLayers ( )

Duplicate the selected layers.

This is equivalent of doing a copy-paste.

◆ FBDelete()

FBDelete ( )

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.

See sample: DeleteHierarchy.py.

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

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

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< FB >	pProperties,
		FBTime	pOffsetTime,
		FBTime	pStartTime = `FBTime::MinusInfinity`,
		FBTime	pStopTime = `FBTime::Infinity`,
		bool	pInclusive = `True`,
		int	pLayerID = `-1`,
		bool	pOnLockedProperties = `False`,
		FBComponents	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()

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

PlotAllTakesOnProperties	(	FBTime	pPlotPeriod,
		FBArrayTemplate< FB >	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()

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

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]

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]

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]

PlotTakeOnProperties	(	FBPlotOptions	pPlotOptions,
		FBArrayTemplate< FB >	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]

PlotTakeOnProperties	(	FBTime	pPlotPeriod,
		FBArrayTemplate< FB >	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]

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]

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]

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]

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

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

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

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,
		str	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

str Comments

Read Write Property: Take comments.

◆ LocalTimeSpan

FBTimeSpan LocalTimeSpan

Read Write Property: Local time span.

◆ ReferenceTimeSpan

FBTimeSpan ReferenceTimeSpan

Read Write Property: Reference time span.

Public Member Functions

Public Attributes

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