Jazz2::Editor::SetAdditionalPaletteCommand class

Changes the colors of an additional palette of the level, as an undoable step.

Consecutive changes of the same entries of the same palette by the same name are merged, as a color dragged.

Base classes

class EditCommand
Undoable change of a level being edited.

Constructors, destructors, conversion operators

SetAdditionalPaletteCommand(const LevelDocument& document, std::int32_t index, const std::uint32_t* palette, String name)
Creates a change of the palette of an index from its current colors 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 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::SetAdditionalPaletteCommand::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::SetAdditionalPaletteCommand::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.