FBTake Class Reference

#include <mobu-python-api.h>

Class 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

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

C++ sample code:

FBTake* lTake = FBSystem::ThenOne().CurrentTake->CopyTake( "my new 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" ));

See the C++ reference

Inheritance diagram for FBTake:

Public Member Functions
	__reduce__ ()
FBColor	GetTimeMarkColor (FBTake arg1, object arg2)
	Returns the color associated with a time mark. More...
FBTime	GetTimeMarkTime (FBTake arg1, object arg2)
	Returns the time associated with a time mark. More...
	__init__ (object arg1, str arg2)
	Constructor. More...
	ClearAllProperties (FBTake arg1, object arg2, object arg3)
	Clear the animation on all the properties. More...
	ClearAllPropertiesOnCurrentLayer (FBTake arg1)
	Clear all the animation on the current layer. More...
object	CopyTake (FBTake arg1, str arg2)
	Copy the take. More...
	PlotAllTakesOnSelected (FBTake arg1, FBTime arg2)
	Plot the animation on selected models for all takes. More...
	PlotAllTakesOnSelectedProperties (FBTake arg1, FBTime arg2)
	Plot the animation on selected properties for all takes. More...
	CreateNewLayer (FBTake arg1)
	Create a new layer. More...
	RemoveLayer (FBTake arg1, object arg2)
	Remove a layer. More...
object	GetLayer (FBTake arg1, object arg2)
	Get the layer object that have the specified ID. More...
object	GetLayerByName (FBTake arg1, str arg2)
	Get the layer object that have the specified name. More...
	SetCurrentLayer (FBTake arg1, object arg2)
	Set the current layer for the take. More...
int	GetCurrentLayer (FBTake arg1)
	Get the current layer for the take. More...
int	GetLayerCount (FBTake arg1)
	Get the layer count. More...
bool	MoveCurrentLayerUp (FBTake arg1)
	Move the current layer up, similar to using the button to move the layer in the Animation Layer tool. More...
bool	MoveCurrentLayerDown (FBTake arg1)
	Move the current layer down, similar to using the button to move the layer in the Animation Layer tool. More...
	DuplicateSelectedLayers (FBTake arg1)
	Duplicate the selected layers. More...
	MergeLayers (FBTake arg1, FBAnimationLayerMergeOptions arg2, object arg3, FBMergeLayerMode arg4, object arg5)
	Merge the selected layers. More...
	FBDelete (FBTake arg1)
	Deletion method. More...
	PlotTakeOnSelected (...)
	PlotTakeOnSelectedProperties (...)
	PlotTakeOnObjects (...)
	PlotAllTakesOnObjects (FBTake arg1, FBTime arg2, list arg3)
	Plot the animation on given objects for all takes. More...
	PlotTakeOnProperties (FBTake arg1, FBTime arg2, list arg3)
	Plot the animation on given properties. More...
	PlotAllTakesOnProperties (FBTake arg1, FBTime arg2, list arg3)
	Plot the animation on given properties for all takes. More...
int	AddTimeMark (FBTake arg1, FBTime arg2)
	Add a time mark to the take. More...
bool	DeleteTimeMark (FBTake arg1, object arg2)
	Delete a time mark from the take. More...
	DeleteAllTimeMarks (FBTake arg1)
	Delete all time marks from the take. More...
int	GetTimeMarkCount (FBTake arg1)
	Returns the number of time marks on the take. More...
int	SetTimeMarkTime (FBTake arg1, object arg2, FBTime arg3)
	Sets a new time for an existing time mark. More...
str	GetTimeMarkName (FBTake arg1, object arg2)
	Returns the name associated with a time mark. More...
bool	SetTimeMarkName (FBTake arg1, object arg2, str arg3)
	Sets a new name for an existing time mark. More...
FBTimeMarkAction	GetTimeMarkAction (FBTake arg1, object arg2)
	Returns the action associated with a time mark. More...
bool	SetTimeMarkAction (FBTake arg1, object arg2, FBTimeMarkAction arg3)
	Sets a new action for an existing time mark. More...
