yaze::editor::ScreenEditor Class Reference

The ScreenEditor class allows the user to edit a variety of screens in the game or create a custom menu. More...

#include <screen_editor.h>

Inheritance diagram for yaze::editor::ScreenEditor:

Public Member Functions
	ScreenEditor (Rom *rom=nullptr)
void	Initialize () override
absl::Status	Load () override
absl::Status	Update () override
absl::Status	Undo () override
absl::Status	Redo () override
absl::Status	Cut () override
absl::Status	Copy () override
absl::Status	Paste () override
absl::Status	Find () override
absl::Status	Save () override
void	set_rom (Rom *rom)
Rom *	rom () const
Public Member Functions inherited from yaze::editor::Editor
	Editor ()=default
virtual	~Editor ()=default
virtual void	SetDependencies (const EditorDependencies &deps)
virtual void	SetGameData (zelda3::GameData *game_data)
virtual std::string	GetUndoDescription () const
virtual std::string	GetRedoDescription () const
const UndoManager &	undo_manager () const
virtual absl::Status	Clear ()
virtual void	ContributeStatus (StatusBar *)
EditorType	type () const
bool *	active ()
void	set_active (bool active)
void	toggle_active ()
virtual bool	IsRomLoaded () const
virtual std::string	GetRomStatus () const
Rom *	rom () const
zelda3::GameData *	game_data () const
EditorContext	context () const
bool	HasContext () const

Public Attributes
std::vector< zelda3::DungeonMap >	dungeon_maps_

Private Types
enum class	EditingMode { DRAW , EDIT }

Private Member Functions
void	DrawTitleScreenEditor ()
void	DrawNamingScreenEditor ()
void	DrawOverworldMapEditor ()
void	DrawInventoryMenuEditor ()
void	DrawInventoryItemIcons ()
void	DrawToolset ()
void	DrawDungeonMapToolset ()
void	DrawInventoryToolset ()
void	DrawTitleScreenCompositeCanvas ()
void	DrawTitleScreenBG1Canvas ()
void	DrawTitleScreenBG2Canvas ()
void	DrawTitleScreenBlocksetSelector ()
absl::Status	LoadDungeonMapTile16 (const std::vector< uint8_t > &gfx_data, bool bin_mode=false)
absl::Status	SaveDungeonMapTile16 ()
void	DrawDungeonMapScreen (int i)
void	DrawDungeonMapsTabs ()
void	DrawDungeonMapsEditor ()
	Draw dungeon maps editor with enhanced ROM hacking features.
void	DrawDungeonMapsRoomGfx ()
	Draw dungeon room graphics editor with enhanced tile16 editing.
void	LoadBinaryGfx ()
ScreenSnapshot	CaptureDungeonMapSnapshot () const
ScreenSnapshot	CaptureTile16CompSnapshot () const
void	SaveDungeonMapUndoState (const std::string &description)
void	SaveTile16CompUndoState (const std::string &description)
void	CommitDungeonMapUndo ()
void	CommitTile16CompUndo ()
void	RestoreFromSnapshot (const ScreenSnapshot &snapshot)

Private Attributes
EditingMode	current_mode_ = EditingMode::DRAW
bool	binary_gfx_loaded_ = false
uint8_t	selected_room = 0
int	selected_tile16_ = 0
int	selected_tile8_ = 0
int	selected_dungeon = 0
int	floor_number = 1
bool	copy_button_pressed = false
bool	paste_button_pressed = false
zelda3::DungeonMapLabels	dungeon_map_labels_
gfx::SnesPalette	palette_
gfx::BitmapTable	sheets_
gfx::Tilemap	tile16_blockset_
gfx::Tilemap	tile8_tilemap_
std::array< gfx::TileInfo, 4 >	current_tile16_info
gui::Canvas	current_tile_canvas_
gui::Canvas	screen_canvas_
gui::Canvas	tilesheet_canvas_
gui::Canvas	tilemap_canvas_
gui::Canvas	title_bg1_canvas_
gui::Canvas	title_bg2_canvas_
gui::Canvas	title_blockset_canvas_
zelda3::Inventory	inventory_
bool	inventory_loaded_ = false
zelda3::TitleScreen	title_screen_
zelda3::OverworldMapScreen	ow_map_screen_
int	selected_title_tile16_ = 0
bool	title_screen_loaded_ = false
bool	title_h_flip_ = false
bool	title_v_flip_ = false
int	title_palette_ = 0
bool	show_title_bg1_ = true
bool	show_title_bg2_ = true
int	selected_ow_tile_ = 0
bool	ow_map_loaded_ = false
bool	ow_show_dark_world_ = false
gui::Canvas	ow_map_canvas_
gui::Canvas	ow_tileset_canvas_
bool	has_pending_dungeon_undo_ = false
bool	has_pending_tile16_undo_ = false
ScreenSnapshot	pending_dungeon_before_
ScreenSnapshot	pending_tile16_before_
std::string	pending_dungeon_desc_
std::string	pending_tile16_desc_
Rom *	rom_
absl::Status	status_

Additional Inherited Members
Protected Member Functions inherited from yaze::editor::Editor
std::string	MakePanelTitle (const std::string &base_title) const
std::string	MakeWindowId (const std::string &base_id) const
template<typename T >
absl::StatusOr< T >	SafeRomAccess (std::function< T()> accessor, const std::string &operation="") const
Protected Attributes inherited from yaze::editor::Editor
bool	active_ = false
EditorType	type_
EditorDependencies	dependencies_
UndoManager	undo_manager_

Detailed Description

The ScreenEditor class allows the user to edit a variety of screens in the game or create a custom menu.

This class is currently a work in progress (WIP) and provides functionality for updating the screens, saving dungeon maps, drawing different types of screens, loading dungeon maps, and managing various properties related to the editor.

