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

ZSCustomOverworld configuration settings. More...

#include <v3_settings_panel.h>

Inheritance diagram for yaze::editor::V3SettingsPanel:
Collaboration diagram for yaze::editor::V3SettingsPanel:

Public Member Functions

 V3SettingsPanel (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.
 
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 std::string GetShortcutHint () const
 Get keyboard shortcut hint for display.
 
virtual int GetPriority () const
 Get display priority for menu ordering.
 
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

OverworldEditoreditor_
 

Detailed Description

ZSCustomOverworld configuration settings.

Definition at line 16 of file v3_settings_panel.h.

Constructor & Destructor Documentation

◆ V3SettingsPanel()

yaze::editor::V3SettingsPanel::V3SettingsPanel ( OverworldEditor * editor)
inlineexplicit

Definition at line 18 of file v3_settings_panel.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::V3SettingsPanel::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 21 of file v3_settings_panel.h.

◆ GetDisplayName()

std::string yaze::editor::V3SettingsPanel::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 22 of file v3_settings_panel.h.

◆ GetIcon()

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

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::EditorPanel.

Definition at line 23 of file v3_settings_panel.h.

References ICON_MD_SETTINGS.

◆ GetEditorCategory()

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

◆ Draw()

void yaze::editor::V3SettingsPanel::Draw ( bool * p_open)
overridevirtual

Draw the panel content.

Parameters
p_openPointer 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 v3_settings_panel.cc.

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

Here is the call graph for this function:

Member Data Documentation

◆ editor_

OverworldEditor* yaze::editor::V3SettingsPanel::editor_
private

Definition at line 28 of file v3_settings_panel.h.

Referenced by Draw().


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