FBUndoManager Class Reference
FBUndoManager Class Reference
Related help topics: #include <mobu-python-api.h>
Class 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.
Inheritance diagram for FBUndoManager:
Public Member Functions | |
| __reduce__ () | |
| bool | Clear (FBUndoManager arg1) |
| Clear the undo and redo stacks. More... | |
| __init__ (object arg1) | |
| Redo (FBUndoManager arg1) | |
| Redo last undone action. More... | |
| Undo (FBUndoManager arg1, object arg2) | |
| Undo last action. More... | |
| bool | TransactionBegin (FBUndoManager arg1, str arg2) |
| Open transaction stack for adding transactions. More... | |
| bool | TransactionIsOpen (FBUndoManager arg1) |
| Query if transaction stack is already open. More... | |
| bool | TransactionAddModelTRS (FBUndoManager arg1, FBModel arg2) |
| Add Transaction if transaction stack is open. More... | |
| bool | TransactionAddProperty (FBUndoManager arg1, FBProperty arg2) |
| Add Transaction if transaction stack is open. More... | |
| bool | TransactionAddObjectDestroy (FBUndoManager arg1, FBComponent arg2) |
| Add Transaction if transaction stack is open. More... | |
| bool | TransactionEnd (FBUndoManager arg1) |
| Close transaction stack. More... | |
| bool | ActiveOperation (FBUndoManager arg1) |
| Determine if an undo operation is in action. 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::FBPropertyEvent | OnUndo |
| Event: An undo operation will be executed. More... | |
| ORSDK2018::FBPropertyEvent | OnUndoCompleted |
| Event: An undo operation has been executed. More... | |
| ORSDK2018::FBPropertyEvent | OnRedo |
| Event: A redo operation will be executed. More... | |
| ORSDK2018::FBPropertyEvent | OnRedoCompleted |
| Event: A redo operation has been executed. 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 | ) |
Python Docstring:
__init__( (object)arg1) -> None
C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.
| __reduce__ | ( | ) |
| bool ActiveOperation | ( | FBUndoManager | arg1 | ) |
Determine if an undo operation is in action.
Python Docstring:
ActiveOperation( (FBUndoManager)arg1) -> bool
C++ Signature:
bool ActiveOperation()
- Returns
- true the Undo Manager is performing an Undo or a Redo operation.
| bool Clear | ( | FBUndoManager | arg1 | ) |
Clear the undo and redo stacks.
Python Docstring:
Clear( (FBUndoManager)arg1) -> bool
C++ Signature:
bool Clear()
- Returns
- A boolean value indicating success (true) or failure (false).
| Redo | ( | FBUndoManager | arg1 | ) |
Redo last undone action.
Python Docstring:
Redo( (FBUndoManager)arg1) -> None
C++ Signature:
void Redo()
| bool TransactionAddModelTRS | ( | FBUndoManager | arg1, |
| FBModel | arg2 | ||
| ) |
Add Transaction if transaction stack is open.
Python Docstring:
TransactionAddModelTRS( (FBUndoManager)arg1, (FBModel)arg2) -> bool
C++ Signature:
bool TransactionAddModelTRS(ORSDK2018::FBModel * pModel)
Quick Function to add Model TRS in Undo Stack
- Parameters
-
pModel Model to backup TRS
- Returns
- true if add transaction successfully.
| bool TransactionAddObjectDestroy | ( | FBUndoManager | arg1, |
| FBComponent | arg2 | ||
| ) |
Add Transaction if transaction stack is open.
Python Docstring:
TransactionAddObjectDestroy( (FBUndoManager)arg1, (FBComponent)arg2) -> bool
C++ Signature:
bool TransactionAddObjectDestroy(FBObject * pObject)
Function to add object to destroy in Undo Stack
- Parameters
-
pObject Object to backup
- Returns
- true if add transaction successfully.
| bool TransactionAddProperty | ( | FBUndoManager | arg1, |
| FBProperty | arg2 | ||
| ) |
Add Transaction if transaction stack is open.
Python Docstring:
TransactionAddProperty( (FBUndoManager)arg1, (FBProperty)arg2) -> bool
C++ Signature:
bool TransactionAddProperty(ORSDK2018::FBProperty * pProperty)
Quick Function to add property value in Undo Stack
- Parameters
-
pProperty Property to backup
- Returns
- true if add transaction successfully.
| bool TransactionBegin | ( | FBUndoManager | arg1, |
| str | arg2 | ||
| ) |
Open transaction stack for adding transactions.
Python Docstring:
TransactionBegin( (FBUndoManager)arg1, (str)arg2) -> bool
C++ Signature:
bool TransactionBegin(const char * pTransactionName)
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.
| bool TransactionEnd | ( | FBUndoManager | arg1 | ) |
Close transaction stack.
Python Docstring:
TransactionEnd( (FBUndoManager)arg1) -> bool
C++ Signature:
bool TransactionEnd()
Users should call TransactionBegin()/TransactionEnd() in pairs, Transaction stack must be closed before UI event callback return.
- Returns
- true if transaction close successfully.
| bool TransactionIsOpen | ( | FBUndoManager | arg1 | ) |
Query if transaction stack is already open.
Python Docstring:
TransactionIsOpen( (FBUndoManager)arg1) -> bool
C++ Signature:
bool TransactionIsOpen()
- Returns
- true if transaction is already open.
| Undo | ( | FBUndoManager | arg1, |
| object | arg2 | ||
| ) |
Undo last action.
Python Docstring:
Undo( (FBUndoManager)arg1 [, (object)arg2]) -> None
C++ Signature:
void Undo(bool pNoRedo = false)
- Parameters
-
pNoRedo If true, once the action is undone, it cannot be redone.
Member Data Documentation
| ORSDK2018::FBPropertyEvent OnRedo |
Event: A redo operation will be executed.
| ORSDK2018::FBPropertyEvent OnRedoCompleted |
Event: A redo operation has been executed.
| ORSDK2018::FBPropertyEvent OnUndo |
Event: An undo operation will be executed.
| ORSDK2018::FBPropertyEvent OnUndoCompleted |
Event: An undo operation has been executed.