bool	SetTimeMarkColor (FBTake arg1, object arg2, FBColor arg3)
	Sets a new color for an existing time mark. More...
int	GetNextTimeMarkIndex (FBTake arg1)
	Returns the next time mark index, based on the current local time. More...
int	GetPreviousTimeMarkIndex (FBTake arg1)
	Returns the previous time mark index, based on the current local time. More...
bool	GetLayerRealSelection (FBTake arg1)
	Real selection for layer. More...
	SetLayerRealSelection (FBTake arg1, object arg2)
	Set real selection for layer. 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
ORSDK2018::FBPropertyString	Comments
	Read Write Property: Take comments. More...
FBPropertyTimeSpan	LocalTimeSpan
	Read Write Property: Local time span. More...
FBPropertyTimeSpan	ReferenceTimeSpan
	Read Write Property: Reference time span. 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
	)

Constructor.

Python Docstring:

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

C++ Signature:

 FBTake(const char * pName, HIObject pObject = ((void *) 0)) 

Parameters

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

See the C++ reference

__reduce__

(

)

int AddTimeMark	(	FBTake	arg1,
		FBTime	arg2
	)

Add a time mark to the take.

Python Docstring:

AddTimeMark( (FBTake)arg1, (FBTime)arg2) -> int 

C++ Signature:

int AddTimeMark(ORSDK2018::FBTime pTime, const char * pName = ((void *) 0)) 

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.

See the C++ reference

ClearAllProperties	(	FBTake	arg1,
		object	arg2,
		object	arg3
	)

Clear the animation on all the properties.

Python Docstring:

ClearAllProperties( (FBTake)arg1, (object)arg2 [, (object)arg3]) -> None 

C++ Signature:

void ClearAllProperties(bool pOnSelectedObjectsOnly, bool pOnLockedProperties = false) 

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.

See the C++ reference

ClearAllPropertiesOnCurrentLayer

(

FBTake

arg1

)

Clear all the animation on the current layer.

Python Docstring:

ClearAllPropertiesOnCurrentLayer( (FBTake)arg1) -> None 

C++ Signature:

void ClearAllPropertiesOnCurrentLayer() 

See the C++ reference

object CopyTake	(	FBTake	arg1,
		str	arg2
	)

Copy the take.

Python Docstring:

CopyTake( (FBTake)arg1, (str)arg2) -> object 

C++ Signature:

ORSDK2018::FBTake * CopyTake(const char * pNewTakeName) 

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.

See the C++ reference

CreateNewLayer

(

FBTake

arg1

)

Create a new layer.

Python Docstring:

CreateNewLayer( (FBTake)arg1) -> None 

C++ Signature:

void CreateNewLayer() 

See the C++ reference

DeleteAllTimeMarks

(

FBTake

arg1

)

Delete all time marks from the take.

Python Docstring:

DeleteAllTimeMarks( (FBTake)arg1) -> None 

C++ Signature:

void DeleteAllTimeMarks() 

See the C++ reference

bool DeleteTimeMark	(	FBTake	arg1,
		object	arg2
	)

Delete a time mark from the take.

Python Docstring:

DeleteTimeMark( (FBTake)arg1, (object)arg2) -> bool 

C++ Signature:

bool DeleteTimeMark(int pIndex) 

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.

See the C++ reference

DuplicateSelectedLayers

(

FBTake

arg1

)

Duplicate the selected layers.

Python Docstring:

DuplicateSelectedLayers( (FBTake)arg1) -> None 

C++ Signature:

void DuplicateSelectedLayers() 

This is equivalent of doing a copy-paste.

See the C++ reference

FBDelete

(

FBTake

arg1

)

Deletion method.

Python Docstring:

FBDelete( (FBTake)arg1) -> None 

C++ Signature:

void FBDelete() 

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

See the C++ reference

int GetCurrentLayer

(

FBTake

arg1

)

Get the current layer for the take.

Python Docstring:

GetCurrentLayer( (FBTake)arg1) -> int 

C++ Signature:

int GetCurrentLayer() 

Returns

