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

#include <menu_inspector_panel.h>

Inheritance diagram for yaze::editor::OracleMenuInspectorPanel:
Collaboration diagram for yaze::editor::OracleMenuInspectorPanel:

Public Member Functions

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.
 
std::string GetWorkflowGroup () const override
 Optional workflow group for hack-centric actions.
 
std::string GetWorkflowDescription () const override
 Optional workflow description for menus/command palette.
 
WindowLifecycle GetWindowLifecycle () const override
 Get the lifecycle category for this window.
 
float GetPreferredWidth () const override
 Get preferred width for this panel (optional)
 
void Draw (bool *p_open) override
 Draw the panel content.
 
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.
 
std::string GetWorkflowGroup () const override
 Optional workflow group for hack-centric actions.
 
std::string GetWorkflowDescription () const override
 Optional workflow description for menus/command palette.
 
WindowLifecycle GetWindowLifecycle () const override
 Get the lifecycle category for this window.
 
float GetPreferredWidth () const override
 Get preferred width for this panel (optional)
 
void Draw (bool *p_open) override
 Draw the panel content.
 
- 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 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 int GetPriority () const
 Get display priority for menu ordering.
 
virtual std::string GetWorkflowLabel () const
 Optional workflow label 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 EnsureProjectPath ()
 
void RefreshRegistry ()
 
void DrawToolbar ()
 
void DrawSummary () const
 
void DrawBinsTab ()
 
void DrawDrawRoutinesTab ()
 
void DrawComponentsTab ()
 
bool MatchesFilter (const std::string &value, const std::string &filter) const
 
void EnsureProjectPath ()
 
void RefreshRegistry ()
 
void DrawToolbar ()
 
void DrawSummary () const
 
void DrawBinsTab ()
 
void DrawDrawRoutinesTab ()
 
void DrawComponentsTab ()
 
bool MatchesFilter (const std::string &value, const std::string &filter) const
 

Private Attributes

std::string project_path_
 
bool attempted_initial_load_ = false
 
bool has_registry_ = false
 
core::OracleMenuRegistry registry_
 
std::string last_error_
 
std::string status_message_
 
bool bins_missing_only_ = false
 
std::string draw_filter_
 
std::string component_table_filter_
 
std::vector< const core::OracleMenuComponent * > filtered_components_
 
int selected_component_list_index_ = -1
 
int edit_row_ = 0
 
int edit_col_ = 0
 

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 menu_inspector_panel.h.

Member Function Documentation

◆ GetId() [1/2]

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

◆ GetDisplayName() [1/2]

std::string yaze::editor::OracleMenuInspectorPanel::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 19 of file menu_inspector_panel.h.

◆ GetIcon() [1/2]

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

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::WindowContent.

Definition at line 20 of file menu_inspector_panel.h.

References ICON_MD_MENU_BOOK.

◆ GetEditorCategory() [1/2]

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

◆ GetWorkflowGroup() [1/2]

std::string yaze::editor::OracleMenuInspectorPanel::GetWorkflowGroup ( ) const
inlineoverridevirtual

Optional workflow group for hack-centric actions.

Returns
Non-empty group name to surface this panel in hack workflows.

Reimplemented from yaze::editor::WindowContent.

Definition at line 22 of file menu_inspector_panel.h.

◆ GetWorkflowDescription() [1/2]

std::string yaze::editor::OracleMenuInspectorPanel::GetWorkflowDescription ( ) const
inlineoverridevirtual

Optional workflow description for menus/command palette.

Reimplemented from yaze::editor::WindowContent.

Definition at line 23 of file menu_inspector_panel.h.

◆ GetWindowLifecycle() [1/2]

WindowLifecycle yaze::editor::OracleMenuInspectorPanel::GetWindowLifecycle ( ) const
inlineoverridevirtual

Get the lifecycle category for this window.

Returns
WindowLifecycle determining visibility behavior on editor switch

Default is EditorBound (hidden when switching editors).

Reimplemented from yaze::editor::WindowContent.

Definition at line 26 of file menu_inspector_panel.h.

References yaze::editor::CrossEditor.

◆ GetPreferredWidth() [1/2]

