yaze::editor::CustomSpriteEditorPanel Class Reference

EditorPanel for Custom Sprite Editor (ZSM format) More...

#include <sprite_editor_panels.h>

Inheritance diagram for yaze::editor::CustomSpriteEditorPanel:

Collaboration diagram for yaze::editor::CustomSpriteEditorPanel:

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

Public Member Functions
	CustomSpriteEditorPanel (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

EditorPanel for Custom Sprite Editor (ZSM format)

Allows creating and editing custom sprites in ZSM format. Includes animation editor, properties panel, and user routines.

Definition at line 54 of file sprite_editor_panels.h.

Member Typedef Documentation

DrawCallback

using yaze::editor::CustomSpriteEditorPanel::DrawCallback = std::function<void()>

Definition at line 56 of file sprite_editor_panels.h.

Constructor & Destructor Documentation

CustomSpriteEditorPanel()

yaze::editor::CustomSpriteEditorPanel::CustomSpriteEditorPanel ( DrawCallback draw_callback )

inlineexplicit

Definition at line 58 of file sprite_editor_panels.h.

Member Function Documentation

GetId()

std::string yaze::editor::CustomSpriteEditorPanel::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 61 of file sprite_editor_panels.h.

GetDisplayName()

std::string yaze::editor::CustomSpriteEditorPanel::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 62 of file sprite_editor_panels.h.

GetIcon()

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

inlineoverridevirtual

Material Design icon for this panel.

Returns

Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::EditorPanel.

Definition at line 63 of file sprite_editor_panels.h.

References ICON_MD_ADD_CIRCLE.

GetEditorCategory()

std::string yaze::editor::CustomSpriteEditorPanel::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 64 of file sprite_editor_panels.h.

GetPriority()

int yaze::editor::CustomSpriteEditorPanel::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 65 of file sprite_editor_panels.h.

GetPreferredWidth()

float yaze::editor::CustomSpriteEditorPanel::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 66 of file sprite_editor_panels.h.

Draw()

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

inlineoverridevirtual

Draw the panel content.

Parameters

p_open

Pointer 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 68 of file sprite_editor_panels.h.

References draw_callback_.

Member Data Documentation

draw_callback_

DrawCallback yaze::editor::CustomSpriteEditorPanel::draw_callback_

private

Definition at line 75 of file sprite_editor_panels.h.

Referenced by Draw().

---

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

• src/app/editor/sprite/panels/sprite_editor_panels.h