root
/
aseprite
mirror of https://github.com/aseprite/aseprite.git
1
0
Fork 0
Code Issues Actions 6 Packages Projects Releases Wiki Activity
aseprite/src/app/doc_observer.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

132 lines
4.5 KiB
C
Raw Normal View History

Move doc::Context to app::Context (#378) We've moved everything related to Context/active site/observable documents from "doc" namespace to "app" namespace.
2018-07-07 13:47:42 +08:00
// Aseprite
Add slices copy&paste and duplication (fix #4466)
2025-03-08 05:03:49 +08:00
// Copyright (C) 2018-2025 Igara Studio S.A.
Add ability to edit multiple slices Related to #721 and #1651, still need more work to give a better UX to edit static and animated slices.
2019-05-03 03:26:13 +08:00
// Copyright (C) 2001-2018 David Capello
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
//
Move doc::Context to app::Context (#378) We've moved everything related to Context/active site/observable documents from "doc" namespace to "app" namespace.
2018-07-07 13:47:42 +08:00
// This program is distributed under the terms of
// the End-User License Agreement for Aseprite.
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
Move doc::Context to app::Context (#378) We've moved everything related to Context/active site/observable documents from "doc" namespace to "app" namespace.
2018-07-07 13:47:42 +08:00
#ifndef APP_DOC_OBSERVER_H_INCLUDED
#define APP_DOC_OBSERVER_H_INCLUDED
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
#pragma once
[lua] Add remaptileset event for sprites
2022-12-28 01:11:05 +08:00
namespace doc {
class Remap;
}
Move doc::Context to app::Context (#378) We've moved everything related to Context/active site/observable documents from "doc" namespace to "app" namespace.
2018-07-07 13:47:42 +08:00
namespace app {
Rename app::Document -> Doc
2018-07-07 22:54:44 +08:00
class Doc;
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
class DocEvent;
clang-format all files
2024-12-16 21:10:34 +08:00
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
class DocObserver {
public:
virtual ~DocObserver() {}
clang-format all files
2024-12-16 21:10:34 +08:00
Fix deadlock destroying SpriteEvents disconnecting observers onCloseDocument Instead of using an onDestroy(Document), which can be called from the ClosedDocs background thread, we can disconnect all Doc observers on a new onCloseDocument() event called from Doc::close() (from the UI thread). This deadlock issue was commented here: https://github.com/aseprite/aseprite/pull/3009#issue-1029413592
2021-10-19 23:43:56 +08:00
virtual void onCloseDocument(Doc* doc) {}
Rename app::Document -> Doc
2018-07-07 22:54:44 +08:00
virtual void onFileNameChanged(Doc* doc) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
// General update. If an observer receives this event, it's because
// anything in the document could be changed.
virtual void onGeneralUpdate(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Manage color profiles (fix #1576)
2018-10-19 02:29:16 +08:00
virtual void onColorSpaceChanged(DocEvent& ev) {}
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
virtual void onPixelFormatChanged(DocEvent& ev) {}
Refresh screen/current palette automatically on Transaction::commit() (#378) Removed app_update_current_palette() with this patch.
2019-10-01 20:24:03 +08:00
virtual void onPaletteChanged(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
virtual void onAddLayer(DocEvent& ev) {}
virtual void onAddFrame(DocEvent& ev) {}
virtual void onAddCel(DocEvent& ev) {}
Add ability to edit multiple slices Related to #721 and #1651, still need more work to give a better UX to edit static and animated slices.
2019-05-03 03:26:13 +08:00
virtual void onAddSlice(DocEvent& ev) {}
Rename FrameTag -> Tag
2019-10-02 01:55:08 +08:00
virtual void onAddTag(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
virtual void onBeforeRemoveLayer(DocEvent& ev) {}
virtual void onAfterRemoveLayer(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
// Called when a frame is removed. It's called after the frame was
// removed, and the sprite's total number of frames is modified.
virtual void onRemoveFrame(DocEvent& ev) {}
Rename FrameTag -> Tag
2019-10-02 01:55:08 +08:00
virtual void onRemoveTag(DocEvent& ev) {}
Fix crash using opacity slider on CelProperties after deleting a cel Crash report: https://igarastudio.zendesk.com/agent/tickets/1208
2020-08-04 21:40:42 +08:00
virtual void onBeforeRemoveCel(DocEvent& ev) {}
virtual void onAfterRemoveCel(DocEvent& ev) {}
Add ability to edit multiple slices Related to #721 and #1651, still need more work to give a better UX to edit static and animated slices.
2019-05-03 03:26:13 +08:00
virtual void onRemoveSlice(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
virtual void onSpriteSizeChanged(DocEvent& ev) {}
virtual void onSpriteTransparentColorChanged(DocEvent& ev) {}
virtual void onSpritePixelRatioChanged(DocEvent& ev) {}
Save grid bounds inside .aseprite files and doc::Sprite (fix #688)
2019-10-11 02:08:59 +08:00
virtual void onSpriteGridBoundsChanged(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
virtual void onLayerNameChange(DocEvent& ev) {}
virtual void onLayerOpacityChange(DocEvent& ev) {}
virtual void onLayerBlendModeChange(DocEvent& ev) {}
virtual void onLayerRestacked(DocEvent& ev) {}
virtual void onLayerMergedDown(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
virtual void onCelMoved(DocEvent& ev) {}
virtual void onCelCopied(DocEvent& ev) {}
virtual void onCelFrameChanged(DocEvent& ev) {}
virtual void onCelPositionChanged(DocEvent& ev) {}
virtual void onCelOpacityChange(DocEvent& ev) {}
Add z-index property to cels (fix aseprite/Attachment-System#88) * Now a Cel has a z-index property to change the order of layers per frame * A new doc::RenderPlan class can calculate the order of cels to be rendered * z-index is saved as a int16_t in the .aseprite files * This new field can be set/get from Lua with Cel.zIndex
2023-04-11 04:44:22 +08:00
virtual void onCelZIndexChange(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
UI user data window integration
2020-09-11 02:49:08 +08:00
virtual void onUserDataChange(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
virtual void onFrameDurationChanged(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
virtual void onImagePixelsModified(DocEvent& ev) {}
virtual void onSpritePixelsModified(DocEvent& ev) {}
virtual void onExposeSpritePixels(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
// When the number of total frames available is modified.
virtual void onTotalFramesChanged(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
// The selection has changed.
virtual void onSelectionChanged(DocEvent& ev) {}
Generate selection boundaries automatically after transactions Now Transaction::commit() will regenerate mask boundaries automatically if in the middle of the transaction the document selection was modified. This is the first step to finally remove update_screen_for_document() and any kind of manual screen refresh. This will be useful for scripting functions that modify the selection too, because we wouldn't need to regenerate the selection boundaries automatically from the script or from app.refresh() Lua function. Related to #378
2019-02-16 04:14:44 +08:00
virtual void onSelectionBoundariesChanged(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Fix timeline re-painting issue when changing tag range (#3242)
2022-04-26 01:00:26 +08:00
// When the tag range changes
Fix playback of same tag when adding new frames (fix https://community.aseprite.org/t/6486)
2020-07-28 05:17:48 +08:00
virtual void onTagChange(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Fix timeline re-painting issue when changing tag range (#3242)
2022-04-26 01:00:26 +08:00
// When the tag is renamed
Fix timeline re-painting issue when renaming a tag (#3242)
2022-04-26 00:32:16 +08:00
virtual void onTagRename(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Improve context bar for slice tool (combobox of slices + action buttons)
2019-05-07 21:28:37 +08:00
// Slices
virtual void onSliceNameChange(DocEvent& ev) {}
Add slices copy&paste and duplication (fix #4466)
2025-03-08 05:03:49 +08:00
virtual void onBeforeSlicesDuplication(DocEvent& ev) {}
virtual void onSliceDuplicated(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Add tilemap layers (#977) This is the first commit with a simple tilemap editor. Still buggy but functional in several ways. Several changes were made: * NewLayer command can receive a tilemap=true to create a new tilemap layer * New ToggleTilesMode command added to switch between the palette and the tileset in the ColorBar (the ColorBar was expanded to show colors or tilesets with a generic AbstractPaletteViewAdapter) * All commands to create new layers were moved to Layer > New... submenu * There are a new tileset chunk to save tilesets in .aseprite files, and a new kind of cels to save tilemaps * Added doc::LayerTilemap, doc::Tileset, etc. and several other types to handle tilesets/tilemaps in the doc layer. * Added doc::Grid class with grid specifications that indicates how a tilemap <-> tileset must be drawn * Added and expanded cel operations to work with tilemaps and conversions between regular LayerImage cels <-> LayerTilemap cels (e.g. copy cels in the timeline between layer types)
2019-03-30 02:57:10 +08:00
// The tileset has changed.
virtual void onTilesetChanged(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Fix bug where Layer > Open Group didn't update the Timeline rows
2022-10-25 04:17:06 +08:00
// The collapsed/expanded flag of a specific layer changed.
virtual void onLayerCollapsedChanged(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Drop selection when we hide a layer that is being transformed (fix #4179, fix #3254) This fixes several problems in MovingPixelsState where hidden layers were transformed anyway when we switched the visibility of a layer in this state. Other fix was tried before in #3254 but we needed the onBefore/After layer visibility change notifications to make this work properly (i.e. drop pixels when the visiblity of a layer is changed). The only drawback at this moment is that changing the visibility of the non-active layer when we are transforming multiple cels/timeline range can be confused because we don't have #2144/#2865 implemented yet. This bug was originally reported here: https://community.aseprite.org/t/20621
2024-02-27 00:11:26 +08:00
// The visibility flag of a specific layer is going to change/changed.
virtual void onBeforeLayerVisibilityChange(DocEvent& ev, bool newState) {}
virtual void onAfterLayerVisibilityChange(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Fix locking a layer reverts changes (fix #4586)
2024-12-12 01:42:14 +08:00
// The editable flag of a specific layer is going to change/changed.
virtual void onBeforeLayerEditableChange(DocEvent& ev, bool newState) {}
[lua] Add remaptileset event for sprites
2022-12-28 01:11:05 +08:00
// The tileset was remapped (e.g. when tiles are re-ordered).
virtual void onRemapTileset(DocEvent& ev, const doc::Remap& remap) {}
clang-format all files
2024-12-16 21:10:34 +08:00
Add property to disable the standard tilemap UI Added a Sprite.tileManagementPlugin property for plugins that want to replace the standard tilemap/tileset interface. This includes a new external file field in .aseprite files to specify that the sprite tiles are controlled by a specific plugin. Once this property is set, the standard tilemap/tileset modes selectors will disappear and the only way to make then available will be setting this property to nil/empty string again. Fix https://github.com/aseprite/Attachment-System/issues/21
2023-02-16 05:49:36 +08:00
// When the tile management plugin property is changed.
virtual void onTileManagementPluginChange(DocEvent& ev) {}
clang-format all files
2024-12-16 21:10:34 +08:00
[lua] Add new AfterAddTile event for tile management plugins Replaced the App BeforePaintEmptyTilemap event (introduced in c26351712a21dece24ffee1b0a05ed4686412792) with the new Sprite AfterAddTile event triggered by draw_image_into_new_tilemap_cel(). This new event handles two cases: 1) When the user paints on an empty tilemap cel, a new tile is created, so the tile management plugin can handle AfterAddTile to know the existence of this new tile. (This case was disabled with fae3c6566cd87e0b5fcf788deab742b781876c4a, then handled with c26351712a21dece24ffee1b0a05ed4686412792, now handled with this patch). 2) When we copy & paste cels (or drag & drop cels) in the timeline between layers, if a new tile is created, the AfterAddTile is called and the plugin can associate tiles with its internal information (e.g. folders) Related to: https://github.com/aseprite/Attachment-System/issues/135
2023-07-08 05:40:06 +08:00
// When a new tilemap cel/tile is created in certain situations,
// like after drawing in an empty tilemap cel, or when we paste a
// cel into an empty tilemap cel, so a new tile is created.
//
// This is useful for a tile management plugin to know when a new
// tile is added automatically by the editor or the timeline
// through draw_image_into_new_tilemap_cel(), and the plugin can
// do some extra work with it.
//
// Warning: This must be triggered from the UI thread (because
// scripts will listen this event).
virtual void onAfterAddTile(DocEvent& ev) {}
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
};
Move doc::Context to app::Context (#378) We've moved everything related to Context/active site/observable documents from "doc" namespace to "app" namespace.
2018-07-07 13:47:42 +08:00
} // namespace app
Rename DocumentObserver/Event to DocObserver/Event
2018-07-07 08:06:03 +08:00
#endif