The screens that can be edited include the title screen, naming screen, overworld map, inventory menu, and more.

Definition at line 37 of file screen_editor.h.

Member Enumeration Documentation

EditingMode

enum class yaze::editor::ScreenEditor::EditingMode

strongprivate

Enumerator
DRAW
EDIT

Definition at line 96 of file screen_editor.h.

Constructor & Destructor Documentation

ScreenEditor()

yaze::editor::ScreenEditor::ScreenEditor ( Rom * rom = nullptr )

inlineexplicit

Definition at line 39 of file screen_editor.h.

References yaze::editor::kScreen, screen_canvas_, yaze::gui::Canvas::SetCanvasSize(), and yaze::editor::Editor::type_.

Here is the call graph for this function:

Member Function Documentation

Initialize()

void yaze::editor::ScreenEditor::Initialize ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 28 of file screen_editor.cc.

References yaze::editor::Editor::dependencies_, DrawDungeonMapsEditor(), DrawInventoryMenuEditor(), DrawNamingScreenEditor(), DrawOverworldMapEditor(), DrawTitleScreenEditor(), ICON_MD_EDIT, ICON_MD_INVENTORY, ICON_MD_MAP, ICON_MD_PUBLIC, ICON_MD_TITLE, yaze::Rom::is_loaded(), yaze::editor::WorkspaceWindowManager::RegisterPanel(), rom(), and yaze::editor::EditorDependencies::window_manager.

Load()

absl::Status yaze::editor::ScreenEditor::Load ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 100 of file screen_editor.cc.

References ASSIGN_OR_RETURN, yaze::gfx::Tilemap::atlas, yaze::gfx::Bitmap::Create(), yaze::gfx::Arena::CREATE, yaze::gfx::PaletteGroupMap::dungeon_main, dungeon_map_labels_, dungeon_maps_, yaze::editor::Editor::game_data(), yaze::gfx::Arena::Get(), inventory_loaded_, yaze::zelda3::LoadDungeonMaps(), yaze::zelda3::LoadDungeonMapTile16(), yaze::gfx::Tilemap::map_size, yaze::gfx::PaletteGroup::mutable_palette(), yaze::zelda3::GameData::palette_groups, yaze::gfx::Arena::QueueTextureCommand(), RETURN_IF_ERROR, rom(), yaze::gfx::Bitmap::SetPalette(), sheets_, tile16_blockset_, tile8_tilemap_, and yaze::gfx::Tilemap::tile_size.

Update()

absl::Status yaze::editor::ScreenEditor::Update ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 175 of file screen_editor.cc.

References status_.

Undo()

absl::Status yaze::editor::ScreenEditor::Undo ( )

inlineoverridevirtual

Implements yaze::editor::Editor.

Definition at line 47 of file screen_editor.h.

References yaze::editor::UndoManager::Undo(), and yaze::editor::Editor::undo_manager_.

Referenced by DrawInventoryToolset().

Here is the call graph for this function:

Redo()

absl::Status yaze::editor::ScreenEditor::Redo ( )

inlineoverridevirtual

Implements yaze::editor::Editor.

Definition at line 48 of file screen_editor.h.

References yaze::editor::UndoManager::Redo(), and yaze::editor::Editor::undo_manager_.

Referenced by DrawInventoryToolset().

Here is the call graph for this function:

Cut()

absl::Status yaze::editor::ScreenEditor::Cut ( )

inlineoverridevirtual

Implements yaze::editor::Editor.

Definition at line 49 of file screen_editor.h.

Copy()

absl::Status yaze::editor::ScreenEditor::Copy ( )

inlineoverridevirtual

Implements yaze::editor::Editor.

Definition at line 50 of file screen_editor.h.

Paste()

absl::Status yaze::editor::ScreenEditor::Paste ( )

inlineoverridevirtual

Implements yaze::editor::Editor.

Definition at line 51 of file screen_editor.h.

Find()

absl::Status yaze::editor::ScreenEditor::Find ( )

inlineoverridevirtual

Implements yaze::editor::Editor.

Definition at line 52 of file screen_editor.h.

Save()

absl::Status yaze::editor::ScreenEditor::Save ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 165 of file screen_editor.cc.

References dungeon_maps_, yaze::core::FeatureFlags::get(), RETURN_IF_ERROR, rom(), and yaze::zelda3::SaveDungeonMaps().

Here is the call graph for this function:

set_rom()

void yaze::editor::ScreenEditor::set_rom ( Rom * rom )

inline

Definition at line 54 of file screen_editor.h.

References rom(), and rom_.

Here is the call graph for this function:

rom()

Rom * yaze::editor::ScreenEditor::rom ( ) const

inline

Definition at line 55 of file screen_editor.h.

References rom_.

Referenced by DrawDungeonMapsEditor(), DrawInventoryMenuEditor(), DrawOverworldMapEditor(), DrawTitleScreenEditor(), Initialize(), Load(), LoadBinaryGfx(), Save(), and set_rom().

DrawTitleScreenEditor()

void yaze::editor::ScreenEditor::DrawTitleScreenEditor ( )

private

Definition at line 829 of file screen_editor.cc.

References yaze::zelda3::TitleScreen::composite_bitmap(), yaze::zelda3::TitleScreen::Create(), current_mode_, DRAW, DrawTitleScreenBlocksetSelector(), DrawTitleScreenCompositeCanvas(), yaze::editor::Editor::game_data(), yaze::gfx::Arena::Get(), yaze::editor::AgentUI::GetTheme(), ICON_MD_DRAW, ICON_MD_SAVE, yaze::gfx::Arena::QueueTextureCommand(), yaze::zelda3::TitleScreen::RenderCompositeLayer(), rom(), yaze::zelda3::TitleScreen::Save(), selected_title_tile16_, show_title_bg1_, show_title_bg2_, status_, title_screen_, title_screen_loaded_, and yaze::gfx::Arena::UPDATE.

