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

EditorPanel for managing chest contents in dungeon rooms. More...

#include <chest_editor_panel.h>

Inheritance diagram for yaze::editor::ChestEditorPanel:
Collaboration diagram for yaze::editor::ChestEditorPanel:

Public Member Functions

 ChestEditorPanel (int *current_room_id, std::array< zelda3::Room, 0x128 > *rooms, DungeonCanvasViewer *canvas_viewer=nullptr)
 
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.
 
void Draw (bool *p_open) override
 Draw the panel content.
 
void SetCanvasViewer (DungeonCanvasViewer *viewer)
 
void SetChestModifiedCallback (std::function< void(int, int)> callback)
 
- Public Member Functions inherited from yaze::editor::EditorPanel
virtual ~EditorPanel ()=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 PanelCategory GetPanelCategory () const
 Get the lifecycle category for this panel.
 
virtual PanelContextScope GetContextScope () const
 Optional context binding for this panel (room/selection/etc)
 
virtual PanelScope GetScope () const
 Get the registration scope 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 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.
 
void DrawWithLazyInit (bool *p_open)
 Execute lazy initialization if needed, then call Draw()
 

Private Member Functions

void DrawChestList ()
 
void DrawChestProperties ()
 

Private Attributes

int * current_room_id_ = nullptr
 
std::array< zelda3::Room, 0x128 > * rooms_ = nullptr
 
DungeonCanvasViewercanvas_viewer_ = nullptr
 
int selected_chest_index_ = -1
 
std::function< void(int, int)> chest_modified_callback_
 

Additional Inherited Members

- Protected Member Functions inherited from yaze::editor::EditorPanel
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

EditorPanel for managing chest contents in dungeon rooms.

This panel provides chest item editing functionality, similar to ZScream's chest editor. Displays all chests in the current room with their contents and allows editing item type and chest size.

See also
EditorPanel - Base interface
SpriteEditorPanel - Similar panel for sprites

Definition at line 34 of file chest_editor_panel.h.

Constructor & Destructor Documentation

◆ ChestEditorPanel()

yaze::editor::ChestEditorPanel::ChestEditorPanel ( int * current_room_id,
std::array< zelda3::Room, 0x128 > * rooms,
DungeonCanvasViewer * canvas_viewer = nullptr )
inline

Definition at line 36 of file chest_editor_panel.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::ChestEditorPanel::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 47 of file chest_editor_panel.h.

◆ GetDisplayName()

std::string yaze::editor::ChestEditorPanel::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 48 of file chest_editor_panel.h.

◆ GetIcon()

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

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::EditorPanel.

Definition at line 49 of file chest_editor_panel.h.

References ICON_MD_INVENTORY_2.

◆ GetEditorCategory()

std::string yaze::editor::ChestEditorPanel::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 50 of file chest_editor_panel.h.

◆ GetPriority()

int yaze::editor::ChestEditorPanel::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 51 of file chest_editor_panel.h.

◆ Draw()

void yaze::editor::ChestEditorPanel::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 57 of file chest_editor_panel.h.

References current_room_id_, DrawChestList(), DrawChestProperties(), and rooms_.

Here is the call graph for this function:

◆ SetCanvasViewer()

void yaze::editor::ChestEditorPanel::SetCanvasViewer ( DungeonCanvasViewer * viewer)
inline

Definition at line 78 of file chest_editor_panel.h.

References canvas_viewer_.

◆ SetChestModifiedCallback()

void yaze::editor::ChestEditorPanel::SetChestModifiedCallback ( std::function< void(int, int)> callback)
inline

Definition at line 82 of file chest_editor_panel.h.

References chest_modified_callback_.

◆ DrawChestList()

void yaze::editor::ChestEditorPanel::DrawChestList ( )
inlineprivate

◆ DrawChestProperties()

void yaze::editor::ChestEditorPanel::DrawChestProperties ( )
inlineprivate

Member Data Documentation

◆ current_room_id_

int* yaze::editor::ChestEditorPanel::current_room_id_ = nullptr
private

Definition at line 274 of file chest_editor_panel.h.

Referenced by Draw(), DrawChestList(), and DrawChestProperties().

◆ rooms_

std::array<zelda3::Room, 0x128>* yaze::editor::ChestEditorPanel::rooms_ = nullptr
private

Definition at line 275 of file chest_editor_panel.h.

Referenced by Draw().

◆ canvas_viewer_

DungeonCanvasViewer* yaze::editor::ChestEditorPanel::canvas_viewer_ = nullptr
private

Definition at line 276 of file chest_editor_panel.h.

Referenced by SetCanvasViewer().

◆ selected_chest_index_

int yaze::editor::ChestEditorPanel::selected_chest_index_ = -1
private

Definition at line 279 of file chest_editor_panel.h.

Referenced by DrawChestList(), and DrawChestProperties().

◆ chest_modified_callback_

std::function<void(int, int)> yaze::editor::ChestEditorPanel::chest_modified_callback_
private

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