FBMotionBlend Class Reference

Motion Blend class. More...

#include <fbmotionblend.h>

Inheritance diagram for FBMotionBlend:

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

Static Public Member Functions
static FBMotionBlend &	TheOne ()
	Get the global FBMotionBlend object.
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)

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

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 )

Definition at line 48 of file fbmotionblend.h.

Member Function Documentation

AddEdit()

FBMotionBlendEdit * AddEdit	(	const char *	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.

TheOne()

static FBMotionBlend & TheOne ( )

static

Get the global FBMotionBlend object.

Returns

The global FBMotionBlend object.

---

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

• fbmotionblend.h