float yaze::editor::OracleMenuInspectorPanel::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 29 of file menu_inspector_panel.h.

◆ Draw() [1/2]

void yaze::editor::OracleMenuInspectorPanel::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 299 of file menu_inspector_panel.cc.

References yaze::gui::BeginThemedTabBar(), DrawBinsTab(), DrawComponentsTab(), DrawDrawRoutinesTab(), DrawSummary(), DrawToolbar(), yaze::gui::EndThemedTabBar(), EnsureProjectPath(), yaze::editor::AgentUI::GetTheme(), has_registry_, last_error_, registry_, status_message_, and yaze::core::OracleMenuRegistry::warnings.

◆ EnsureProjectPath() [1/2]

void yaze::editor::OracleMenuInspectorPanel::EnsureProjectPath ( )
private

Definition at line 30 of file menu_inspector_panel.cc.

References attempted_initial_load_, project_path_, and RefreshRegistry().

Referenced by Draw().

Here is the call graph for this function:

◆ RefreshRegistry() [1/2]

◆ DrawToolbar() [1/2]

void yaze::editor::OracleMenuInspectorPanel::DrawToolbar ( )
private

Definition at line 74 of file menu_inspector_panel.cc.

References project_path_, and RefreshRegistry().

Referenced by Draw().

Here is the call graph for this function:

◆ DrawSummary() [1/2]

◆ DrawBinsTab() [1/2]

void yaze::editor::OracleMenuInspectorPanel::DrawBinsTab ( )
private

Definition at line 97 of file menu_inspector_panel.cc.

References yaze::core::OracleMenuRegistry::bins, bins_missing_only_, yaze::editor::AgentUI::GetTheme(), and registry_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawDrawRoutinesTab() [1/2]

void yaze::editor::OracleMenuInspectorPanel::DrawDrawRoutinesTab ( )
private

Definition at line 140 of file menu_inspector_panel.cc.

References draw_filter_, yaze::core::OracleMenuRegistry::draw_routines, MatchesFilter(), and registry_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawComponentsTab() [1/2]

◆ MatchesFilter() [1/2]

bool yaze::editor::OracleMenuInspectorPanel::MatchesFilter ( const std::string & value,
const std::string & filter ) const
private

Definition at line 64 of file menu_inspector_panel.cc.

Referenced by DrawComponentsTab(), and DrawDrawRoutinesTab().

◆ GetId() [2/2]

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

◆ GetDisplayName() [2/2]

std::string yaze::editor::OracleMenuInspectorPanel::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 19 of file menu_inspector_panel.h.

◆ GetIcon() [2/2]

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

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::WindowContent.

Definition at line 20 of file menu_inspector_panel.h.

References ICON_MD_MENU_BOOK.

◆ GetEditorCategory() [2/2]

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

◆ GetWorkflowGroup() [2/2]

std::string yaze::editor::OracleMenuInspectorPanel::GetWorkflowGroup ( ) const
inlineoverridevirtual

Optional workflow group for hack-centric actions.

Returns
Non-empty group name to surface this panel in hack workflows.

Reimplemented from yaze::editor::WindowContent.

Definition at line 22 of file menu_inspector_panel.h.

◆ GetWorkflowDescription() [2/2]

std::string yaze::editor::OracleMenuInspectorPanel::GetWorkflowDescription ( ) const
inlineoverridevirtual

Optional workflow description for menus/command palette.

Reimplemented from yaze::editor::WindowContent.

Definition at line 23 of file menu_inspector_panel.h.

◆ GetWindowLifecycle() [2/2]

WindowLifecycle yaze::editor::OracleMenuInspectorPanel::GetWindowLifecycle ( ) const
inlineoverridevirtual

Get the lifecycle category for this window.

Returns
WindowLifecycle determining visibility behavior on editor switch

Default is EditorBound (hidden when switching editors).

Reimplemented from yaze::editor::WindowContent.

Definition at line 26 of file menu_inspector_panel.h.

References yaze::editor::CrossEditor.

◆ GetPreferredWidth() [2/2]

float yaze::editor::OracleMenuInspectorPanel::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 29 of file menu_inspector_panel.h.

