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

Displays the current area's GFX sheet for preview. More...

#include <area_graphics_panel.h>

Inheritance diagram for yaze::editor::AreaGraphicsPanel:
Collaboration diagram for yaze::editor::AreaGraphicsPanel:

Public Member Functions

 AreaGraphicsPanel (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.
 
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 int GetPriority () const
 Get display priority for menu ordering.
 
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

Displays the current area's GFX sheet for preview.

Shows the graphics tileset used by the current overworld map, useful for visual reference while editing.

Definition at line 19 of file area_graphics_panel.h.

Constructor & Destructor Documentation

◆ AreaGraphicsPanel()

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

Definition at line 21 of file area_graphics_panel.h.

Member Function Documentation

◆ GetId()

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

◆ GetDisplayName()

std::string yaze::editor::AreaGraphicsPanel::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 25 of file area_graphics_panel.h.

◆ GetIcon()

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

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::EditorPanel.

Definition at line 26 of file area_graphics_panel.h.

References ICON_MD_IMAGE.

◆ GetEditorCategory()

std::string yaze::editor::AreaGraphicsPanel::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 27 of file area_graphics_panel.h.

◆ GetPreferredWidth()

float yaze::editor::AreaGraphicsPanel::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 28 of file area_graphics_panel.h.

◆ Draw()

void yaze::editor::AreaGraphicsPanel::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 9 of file area_graphics_panel.cc.

References yaze::editor::OverworldEditor::DrawAreaGraphics(), editor_, and LOG_ERROR.

Here is the call graph for this function:

Member Data Documentation

◆ editor_

OverworldEditor* yaze::editor::AreaGraphicsPanel::editor_
private

Definition at line 35 of file area_graphics_panel.h.

Referenced by Draw().


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