Difference between revisions of "Undo"
(Adding couple of undo caviats) |
|||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ''(Incentive PyMOL only feature)'' | |
| − | ''' | ||
| − | + | Most actions as of '''Incentive PyMOL 2.5''' are undoable. | |
| − | |||
| − | + | Actions are undoable via GUI menu (Edit -> Undo). The undo feature may be manually disabled by unchecking `Edit -> Undo Enabled`, and can be re-enabled by rechecking the same menu item. | |
| − | |||
| − | [[Category:Commands| | + | == Usage == |
| + | undo [, steps] | ||
| + | |||
| + | * '''steps''' = integer: number of steps to undo | ||
| + | |||
| + | == PyMOL API == | ||
| + | <source lang="python"> | ||
| + | cmd.undo(int steps=1) | ||
| + | </source> | ||
| + | |||
| + | <code>undo_enable</code> is an API-only feature that allows you enable undo. | ||
| + | |||
| + | <source lang="python"> | ||
| + | cmd.undo_enable() | ||
| + | </source> | ||
| + | |||
| + | <code>undo_disable</code> is an API-only feature that allows you disable undo. | ||
| + | |||
| + | <source lang="python"> | ||
| + | cmd.undo_disable() | ||
| + | </source> | ||
| + | |||
| + | == Example == | ||
| + | undo | ||
| + | undo 5 | ||
| + | |||
| + | == Comments == | ||
| + | |||
| + | Currently, the undo stack supports the previous 25 actions or up to 1GB memory used. These will later be configurable in an upcoming release. | ||
| + | |||
| + | Currently, undo support for builder is not available but will be supported in a later patch release. | ||
| + | |||
| + | While movie is playing, the undo manager is paused and will save the current session's state when the user ends the movie. | ||
| + | |||
| + | During wizards, the undo manager is paused, and the current session's state is saved when the user clicks 'Done' for active wizards. | ||
| + | |||
| + | For larger sessions, it may be suitable to manually turn off undo to save on memory usage (commands such as set will incur a high memory cost). Add <code>cmd.undo_disable()</code> in your pymolrc if you need to disable undo automatically upon startup. | ||
| + | |||
| + | For '''Incentive PyMOL''', all previous undo features are deprecated and will now be superseded by the one introduced in '''Incentive PyMOL 2.5'''. | ||
| + | |||
| + | == SEE ALSO == | ||
| + | [[Redo]] | ||
| + | |||
| + | [[Category:Commands|Undo]] | ||
| + | [[Category:Editing Module|Undo]] | ||
Latest revision as of 22:09, 10 May 2021
(Incentive PyMOL only feature)
Most actions as of Incentive PyMOL 2.5 are undoable.
Actions are undoable via GUI menu (Edit -> Undo). The undo feature may be manually disabled by unchecking `Edit -> Undo Enabled`, and can be re-enabled by rechecking the same menu item.
Usage
undo [, steps]
- steps = integer: number of steps to undo
PyMOL API
cmd.undo(int steps=1)
undo_enable is an API-only feature that allows you enable undo.
cmd.undo_enable()
undo_disable is an API-only feature that allows you disable undo.
cmd.undo_disable()
Example
undo undo 5
Comments
Currently, the undo stack supports the previous 25 actions or up to 1GB memory used. These will later be configurable in an upcoming release.
Currently, undo support for builder is not available but will be supported in a later patch release.
While movie is playing, the undo manager is paused and will save the current session's state when the user ends the movie.
During wizards, the undo manager is paused, and the current session's state is saved when the user clicks 'Done' for active wizards.
For larger sessions, it may be suitable to manually turn off undo to save on memory usage (commands such as set will incur a high memory cost). Add cmd.undo_disable() in your pymolrc if you need to disable undo automatically upon startup.
For Incentive PyMOL, all previous undo features are deprecated and will now be superseded by the one introduced in Incentive PyMOL 2.5.