Members
(static) StateType
- Description:
An Enum of all types of state saves.
- Source:
An Enum of all types of state saves.
(static) VERBOSE :boolean
- Source:
Type:
- boolean
numRedoStates :number
- Description:
The number of states currently stored for redoing.
- Source:
The number of states currently stored for redoing.
Type:
- number
numUndoStates :number
- Description:
The number of states currently stored for undoing.
- Source:
The number of states currently stored for undoing.
Type:
- number
Methods
getObjectUUIDs() → {Set}
- Description:
Returns all objects that are currently referenced by the history.
- Source:
Returns:
uuids of all objects currently referenced in the history.
- Type
- Set
loadSnapshot(name)
- Description:
Save a state to the list of snapshots to be recovered at any time.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | the name of the snapshot to recover |
popState() → {boolean}
- Description:
Pop the last state in the undo stack off and apply the new last state to the project.
- Source:
Returns:
True if the undo stack is non-empty, false otherwise
- Type
- boolean
pushState(filter, actionName)
- Description:
Push the current state of the ObjectCache to the undo stack.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
filter |
number | the filter to choose which objects to serialize. See Wick.History.StateType |
actionName |
string | Optional: Name of the action conducted to generate this state. If no name is presented, "Unknown Action" is presented in its place. |
recoverState() → {boolean}
- Description:
Recover a state that was undone.
- Source:
Returns:
True if the redo stack is non-empty, false otherwise
- Type
- boolean
reset()
- Description:
Resets history in the editor. This is non-reversible.
- Source:
saveSnapshot(name, filter)
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | the name of the snapshot |
filter |
number | the filter to choose which objects to serialize. See Wick.History.StateType |