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

WindowContent wrapper for PaletteEditorWidget in dungeon context. More...

#include <palette_editor_content.h>

Inheritance diagram for yaze::editor::PaletteEditorContent:
Collaboration diagram for yaze::editor::PaletteEditorContent:

Public Member Functions

 PaletteEditorContent (gui::PaletteEditorWidget *palette_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.
 
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.
 
gui::PaletteEditorWidgetpalette_editor () const
 
void SetCurrentRoomPalette (int palette_id)
 Set the current palette ID based on the active room.
 
- 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 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 Attributes

gui::PaletteEditorWidgetpalette_editor_ = nullptr
 

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

WindowContent wrapper for PaletteEditorWidget in dungeon context.

This panel provides palette editing specifically for dungeon rooms, wrapping the PaletteEditorWidget component.

See also
PaletteEditorWidget - The underlying component
WindowContent - Base interface

Definition at line 23 of file palette_editor_content.h.

Constructor & Destructor Documentation

◆ PaletteEditorContent()

yaze::editor::PaletteEditorContent::PaletteEditorContent ( gui::PaletteEditorWidget * palette_editor)
inlineexplicit

Definition at line 25 of file palette_editor_content.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::PaletteEditorContent::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 32 of file palette_editor_content.h.

◆ GetDisplayName()

std::string yaze::editor::PaletteEditorContent::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 33 of file palette_editor_content.h.

◆ GetIcon()

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

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::WindowContent.

Definition at line 34 of file palette_editor_content.h.

References ICON_MD_PALETTE.

◆ GetEditorCategory()

std::string yaze::editor::PaletteEditorContent::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 35 of file palette_editor_content.h.

◆ GetPriority()

int yaze::editor::PaletteEditorContent::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 36 of file palette_editor_content.h.

◆ GetPreferredWidth()

float yaze::editor::PaletteEditorContent::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::WindowContent.

Definition at line 37 of file palette_editor_content.h.

◆ Draw()

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

Draw the panel content.

Parameters
p_openPointer to visibility flag (nullptr if not closable)

Called by WorkspaceWindowManager when the panel is visible. Do NOT call ImGui::Begin/End - the PanelWindow wrapper handles that. Just draw your content directly.

Implements yaze::editor::WindowContent.

Definition at line 43 of file palette_editor_content.h.

References yaze::gui::PaletteEditorWidget::Draw(), and palette_editor_.

Here is the call graph for this function:

◆ palette_editor()

gui::PaletteEditorWidget * yaze::editor::PaletteEditorContent::palette_editor ( ) const
inline

Definition at line 52 of file palette_editor_content.h.

References palette_editor_.

◆ SetCurrentRoomPalette()

void yaze::editor::PaletteEditorContent::SetCurrentRoomPalette ( int palette_id)
inline

Set the current palette ID based on the active room.

Parameters
palette_idThe palette ID from the room

Definition at line 58 of file palette_editor_content.h.

References palette_editor_, and yaze::gui::PaletteEditorWidget::SetCurrentPaletteId().

Here is the call graph for this function:

Member Data Documentation

◆ palette_editor_

gui::PaletteEditorWidget* yaze::editor::PaletteEditorContent::palette_editor_ = nullptr
private

Definition at line 65 of file palette_editor_content.h.

Referenced by Draw(), palette_editor(), and SetCurrentRoomPalette().


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