The current layer index.

See the C++ reference

object GetLayer	(	FBTake	arg1,
		object	arg2
	)

Get the layer object that have the specified ID.

Python Docstring:

GetLayer( (FBTake)arg1, (object)arg2) -> object 

C++ Signature:

ORSDK2018::FBAnimationLayer * GetLayer(int pLayerIndex) 

Parameters

pLayerIndex

The index of the layer that will be returned.

Returns

Layer with the specified ID.

See the C++ reference

object GetLayerByName	(	FBTake	arg1,
		str	arg2
	)

Get the layer object that have the specified name.

Python Docstring:

GetLayerByName( (FBTake)arg1, (str)arg2) -> object 

C++ Signature:

ORSDK2018::FBAnimationLayer * GetLayerByName(const char * pName) 

Parameters

pName

The name of the animation layer to get.

Returns

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

See the C++ reference

int GetLayerCount

(

FBTake

arg1

)

Get the layer count.

Python Docstring:

GetLayerCount( (FBTake)arg1) -> int 

C++ Signature:

int GetLayerCount() 

Returns

The layer count.

See the C++ reference

bool GetLayerRealSelection

(

FBTake

arg1

)

Real selection for layer.

Python Docstring:

GetLayerRealSelection( (FBTake)arg1) -> bool 

C++ Signature:

bool GetLayerRealSelection() 

Check the SetLayerRealSelection function for more information about this.

Returns

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

See the C++ reference

int GetNextTimeMarkIndex

(

FBTake

arg1

)

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

Python Docstring:

GetNextTimeMarkIndex( (FBTake)arg1) -> int 

C++ Signature:

int GetNextTimeMarkIndex() 

Returns

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

See the C++ reference

int GetPreviousTimeMarkIndex

(

FBTake

arg1

)

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

Python Docstring:

GetPreviousTimeMarkIndex( (FBTake)arg1) -> int 

C++ Signature:

int GetPreviousTimeMarkIndex() 

Returns

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

See the C++ reference

FBTimeMarkAction GetTimeMarkAction	(	FBTake	arg1,
		object	arg2
	)

Returns the action associated with a time mark.

Python Docstring:

GetTimeMarkAction( (FBTake)arg1, (object)arg2) -> FBTimeMarkAction 

C++ Signature:

FBTimeMarkAction GetTimeMarkAction(int pIndex) 

Parameters

pIndex

Index of the time mark.

Returns

The action associated with the time mark.

See the C++ reference

FBColor GetTimeMarkColor	(	FBTake	arg1,
		object	arg2
	)

Returns the color associated with a time mark.

Python Docstring:

GetTimeMarkColor( (FBTake)arg1, (object)arg2) -> FBColor 

C++ Signature:

ORSDK2018::FBColor GetTimeMarkColor(int pIndex) 

Parameters

pIndex

Index of the time mark.

Returns

The color associated with the time mark.

See the C++ reference

int GetTimeMarkCount

(

FBTake

arg1

)

Returns the number of time marks on the take.

Python Docstring:

GetTimeMarkCount( (FBTake)arg1) -> int 

C++ Signature:

int GetTimeMarkCount() 

Returns

The number of time marks on the take.

See the C++ reference

str GetTimeMarkName	(	FBTake	arg1,
		object	arg2
	)

Returns the name associated with a time mark.

Python Docstring:

GetTimeMarkName( (FBTake)arg1, (object)arg2) -> str 

C++ Signature:

const char * GetTimeMarkName(int pIndex) 

Parameters

pIndex

Index of the time mark.

Returns

The name associated with the time mark.

See the C++ reference

FBTime GetTimeMarkTime	(	FBTake	arg1,
		object	arg2
	)

Returns the time associated with a time mark.

Python Docstring:

GetTimeMarkTime( (FBTake)arg1, (object)arg2) -> FBTime 

C++ Signature:

ORSDK2018::FBTime GetTimeMarkTime(int pIndex) 

Parameters

pIndex

Index of the time mark.

Returns

The time associated with the time mark.

See the C++ reference

