yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
yaze::editor::PalettesetEditorView Class Reference

Dedicated view for editing dungeon palette sets. More...

#include <paletteset_editor_view.h>

Inheritance diagram for yaze::editor::PalettesetEditorView:
Collaboration diagram for yaze::editor::PalettesetEditorView:

Public Member Functions

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.
 
float GetPreferredWidth () const override
 Get preferred width for this panel (optional)
 
void Draw (bool *p_open) override
 Draw the panel content.
 
absl::Status Update ()
 
void SetRom (Rom *rom)
 
Romrom () const
 
void SetGameData (zelda3::GameData *data)
 
zelda3::GameDatagame_data () const
 
- Public Member Functions inherited from yaze::editor::WindowContent
virtual ~WindowContent ()=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 WindowLifecycle GetWindowLifecycle () const
 Get the lifecycle category for this window.
 
virtual WindowContextScope GetContextScope () const
 Optional context binding for this window (room/selection/etc)
 
virtual WindowScope GetScope () const
 Get the registration scope for this window.
 
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 std::string GetWorkflowGroup () const
 Optional workflow group for hack-centric actions.
 
virtual std::string GetWorkflowLabel () const
 Optional workflow label for menus/command palette.
 
virtual std::string GetWorkflowDescription () const
 Optional workflow description for menus/command palette.
 
virtual int GetWorkflowPriority () const
 Optional workflow ordering priority (lower sorts first).
 
virtual bool PreferAutoHideTabBar () const
 Whether the dock node hosting this panel should auto-hide its tab bar.
 
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 DrawPalettesetList ()
 
void DrawPalettesetEditor ()
 
void DrawPalettePreview (gfx::SnesPalette &palette, const char *label)
 
void DrawPaletteGrid (gfx::SnesPalette &palette, bool editable=false)
 

Private Attributes

uint8_t selected_paletteset_ = 0
 
bool show_all_colors_ = false
 
Romrom_ = nullptr
 
zelda3::GameDatagame_data_ = nullptr
 

Additional Inherited Members

- Protected Member Functions inherited from yaze::editor::WindowContent
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

Dedicated view for editing dungeon palette sets.

A paletteset defines which palettes are used together in a dungeon room:

  • Dungeon Main: The primary background/tileset palette
  • Sprite Aux 1-3: Three auxiliary sprite palettes for enemies/NPCs

This view allows inspecting and editing these associations, providing a better UX than the combined GfxGroupEditor tab.

Definition at line 27 of file paletteset_editor_view.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::PalettesetEditorView::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::WindowContent.

Definition at line 29 of file paletteset_editor_view.h.

◆ GetDisplayName()

std::string yaze::editor::PalettesetEditorView::GetDisplayName ( ) const
inlineoverridevirtual

Human-readable name shown in menus and title bars.

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

Implements yaze::editor::WindowContent.

Definition at line 30 of file paletteset_editor_view.h.

◆ GetIcon()

std::string yaze::editor::PalettesetEditorView::GetIcon ( ) const
inlineoverridevirtual

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::WindowContent.

Definition at line 31 of file paletteset_editor_view.h.

References ICON_MD_COLOR_LENS.

◆ GetEditorCategory()

std::string yaze::editor::PalettesetEditorView::GetEditorCategory ( ) const
inlineoverridevirtual

Editor category this panel belongs to.

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

Implements yaze::editor::WindowContent.

Definition at line 32 of file paletteset_editor_view.h.

◆ GetPriority()

int yaze::editor::PalettesetEditorView::GetPriority ( ) const
inlineoverridevirtual

Get display priority for menu ordering.

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

Reimplemented from yaze::editor::WindowContent.

Definition at line 33 of file paletteset_editor_view.h.

◆ GetPreferredWidth()

float yaze::editor::PalettesetEditorView::GetPreferredWidth ( ) const
inlineoverridevirtual

Get preferred width for this panel (optional)

Returns
Preferred width in pixels, or 0 to use default (250px)

