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

Graphics group editor panel for managing GFX groups. More...

#include <graphics_editor_panels.h>

Inheritance diagram for yaze::editor::GraphicsGfxGroupPanel:
Collaboration diagram for yaze::editor::GraphicsGfxGroupPanel:

Public Types

using DrawCallback = std::function<void()>
 

Public Member Functions

 GraphicsGfxGroupPanel (DrawCallback draw_callback)
 
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.
 
float GetPreferredWidth () const override
 Get preferred width for this panel (optional)
 
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 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

DrawCallback draw_callback_
 

Detailed Description

Graphics group editor panel for managing GFX groups.

Definition at line 157 of file graphics_editor_panels.h.

Member Typedef Documentation

◆ DrawCallback

Definition at line 159 of file graphics_editor_panels.h.

Constructor & Destructor Documentation

◆ GraphicsGfxGroupPanel()

yaze::editor::GraphicsGfxGroupPanel::GraphicsGfxGroupPanel ( DrawCallback draw_callback)
inlineexplicit

Definition at line 161 of file graphics_editor_panels.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::GraphicsGfxGroupPanel::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 164 of file graphics_editor_panels.h.

◆ GetDisplayName()

std::string yaze::editor::GraphicsGfxGroupPanel::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 165 of file graphics_editor_panels.h.

◆ GetIcon()

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

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::EditorPanel.

Definition at line 166 of file graphics_editor_panels.h.

References ICON_MD_VIEW_MODULE.

◆ GetEditorCategory()

std::string yaze::editor::GraphicsGfxGroupPanel::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 167 of file graphics_editor_panels.h.

◆ GetPriority()

int yaze::editor::GraphicsGfxGroupPanel::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 168 of file graphics_editor_panels.h.

◆ GetPreferredWidth()

float yaze::editor::GraphicsGfxGroupPanel::GetPreferredWidth ( ) const
inlineoverridevirtual

Get preferred width for this panel (optional)

Returns
Preferred width in pixels, or 0 to use default (250px)

Override this to specify content-based sizing. For example, a tile selector with 8 tiles at 16px × 2.0 scale would return ~276px.

Reimplemented from yaze::editor::EditorPanel.

Definition at line 169 of file graphics_editor_panels.h.

◆ Draw()

void yaze::editor::GraphicsGfxGroupPanel::Draw ( bool * p_open)
inlineoverridevirtual

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 171 of file graphics_editor_panels.h.

References draw_callback_.

Member Data Documentation

◆ draw_callback_

DrawCallback yaze::editor::GraphicsGfxGroupPanel::draw_callback_
private

Definition at line 178 of file graphics_editor_panels.h.

Referenced by Draw().


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