Referenced by Initialize().

DrawNamingScreenEditor()

void yaze::editor::ScreenEditor::DrawNamingScreenEditor ( )

private

Definition at line 1089 of file screen_editor.cc.

Referenced by Initialize().

DrawOverworldMapEditor()

void yaze::editor::ScreenEditor::DrawOverworldMapEditor ( )

private

Definition at line 1091 of file screen_editor.cc.

References yaze::zelda3::OverworldMapScreen::Create(), current_mode_, DRAW, yaze::gui::Canvas::DrawBackground(), yaze::gui::Canvas::DrawBitmap(), yaze::gui::Canvas::DrawContextMenu(), yaze::gui::Canvas::DrawGrid(), yaze::gui::Canvas::DrawOverlay(), yaze::gui::Canvas::DrawTileSelector(), yaze::zelda3::OverworldMapScreen::dw_palette(), yaze::gfx::Arena::Get(), yaze::editor::AgentUI::GetTheme(), ICON_MD_DRAW, ICON_MD_SAVE, yaze::gui::InlinePaletteEditor(), yaze::zelda3::OverworldMapScreen::LoadCustomMap(), yaze::zelda3::OverworldMapScreen::lw_palette(), yaze::zelda3::OverworldMapScreen::map_bitmap(), yaze::zelda3::OverworldMapScreen::mutable_dw_tiles(), yaze::zelda3::OverworldMapScreen::mutable_lw_tiles(), ow_map_canvas_, ow_map_loaded_, ow_map_screen_, ow_show_dark_world_, ow_tileset_canvas_, yaze::gui::Canvas::points(), yaze::gfx::Arena::QueueTextureCommand(), yaze::zelda3::OverworldMapScreen::RenderMapLayer(), rom(), yaze::zelda3::OverworldMapScreen::Save(), yaze::zelda3::OverworldMapScreen::SaveCustomMap(), selected_ow_tile_, yaze::util::FileDialogWrapper::ShowOpenFileDialog(), yaze::util::FileDialogWrapper::ShowSaveFileDialog(), status_, yaze::zelda3::OverworldMapScreen::tiles8_bitmap(), and yaze::gfx::Arena::UPDATE.

Referenced by Initialize().

DrawInventoryMenuEditor()

void yaze::editor::ScreenEditor::DrawInventoryMenuEditor ( )

private

Definition at line 187 of file screen_editor.cc.

References yaze::gui::BeginCanvas(), yaze::zelda3::Inventory::bitmap(), yaze::gui::CanvasFrameOptions::canvas_size, yaze::zelda3::Inventory::Create(), yaze::gui::DisplayPalette(), yaze::gui::CanvasFrameOptions::draw_grid, yaze::gui::DrawBitmap(), DrawInventoryItemIcons(), DrawInventoryToolset(), yaze::gui::EndCanvas(), yaze::editor::Editor::game_data(), yaze::editor::AgentUI::GetTheme(), yaze::gui::CanvasFrameOptions::grid_step, inventory_, inventory_loaded_, yaze::zelda3::Inventory::palette(), palette_, yaze::gui::CanvasFrameOptions::render_popups, rom(), screen_canvas_, status_, yaze::zelda3::Inventory::tilesheet(), and tilesheet_canvas_.

Referenced by Initialize().

DrawInventoryItemIcons()

void yaze::editor::ScreenEditor::DrawInventoryItemIcons ( )

private

Todo

Select this icon for editing

Definition at line 302 of file screen_editor.cc.

References inventory_, and yaze::zelda3::Inventory::item_icons().

Referenced by DrawInventoryMenuEditor().

Here is the call graph for this function:

DrawToolset()

void yaze::editor::ScreenEditor::DrawToolset ( )

private

Definition at line 182 of file screen_editor.cc.

DrawDungeonMapToolset()

void yaze::editor::ScreenEditor::DrawDungeonMapToolset ( )

private

Definition at line 1259 of file screen_editor.cc.

DrawInventoryToolset()

void yaze::editor::ScreenEditor::DrawInventoryToolset ( )

private

Definition at line 253 of file screen_editor.cc.

References yaze::editor::UndoManager::CanRedo(), yaze::editor::UndoManager::CanUndo(), current_mode_, DRAW, ICON_MD_BUILD, ICON_MD_DRAW, ICON_MD_MORE_VERT, ICON_MD_REDO, ICON_MD_UNDO, ICON_MD_ZOOM_IN, ICON_MD_ZOOM_OUT, Redo(), screen_canvas_, status_, yaze::gui::ToolbarIconButton(), Undo(), yaze::editor::Editor::undo_manager_, yaze::gui::Canvas::ZoomIn(), and yaze::gui::Canvas::ZoomOut().

Referenced by DrawInventoryMenuEditor().

DrawTitleScreenCompositeCanvas()

void yaze::editor::ScreenEditor::DrawTitleScreenCompositeCanvas ( )

private

Definition at line 904 of file screen_editor.cc.

References yaze::zelda3::TitleScreen::bg1_bitmap(), yaze::zelda3::TitleScreen::composite_bitmap(), current_mode_, DRAW, yaze::gui::Canvas::DrawBackground(), yaze::gui::Canvas::DrawBitmap(), yaze::gui::Canvas::DrawContextMenu(), yaze::gui::Canvas::DrawGrid(), yaze::gui::Canvas::DrawOverlay(), yaze::gui::Canvas::DrawTileSelector(), yaze::gfx::Arena::Get(), yaze::zelda3::TitleScreen::mutable_bg1_buffer(), yaze::gui::Canvas::points(), yaze::gfx::Arena::QueueTextureCommand(), yaze::zelda3::TitleScreen::RenderBG1Layer(), yaze::zelda3::TitleScreen::RenderCompositeLayer(), selected_title_tile16_, show_title_bg1_, show_title_bg2_, status_, title_bg1_canvas_, title_h_flip_, title_palette_, title_screen_, title_v_flip_, and yaze::gfx::Arena::UPDATE.

