FBMotionBlend Class Reference

Motion Blend class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBMotionBlend:

Public Member Functions
FBMotionBlendEdit	AddEdit (str pName=nullptr, bool pSetAsCurrent=True)
	Add a new Edit in the Motion Blend.
FBMotionBlendEdit	GetCurrentEdit ()
	Get the current Edit used in the Motion Blend.
FBMotionBlendEdit	GetEdit (int pIndex)
	Get the Edit associated to the input index.
int	GetEditCount ()
	Get the number of Edits in the Motion Blend.
bool	GetForceTime ()
	Get the "Force Time" state.
bool	GetSnapOnFrame ()
	Get the "Snap On Frame" state.
bool	GetSyncTakeEditStartEnd ()
	Get the "Sync Take/Edit Start & End" state.
bool	RemoveAllEdits ()
	Remove all Edits from the Motion Blend.
bool	RemoveEdit (FBMotionBlendEdit pEdit)
	Remove an Edit from the Motion Blend.
bool	SetCurrentEdit (FBMotionBlendEdit pEdit)
	Set the current Edit to be used in the Motion Blend.
bool	SetForceTime (bool pForceTime)
	Set the "Force Time" state.
bool	SetSnapOnFrame (bool pSnap)
	Set the "Snap On Frame" state.
bool	SetSyncTakeEditStartEnd (bool pSync)
	Set the "Sync Take/Edit Start & End" state.
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.

Additional Inherited Members
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

Motion Blend class.

This class allows interacting with the Edits and options of the Motion Blend window.

# This example shows how to clear all the Edits, create a new Edit and activate the 'Snap On Frame' option.
from pyfbsdk import *
motionBlend = FBMotionBlend()
motionBlend.RemoveAllEdits()
myEdit = motionBlend.AddEdit( "myEdit" )
motionBlend.SetSnapOnFrame( True )

Member Function Documentation

AddEdit()

FBMotionBlendEdit AddEdit	(	str	pName = nullptr,
		bool	pSetAsCurrent = True
	)

Add a new Edit in the Motion Blend.

Parameters

pName	The new Edit name. If unset, the name "Edit" will be set.
pSetAsCurrent	True (default) to set the new Edit as the current Edit to be used in the Motion Blend.

Returns

The new FBMotionBlendEdit object if successful, nullptr (C++) or None (Python) otherwise.

GetCurrentEdit()

FBMotionBlendEdit GetCurrentEdit

(

)

Get the current Edit used in the Motion Blend.

Returns

The current FBMotionBlendEdit object if successful, nullptr (C++) or None (Python) otherwise.

GetEdit()

FBMotionBlendEdit GetEdit

(

int

pIndex

)

Get the Edit associated to the input index.

Parameters

pIndex

The index of the Edit to get.

Returns

The FBMotionBlendEdit object if successful, nullptr (C++) or None (Python) otherwise.

GetEditCount()

int GetEditCount

(

)

Get the number of Edits in the Motion Blend.

Returns

The number of Edits in the Motion Blend, or -1 in case of an error.

GetForceTime()

bool GetForceTime

(

)

Get the "Force Time" state.

Returns

True if the Motion Blend snaps the Timeline indicator in place so that it cannot be moved by dragging, false otherwise.

GetSnapOnFrame()

bool GetSnapOnFrame

(

)

Get the "Snap On Frame" state.

Returns

True if the Motion Blend forces the start and end times of all cuts and poses to snap to the nearest frame, false otherwise.

GetSyncTakeEditStartEnd()

bool GetSyncTakeEditStartEnd

(

)

Get the "Sync Take/Edit Start & End" state.

Returns

True if the Take start/end times sync with the Take start/end times stored in the Motion Blend Edit selected, false otherwise.

RemoveAllEdits()

bool RemoveAllEdits

(

)

Remove all Edits from the Motion Blend.

A default empty Edit is then created.

Returns

True if the operation is successful, false otherwise.

RemoveEdit()

bool RemoveEdit

(

FBMotionBlendEdit

pEdit

)

Remove an Edit from the Motion Blend.

Parameters

pEdit

The FBMotionBlendEdit object to remove.

Returns

True if the operation is successful, false otherwise.

SetCurrentEdit()

bool SetCurrentEdit

(

FBMotionBlendEdit

pEdit

)

Set the current Edit to be used in the Motion Blend.

Parameters

pEdit

The FBMotionBlendEdit object to set as the current Edit.

Returns

True if the operation is successful, false otherwise.

SetForceTime()

bool SetForceTime

(

bool

pForceTime

)

Set the "Force Time" state.

Parameters

pForceTime

True to snap the Timeline indicator in place so that it cannot be moved by dragging, false otherwise.

Returns

True if the operation is successful, false otherwise.

SetSnapOnFrame()

bool SetSnapOnFrame

(

bool

pSnap

)

Set the "Snap On Frame" state.

Parameters

pSnap

True to force the start and end times of all cuts and poses to snap to the nearest frame, false otherwise.

Returns

True if the operation is successful, false otherwise.

SetSyncTakeEditStartEnd()

bool SetSyncTakeEditStartEnd

(

bool

pSync

)

Set the "Sync Take/Edit Start & End" state.

Parameters

pSync

True to sync the Take start/end times with the Take start/end times stored in the Motion Blend Edit selected, false otherwise.

Returns

True if the operation is successful, false otherwise.