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

#include <dungeon_settings_panel.h>

Inheritance diagram for yaze::editor::DungeonSettingsPanel:
Collaboration diagram for yaze::editor::DungeonSettingsPanel:

Public Member Functions

 DungeonSettingsPanel (DungeonCanvasViewer *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.
 
void SetCanvasViewer (DungeonCanvasViewer *viewer)
 
void SetSaveRoomCallback (std::function< void(int)> callback)
 
void SetSaveAllRoomsCallback (std::function< void()> callback)
 
void SetCurrentRoomId (int *room_id)
 
void Draw (bool *p_open) override
 Draw the panel content.
 
- 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 int GetPriority () const
 Get display priority for menu ordering.
 
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 SetAllSaveFlags (bool value)
 
void DrawLayerCompositingControls (int room_id)
 

Private Attributes

DungeonCanvasViewerviewer_ = nullptr
 
std::function< void(int)> save_room_callback_
 
std::function< void()> save_all_rooms_callback_
 
int * current_room_id_ = nullptr
 

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

Definition at line 12 of file dungeon_settings_panel.h.

Constructor & Destructor Documentation

◆ DungeonSettingsPanel()

yaze::editor::DungeonSettingsPanel::DungeonSettingsPanel ( DungeonCanvasViewer * viewer = nullptr)
inline

Definition at line 14 of file dungeon_settings_panel.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::DungeonSettingsPanel::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 17 of file dungeon_settings_panel.h.

◆ GetDisplayName()

std::string yaze::editor::DungeonSettingsPanel::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 18 of file dungeon_settings_panel.h.

◆ GetIcon()

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

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::EditorPanel.

Definition at line 19 of file dungeon_settings_panel.h.

References ICON_MD_SETTINGS.

◆ GetEditorCategory()

std::string yaze::editor::DungeonSettingsPanel::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 20 of file dungeon_settings_panel.h.

◆ SetCanvasViewer()

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

Definition at line 22 of file dungeon_settings_panel.h.

References viewer_.

Referenced by yaze::editor::DungeonEditorV2::~DungeonEditorV2().

◆ SetSaveRoomCallback()

void yaze::editor::DungeonSettingsPanel::SetSaveRoomCallback ( std::function< void(int)> callback)
inline

Definition at line 23 of file dungeon_settings_panel.h.

References save_room_callback_.

◆ SetSaveAllRoomsCallback()

void yaze::editor::DungeonSettingsPanel::SetSaveAllRoomsCallback ( std::function< void()> callback)
inline

Definition at line 26 of file dungeon_settings_panel.h.

References save_all_rooms_callback_.

◆ SetCurrentRoomId()

void yaze::editor::DungeonSettingsPanel::SetCurrentRoomId ( int * room_id)
inline

Definition at line 29 of file dungeon_settings_panel.h.

References current_room_id_.

◆ Draw()

void yaze::editor::DungeonSettingsPanel::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 31 of file dungeon_settings_panel.h.

References current_room_id_, DrawLayerCompositingControls(), yaze::core::FeatureFlags::Flags::dungeon, yaze::core::FeatureFlags::get(), yaze::editor::GetDungeonOverlayControlEnabled(), yaze::editor::GetDungeonOverlayControlSpecs(), ICON_MD_LAYERS, ICON_MD_PALETTE, ICON_MD_SAVE, ICON_MD_SAVE_ALT, ICON_MD_WORKSPACES, save_all_rooms_callback_, save_room_callback_, SetAllSaveFlags(), yaze::editor::SetDungeonOverlayControlEnabled(), and viewer_.

◆ SetAllSaveFlags()

void yaze::editor::DungeonSettingsPanel::SetAllSaveFlags ( bool value)
inlineprivate

Definition at line 121 of file dungeon_settings_panel.h.

References yaze::core::FeatureFlags::Flags::dungeon, yaze::core::FeatureFlags::get(), and yaze::core::FeatureFlags::Flags::Dungeon::kSaveObjects.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawLayerCompositingControls()

Member Data Documentation

◆ viewer_

DungeonCanvasViewer* yaze::editor::DungeonSettingsPanel::viewer_ = nullptr
private

Definition at line 138 of file dungeon_settings_panel.h.

Referenced by Draw(), DrawLayerCompositingControls(), and SetCanvasViewer().

◆ save_room_callback_

std::function<void(int)> yaze::editor::DungeonSettingsPanel::save_room_callback_
private

Definition at line 139 of file dungeon_settings_panel.h.

Referenced by Draw(), and SetSaveRoomCallback().

◆ save_all_rooms_callback_

std::function<void()> yaze::editor::DungeonSettingsPanel::save_all_rooms_callback_
private

Definition at line 140 of file dungeon_settings_panel.h.

Referenced by Draw(), and SetSaveAllRoomsCallback().

◆ current_room_id_

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

Definition at line 141 of file dungeon_settings_panel.h.

Referenced by Draw(), and SetCurrentRoomId().


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