EditorPanel wrapper for DungeonObjectEmulatorPreview. More...

#include <dungeon_emulator_preview_panel.h>

Inheritance diagram for yaze::editor::DungeonEmulatorPreviewPanel:

Collaboration diagram for yaze::editor::DungeonEmulatorPreviewPanel:

[legend]

Public Member Functions
	DungeonEmulatorPreviewPanel (gui::DungeonObjectEmulatorPreview *preview)

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	OnClose () override
	Called when panel is hidden.

gui::DungeonObjectEmulatorPreview *	preview () const

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

virtual void	OnOpen ()
	Called when panel becomes visible.

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::DungeonObjectEmulatorPreview *	preview_ = nullptr

Detailed Description

EditorPanel wrapper for DungeonObjectEmulatorPreview.

This panel provides a SNES emulator-based preview of dungeon objects, showing how they will appear in-game.

See also: DungeonObjectEmulatorPreview - The underlying component; EditorPanel - Base interface

Definition at line 23 of file dungeon_emulator_preview_panel.h.

Constructor & Destructor Documentation

◆ DungeonEmulatorPreviewPanel()

yaze::editor::DungeonEmulatorPreviewPanel::DungeonEmulatorPreviewPanel ( gui::DungeonObjectEmulatorPreview * preview )

inlineexplicit

Definition at line 25 of file dungeon_emulator_preview_panel.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::DungeonEmulatorPreviewPanel::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 33 of file dungeon_emulator_preview_panel.h.

◆ GetDisplayName()

std::string yaze::editor::DungeonEmulatorPreviewPanel::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 34 of file dungeon_emulator_preview_panel.h.

◆ GetIcon()

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

inlineoverridevirtual

Material Design icon for this panel.

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

Implements yaze::editor::EditorPanel.

Definition at line 35 of file dungeon_emulator_preview_panel.h.

References ICON_MD_MONITOR.

◆ GetEditorCategory()

std::string yaze::editor::DungeonEmulatorPreviewPanel::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 36 of file dungeon_emulator_preview_panel.h.

◆ GetPriority()

int yaze::editor::DungeonEmulatorPreviewPanel::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 37 of file dungeon_emulator_preview_panel.h.

◆ Draw()

void yaze::editor::DungeonEmulatorPreviewPanel::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 43 of file dungeon_emulator_preview_panel.h.

References yaze::gui::DungeonObjectEmulatorPreview::is_visible(), preview_, yaze::gui::DungeonObjectEmulatorPreview::Render(), and yaze::gui::DungeonObjectEmulatorPreview::set_visible().

Here is the call graph for this function: