SetOffGridEventsCommand class
#include <Jazz2/Editor/Document/Commands.h>
Changes the events placed off the grid, all of them at once.
Given the whole list as it is to be, only the parts of it that change are kept, before and after, so a step of a drag over a few of many events doesn't keep all of them. Changes with the same name of the same events are merged when it's allowed, so dragging a value of one or more of them is a single step.
Base classes
- class EditCommand
- Undoable change of a level being edited.
Constructors, destructors, conversion operators
-
SetOffGridEventsCommand(const LevelDocument& document,
SmallVector<Formats::
OffGridEventRecord, 0> events, String name) - Creates a change from the current events off the grid to the given ones.
Public functions
- void Do(LevelDocument& document, DocumentChanges& changes) override
- Applies the change to the document, again after it was undone.
- void Undo(LevelDocument& document, DocumentChanges& changes) override
- Reverts the change.
- auto TryMerge(EditCommand& next) -> bool override
- Tries to take over a change that follows this one, which was already applied.
- auto CanMerge(EditCommand& next) -> bool override
- Returns
trueif TryMerge() would take overnext, without taking it over. - auto GetName() const -> String override
- Returns the name shown in the history.
-
auto GetMemoryUsage() const -> std::
size_t override - Returns the memory the command takes.
Function documentation
bool Jazz2:: Editor:: SetOffGridEventsCommand:: TryMerge(EditCommand& next) override
Tries to take over a change that follows this one, which was already applied.
Lets a continuous change, such as dragging a slider, be undone in a single step. Returns true if next was taken over, it's then dropped.
bool Jazz2:: Editor:: SetOffGridEventsCommand:: CanMerge(EditCommand& next) override
Returns true if TryMerge() would take over next, without taking it over.
A transaction is merged only if all of its changes can be, it asks each of them first. A command that merges has to say the same here as its TryMerge() does.