Referenced by DrawTitleScreenEditor().

DrawTitleScreenBG1Canvas()

void yaze::editor::ScreenEditor::DrawTitleScreenBG1Canvas ( )

private

Definition at line 959 of file screen_editor.cc.

References yaze::zelda3::TitleScreen::bg1_bitmap(), current_mode_, DRAW, yaze::gui::Canvas::DrawBackground(), yaze::gui::Canvas::DrawBitmap(), yaze::gui::Canvas::DrawContextMenu(), yaze::gui::Canvas::DrawGrid(), yaze::gui::Canvas::DrawOverlay(), yaze::gui::Canvas::DrawTileSelector(), yaze::gfx::Arena::Get(), yaze::zelda3::TitleScreen::mutable_bg1_buffer(), yaze::gui::Canvas::points(), yaze::gfx::Arena::QueueTextureCommand(), yaze::zelda3::TitleScreen::RenderBG1Layer(), selected_title_tile16_, status_, title_bg1_canvas_, title_h_flip_, title_palette_, title_screen_, title_v_flip_, and yaze::gfx::Arena::UPDATE.

DrawTitleScreenBG2Canvas()

void yaze::editor::ScreenEditor::DrawTitleScreenBG2Canvas ( )

private

Definition at line 1004 of file screen_editor.cc.

References yaze::zelda3::TitleScreen::bg2_bitmap(), current_mode_, DRAW, yaze::gui::Canvas::DrawBackground(), yaze::gui::Canvas::DrawBitmap(), yaze::gui::Canvas::DrawContextMenu(), yaze::gui::Canvas::DrawGrid(), yaze::gui::Canvas::DrawOverlay(), yaze::gui::Canvas::DrawTileSelector(), yaze::gfx::Arena::Get(), yaze::zelda3::TitleScreen::mutable_bg2_buffer(), yaze::gui::Canvas::points(), yaze::gfx::Arena::QueueTextureCommand(), yaze::zelda3::TitleScreen::RenderBG2Layer(), selected_title_tile16_, status_, title_bg2_canvas_, title_h_flip_, title_palette_, title_screen_, title_v_flip_, and yaze::gfx::Arena::UPDATE.

DrawTitleScreenBlocksetSelector()

void yaze::editor::ScreenEditor::DrawTitleScreenBlocksetSelector ( )

private

Definition at line 1049 of file screen_editor.cc.

References yaze::gui::Canvas::DrawBackground(), yaze::gui::Canvas::DrawBitmap(), yaze::gui::Canvas::DrawContextMenu(), yaze::gui::Canvas::DrawGrid(), yaze::gui::Canvas::DrawOverlay(), yaze::gui::Canvas::DrawTileSelector(), yaze::gui::Canvas::points(), selected_title_tile16_, yaze::zelda3::TitleScreen::tiles8_bitmap(), title_blockset_canvas_, title_h_flip_, title_palette_, title_screen_, and title_v_flip_.

Referenced by DrawTitleScreenEditor().

LoadDungeonMapTile16()

absl::Status yaze::editor::ScreenEditor::LoadDungeonMapTile16 ( const std::vector< uint8_t > & gfx_data, bool bin_mode = false )

private

SaveDungeonMapTile16()

absl::Status yaze::editor::ScreenEditor::SaveDungeonMapTile16 ( )

private

DrawDungeonMapScreen()

void yaze::editor::ScreenEditor::DrawDungeonMapScreen ( int i )

private

Definition at line 356 of file screen_editor.cc.

References yaze::gfx::Tilemap::atlas, yaze::gfx::TileCache::CacheTile(), yaze::gfx::Arena::CREATE, yaze::gui::Canvas::DrawBackground(), yaze::gui::Canvas::DrawBitmap(), yaze::gui::Canvas::DrawGrid(), yaze::gui::Canvas::DrawOutlineWithColor(), yaze::gui::Canvas::DrawOverlay(), yaze::gui::Canvas::DrawText(), yaze::gui::Canvas::DrawTileSelector(), dungeon_map_labels_, dungeon_maps_, floor_number, yaze::gfx::Arena::Get(), yaze::gfx::Bitmap::Get16x16Tile(), yaze::editor::AgentUI::GetTheme(), yaze::gfx::TileCache::GetTile(), yaze::util::HexByte(), yaze::zelda3::kNumRooms, yaze::gfx::Bitmap::palette(), yaze::gui::Canvas::points(), yaze::gfx::Arena::QueueTextureCommand(), screen_canvas_, selected_dungeon, selected_room, yaze::gfx::Bitmap::set_data(), yaze::gfx::Bitmap::SetPalette(), tile16_blockset_, yaze::gfx::Tilemap::tile_cache, and yaze::gfx::Bitmap::width().

Referenced by DrawDungeonMapsTabs().

DrawDungeonMapsTabs()

void yaze::editor::ScreenEditor::DrawDungeonMapsTabs ( )

private

Definition at line 455 of file screen_editor.cc.

References yaze::gui::BeginThemedTabBar(), CaptureDungeonMapSnapshot(), CommitDungeonMapUndo(), copy_button_pressed, DrawDungeonMapScreen(), dungeon_map_labels_, dungeon_maps_, yaze::gui::EndThemedTabBar(), floor_number, yaze::gui::InputHexByte(), yaze::gui::InputHexWord(), paste_button_pressed, yaze::editor::UndoManager::Push(), RestoreFromSnapshot(), SaveDungeonMapUndoState(), selected_dungeon, selected_room, and yaze::editor::Editor::undo_manager_.