MergeLayers	(	FBTake	arg1,
		FBAnimationLayerMergeOptions	arg2,
		object	arg3,
		FBMergeLayerMode	arg4,
		object	arg5
	)

Merge the selected layers.

Python Docstring:

MergeLayers( (FBTake)arg1, (FBAnimationLayerMergeOptions)arg2, (object)arg3, (FBMergeLayerMode)arg4 [, (object)arg5]) -> None 

C++ Signature:

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

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.

See the C++ reference

bool MoveCurrentLayerDown

(

FBTake

arg1

)

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

Python Docstring:

MoveCurrentLayerDown( (FBTake)arg1) -> bool 

C++ Signature:

bool MoveCurrentLayerDown() 

Use the SetCurrentLayer to specify the current layer.

Returns

True if successful.

See the C++ reference

bool MoveCurrentLayerUp

(

FBTake

arg1

)

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

Python Docstring:

MoveCurrentLayerUp( (FBTake)arg1) -> bool 

C++ Signature:

bool MoveCurrentLayerUp() 

Use the SetCurrentLayer to specify the current layer.

Returns

True if successful.

See the C++ reference

PlotAllTakesOnObjects	(	FBTake	arg1,
		FBTime	arg2,
		list	arg3
	)

Plot the animation on given objects for all takes.

Python Docstring:

PlotAllTakesOnObjects( (FBTake)arg1, (FBTime)arg2, (list)arg3) -> None 

C++ Signature:

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

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.

See the C++ reference

PlotAllTakesOnProperties	(	FBTake	arg1,
		FBTime	arg2,
		list	arg3
	)

Plot the animation on given properties for all takes.

Python Docstring:

PlotAllTakesOnProperties( (FBTake)arg1, (FBTime)arg2, (list)arg3) -> None 

C++ Signature:

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

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

Parameters

pPlotPeriod	Period for the plot.
pPropertiesToPlot	Properties to plot.

See the C++ reference

PlotAllTakesOnSelected	(	FBTake	arg1,
		FBTime	arg2
	)

Plot the animation on selected models for all takes.

Python Docstring:

PlotAllTakesOnSelected( (FBTake)arg1, (FBTime)arg2) -> None 

C++ Signature:

void PlotAllTakesOnSelected(ORSDK2018::FBTime pPlotPeriod) 

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

Parameters

pPlotPeriod

Period for the plot.

See the C++ reference

PlotAllTakesOnSelectedProperties	(	FBTake	arg1,
		FBTime	arg2
	)

Plot the animation on selected properties for all takes.

Python Docstring:

PlotAllTakesOnSelectedProperties( (FBTake)arg1, (FBTime)arg2) -> None 

C++ Signature:

void PlotAllTakesOnSelectedProperties(ORSDK2018::FBTime pPlotPeriod) 

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

Parameters

pPlotPeriod

Period for the plot.

See the C++ reference

PlotTakeOnObjects

(

...

)

Python Docstring:

PlotTakeOnObjects( (FBTake)arg1, (FBTime)arg2, (list)arg3) -> None

PlotTakeOnObjects( (FBTake)arg1, (FBPlotOptions)arg2, (list)arg3) -> None 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

void PlotTakeOnObjects(ORSDK2018::FBPlotOptions * pPlotOptions, ORSDK2018::FBArrayTemplate< ORSDK2018::FBBox * > * pObjectsToPlot)
void PlotTakeOnObjects(ORSDK2018::FBTime pPlotPeriod, ORSDK2018::FBArrayTemplate< ORSDK2018::FBBox * > * pObjectsToPlot)

PlotTakeOnProperties	(	FBTake	arg1,
		FBTime	arg2,
		list	arg3
	)

Plot the animation on given properties.

Python Docstring:

PlotTakeOnProperties( (FBTake)arg1, (FBTime)arg2, (list)arg3) -> None 

C++ Signature:

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

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.

See the C++ reference

PlotTakeOnSelected

(

...

)

Python Docstring:

PlotTakeOnSelected( (FBTake)arg1, (FBTime)arg2) -> None

