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

EditorPanel for placing and managing dungeon pot items. More...

#include <item_editor_panel.h>

Inheritance diagram for yaze::editor::ItemEditorPanel:
Collaboration diagram for yaze::editor::ItemEditorPanel:

Public Member Functions

 ItemEditorPanel (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 SetItemPlacedCallback (std::function< void(const zelda3::PotItem &)> callback)
 
- 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 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.
 

Private Member Functions

void DrawPlacementControls ()
 
void DrawItemSelector ()
 
void DrawRoomItems ()
 
ImVec4 GetItemTypeColor (int item_id, const AgentUITheme &theme)
 
const char * GetItemTypeIcon (int item_id)
 

Private Attributes

int * current_room_id_ = nullptr
 
std::array< zelda3::Room, 0x128 > * rooms_ = nullptr
 
DungeonCanvasViewercanvas_viewer_ = nullptr
 
int selected_item_id_ = 0
 
bool placement_mode_ = false
 
std::function< void(const zelda3::PotItem &) item_placed_callback_ )
 

Static Private Attributes

static constexpr const char * kPotItemNames []
 
static constexpr size_t kPotItemCount = sizeof(kPotItemNames) / sizeof(kPotItemNames[0])
 

Detailed Description

EditorPanel for placing and managing dungeon pot items.

This panel provides item selection and placement functionality for dungeon rooms, similar to ObjectEditorPanel and SpriteEditorPanel.

See also
EditorPanel - Base interface
ObjectEditorPanel - Similar panel for tile objects
SpriteEditorPanel - Similar panel for sprites

Definition at line 31 of file item_editor_panel.h.

Constructor & Destructor Documentation

◆ ItemEditorPanel()

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

Definition at line 33 of file item_editor_panel.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::ItemEditorPanel::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 44 of file item_editor_panel.h.

◆ GetDisplayName()

std::string yaze::editor::ItemEditorPanel::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 45 of file item_editor_panel.h.

◆ GetIcon()

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

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::EditorPanel.

Definition at line 46 of file item_editor_panel.h.

References ICON_MD_INVENTORY.

◆ GetEditorCategory()

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

◆ GetPriority()

int yaze::editor::ItemEditorPanel::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 48 of file item_editor_panel.h.

◆ Draw()

void yaze::editor::ItemEditorPanel::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 54 of file item_editor_panel.h.

References current_room_id_, DrawItemSelector(), DrawPlacementControls(), DrawRoomItems(), and rooms_.

Here is the call graph for this function:

◆ SetCanvasViewer()

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

◆ SetItemPlacedCallback()

void yaze::editor::ItemEditorPanel::SetItemPlacedCallback ( std::function< void(const zelda3::PotItem &)> callback)
inline

Definition at line 81 of file item_editor_panel.h.

References item_placed_callback_.

◆ DrawPlacementControls()

void yaze::editor::ItemEditorPanel::DrawPlacementControls ( )
inlineprivate

◆ DrawItemSelector()

◆ DrawRoomItems()

void yaze::editor::ItemEditorPanel::DrawRoomItems ( )
inlineprivate

Definition at line 224 of file item_editor_panel.h.

References current_room_id_, yaze::editor::AgentUI::GetTheme(), ICON_MD_DELETE, ICON_MD_INFO, ICON_MD_LIST, kPotItemCount, and kPotItemNames.

Referenced by Draw().

Here is the call graph for this function:

◆ GetItemTypeColor()

◆ GetItemTypeIcon()

Member Data Documentation

◆ kPotItemNames

constexpr const char* yaze::editor::ItemEditorPanel::kPotItemNames[]
staticconstexprprivate
Initial value:
= {
"Nothing",
"Green Rupee",
"Rock",
"Bee",
"Health",
"Bomb",
"Heart",
"Blue Rupee",
"Key",
"Arrow",
"Bomb",
"Heart",
"Magic",
"Full Magic",
"Cucco",
"Green Soldier",
"Bush Stal",
"Blue Soldier",
"Landmine",
"Heart",
"Fairy",
"Heart",
"Nothing",
"Hole",
"Warp",
"Staircase",
"Bombable",
"Switch"
}

Definition at line 88 of file item_editor_panel.h.

Referenced by DrawItemSelector(), DrawPlacementControls(), and DrawRoomItems().

◆ kPotItemCount

constexpr size_t yaze::editor::ItemEditorPanel::kPotItemCount = sizeof(kPotItemNames) / sizeof(kPotItemNames[0])
staticconstexprprivate

Definition at line 118 of file item_editor_panel.h.

Referenced by DrawItemSelector(), DrawPlacementControls(), and DrawRoomItems().

◆ current_room_id_

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

Definition at line 324 of file item_editor_panel.h.

Referenced by Draw(), and DrawRoomItems().

◆ rooms_

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

Definition at line 325 of file item_editor_panel.h.

Referenced by Draw().

◆ canvas_viewer_

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

Definition at line 326 of file item_editor_panel.h.

Referenced by DrawItemSelector(), DrawPlacementControls(), and SetCanvasViewer().

◆ selected_item_id_

int yaze::editor::ItemEditorPanel::selected_item_id_ = 0
private

Definition at line 329 of file item_editor_panel.h.

Referenced by DrawItemSelector(), and DrawPlacementControls().

◆ placement_mode_

bool yaze::editor::ItemEditorPanel::placement_mode_ = false
private

Definition at line 330 of file item_editor_panel.h.

Referenced by DrawItemSelector(), and DrawPlacementControls().

◆ item_placed_callback_

std::function<void(const zelda3::PotItem&) yaze::editor::ItemEditorPanel::item_placed_callback_)
private

Definition at line 332 of file item_editor_panel.h.

Referenced by SetItemPlacedCallback().


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