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

#include <overlay_manager_panel.h>

Inheritance diagram for yaze::editor::OverlayManagerPanel:
Collaboration diagram for yaze::editor::OverlayManagerPanel:

Classes

struct  OverlayState
 

Public Member Functions

 OverlayManagerPanel ()=default
 
 OverlayManagerPanel (OverlayState state)
 
void SetState (OverlayState state)
 
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.
 
- 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 GetShortcutHint () const
 Get keyboard shortcut hint for display.
 
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 bool PreferAutoHideTabBar () const
 Whether the dock node hosting this panel should auto-hide its tab bar.
 
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

void OverlayToggle (const char *label, bool *value)
 
void SetAll (bool value)
 

Private Attributes

OverlayState state_
 

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

Definition at line 14 of file overlay_manager_panel.h.

Constructor & Destructor Documentation

◆ OverlayManagerPanel() [1/2]

yaze::editor::OverlayManagerPanel::OverlayManagerPanel ( )
default

◆ OverlayManagerPanel() [2/2]

yaze::editor::OverlayManagerPanel::OverlayManagerPanel ( OverlayState state)
inlineexplicit

Definition at line 33 of file overlay_manager_panel.h.

Member Function Documentation

◆ SetState()

void yaze::editor::OverlayManagerPanel::SetState ( OverlayState state)
inline

Definition at line 35 of file overlay_manager_panel.h.

References state_.

◆ GetId()

std::string yaze::editor::OverlayManagerPanel::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 38 of file overlay_manager_panel.h.

◆ GetDisplayName()

std::string yaze::editor::OverlayManagerPanel::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 39 of file overlay_manager_panel.h.

◆ GetIcon()

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

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::WindowContent.

Definition at line 40 of file overlay_manager_panel.h.

References ICON_MD_LAYERS.

◆ GetEditorCategory()

std::string yaze::editor::OverlayManagerPanel::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 41 of file overlay_manager_panel.h.

◆ GetPriority()

int yaze::editor::OverlayManagerPanel::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 42 of file overlay_manager_panel.h.

◆ Draw()

◆ OverlayToggle()

void yaze::editor::OverlayManagerPanel::OverlayToggle ( const char * label,
bool * value )
inlineprivate

Definition at line 91 of file overlay_manager_panel.h.

Referenced by Draw().

◆ SetAll()

Member Data Documentation

◆ state_

OverlayState yaze::editor::OverlayManagerPanel::state_
private

Definition at line 123 of file overlay_manager_panel.h.

Referenced by Draw(), SetAll(), and SetState().


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