FBUndoManager Class Reference

Access to global undo and redo functionality. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBUndoManager:

Public Member Functions
	FBUndoManager ()
	Constructor.
bool	ActiveOperation ()
	Determine if an undo operation is in action.
bool	Clear ()
	Clear the undo and redo stacks.
	Redo ()
	Redo last undone action.
bool	TransactionAddModelTRS (FBModel pModel)
	Add Transaction if transaction stack is open.
bool	TransactionAddObjectDestroy (FBObject pObject)
	Add Transaction if transaction stack is open.
bool	TransactionAddProperty (FBProperty pProperty)
	Add Transaction if transaction stack is open.
bool	TransactionBegin (str pTransactionName)
	Open transaction stack for adding transactions.
bool	TransactionEnd ()
	Close transaction stack.
bool	TransactionIsOpen ()
	Query if transaction stack is already open.
	Undo (bool pNoRedo=False)
	Undo last action.
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
FBEvent	OnRedo
	Event: A redo operation will be executed.
FBEvent	OnRedoCompleted
	Event: A redo operation has been executed.
FBEvent	OnUndo
	Event: An undo operation will be executed.
FBEvent	OnUndoCompleted
	Event: An undo operation has been executed.
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

Access to global undo and redo functionality.

Users have the possibility of undoing and redoing actions performed using the GUI, and interacting with the undo and redo stacks with custom actions.All undo/redo related functions should only be called inside UI event callback. Users should call TransactionBegin()/TransactionEnd() in pairs, Transaction stack must be closed before UI event callback return.This class cannot be used as a base class.

See sample: IndividualUndoCalls.py.

Constructor & Destructor Documentation

FBUndoManager()

FBUndoManager

(

)

Constructor.

Member Function Documentation

ActiveOperation()

bool ActiveOperation

(

)

Determine if an undo operation is in action.

Returns

true the Undo Manager is performing an Undo or a Redo operation.

Clear()

bool Clear

(

)

Clear the undo and redo stacks.

Returns

A boolean value indicating success (true) or failure (false).

Redo()

Redo

(

)

Redo last undone action.

TransactionAddModelTRS()

bool TransactionAddModelTRS

(

FBModel

pModel

)

Add Transaction if transaction stack is open.

Quick Function to add Model TRS in Undo Stack

Parameters

pModel

Model to backup TRS

Returns

true if add transaction successfully.

TransactionAddObjectDestroy()

bool TransactionAddObjectDestroy

(

FBObject

pObject

)

Add Transaction if transaction stack is open.

Function to add object to destroy in Undo Stack. No need to call FBDelete() on the object after calling this function.

Parameters

pObject

Object to backup

Returns

true if add transaction successfully.

TransactionAddProperty()

bool TransactionAddProperty

(

FBProperty

pProperty

)

Add Transaction if transaction stack is open.

Quick Function to add property value in Undo Stack

Parameters

pProperty

Property to backup

Returns

true if add transaction successfully.

TransactionBegin()

bool TransactionBegin

(

str

pTransactionName

)

Open transaction stack for adding transactions.

Users should call TransactionBegin()/TransactionEnd() in pairs, Transaction stack must be closed before UI event callback return.

Parameters

pTransactionName

Name of Transaction.

Returns

true if open transaction stack successfully.

TransactionEnd()

bool TransactionEnd

(

)

Close transaction stack.

Users should call TransactionBegin()/TransactionEnd() in pairs, Transaction stack must be closed before UI event callback return.

Returns

true if transaction close successfully.

TransactionIsOpen()

bool TransactionIsOpen

(

)

Query if transaction stack is already open.

Returns

true if transaction is already open.

Undo()

Undo

(

bool

pNoRedo = False

)

Undo last action.

Parameters

pNoRedo

If true, once the action is undone, it cannot be redone.

Member Data Documentation

OnRedo

FBEvent OnRedo

Event: A redo operation will be executed.

OnRedoCompleted

FBEvent OnRedoCompleted

Event: A redo operation has been executed.

OnUndo

FBEvent OnUndo

Event: An undo operation will be executed.

OnUndoCompleted

FBEvent OnUndoCompleted

Event: An undo operation has been executed.