EditorPanel for displaying a visual 16x19 grid of all dungeon rooms. More...

#include <dungeon_room_matrix_panel.h>

Inheritance diagram for yaze::editor::DungeonRoomMatrixPanel:

Collaboration diagram for yaze::editor::DungeonRoomMatrixPanel:

Public Member Functions
	DungeonRoomMatrixPanel (int current_room_id, ImVector< int > active_rooms, std::function< void(int)> on_room_selected, std::function< void(int, int)> on_room_swap=nullptr, std::array< zelda3::Room, 0x128 > *rooms=nullptr)
	Construct a room matrix panel.

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	SetRoomIntentCallback (std::function< void(int, RoomSelectionIntent)> callback)

void	Draw (bool *p_open) override
	Draw the panel content.

void	SetRooms (std::array< zelda3::Room, 0x128 > *rooms)

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
ImU32	GetRoomColor (int room_id, const AgentUITheme &theme)
	Get color for a room from dominant preview color, with fallback.

Private Attributes
int *	current_room_id_ = nullptr

ImVector< int > *	active_rooms_ = nullptr

std::array< zelda3::Room, 0x128 > *	rooms_ = nullptr

std::function< void(int)>	on_room_selected_

std::function< void(int, int)>	on_room_swap_

std::function< void(int, RoomSelectionIntent)>	on_room_intent_

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

EditorPanel for displaying a visual 16x19 grid of all dungeon rooms.

This panel provides a compact overview of all 296 dungeon rooms in a matrix layout. Users can click on cells to select and open rooms.

Features:

Responsive cell sizing based on panel width
Palette-based coloring when room data is available
Theme-aware selection highlighting

See also: EditorPanel - Base interface

Definition at line 39 of file dungeon_room_matrix_panel.h.

Constructor & Destructor Documentation

◆ DungeonRoomMatrixPanel()

yaze::editor::DungeonRoomMatrixPanel::DungeonRoomMatrixPanel	(	int *	current_room_id,
		ImVector< int > *	active_rooms,
		std::function< void(int)>	on_room_selected,
		std::function< void(int, int)>	on_room_swap = nullptr,
		std::array< zelda3::Room, 0x128 > *	rooms = nullptr )

inline

Construct a room matrix panel.

Parameters

current_room_id	Pointer to the current room ID (for highlighting)
active_rooms	Pointer to list of currently open rooms
on_room_selected	Callback when a room is clicked
rooms	Optional pointer to room array for palette-based coloring

Definition at line 48 of file dungeon_room_matrix_panel.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::DungeonRoomMatrixPanel::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 62 of file dungeon_room_matrix_panel.h.

◆ GetDisplayName()

std::string yaze::editor::DungeonRoomMatrixPanel::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 63 of file dungeon_room_matrix_panel.h.

◆ GetIcon()

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

inlineoverridevirtual

Material Design icon for this panel.

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

Implements yaze::editor::EditorPanel.

Definition at line 64 of file dungeon_room_matrix_panel.h.

References ICON_MD_GRID_VIEW.

◆ GetEditorCategory()

std::string yaze::editor::DungeonRoomMatrixPanel::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 65 of file dungeon_room_matrix_panel.h.

◆ GetPriority()

int yaze::editor::DungeonRoomMatrixPanel::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 66 of file dungeon_room_matrix_panel.h.

◆ SetRoomIntentCallback()

void yaze::editor::DungeonRoomMatrixPanel::SetRoomIntentCallback ( std::function< void(int, RoomSelectionIntent)> callback )

inline

Definition at line 68 of file dungeon_room_matrix_panel.h.

References on_room_intent_.

◆ Draw()

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

inlineoverridevirtual

Draw the panel content.

Parameters

p_open Pointer 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 77 of file dungeon_room_matrix_panel.h.

References active_rooms_, yaze::zelda3::RoomLayerManager::ApplyLayerMerging(), current_room_id_, GetRoomColor(), yaze::zelda3::GetRoomLabel(), yaze::editor::AgentUI::GetTheme(), yaze::editor::kFocusInWorkbench, yaze::editor::kOpenStandalone, on_room_intent_, on_room_selected_, on_room_swap_, and rooms_.