Referenced by DrawDungeonMapsEditor().

DrawDungeonMapsEditor()

void yaze::editor::ScreenEditor::DrawDungeonMapsEditor ( )

private

Draw dungeon maps editor with enhanced ROM hacking features.

Enhanced Features:

• Multi-mode editing (DRAW, EDIT, SELECT)
• Real-time tile16 preview and editing
• Floor/basement management for complex dungeons
• Copy/paste operations for floor layouts
• Integration with ROM tile16 data

Performance Notes:

• Lazy loading of dungeon graphics
• Cached tile16 rendering for fast updates
• Batch operations for multiple tile changes
• Efficient memory management for large dungeons

Definition at line 728 of file screen_editor.cc.

References current_mode_, DRAW, yaze::gui::Canvas::DrawBackground(), yaze::gui::Canvas::DrawBitmapTable(), yaze::gui::Canvas::DrawContextMenu(), DrawDungeonMapsRoomGfx(), DrawDungeonMapsTabs(), yaze::gui::Canvas::DrawGrid(), yaze::gui::Canvas::DrawOverlay(), yaze::gui::Canvas::DrawTileSelector(), EDIT, yaze::gui::Canvas::GetTileIdFromMousePos(), ICON_MD_DRAW, ICON_MD_EDIT, ICON_MD_SAVE, LoadBinaryGfx(), PRINT_IF_ERROR, yaze::Rom::resource_label(), rom(), yaze::zelda3::SaveDungeonMapTile16(), yaze::project::ResourceLabelManager::SelectableLabelWithNameEdit(), selected_dungeon, selected_tile8_, sheets_, tile16_blockset_, tilemap_canvas_, and yaze::gui::ToolbarIconButton().

Referenced by Initialize().

DrawDungeonMapsRoomGfx()

void yaze::editor::ScreenEditor::DrawDungeonMapsRoomGfx ( )

private

Draw dungeon room graphics editor with enhanced tile16 editing.

Enhanced Features:

• Interactive tile16 selector with visual feedback
• Real-time tile16 composition from 4x 8x8 tiles
• Tile metadata editing (mirroring, palette, etc.)
• Integration with ROM graphics buffer
• Undo/redo support for tile modifications

Performance Notes:

• Cached tile16 rendering to avoid repeated composition
• Efficient tile selector with grid-based snapping
• Batch tile updates to minimize ROM writes
• Lazy loading of tile graphics data

Definition at line 558 of file screen_editor.cc.

References yaze::gfx::Tilemap::atlas, yaze::gui::BeginCanvas(), yaze::gfx::TileCache::CacheTile(), yaze::gui::CanvasFrameOptions::canvas_size, CommitDungeonMapUndo(), CommitTile16CompUndo(), yaze::gfx::Arena::CREATE, current_tile16_info, current_tile_canvas_, yaze::gfx::Bitmap::data(), yaze::gui::CanvasFrameOptions::draw_grid, yaze::gui::DrawBitmap(), yaze::gui::Canvas::DrawTilePainter(), yaze::gui::DrawTileSelector(), dungeon_maps_, yaze::gui::EndCanvas(), floor_number, yaze::editor::Editor::game_data(), yaze::gfx::Arena::Get(), yaze::gfx::TileCache::GetTile(), yaze::gui::CanvasFrameOptions::grid_step, yaze::gui::InputTileInfo(), yaze::gui::Canvas::IsMouseHovering(), yaze::gfx::ModifyTile16(), yaze::gui::Canvas::mutable_points(), yaze::gfx::Bitmap::palette(), yaze::gui::Canvas::points(), yaze::gfx::Arena::QueueTextureCommand(), yaze::gui::CanvasFrameOptions::render_popups, yaze::gfx::RenderTile16(), SaveDungeonMapUndoState(), SaveTile16CompUndoState(), screen_canvas_, selected_dungeon, selected_room, selected_tile16_, selected_tile8_, yaze::gfx::Bitmap::SetPalette(), yaze::gfx::Bitmap::size(), tile16_blockset_, tile8_tilemap_, yaze::gfx::Tilemap::tile_cache, yaze::gfx::Tilemap::tile_info, tilesheet_canvas_, yaze::gfx::UpdateTile16(), and yaze::gfx::Bitmap::width().

Referenced by DrawDungeonMapsEditor().

LoadBinaryGfx()

void yaze::editor::ScreenEditor::LoadBinaryGfx ( )

private

Definition at line 796 of file screen_editor.cc.

References binary_gfx_loaded_, yaze::gfx::Arena::CREATE, yaze::editor::Editor::game_data(), yaze::gfx::Arena::Get(), yaze::zelda3::LoadDungeonMapTile16(), yaze::gfx::Arena::QueueTextureCommand(), rom(), sheets_, yaze::util::FileDialogWrapper::ShowOpenFileDialog(), yaze::gfx::SnesTo8bppSheet(), status_, and tile16_blockset_.

Referenced by DrawDungeonMapsEditor().

CaptureDungeonMapSnapshot()

ScreenSnapshot yaze::editor::ScreenEditor::CaptureDungeonMapSnapshot ( ) const

private

Definition at line 1283 of file screen_editor.cc.

References yaze::editor::DungeonMapSnapshot::dungeon_index, yaze::editor::ScreenSnapshot::dungeon_map, dungeon_map_labels_, dungeon_maps_, yaze::editor::ScreenSnapshot::edit_type, yaze::editor::kDungeonMap, yaze::editor::DungeonMapSnapshot::labels, yaze::editor::DungeonMapSnapshot::map_data, and selected_dungeon.

Referenced by CommitDungeonMapUndo(), DrawDungeonMapsTabs(), and SaveDungeonMapUndoState().

CaptureTile16CompSnapshot()

