Eyeon:Script/Reference/Applications/Fusion/Classes/Composition/EndUndo
From VFXPedia
Contents |
Composition : EndUndo
Arguments
EndUndo( keep )
- keep(required, boolean)
This argument determines whether the captured undo event is to kept or discarded.
Returns
This function does not return any values.
Remarks
The StartUndo() function is always paired with an EndUndo() function. Any changes made to the composition by the lines of script between StartUndo() and EndUndo() are stored as a single Undo event.
Changes captured in the undo event can be undone from the GUI using CTRL-Z, or the Edit menu. They can also be undone from script, by calling the Undo function.
Specifying 'true' results in the undo event being added to the undo stack, and appearing in the appropriate menu. Specifying 'false' will result in no undo event being created. This should be used sparingly, as the user (or script) will have no way to undo the preceding commands.
If the script exits before the EndUndo() is called Fusion will automatically close the undo event.
Requirements
- eyeonScript 5.0
- Fusion 5.0
Examples
fusion = Fusion("127.0.0.1")
composition = composition:NewComp()
SetActiveComp(comp)
composition:StartUndo("Add some tools")
bg1 = Background{}
pl1 = Plasma{}
mg1 = Merge{ Background = bg1, Foreground = pl1 }
composition:EndUndo(true)
See Also
StartUndo(), Undo(),Redo()
Tips for EndUndo (edit)
EyeonTips:Script/Reference/Applications/Fusion/Classes/Composition/EndUndo