Jazz2::Editor::SetChunkCommand class

Changes the payload of a chunk, as an undoable step.

For data the level keeps in chunks of its own, such as bookmarks and notes. An empty payload removes the chunk. Changes of the same chunk by the same name are merged when it's allowed.

Base classes

class EditCommand
Undoable change of a level being edited.

Constructors, destructors, conversion operators

SetChunkCommand(const LevelDocument& document, std::uint32_t tag, ArrayView<const std::uint8_t> data, String name)
Creates a change from the current payload of the chunk to the given one.

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 true if TryMerge() would take over next, 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::SetChunkCommand::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::SetChunkCommand::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.