Panel for managing palettes applied to graphics sheets. More...

#include <palette_controls_panel.h>

Inheritance diagram for yaze::editor::PaletteControlsPanel:

Collaboration diagram for yaze::editor::PaletteControlsPanel:

[legend]

Public Member Functions
	PaletteControlsPanel (GraphicsEditorState state, Rom rom, zelda3::GameData *game_data=nullptr)

void	SetGameData (zelda3::GameData *game_data)

std::string	GetId () const override
	Unique identifier for this panel.

std::string	GetDisplayName () const override
	Human-readable name shown in menus and title bars.

std::string	GetIcon () const override
	Material Design icon for this panel.

std::string	GetEditorCategory () const override
	Editor category this panel belongs to.

int	GetPriority () const override
	Get display priority for menu ordering.

void	Initialize ()
	Initialize the panel.

void	Draw (bool *p_open) override
	Draw the palette controls UI (EditorPanel interface)

absl::Status	Update ()
	Legacy Update method for backward compatibility.

Public Member Functions inherited from yaze::editor::EditorPanel
virtual	~EditorPanel ()=default

virtual void	OnFirstDraw ()
	Called once before the first Draw() in a session.

virtual bool	RequiresLazyInit () const
	Whether this panel uses lazy initialization.

void	InvalidateLazyInit ()
	Reset lazy init state so OnFirstDraw() runs again.

virtual void	OnOpen ()
	Called when panel becomes visible.

virtual void	OnClose ()
	Called when panel is hidden.

virtual void	OnFocus ()
	Called when panel receives focus.

virtual PanelCategory	GetPanelCategory () const
	Get the lifecycle category for this panel.

virtual PanelContextScope	GetContextScope () const
	Optional context binding for this panel (room/selection/etc)

virtual PanelScope	GetScope () const
	Get the registration scope for this panel.

virtual bool	IsEnabled () const
	Check if this panel is currently enabled.

virtual std::string	GetDisabledTooltip () const
	Get tooltip text when panel is disabled.

virtual std::string	GetShortcutHint () const
	Get keyboard shortcut hint for display.

virtual float	GetPreferredWidth () const
	Get preferred width for this panel (optional)

virtual bool	IsVisibleByDefault () const
	Whether this panel should be visible by default.

virtual std::string	GetParentPanelId () const
	Get parent panel ID for cascade behavior.

virtual bool	CascadeCloseChildren () const
	Whether closing this panel should close child panels.

void	DrawWithLazyInit (bool *p_open)
	Execute lazy initialization if needed, then call Draw()

Private Member Functions
void	DrawPresets ()
	Draw quick preset buttons.

void	DrawPaletteGroupSelector ()
	Draw palette group selection.

void	DrawPaletteDisplay ()
	Draw the current palette display.

void	DrawApplyButtons ()
	Draw apply buttons.

void	ApplyPaletteToSheet (uint16_t sheet_id)
	Apply current palette to specified sheet.

void	ApplyPaletteToAllSheets ()
	Apply current palette to all active sheets.

Private Attributes
GraphicsEditorState *	state_

Rom *	rom_

zelda3::GameData *	game_data_ = nullptr

Additional Inherited Members
Protected Member Functions inherited from yaze::editor::EditorPanel
void	InvalidateCache ()
	Invalidate all cached computations.

template<typename T >
T &	GetCached (const std::string &key, std::function< T()> compute)
	Get or compute a cached value.

bool	IsCacheValid () const
	Check if cache has been invalidated.

void	ClearCache ()
	Clear all cached values (more aggressive than InvalidateCache)

Detailed Description

Panel for managing palettes applied to graphics sheets.

Provides palette group selection, quick presets, and apply-to-sheet functionality.

Definition at line 20 of file palette_controls_panel.h.

Constructor & Destructor Documentation

◆ PaletteControlsPanel()

yaze::editor::PaletteControlsPanel::PaletteControlsPanel	(	GraphicsEditorState *	state,
		Rom *	rom,
		zelda3::GameData *	game_data = nullptr )

inlineexplicit

Definition at line 22 of file palette_controls_panel.h.

Member Function Documentation

◆ SetGameData()

void yaze::editor::PaletteControlsPanel::SetGameData ( zelda3::GameData * game_data )

inline

Definition at line 26 of file palette_controls_panel.h.

References game_data_.

◆ GetId()

std::string yaze::editor::PaletteControlsPanel::GetId ( ) const

inlineoverridevirtual

Unique identifier for this panel.

Returns: Panel ID in format "{category}.{name}" (e.g., "dungeon.room_selector")

IDs should be:

Lowercase with underscores
Prefixed with editor category
Unique across all panels

Implements yaze::editor::EditorPanel.

Definition at line 32 of file palette_controls_panel.h.

◆ GetDisplayName()

std::string yaze::editor::PaletteControlsPanel::GetDisplayName ( ) const

inlineoverridevirtual

Human-readable name shown in menus and title bars.

Returns: Display name (e.g., "Room Selector")

Implements yaze::editor::EditorPanel.

Definition at line 33 of file palette_controls_panel.h.

◆ GetIcon()

std::string yaze::editor::PaletteControlsPanel::GetIcon ( ) const

inlineoverridevirtual

Material Design icon for this panel.

Returns: Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::EditorPanel.

Definition at line 34 of file palette_controls_panel.h.

References ICON_MD_PALETTE.

◆ GetEditorCategory()

std::string yaze::editor::PaletteControlsPanel::GetEditorCategory ( ) const

inlineoverridevirtual

Editor category this panel belongs to.

Returns: Category name matching EditorType (e.g., "Dungeon", "Overworld")

Implements yaze::editor::EditorPanel.

Definition at line 35 of file palette_controls_panel.h.

◆ GetPriority()

int yaze::editor::PaletteControlsPanel::GetPriority ( ) const

inlineoverridevirtual

Get display priority for menu ordering.

Returns: Priority value (lower = higher in list, default 50)

Reimplemented from yaze::editor::EditorPanel.

Definition at line 36 of file palette_controls_panel.h.

◆ Initialize()

void yaze::editor::PaletteControlsPanel::Initialize ( )

Initialize the panel.

Definition at line 108 of file palette_controls_panel.cc.

References yaze::editor::GraphicsEditorState::palette_group_index, yaze::editor::GraphicsEditorState::palette_index, state_, and yaze::editor::GraphicsEditorState::sub_palette_index.

◆ Draw()

void yaze::editor::PaletteControlsPanel::Draw ( bool * p_open )

overridevirtual

Draw the palette controls UI (EditorPanel interface)

Implements yaze::editor::EditorPanel.

Definition at line 115 of file palette_controls_panel.cc.

References DrawApplyButtons(), DrawPaletteDisplay(), DrawPaletteGroupSelector(), DrawPresets(), yaze::Rom::is_loaded(), and rom_.

◆ Update()

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

Legacy Update method for backward compatibility.

Returns: Status of the render operation

Definition at line 131 of file palette_controls_panel.cc.

References DrawApplyButtons(), DrawPaletteDisplay(), DrawPaletteGroupSelector(), DrawPresets(), yaze::Rom::is_loaded(), and rom_.

◆ DrawPresets()

void yaze::editor::PaletteControlsPanel::DrawPresets ( )

private

Draw quick preset buttons.

Definition at line 148 of file palette_controls_panel.cc.

References HOVER_HINT, ICON_MD_ACCOUNT_BOX, ICON_MD_CASTLE, ICON_MD_LANDSCAPE, ICON_MD_MENU, ICON_MD_PERSON, yaze::editor::GraphicsEditorState::palette_group_index, yaze::editor::GraphicsEditorState::palette_index, yaze::editor::GraphicsEditorState::refresh_graphics, state_, and yaze::gui::TextWithSeparators().

Referenced by Draw(), and Update().

Here is the call graph for this function:

◆ DrawPaletteGroupSelector()

void yaze::editor::PaletteControlsPanel::DrawPaletteGroupSelector ( )

private

Draw palette group selection.

Definition at line 193 of file palette_controls_panel.cc.

References yaze::gui::LayoutHelpers::GetComboWidth(), yaze::gui::LayoutHelpers::GetStandardInputWidth(), HOVER_HINT, yaze::editor::GraphicsEditorState::palette_group_index, yaze::editor::GraphicsEditorState::palette_index, yaze::editor::GraphicsEditorState::refresh_graphics, state_, yaze::editor::GraphicsEditorState::sub_palette_index, and yaze::gui::TextWithSeparators().

Referenced by Draw(), and Update().

Here is the call graph for this function:

◆ DrawPaletteDisplay()

void yaze::editor::PaletteControlsPanel::DrawPaletteDisplay ( )

private

Draw the current palette display.

Definition at line 226 of file palette_controls_panel.cc.

References game_data_, yaze::gfx::PaletteGroupMap::get_group(), yaze::gui::GetSelectedColor(), yaze::gui::GetWarningColor(), yaze::editor::GraphicsEditorState::palette_group_index, yaze::zelda3::GameData::palette_groups, yaze::editor::GraphicsEditorState::palette_index, yaze::editor::GraphicsEditorState::refresh_graphics, state_, yaze::editor::GraphicsEditorState::sub_palette_index, and yaze::gui::TextWithSeparators().

