WindowContent wrapper for the main overworld canvas. More...

#include <overworld_canvas_view.h>

Inheritance diagram for yaze::editor::OverworldCanvasView:

Collaboration diagram for yaze::editor::OverworldCanvasView:

Public Member Functions
	OverworldCanvasView ()=default

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	PreferAutoHideTabBar () const override
	Whether the dock node hosting this panel should auto-hide its tab bar.

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::WindowContent
virtual	~WindowContent ()=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 WindowLifecycle	GetWindowLifecycle () const
	Get the lifecycle category for this window.

virtual WindowContextScope	GetContextScope () const
	Optional context binding for this window (room/selection/etc)

virtual WindowScope	GetScope () const
	Get the registration scope for this window.

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	GetWorkflowGroup () const
	Optional workflow group for hack-centric actions.

virtual std::string	GetWorkflowLabel () const
	Optional workflow label for menus/command palette.

virtual std::string	GetWorkflowDescription () const
	Optional workflow description for menus/command palette.

virtual int	GetWorkflowPriority () const
	Optional workflow ordering priority (lower sorts first).

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.

void	DrawWithLazyInit (bool *p_open)
	Execute lazy initialization if needed, then call Draw()

Additional Inherited Members
Protected Member Functions inherited from yaze::editor::WindowContent
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

WindowContent wrapper for the main overworld canvas.

Handles the display of the overworld map and associated tools.

Uses ContentRegistry::Context to access the current OverworldEditor. Self-registers via REGISTER_PANEL macro.

Definition at line 18 of file overworld_canvas_view.h.

Constructor & Destructor Documentation

◆ OverworldCanvasView()

yaze::editor::OverworldCanvasView::OverworldCanvasView ( )

default

Member Function Documentation

◆ GetId()

std::string yaze::editor::OverworldCanvasView::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::WindowContent.

Definition at line 23 of file overworld_canvas_view.h.

◆ GetDisplayName()

std::string yaze::editor::OverworldCanvasView::GetDisplayName ( ) const

inlineoverridevirtual

Human-readable name shown in menus and title bars.

Returns: Display name (e.g., "Room Selector")

Implements yaze::editor::WindowContent.

Definition at line 24 of file overworld_canvas_view.h.

◆ GetIcon()

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

inlineoverridevirtual

Material Design icon for this panel.

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

Implements yaze::editor::WindowContent.

Definition at line 25 of file overworld_canvas_view.h.

References ICON_MD_MAP.

◆ GetEditorCategory()

std::string yaze::editor::OverworldCanvasView::GetEditorCategory ( ) const

inlineoverridevirtual

Editor category this panel belongs to.

Returns: Category name matching EditorType (e.g., "Dungeon", "Overworld")

Implements yaze::editor::WindowContent.

Definition at line 26 of file overworld_canvas_view.h.

◆ GetShortcutHint()

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

inlineoverridevirtual

Get keyboard shortcut hint for display.

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

Reimplemented from yaze::editor::WindowContent.

Definition at line 27 of file overworld_canvas_view.h.

◆ GetPriority()

int yaze::editor::OverworldCanvasView::GetPriority ( ) const

inlineoverridevirtual

Get display priority for menu ordering.

Returns: Priority value (lower = higher in list, default 50)

Reimplemented from yaze::editor::WindowContent.

Definition at line 28 of file overworld_canvas_view.h.

◆ PreferAutoHideTabBar()

bool yaze::editor::OverworldCanvasView::PreferAutoHideTabBar ( ) const

inlineoverridevirtual

Whether the dock node hosting this panel should auto-hide its tab bar.

Returns: true to prefer ImGuiDockNodeFlags_AutoHideTabBar

This is a node-level hint applied by LayoutManager during DockBuilder setup. It is best used for primary single-panel work areas where the tab bar should disappear until another panel is docked into the same node.

Reimplemented from yaze::editor::WindowContent.

Definition at line 29 of file overworld_canvas_view.h.

◆ IsVisibleByDefault()

bool yaze::editor::OverworldCanvasView::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::WindowContent.

Definition at line 30 of file overworld_canvas_view.h.

◆ Draw()

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

overridevirtual

Draw the panel content.

Parameters

p_open Pointer to visibility flag (nullptr if not closable)

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

Implements yaze::editor::WindowContent.

Definition at line 8 of file overworld_canvas_view.cc.

References yaze::editor::CurrentOverworldWindowContext().

Here is the call graph for this function:

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

src/app/editor/overworld/ui/canvas/overworld_canvas_view.h
src/app/editor/overworld/ui/canvas/overworld_canvas_view.cc

	yaze 0.3.2 Link to the Past ROM Editor

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OverworldCanvasView()

Member Function Documentation

◆ GetId()

◆ GetDisplayName()

◆ GetIcon()

◆ GetEditorCategory()

◆ GetShortcutHint()

◆ GetPriority()

◆ PreferAutoHideTabBar()

◆ IsVisibleByDefault()

◆ Draw()