Class UndoSystem

constructor

• new UndoSystem(): UndoSystem

  Returns UndoSystem

Optionalcurrent_save

history

index

addKeyframeCasualties

• addKeyframeCasualties(keyframes: _Keyframe[]): void

  Add keyframes to the current edit that were indirectly removed by moving other keyframes to their position

  Parameters

  • keyframes: _Keyframe[]

  Returns void

amendEdit

• amendEdit(
      form: InputFormConfig,
      callback: (values: any, form: any) => void,
  ): void

  Provides a menu to amend the latest edit with slightly changed values

  Parameters

  • form: InputFormConfig
  • callback: (values: any, form: any) => void

  Returns void

cancelEdit

• cancelEdit(): void

  Cancels an event before it was finished and reset the project to the state before

  Returns void

cancelSelection

• cancelSelection(revert_changes?: boolean): void

  Cancel the selection changes

  Parameters

  • Optionalrevert_changes: boolean

    If true, the already tracked selection changes will be reverted to the state before initSelection

  Returns void

closeAmendEditMenu

• closeAmendEditMenu(): void

  Closes the amend edit menu

  Returns void

finishEdit

• finishEdit(action: string, aspects?: UndoAspects): UndoEntry

  Finishes an edit by saving the state of the project after it was changed

  Parameters

  • action: string

    Description of the edit

  • Optionalaspects: UndoAspects

  Returns UndoEntry

finishSelection

• finishSelection(action: string, aspects?: UndoSelectionAspects): UndoEntry

  Finishes a selection change in the current project

  Parameters

  • action: string

    Description of the edit

  • Optionalaspects: UndoSelectionAspects

  Returns UndoEntry

initEdit

• initEdit(aspects: UndoAspects, amended?: boolean): UndoEntry

  Starts an edit to the current project by saving the state of the provided aspects

  Parameters

  • aspects: UndoAspects

    Aspects to save

  • amended: boolean = false

  Returns UndoEntry

initSelection

• initSelection(aspects?: UndoSelectionAspects): UndoEntry

  Starts a selection change in the current project

  Parameters

  • Optionalaspects: UndoSelectionAspects

    Aspects to save

  Returns UndoEntry

loadSave

• loadSave(save: UndoSave, reference: UndoSave, mode?: "session"): void

  Loads a specific undo save

  Parameters

  • save: UndoSave

    The undo save to load

  • reference: UndoSave

    The current undo save for reference

  • Optionalmode: "session"

    The load save modes

  Returns void

redo

• redo(remote?: boolean): void

  Redoes the latest edit

  Parameters

  • Optionalremote: boolean

  Returns void

undo

• undo(remote?: boolean): void

  Cancels an event before it was finished and reset the project to the state before

  Parameters

  • Optionalremote: boolean

  Returns void