Referenced by Draw(), and Update().

Here is the call graph for this function:

◆ DrawApplyButtons()

void yaze::editor::PaletteControlsPanel::DrawApplyButtons ( )

private

Draw apply buttons.

Definition at line 323 of file palette_controls_panel.cc.

References ApplyPaletteToAllSheets(), ApplyPaletteToSheet(), yaze::editor::GraphicsEditorState::current_sheet_id, HOVER_HINT, ICON_MD_BRUSH, ICON_MD_CHECKLIST, ICON_MD_FORMAT_PAINT, ICON_MD_REFRESH, yaze::editor::GraphicsEditorState::open_sheets, yaze::editor::GraphicsEditorState::refresh_graphics, yaze::editor::GraphicsEditorState::selected_sheets, state_, and yaze::gui::TextWithSeparators().

Referenced by Draw(), and Update().

Here is the call graph for this function:

◆ ApplyPaletteToSheet()

void yaze::editor::PaletteControlsPanel::ApplyPaletteToSheet ( uint16_t sheet_id )

private

Apply current palette to specified sheet.

Definition at line 371 of file palette_controls_panel.cc.

References game_data_, yaze::gfx::Arena::Get(), yaze::gfx::PaletteGroupMap::get_group(), yaze::Rom::is_loaded(), yaze::gfx::Arena::mutable_gfx_sheets(), yaze::gfx::Arena::NotifySheetModified(), yaze::gfx::PaletteGroup::palette(), yaze::editor::GraphicsEditorState::palette_group_index, yaze::zelda3::GameData::palette_groups, yaze::editor::GraphicsEditorState::palette_index, rom_, state_, and yaze::editor::GraphicsEditorState::sub_palette_index.

Referenced by DrawApplyButtons().

◆ ApplyPaletteToAllSheets()

void yaze::editor::PaletteControlsPanel::ApplyPaletteToAllSheets ( )

private

Apply current palette to all active sheets.

Definition at line 407 of file palette_controls_panel.cc.

References game_data_, yaze::gfx::Arena::Get(), yaze::gfx::PaletteGroupMap::get_group(), yaze::Rom::is_loaded(), yaze::zelda3::kNumGfxSheets, yaze::gfx::Arena::mutable_gfx_sheets(), yaze::gfx::Arena::NotifySheetModified(), yaze::gfx::PaletteGroup::palette(), yaze::editor::GraphicsEditorState::palette_group_index, yaze::zelda3::GameData::palette_groups, yaze::editor::GraphicsEditorState::palette_index, rom_, state_, and yaze::editor::GraphicsEditorState::sub_palette_index.

Referenced by DrawApplyButtons().

Member Data Documentation

◆ state_

GraphicsEditorState* yaze::editor::PaletteControlsPanel::state_

private

Definition at line 89 of file palette_controls_panel.h.

Referenced by ApplyPaletteToAllSheets(), ApplyPaletteToSheet(), DrawApplyButtons(), DrawPaletteDisplay(), DrawPaletteGroupSelector(), DrawPresets(), and Initialize().

◆ rom_

Rom* yaze::editor::PaletteControlsPanel::rom_

private

Definition at line 90 of file palette_controls_panel.h.

Referenced by ApplyPaletteToAllSheets(), ApplyPaletteToSheet(), Draw(), and Update().

◆ game_data_

zelda3::GameData* yaze::editor::PaletteControlsPanel::game_data_ = nullptr

private

Definition at line 91 of file palette_controls_panel.h.

Referenced by ApplyPaletteToAllSheets(), ApplyPaletteToSheet(), DrawPaletteDisplay(), and SetGameData().

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

src/app/editor/graphics/palette_controls_panel.h
src/app/editor/graphics/palette_controls_panel.cc

	yaze 0.3.2 Link to the Past ROM Editor

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PaletteControlsPanel()

Member Function Documentation

◆ SetGameData()

◆ GetId()

◆ GetDisplayName()

◆ GetIcon()

◆ GetEditorCategory()

◆ GetPriority()

◆ Initialize()

◆ Draw()

◆ Update()

◆ DrawPresets()

◆ DrawPaletteGroupSelector()

◆ DrawPaletteDisplay()

◆ DrawApplyButtons()

◆ ApplyPaletteToSheet()

◆ ApplyPaletteToAllSheets()

Member Data Documentation

◆ state_

◆ rom_

◆ game_data_