PlotTakeOnSelected( (FBTake)arg1, (FBPlotOptions)arg2) -> None 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

void PlotTakeOnSelected(ORSDK2018::FBPlotOptions * pPlotOptions)
void PlotTakeOnSelected(ORSDK2018::FBTime pPlotPeriod)

PlotTakeOnSelectedProperties

(

...

)

Python Docstring:

PlotTakeOnSelectedProperties( (FBTake)arg1, (FBTime)arg2) -> None

PlotTakeOnSelectedProperties( (FBTake)arg1, (FBPlotOptions)arg2) -> None 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

void PlotTakeOnSelectedProperties(ORSDK2018::FBPlotOptions * pPlotOptions)
void PlotTakeOnSelectedProperties(ORSDK2018::FBTime pPlotPeriod)

RemoveLayer	(	FBTake	arg1,
		object	arg2
	)

Remove a layer.

Python Docstring:

RemoveLayer( (FBTake)arg1, (object)arg2) -> None 

C++ Signature:

void RemoveLayer(int pLayerIndex) 

Parameters

pLayerIndex

Layer with at the specified index will be removed.

See the C++ reference

SetCurrentLayer	(	FBTake	arg1,
		object	arg2
	)

Set the current layer for the take.

Python Docstring:

SetCurrentLayer( (FBTake)arg1, (object)arg2) -> None 

C++ Signature:

void SetCurrentLayer(int pLayerIndex) 

Note that this will not deselect the other layers.

Parameters

pLayerIndex

The layer index to be set as the current one.

See the C++ reference

SetLayerRealSelection	(	FBTake	arg1,
		object	arg2
	)

Set real selection for layer.

Python Docstring:

SetLayerRealSelection( (FBTake)arg1, (object)arg2) -> None 

C++ Signature:

void SetLayerRealSelection(bool pValue) 

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.

See the C++ reference

bool SetTimeMarkAction	(	FBTake	arg1,
		object	arg2,
		FBTimeMarkAction	arg3
	)

Sets a new action for an existing time mark.

Python Docstring:

SetTimeMarkAction( (FBTake)arg1, (object)arg2, (FBTimeMarkAction)arg3) -> bool 

C++ Signature:

bool SetTimeMarkAction(int pIndex, FBTimeMarkAction pAction) 

Parameters

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

Returns

True if the operation is successful, false otherwise.

See the C++ reference

bool SetTimeMarkColor	(	FBTake	arg1,
		object	arg2,
		FBColor	arg3
	)

Sets a new color for an existing time mark.

Python Docstring:

SetTimeMarkColor( (FBTake)arg1, (object)arg2, (FBColor)arg3) -> bool 

C++ Signature:

bool SetTimeMarkColor(int pIndex, ORSDK2018::FBColor pColor) 

Parameters

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

Returns

True if the operation is successful, false otherwise.

See the C++ reference

bool SetTimeMarkName	(	FBTake	arg1,
		object	arg2,
		str	arg3
	)

Sets a new name for an existing time mark.

Python Docstring:

SetTimeMarkName( (FBTake)arg1, (object)arg2, (str)arg3) -> bool 

C++ Signature:

bool SetTimeMarkName(int pIndex, const char * pName) 

Parameters

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

Returns

True if the operation is successful, false otherwise.

See the C++ reference

int SetTimeMarkTime	(	FBTake	arg1,
		object	arg2,
		FBTime	arg3
	)

Sets a new time for an existing time mark.

Python Docstring:

SetTimeMarkTime( (FBTake)arg1, (object)arg2, (FBTime)arg3) -> int 

C++ Signature:

int SetTimeMarkTime(int pIndex, ORSDK2018::FBTime pTime) 

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.

See the C++ reference

Member Data Documentation

ORSDK2018::FBPropertyString Comments

Read Write Property: Take comments.

See the C++ reference

FBPropertyTimeSpan LocalTimeSpan

Read Write Property: Local time span.

See the C++ reference

FBPropertyTimeSpan ReferenceTimeSpan

Read Write Property: Reference time span.

See the C++ reference