yaze::editor::OverworldCanvasPanel Class Reference

The main canvas panel for the Overworld Editor. More...

#include <overworld_canvas_panel.h>

Inheritance diagram for yaze::editor::OverworldCanvasPanel:

Collaboration diagram for yaze::editor::OverworldCanvasPanel:

Public Member Functions
	OverworldCanvasPanel (OverworldEditor *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.
std::string	GetShortcutHint () const override
	Get keyboard shortcut hint for display.
int	GetPriority () const override
	Get display priority for menu ordering.
bool	IsVisibleByDefault () const override
	Whether this panel should be visible by default.
void	Draw (bool *p_open) override
	Draw the panel content.
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 float	GetPreferredWidth () const
	Get preferred width for this panel (optional)
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
OverworldEditor *	editor_

Detailed Description

The main canvas panel for the Overworld Editor.

Handles the display of the overworld map and associated tools.

Definition at line 18 of file overworld_canvas_panel.h.

Constructor & Destructor Documentation

OverworldCanvasPanel()

yaze::editor::OverworldCanvasPanel::OverworldCanvasPanel ( OverworldEditor * editor )

inlineexplicit

Definition at line 20 of file overworld_canvas_panel.h.

Member Function Documentation

GetId()

std::string yaze::editor::OverworldCanvasPanel::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 23 of file overworld_canvas_panel.h.

GetDisplayName()

std::string yaze::editor::OverworldCanvasPanel::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 24 of file overworld_canvas_panel.h.

GetIcon()

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

inlineoverridevirtual

Material Design icon for this panel.

Returns

Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::EditorPanel.

Definition at line 25 of file overworld_canvas_panel.h.

References ICON_MD_MAP.

GetEditorCategory()

std::string yaze::editor::OverworldCanvasPanel::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 26 of file overworld_canvas_panel.h.

GetShortcutHint()

std::string yaze::editor::OverworldCanvasPanel::GetShortcutHint ( ) const

inlineoverridevirtual

Get keyboard shortcut hint for display.

Returns

Shortcut string (e.g., "Ctrl+Shift+R")

Reimplemented from yaze::editor::EditorPanel.

Definition at line 27 of file overworld_canvas_panel.h.

GetPriority()

int yaze::editor::OverworldCanvasPanel::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 28 of file overworld_canvas_panel.h.

IsVisibleByDefault()

bool yaze::editor::OverworldCanvasPanel::IsVisibleByDefault ( ) const

inlineoverridevirtual

Whether this panel should be visible by default.

Returns

true if panel should be visible when editor first opens

Override this to set panels as visible by default. Most panels default to hidden to reduce UI clutter.

Reimplemented from yaze::editor::EditorPanel.

Definition at line 29 of file overworld_canvas_panel.h.

Draw()

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

overridevirtual

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 8 of file overworld_canvas_panel.cc.

References yaze::editor::OverworldEditor::DrawOverworldCanvas(), and editor_.

Here is the call graph for this function:

Member Data Documentation

editor_

OverworldEditor* yaze::editor::OverworldCanvasPanel::editor_

private

Definition at line 34 of file overworld_canvas_panel.h.

Referenced by Draw().

---

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

• src/app/editor/overworld/panels/overworld_canvas_panel.h
• src/app/editor/overworld/panels/overworld_canvas_panel.cc