ScreenSnapshot yaze::editor::ScreenEditor::CaptureTile16CompSnapshot ( ) const

private

Definition at line 1295 of file screen_editor.cc.

References current_tile16_info, yaze::editor::ScreenSnapshot::edit_type, yaze::editor::kTile16Edit, selected_tile16_, yaze::editor::ScreenSnapshot::tile16_comp, yaze::editor::Tile16CompSnapshot::tile16_id, and yaze::editor::Tile16CompSnapshot::tile_info.

Referenced by CommitTile16CompUndo(), and SaveTile16CompUndoState().

SaveDungeonMapUndoState()

void yaze::editor::ScreenEditor::SaveDungeonMapUndoState ( const std::string & description )

private

Definition at line 1303 of file screen_editor.cc.

References CaptureDungeonMapSnapshot(), has_pending_dungeon_undo_, pending_dungeon_before_, and pending_dungeon_desc_.

Referenced by DrawDungeonMapsRoomGfx(), and DrawDungeonMapsTabs().

Here is the call graph for this function:

SaveTile16CompUndoState()

void yaze::editor::ScreenEditor::SaveTile16CompUndoState ( const std::string & description )

private

Definition at line 1309 of file screen_editor.cc.

References CaptureTile16CompSnapshot(), has_pending_tile16_undo_, pending_tile16_before_, and pending_tile16_desc_.

Referenced by DrawDungeonMapsRoomGfx().

Here is the call graph for this function:

CommitDungeonMapUndo()

void yaze::editor::ScreenEditor::CommitDungeonMapUndo ( )

private

Definition at line 1315 of file screen_editor.cc.

References CaptureDungeonMapSnapshot(), has_pending_dungeon_undo_, pending_dungeon_before_, pending_dungeon_desc_, yaze::editor::UndoManager::Push(), RestoreFromSnapshot(), and yaze::editor::Editor::undo_manager_.

Referenced by DrawDungeonMapsRoomGfx(), and DrawDungeonMapsTabs().

Here is the call graph for this function:

CommitTile16CompUndo()

void yaze::editor::ScreenEditor::CommitTile16CompUndo ( )

private

Definition at line 1327 of file screen_editor.cc.

References CaptureTile16CompSnapshot(), has_pending_tile16_undo_, pending_tile16_before_, pending_tile16_desc_, yaze::editor::UndoManager::Push(), RestoreFromSnapshot(), and yaze::editor::Editor::undo_manager_.

Referenced by DrawDungeonMapsRoomGfx().

Here is the call graph for this function:

RestoreFromSnapshot()

void yaze::editor::ScreenEditor::RestoreFromSnapshot ( const ScreenSnapshot & snapshot )

private

Definition at line 1339 of file screen_editor.cc.

References current_tile16_info, yaze::editor::DungeonMapSnapshot::dungeon_index, yaze::editor::ScreenSnapshot::dungeon_map, dungeon_map_labels_, dungeon_maps_, yaze::editor::ScreenSnapshot::edit_type, yaze::editor::Editor::game_data(), yaze::editor::kDungeonMap, yaze::editor::kTile16Edit, yaze::editor::DungeonMapSnapshot::labels, yaze::editor::DungeonMapSnapshot::map_data, yaze::gfx::ModifyTile16(), selected_dungeon, selected_tile16_, tile16_blockset_, yaze::editor::ScreenSnapshot::tile16_comp, yaze::editor::Tile16CompSnapshot::tile16_id, yaze::editor::Tile16CompSnapshot::tile_info, and yaze::gfx::UpdateTile16().

Referenced by CommitDungeonMapUndo(), CommitTile16CompUndo(), and DrawDungeonMapsTabs().

Here is the call graph for this function:

Member Data Documentation

dungeon_maps_

std::vector<zelda3::DungeonMap> yaze::editor::ScreenEditor::dungeon_maps_

Definition at line 57 of file screen_editor.h.

Referenced by CaptureDungeonMapSnapshot(), DrawDungeonMapScreen(), DrawDungeonMapsRoomGfx(), DrawDungeonMapsTabs(), Load(), RestoreFromSnapshot(), and Save().

current_mode_

EditingMode yaze::editor::ScreenEditor::current_mode_ = EditingMode::DRAW

private

Definition at line 98 of file screen_editor.h.

Referenced by DrawDungeonMapsEditor(), DrawInventoryToolset(), DrawOverworldMapEditor(), DrawTitleScreenBG1Canvas(), DrawTitleScreenBG2Canvas(), DrawTitleScreenCompositeCanvas(), and DrawTitleScreenEditor().

binary_gfx_loaded_

bool yaze::editor::ScreenEditor::binary_gfx_loaded_ = false

private

Definition at line 100 of file screen_editor.h.

Referenced by LoadBinaryGfx().

selected_room

uint8_t yaze::editor::ScreenEditor::selected_room = 0

private

Definition at line 102 of file screen_editor.h.

Referenced by DrawDungeonMapScreen(), DrawDungeonMapsRoomGfx(), and DrawDungeonMapsTabs().

selected_tile16_

int yaze::editor::ScreenEditor::selected_tile16_ = 0

private

Definition at line 104 of file screen_editor.h.

Referenced by CaptureTile16CompSnapshot(), DrawDungeonMapsRoomGfx(), and RestoreFromSnapshot().

selected_tile8_

int yaze::editor::ScreenEditor::selected_tile8_ = 0

private

Definition at line 105 of file screen_editor.h.

Referenced by DrawDungeonMapsEditor(), and DrawDungeonMapsRoomGfx().

selected_dungeon

int yaze::editor::ScreenEditor::selected_dungeon = 0

private

Definition at line 106 of file screen_editor.h.

Referenced by CaptureDungeonMapSnapshot(), DrawDungeonMapScreen(), DrawDungeonMapsEditor(), DrawDungeonMapsRoomGfx(), DrawDungeonMapsTabs(), and RestoreFromSnapshot().

floor_number

int yaze::editor::ScreenEditor::floor_number = 1

private

Definition at line 107 of file screen_editor.h.

Referenced by DrawDungeonMapScreen(), DrawDungeonMapsRoomGfx(), and DrawDungeonMapsTabs().

copy_button_pressed

bool yaze::editor::ScreenEditor::copy_button_pressed = false

private

Definition at line 109 of file screen_editor.h.

Referenced by DrawDungeonMapsTabs().

paste_button_pressed

bool yaze::editor::ScreenEditor::paste_button_pressed = false

private

Definition at line 110 of file screen_editor.h.

Referenced by DrawDungeonMapsTabs().

dungeon_map_labels_

zelda3::DungeonMapLabels yaze::editor::ScreenEditor::dungeon_map_labels_

private

Definition at line 112 of file screen_editor.h.

Referenced by CaptureDungeonMapSnapshot(), DrawDungeonMapScreen(), DrawDungeonMapsTabs(), Load(), and RestoreFromSnapshot().

palette_

gfx::SnesPalette yaze::editor::ScreenEditor::palette_

private

Definition at line 114 of file screen_editor.h.

Referenced by DrawInventoryMenuEditor().

sheets_

gfx::BitmapTable yaze::editor::ScreenEditor::sheets_

private

Definition at line 115 of file screen_editor.h.

Referenced by DrawDungeonMapsEditor(), Load(), and LoadBinaryGfx().

tile16_blockset_

gfx::Tilemap yaze::editor::ScreenEditor::tile16_blockset_

private

Definition at line 116 of file screen_editor.h.

Referenced by DrawDungeonMapScreen(), DrawDungeonMapsEditor(), DrawDungeonMapsRoomGfx(), Load(), LoadBinaryGfx(), and RestoreFromSnapshot().

tile8_tilemap_

gfx::Tilemap yaze::editor::ScreenEditor::tile8_tilemap_

private

Definition at line 117 of file screen_editor.h.

Referenced by DrawDungeonMapsRoomGfx(), and Load().

current_tile16_info

std::array<gfx::TileInfo, 4> yaze::editor::ScreenEditor::current_tile16_info

private

Definition at line 118 of file screen_editor.h.

Referenced by CaptureTile16CompSnapshot(), DrawDungeonMapsRoomGfx(), and RestoreFromSnapshot().

current_tile_canvas_

gui::Canvas yaze::editor::ScreenEditor::current_tile_canvas_

private

Initial value:

{"##CurrentTileCanvas", ImVec2(32, 32),
                                   gui::CanvasGridSize::k16x16, 2.0f}

Definition at line 120 of file screen_editor.h.

Referenced by DrawDungeonMapsRoomGfx().

screen_canvas_

gui::Canvas yaze::editor::ScreenEditor::screen_canvas_

private

Definition at line 122 of file screen_editor.h.

Referenced by DrawDungeonMapScreen(), DrawDungeonMapsRoomGfx(), DrawInventoryMenuEditor(), DrawInventoryToolset(), and ScreenEditor().

tilesheet_canvas_

gui::Canvas yaze::editor::ScreenEditor::tilesheet_canvas_

private

Definition at line 123 of file screen_editor.h.

Referenced by DrawDungeonMapsRoomGfx(), and DrawInventoryMenuEditor().

tilemap_canvas_

gui::Canvas yaze::editor::ScreenEditor::tilemap_canvas_

private

Initial value:

{"##TilemapCanvas", ImVec2(128 + 2, (192) + 4),
                              gui::CanvasGridSize::k8x8, 2.f}

Definition at line 124 of file screen_editor.h.

Referenced by DrawDungeonMapsEditor().

title_bg1_canvas_

gui::Canvas yaze::editor::ScreenEditor::title_bg1_canvas_

private

Initial value:

{"##TitleBG1Canvas", ImVec2(256, 256),
                                gui::CanvasGridSize::k8x8, 2.0f}

Definition at line 129 of file screen_editor.h.

Referenced by DrawTitleScreenBG1Canvas(), and DrawTitleScreenCompositeCanvas().

title_bg2_canvas_

gui::Canvas yaze::editor::ScreenEditor::title_bg2_canvas_

private

Initial value:

{"##TitleBG2Canvas", ImVec2(256, 256),
                                gui::CanvasGridSize::k8x8, 2.0f}

Definition at line 131 of file screen_editor.h.

Referenced by DrawTitleScreenBG2Canvas().

title_blockset_canvas_

gui::Canvas yaze::editor::ScreenEditor::title_blockset_canvas_

private

Initial value:

{"##TitleBlocksetCanvas", ImVec2(128, 512),
                                     gui::CanvasGridSize::k8x8, 2.0f}

Definition at line 134 of file screen_editor.h.

Referenced by DrawTitleScreenBlocksetSelector().

inventory_

zelda3::Inventory yaze::editor::ScreenEditor::inventory_

private

Definition at line 137 of file screen_editor.h.

Referenced by DrawInventoryItemIcons(), and DrawInventoryMenuEditor().

inventory_loaded_

bool yaze::editor::ScreenEditor::inventory_loaded_ = false

private

Definition at line 138 of file screen_editor.h.

Referenced by DrawInventoryMenuEditor(), and Load().

title_screen_

zelda3::TitleScreen yaze::editor::ScreenEditor::title_screen_

private

Definition at line 139 of file screen_editor.h.

Referenced by DrawTitleScreenBG1Canvas(), DrawTitleScreenBG2Canvas(), DrawTitleScreenBlocksetSelector(), DrawTitleScreenCompositeCanvas(), and DrawTitleScreenEditor().

ow_map_screen_

zelda3::OverworldMapScreen yaze::editor::ScreenEditor::ow_map_screen_