Override this to specify content-based sizing. For example, a tile selector with 8 tiles at 16px × 2.0 scale would return ~276px.

Reimplemented from yaze::editor::WindowContent.

Definition at line 34 of file paletteset_editor_view.h.

◆ Draw()

void yaze::editor::PalettesetEditorView::Draw ( bool * p_open)
overridevirtual

Draw the panel content.

Parameters
p_openPointer to visibility flag (nullptr if not closable)

Called by WorkspaceWindowManager when the panel is visible. Do NOT call ImGui::Begin/End - the PanelWindow wrapper handles that. Just draw your content directly.

Implements yaze::editor::WindowContent.

Definition at line 37 of file paletteset_editor_view.cc.

References Update().

Here is the call graph for this function:

◆ Update()

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

Definition at line 41 of file paletteset_editor_view.cc.

References DrawPalettesetEditor(), DrawPalettesetList(), game_data(), ICON_MD_PALETTE, rom(), and show_all_colors_.

Referenced by Draw().

Here is the call graph for this function:

◆ SetRom()

void yaze::editor::PalettesetEditorView::SetRom ( Rom * rom)
inline

Definition at line 38 of file paletteset_editor_view.h.

References rom(), and rom_.

Here is the call graph for this function:

◆ rom()

Rom * yaze::editor::PalettesetEditorView::rom ( ) const
inline

Definition at line 39 of file paletteset_editor_view.h.

References rom_.

Referenced by DrawPalettesetEditor(), SetRom(), and Update().

◆ SetGameData()

void yaze::editor::PalettesetEditorView::SetGameData ( zelda3::GameData * data)
inline

Definition at line 40 of file paletteset_editor_view.h.

References game_data_.

◆ game_data()

zelda3::GameData * yaze::editor::PalettesetEditorView::game_data ( ) const
inline

Definition at line 41 of file paletteset_editor_view.h.

References game_data_.

Referenced by DrawPalettesetEditor(), and Update().

◆ DrawPalettesetList()

void yaze::editor::PalettesetEditorView::DrawPalettesetList ( )
private

Definition at line 76 of file paletteset_editor_view.cc.

References selected_paletteset_.

Referenced by Update().

◆ DrawPalettesetEditor()

◆ DrawPalettePreview()

void yaze::editor::PalettesetEditorView::DrawPalettePreview ( gfx::SnesPalette & palette,
const char * label )
private

Definition at line 174 of file paletteset_editor_view.cc.

References DrawPaletteGrid().

Referenced by DrawPalettesetEditor().

Here is the call graph for this function:

◆ DrawPaletteGrid()

void yaze::editor::PalettesetEditorView::DrawPaletteGrid ( gfx::SnesPalette & palette,
bool editable = false )
private

Definition at line 181 of file paletteset_editor_view.cc.

References yaze::gfx::SnesPalette::empty(), show_all_colors_, yaze::gfx::SnesPalette::size(), and yaze::gui::SnesColorButton().

Referenced by DrawPalettePreview().

Here is the call graph for this function:

Member Data Documentation

◆ selected_paletteset_

uint8_t yaze::editor::PalettesetEditorView::selected_paletteset_ = 0
private

Definition at line 49 of file paletteset_editor_view.h.

Referenced by DrawPalettesetEditor(), and DrawPalettesetList().

◆ show_all_colors_

bool yaze::editor::PalettesetEditorView::show_all_colors_ = false
private

Definition at line 50 of file paletteset_editor_view.h.

Referenced by DrawPaletteGrid(), and Update().

◆ rom_

Rom* yaze::editor::PalettesetEditorView::rom_ = nullptr
private

Definition at line 52 of file paletteset_editor_view.h.

Referenced by rom(), and SetRom().

◆ game_data_

zelda3::GameData* yaze::editor::PalettesetEditorView::game_data_ = nullptr
private

Definition at line 53 of file paletteset_editor_view.h.

Referenced by game_data(), and SetGameData().


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