FBMotionBlendEdit Class Reference

Motion Blend Edit class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBMotionBlendEdit:

Public Member Functions
	FBMotionBlendEdit (str pName=nullptr, bool pSetAsCurrent=True)
	Constructor.
bool	Clear ()
	Clear the Edit.
	FBDelete ()
	Virtual FBDelete function.
bool	GetKeepActive ()
	Get the "Keep Edit Active" state.
str	GetName ()
	Get the Edit name.
bool	GetShowAllGhosts ()
	Get the "Show All Ghosts" state.
bool	SetKeepActive (bool pKeepActive)
	Set the "Keep Edit Active" state.
bool	SetName (str pName)
	Set the Edit name.
bool	SetShowAllGhosts (bool pShow)
	Set the "Show All Ghosts" 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 Edit class.

This class allows creating, deleting and interacting with Edits contained in the Motion Blend window.

# This example shows how to create a new Edit, rename it and activate its 'Keep Active' option.
from pyfbsdk import *
myEdit = FBMotionBlendEdit( "myEdit" )
myEdit.SetName( "myRenamedEdit" )
myEdit.SetKeepActive( True )

Motion Blend Edit

Constructor & Destructor Documentation

FBMotionBlendEdit()

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

Constructor.

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.

Member Function Documentation

Clear()

bool Clear

(

)

Clear the Edit.

Returns

True if the operation is successful, false otherwise.

FBDelete()

FBDelete

(

)

Virtual FBDelete function.

Remove the Edit from the Motion Blend.

See sample: DeleteHierarchy.py.

GetKeepActive()

bool GetKeepActive

(

)

Get the "Keep Edit Active" state.

Returns

True if the result of the Edit is shown while working on other Edits, false otherwise.

GetName()

str GetName

(

)

Get the Edit name.

Returns

The Edit name.

GetShowAllGhosts()

bool GetShowAllGhosts

(

)

Get the "Show All Ghosts" state.

Returns

True if all Edit ghosts are displayed in the Viewer window, false otherwise.

SetKeepActive()

bool SetKeepActive

(

bool

pKeepActive

)

Set the "Keep Edit Active" state.

Parameters

pKeepActive

True to allow the result of the Edit to be shown while working on other Edits, false otherwise.

Returns

True if the operation is successful, false otherwise.

SetName()

bool SetName

(

str

pName

)

Set the Edit name.

Parameters

pName

The new name.

Returns

True if the operation is successful, false otherwise.

SetShowAllGhosts()

bool SetShowAllGhosts

(

bool

pShow

)

Set the "Show All Ghosts" state.

Parameters

pShow

True to display all of the Edit ghosts in the Viewer window, false to hide them all.

Returns

True if the operation is successful, false otherwise.