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

EditorPanel wrapper for PaletteEditorWidget in dungeon context. More...

#include <dungeon_palette_editor_panel.h>

Inheritance diagram for yaze::editor::DungeonPaletteEditorPanel:
Collaboration diagram for yaze::editor::DungeonPaletteEditorPanel:

Public Member Functions

 DungeonPaletteEditorPanel (gui::PaletteEditorWidget *palette_editor)
 
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 Draw (bool *p_open) override
 Draw the panel content.
 
gui::PaletteEditorWidgetpalette_editor () const
 
void SetCurrentRoomPalette (int palette_id)
 Set the current palette ID based on the active room.
 
- Public Member Functions inherited from yaze::editor::EditorPanel
virtual ~EditorPanel ()=default
 
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 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.
 

Private Attributes

gui::PaletteEditorWidgetpalette_editor_ = nullptr
 

Detailed Description

EditorPanel wrapper for PaletteEditorWidget in dungeon context.

This panel provides palette editing specifically for dungeon rooms, wrapping the PaletteEditorWidget component.

See also
PaletteEditorWidget - The underlying component
EditorPanel - Base interface

Definition at line 23 of file dungeon_palette_editor_panel.h.

Constructor & Destructor Documentation

◆ DungeonPaletteEditorPanel()

yaze::editor::DungeonPaletteEditorPanel::DungeonPaletteEditorPanel ( gui::PaletteEditorWidget * palette_editor)
inlineexplicit

Definition at line 25 of file dungeon_palette_editor_panel.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::DungeonPaletteEditorPanel::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 dungeon_palette_editor_panel.h.

◆ GetDisplayName()

std::string yaze::editor::DungeonPaletteEditorPanel::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 dungeon_palette_editor_panel.h.

◆ GetIcon()

std::string yaze::editor::DungeonPaletteEditorPanel::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 dungeon_palette_editor_panel.h.

References ICON_MD_PALETTE.

◆ GetEditorCategory()

std::string yaze::editor::DungeonPaletteEditorPanel::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 dungeon_palette_editor_panel.h.

◆ GetPriority()

int yaze::editor::DungeonPaletteEditorPanel::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 dungeon_palette_editor_panel.h.

◆ Draw()

void yaze::editor::DungeonPaletteEditorPanel::Draw ( bool * p_open)
inlineoverridevirtual

Draw the panel content.

Parameters
p_openPointer to visibility flag (nullptr if not closable)

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

Implements yaze::editor::EditorPanel.

Definition at line 42 of file dungeon_palette_editor_panel.h.

References yaze::gui::PaletteEditorWidget::Draw(), and palette_editor_.

Here is the call graph for this function:

◆ palette_editor()

gui::PaletteEditorWidget * yaze::editor::DungeonPaletteEditorPanel::palette_editor ( ) const
inline

Definition at line 51 of file dungeon_palette_editor_panel.h.

References palette_editor_.

◆ SetCurrentRoomPalette()

void yaze::editor::DungeonPaletteEditorPanel::SetCurrentRoomPalette ( int palette_id)
inline

Set the current palette ID based on the active room.

Parameters
palette_idThe palette ID from the room

Definition at line 57 of file dungeon_palette_editor_panel.h.

References palette_editor_, and yaze::gui::PaletteEditorWidget::SetCurrentPaletteId().

Here is the call graph for this function:

Member Data Documentation

◆ palette_editor_

gui::PaletteEditorWidget* yaze::editor::DungeonPaletteEditorPanel::palette_editor_ = nullptr
private

Definition at line 64 of file dungeon_palette_editor_panel.h.

Referenced by Draw(), palette_editor(), and SetCurrentRoomPalette().


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