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

EditorPanel for room list selection. More...

#include <dungeon_room_selector_panel.h>

Inheritance diagram for yaze::editor::DungeonRoomSelectorPanel:
Collaboration diagram for yaze::editor::DungeonRoomSelectorPanel:

Public Member Functions

 DungeonRoomSelectorPanel (DungeonRoomSelector *selector, std::function< void(int)> on_room_selected=nullptr)
 Construct a new panel wrapping a DungeonRoomSelector.
 
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.
 
void SetRoomSelectedCallback (std::function< void(int)> callback)
 Set the callback for room selection events.
 
DungeonRoomSelectorselector () const
 Get the underlying selector component.
 
- 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

DungeonRoomSelectorselector_ = nullptr
 
std::function< void(int)> on_room_selected_
 

Detailed Description

EditorPanel for room list selection.

This panel provides room selection UI for the Dungeon Editor. Selecting a room will open/focus the room's resource panel.

Features

  • Room list with search/filter
  • Click to open room as resource panel
See also
DungeonRoomSelector - The underlying component
EditorPanel - Base interface

Definition at line 28 of file dungeon_room_selector_panel.h.

Constructor & Destructor Documentation

◆ DungeonRoomSelectorPanel()

yaze::editor::DungeonRoomSelectorPanel::DungeonRoomSelectorPanel ( DungeonRoomSelector * selector,
std::function< void(int)> on_room_selected = nullptr )
inlineexplicit

Construct a new panel wrapping a DungeonRoomSelector.

Parameters
selectorThe room selector component (must outlive this panel)
on_room_selectedCallback when a room is selected (opens resource panel)

Definition at line 35 of file dungeon_room_selector_panel.h.

References on_room_selected_, selector_, and yaze::editor::DungeonRoomSelector::SetRoomSelectedCallback().

Here is the call graph for this function:

Member Function Documentation

◆ GetId()

std::string yaze::editor::DungeonRoomSelectorPanel::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 49 of file dungeon_room_selector_panel.h.

◆ GetDisplayName()

std::string yaze::editor::DungeonRoomSelectorPanel::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 50 of file dungeon_room_selector_panel.h.

◆ GetIcon()

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

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::EditorPanel.

Definition at line 51 of file dungeon_room_selector_panel.h.

References ICON_MD_LIST.

◆ GetEditorCategory()

std::string yaze::editor::DungeonRoomSelectorPanel::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 52 of file dungeon_room_selector_panel.h.

◆ GetPriority()

int yaze::editor::DungeonRoomSelectorPanel::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 53 of file dungeon_room_selector_panel.h.

◆ Draw()

void yaze::editor::DungeonRoomSelectorPanel::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 59 of file dungeon_room_selector_panel.h.

References yaze::editor::DungeonRoomSelector::DrawRoomSelector(), and selector_.

Here is the call graph for this function:

◆ SetRoomSelectedCallback()

void yaze::editor::DungeonRoomSelectorPanel::SetRoomSelectedCallback ( std::function< void(int)> callback)
inline

Set the callback for room selection events.

Parameters
callbackFunction to call when a room is selected

Definition at line 74 of file dungeon_room_selector_panel.h.

References on_room_selected_, selector_, and yaze::editor::DungeonRoomSelector::SetRoomSelectedCallback().

Here is the call graph for this function:

◆ selector()

DungeonRoomSelector * yaze::editor::DungeonRoomSelectorPanel::selector ( ) const
inline

Get the underlying selector component.

Returns
Pointer to DungeonRoomSelector

Definition at line 85 of file dungeon_room_selector_panel.h.

References selector_.

Member Data Documentation

◆ selector_

DungeonRoomSelector* yaze::editor::DungeonRoomSelectorPanel::selector_ = nullptr
private

◆ on_room_selected_

std::function<void(int)> yaze::editor::DungeonRoomSelectorPanel::on_room_selected_
private

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