◆ Draw() [2/2]

void yaze::editor::OracleMenuInspectorPanel::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.

◆ EnsureProjectPath() [2/2]

void yaze::editor::OracleMenuInspectorPanel::EnsureProjectPath ( )
private

◆ RefreshRegistry() [2/2]

void yaze::editor::OracleMenuInspectorPanel::RefreshRegistry ( )
private

◆ DrawToolbar() [2/2]

void yaze::editor::OracleMenuInspectorPanel::DrawToolbar ( )
private

◆ DrawSummary() [2/2]

void yaze::editor::OracleMenuInspectorPanel::DrawSummary ( ) const
private

◆ DrawBinsTab() [2/2]

void yaze::editor::OracleMenuInspectorPanel::DrawBinsTab ( )
private

◆ DrawDrawRoutinesTab() [2/2]

void yaze::editor::OracleMenuInspectorPanel::DrawDrawRoutinesTab ( )
private

◆ DrawComponentsTab() [2/2]

void yaze::editor::OracleMenuInspectorPanel::DrawComponentsTab ( )
private

◆ MatchesFilter() [2/2]

bool yaze::editor::OracleMenuInspectorPanel::MatchesFilter ( const std::string & value,
const std::string & filter ) const
private

Member Data Documentation

◆ project_path_

std::string yaze::editor::OracleMenuInspectorPanel::project_path_
private

Definition at line 43 of file menu_inspector_panel.h.

Referenced by DrawToolbar(), EnsureProjectPath(), and RefreshRegistry().

◆ attempted_initial_load_

bool yaze::editor::OracleMenuInspectorPanel::attempted_initial_load_ = false
private

Definition at line 44 of file menu_inspector_panel.h.

Referenced by EnsureProjectPath().

◆ has_registry_

bool yaze::editor::OracleMenuInspectorPanel::has_registry_ = false
private

Definition at line 45 of file menu_inspector_panel.h.

Referenced by Draw(), DrawSummary(), and RefreshRegistry().

◆ registry_

core::OracleMenuRegistry yaze::editor::OracleMenuInspectorPanel::registry_
private

◆ last_error_

std::string yaze::editor::OracleMenuInspectorPanel::last_error_
private

Definition at line 47 of file menu_inspector_panel.h.

Referenced by Draw(), and RefreshRegistry().

◆ status_message_

std::string yaze::editor::OracleMenuInspectorPanel::status_message_
private

Definition at line 48 of file menu_inspector_panel.h.

Referenced by Draw(), DrawComponentsTab(), and RefreshRegistry().

◆ bins_missing_only_

bool yaze::editor::OracleMenuInspectorPanel::bins_missing_only_ = false
private

Definition at line 50 of file menu_inspector_panel.h.

Referenced by DrawBinsTab().

◆ draw_filter_

std::string yaze::editor::OracleMenuInspectorPanel::draw_filter_
private

Definition at line 51 of file menu_inspector_panel.h.

Referenced by DrawDrawRoutinesTab().

◆ component_table_filter_

std::string yaze::editor::OracleMenuInspectorPanel::component_table_filter_
private

Definition at line 52 of file menu_inspector_panel.h.

Referenced by DrawComponentsTab().

◆ filtered_components_

std::vector< const core::OracleMenuComponent * > yaze::editor::OracleMenuInspectorPanel::filtered_components_
private

Definition at line 54 of file menu_inspector_panel.h.

Referenced by DrawComponentsTab(), and RefreshRegistry().

◆ selected_component_list_index_

int yaze::editor::OracleMenuInspectorPanel::selected_component_list_index_ = -1
private

Definition at line 55 of file menu_inspector_panel.h.

Referenced by DrawComponentsTab(), and RefreshRegistry().

◆ edit_row_

int yaze::editor::OracleMenuInspectorPanel::edit_row_ = 0
private

Definition at line 56 of file menu_inspector_panel.h.

Referenced by DrawComponentsTab().

◆ edit_col_

int yaze::editor::OracleMenuInspectorPanel::edit_col_ = 0
private

Definition at line 57 of file menu_inspector_panel.h.

Referenced by DrawComponentsTab().


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