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

#include <object_editor_content.h>

Inheritance diagram for yaze::editor::ObjectEditorContent:
Collaboration diagram for yaze::editor::ObjectEditorContent:

Public Member Functions

 ObjectEditorContent (std::shared_ptr< zelda3::DungeonObjectEditor > object_editor=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.
 
float GetPreferredWidth () const override
 Get preferred width for this panel (optional)
 
void Draw (bool *p_open) override
 Draw the panel content.
 
void SetCurrentRoom (int room_id)
 
void SetCanvasViewerProvider (std::function< DungeonCanvasViewer *()> provider)
 
void SetCanvasViewer (DungeonCanvasViewer *viewer)
 
void CycleObjectSelection (int direction)
 
void SelectAllObjects ()
 
void DeleteSelectedObjects ()
 
void CopySelectedObjects ()
 
void PasteObjects ()
 
- 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 Member Functions

void SetupSelectionCallbacks ()
 
void OnSelectionChanged ()
 
DungeonCanvasViewerResolveCanvasViewer ()
 
void DrawSelectionSummary ()
 
void DrawSelectionActions ()
 
void DrawSelectedObjectInfo ()
 
void DrawKeyboardShortcutHelp ()
 
void HandleKeyboardShortcuts ()
 
void DeselectAllObjects ()
 
void DuplicateSelectedObjects ()
 
void NudgeSelectedObjects (int dx, int dy)
 
void ScrollToObject (size_t index)
 

Private Attributes

DungeonCanvasViewercanvas_viewer_ = nullptr
 
std::function< DungeonCanvasViewer *()> canvas_viewer_provider_
 
int current_room_id_ = 0
 
std::shared_ptr< zelda3::DungeonObjectEditorobject_editor_
 
size_t cached_selection_count_ = 0
 
bool selection_callbacks_setup_ = false
 
bool show_shortcut_help_ = false
 

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

Definition at line 16 of file object_editor_content.h.

Constructor & Destructor Documentation

◆ ObjectEditorContent()

yaze::editor::ObjectEditorContent::ObjectEditorContent ( std::shared_ptr< zelda3::DungeonObjectEditor > object_editor = nullptr)
explicit

Definition at line 15 of file object_editor_content.cc.

Member Function Documentation

◆ GetId()

std::string yaze::editor::ObjectEditorContent::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 21 of file object_editor_content.h.

◆ GetDisplayName()

std::string yaze::editor::ObjectEditorContent::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 22 of file object_editor_content.h.

◆ GetIcon()

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

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::WindowContent.

Definition at line 23 of file object_editor_content.h.

References ICON_MD_TUNE.

◆ GetEditorCategory()

std::string yaze::editor::ObjectEditorContent::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 24 of file object_editor_content.h.

◆ GetPriority()

int yaze::editor::ObjectEditorContent::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 25 of file object_editor_content.h.

◆ GetPreferredWidth()

float yaze::editor::ObjectEditorContent::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 26 of file object_editor_content.h.

◆ Draw()

void yaze::editor::ObjectEditorContent::Draw ( bool * p_open)
overridevirtual

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 72 of file object_editor_content.cc.

References cached_selection_count_, DrawKeyboardShortcutHelp(), DrawSelectedObjectInfo(), DrawSelectionActions(), DrawSelectionSummary(), yaze::editor::AgentUI::GetTheme(), HandleKeyboardShortcuts(), ICON_MD_TUNE, object_editor_, ResolveCanvasViewer(), and yaze::gui::SectionHeader().

◆ SetCurrentRoom()

void yaze::editor::ObjectEditorContent::SetCurrentRoom ( int room_id)
inline

Definition at line 30 of file object_editor_content.h.

References current_room_id_.

◆ SetCanvasViewerProvider()

void yaze::editor::ObjectEditorContent::SetCanvasViewerProvider ( std::function< DungeonCanvasViewer *()> provider)
inline

Definition at line 31 of file object_editor_content.h.

References canvas_viewer_provider_.

◆ SetCanvasViewer()

void yaze::editor::ObjectEditorContent::SetCanvasViewer ( DungeonCanvasViewer * viewer)

Definition at line 19 of file object_editor_content.cc.

References canvas_viewer_, selection_callbacks_setup_, and SetupSelectionCallbacks().

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

Here is the call graph for this function:

◆ CycleObjectSelection()

void yaze::editor::ObjectEditorContent::CycleObjectSelection ( int direction)

◆ SelectAllObjects()

void yaze::editor::ObjectEditorContent::SelectAllObjects ( )

◆ DeleteSelectedObjects()

void yaze::editor::ObjectEditorContent::DeleteSelectedObjects ( )

◆ CopySelectedObjects()

void yaze::editor::ObjectEditorContent::CopySelectedObjects ( )

◆ PasteObjects()

void yaze::editor::ObjectEditorContent::PasteObjects ( )

◆ SetupSelectionCallbacks()

void yaze::editor::ObjectEditorContent::SetupSelectionCallbacks ( )
private

◆ OnSelectionChanged()

void yaze::editor::ObjectEditorContent::OnSelectionChanged ( )
private

Definition at line 51 of file object_editor_content.cc.

References cached_selection_count_, object_editor_, and ResolveCanvasViewer().

Referenced by SetupSelectionCallbacks().

Here is the call graph for this function:

◆ ResolveCanvasViewer()

DungeonCanvasViewer * yaze::editor::ObjectEditorContent::ResolveCanvasViewer ( )
private

◆ DrawSelectionSummary()

void yaze::editor::ObjectEditorContent::DrawSelectionSummary ( )
private

Definition at line 105 of file object_editor_content.cc.

References yaze::editor::AgentUI::GetTheme(), ICON_MD_CHECK_CIRCLE, ICON_MD_HELP_OUTLINE, ICON_MD_MOUSE, ICON_MD_SELECT_ALL, ResolveCanvasViewer(), and show_shortcut_help_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawSelectionActions()

◆ DrawSelectedObjectInfo()

◆ DrawKeyboardShortcutHelp()

void yaze::editor::ObjectEditorContent::DrawKeyboardShortcutHelp ( )
private

Definition at line 226 of file object_editor_content.cc.

References yaze::editor::AgentUI::GetTheme(), ICON_MD_EDIT, ICON_MD_KEYBOARD, ICON_MD_OPEN_WITH, and show_shortcut_help_.

Referenced by Draw().

Here is the call graph for this function:

◆ HandleKeyboardShortcuts()

void yaze::editor::ObjectEditorContent::HandleKeyboardShortcuts ( )
private

◆ DeselectAllObjects()

void yaze::editor::ObjectEditorContent::DeselectAllObjects ( )
private

◆ DuplicateSelectedObjects()

void yaze::editor::ObjectEditorContent::DuplicateSelectedObjects ( )
private

◆ NudgeSelectedObjects()

void yaze::editor::ObjectEditorContent::NudgeSelectedObjects ( int dx,
int dy )
private

◆ ScrollToObject()

void yaze::editor::ObjectEditorContent::ScrollToObject ( size_t index)
private

Definition at line 449 of file object_editor_content.cc.

References canvas_viewer_, object_editor_, and yaze::editor::DungeonCanvasViewer::ScrollToTile().

Referenced by CycleObjectSelection().

Here is the call graph for this function:

Member Data Documentation

◆ canvas_viewer_

◆ canvas_viewer_provider_

std::function<DungeonCanvasViewer*()> yaze::editor::ObjectEditorContent::canvas_viewer_provider_
private

Definition at line 59 of file object_editor_content.h.

Referenced by ResolveCanvasViewer(), and SetCanvasViewerProvider().

◆ current_room_id_

int yaze::editor::ObjectEditorContent::current_room_id_ = 0
private

Definition at line 60 of file object_editor_content.h.

Referenced by SetCurrentRoom().

◆ object_editor_

◆ cached_selection_count_

size_t yaze::editor::ObjectEditorContent::cached_selection_count_ = 0
private

Definition at line 63 of file object_editor_content.h.

Referenced by Draw(), DrawSelectionActions(), and OnSelectionChanged().

◆ selection_callbacks_setup_

bool yaze::editor::ObjectEditorContent::selection_callbacks_setup_ = false
private

◆ show_shortcut_help_

bool yaze::editor::ObjectEditorContent::show_shortcut_help_ = false
private

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