private

Definition at line 140 of file screen_editor.h.

Referenced by DrawOverworldMapEditor().

selected_title_tile16_

int yaze::editor::ScreenEditor::selected_title_tile16_ = 0

private

Definition at line 143 of file screen_editor.h.

Referenced by DrawTitleScreenBG1Canvas(), DrawTitleScreenBG2Canvas(), DrawTitleScreenBlocksetSelector(), DrawTitleScreenCompositeCanvas(), and DrawTitleScreenEditor().

title_screen_loaded_

bool yaze::editor::ScreenEditor::title_screen_loaded_ = false

private

Definition at line 144 of file screen_editor.h.

Referenced by DrawTitleScreenEditor().

title_h_flip_

bool yaze::editor::ScreenEditor::title_h_flip_ = false

private

Definition at line 145 of file screen_editor.h.

Referenced by DrawTitleScreenBG1Canvas(), DrawTitleScreenBG2Canvas(), DrawTitleScreenBlocksetSelector(), and DrawTitleScreenCompositeCanvas().

title_v_flip_

bool yaze::editor::ScreenEditor::title_v_flip_ = false

private

Definition at line 146 of file screen_editor.h.

Referenced by DrawTitleScreenBG1Canvas(), DrawTitleScreenBG2Canvas(), DrawTitleScreenBlocksetSelector(), and DrawTitleScreenCompositeCanvas().

title_palette_

int yaze::editor::ScreenEditor::title_palette_ = 0

private

Definition at line 147 of file screen_editor.h.

Referenced by DrawTitleScreenBG1Canvas(), DrawTitleScreenBG2Canvas(), DrawTitleScreenBlocksetSelector(), and DrawTitleScreenCompositeCanvas().

show_title_bg1_

bool yaze::editor::ScreenEditor::show_title_bg1_ = true

private

Definition at line 148 of file screen_editor.h.

Referenced by DrawTitleScreenCompositeCanvas(), and DrawTitleScreenEditor().

show_title_bg2_

bool yaze::editor::ScreenEditor::show_title_bg2_ = true

private

Definition at line 149 of file screen_editor.h.

Referenced by DrawTitleScreenCompositeCanvas(), and DrawTitleScreenEditor().

selected_ow_tile_

int yaze::editor::ScreenEditor::selected_ow_tile_ = 0

private

Definition at line 152 of file screen_editor.h.

Referenced by DrawOverworldMapEditor().

ow_map_loaded_

bool yaze::editor::ScreenEditor::ow_map_loaded_ = false

private

Definition at line 153 of file screen_editor.h.

Referenced by DrawOverworldMapEditor().

ow_show_dark_world_

bool yaze::editor::ScreenEditor::ow_show_dark_world_ = false

private

Definition at line 154 of file screen_editor.h.

Referenced by DrawOverworldMapEditor().

ow_map_canvas_

gui::Canvas yaze::editor::ScreenEditor::ow_map_canvas_

private

Initial value:

{"##OWMapCanvas", ImVec2(512, 512),
                             gui::CanvasGridSize::k8x8, 1.0f}

Definition at line 157 of file screen_editor.h.

Referenced by DrawOverworldMapEditor().

ow_tileset_canvas_

gui::Canvas yaze::editor::ScreenEditor::ow_tileset_canvas_

private

Initial value:

{"##OWTilesetCanvas", ImVec2(128, 128),
                                 gui::CanvasGridSize::k8x8, 2.0f}

Definition at line 159 of file screen_editor.h.

Referenced by DrawOverworldMapEditor().

has_pending_dungeon_undo_

bool yaze::editor::ScreenEditor::has_pending_dungeon_undo_ = false

private

Definition at line 163 of file screen_editor.h.

Referenced by CommitDungeonMapUndo(), and SaveDungeonMapUndoState().

has_pending_tile16_undo_

bool yaze::editor::ScreenEditor::has_pending_tile16_undo_ = false

private

Definition at line 164 of file screen_editor.h.

Referenced by CommitTile16CompUndo(), and SaveTile16CompUndoState().

pending_dungeon_before_

ScreenSnapshot yaze::editor::ScreenEditor::pending_dungeon_before_

private

Definition at line 165 of file screen_editor.h.

Referenced by CommitDungeonMapUndo(), and SaveDungeonMapUndoState().

pending_tile16_before_

ScreenSnapshot yaze::editor::ScreenEditor::pending_tile16_before_

private

Definition at line 166 of file screen_editor.h.

Referenced by CommitTile16CompUndo(), and SaveTile16CompUndoState().

pending_dungeon_desc_

std::string yaze::editor::ScreenEditor::pending_dungeon_desc_

private

Definition at line 167 of file screen_editor.h.

Referenced by CommitDungeonMapUndo(), and SaveDungeonMapUndoState().

pending_tile16_desc_

std::string yaze::editor::ScreenEditor::pending_tile16_desc_

private

Definition at line 168 of file screen_editor.h.

Referenced by CommitTile16CompUndo(), and SaveTile16CompUndoState().

rom_

Rom* yaze::editor::ScreenEditor::rom_

private

Definition at line 170 of file screen_editor.h.

Referenced by rom(), and set_rom().

status_

absl::Status yaze::editor::ScreenEditor::status_

private

Definition at line 171 of file screen_editor.h.

Referenced by DrawInventoryMenuEditor(), DrawInventoryToolset(), DrawOverworldMapEditor(), DrawTitleScreenBG1Canvas(), DrawTitleScreenBG2Canvas(), DrawTitleScreenCompositeCanvas(), DrawTitleScreenEditor(), LoadBinaryGfx(), and Update().

---

The documentation for this class was generated from the following files:

• src/app/editor/graphics/screen_editor.h
• src/app/editor/graphics/screen_editor.cc