Panel for live monitoring of Oracle of Secrets RAM variables. More...

#include <oracle_ram_panel.h>

Inheritance diagram for yaze::editor::OracleRamPanel:

Collaboration diagram for yaze::editor::OracleRamPanel:

Classes
struct	RamVariable

Public Member Functions
	OracleRamPanel ()

	~OracleRamPanel () override=default

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.

WindowPresentationPolicy	GetPresentationPolicy () const override
	How this content is hosted and advertised by workspace chrome.

WindowLifecycle	GetWindowLifecycle () const override
	Get the lifecycle category for this window.

void	Draw (bool *p_open) override
	Draw the panel content.

void	OnOpen () override
	Called when panel becomes visible.

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	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	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 float	GetPreferredWidth () const
	Get preferred width for this panel (optional)

virtual bool	HasExactPreferredWidth () const
	Whether GetPreferredWidth() is an exact content width.

virtual float	GetPreferredHeight () const
	Get preferred height for this panel (optional)

virtual bool	PrefersFloating () const

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	InitializeVariables ()

void	RefreshVariables ()

void	DrawVariableTable ()

Private Attributes
std::vector< RamVariable >	variables_

double	last_refresh_time_ = 0.0

bool	auto_refresh_ = true

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

Panel for live monitoring of Oracle of Secrets RAM variables.

Definition at line 17 of file oracle_ram_panel.h.

Constructor & Destructor Documentation

◆ OracleRamPanel()

yaze::editor::OracleRamPanel::OracleRamPanel ( )

Definition at line 15 of file oracle_ram_panel.cc.

References InitializeVariables().

Here is the call graph for this function:

◆ ~OracleRamPanel()

yaze::editor::OracleRamPanel::~OracleRamPanel ( )

overridedefault

Member Function Documentation

◆ GetId()

std::string yaze::editor::OracleRamPanel::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 23 of file oracle_ram_panel.h.

◆ GetDisplayName()

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

◆ GetIcon()

std::string yaze::editor::OracleRamPanel::GetIcon ( ) const

overridevirtual

Material Design icon for this panel.

Returns: Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::WindowContent.

Definition at line 19 of file oracle_ram_panel.cc.

References ICON_MD_MEMORY.

◆ GetEditorCategory()

std::string yaze::editor::OracleRamPanel::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 26 of file oracle_ram_panel.h.

◆ GetPresentationPolicy()

WindowPresentationPolicy yaze::editor::OracleRamPanel::GetPresentationPolicy ( ) const

inlineoverridevirtual

How this content is hosted and advertised by workspace chrome.

Every panel must override this and return one of the named policies (CoreWorkspace, EmbeddedTool, OptionalPopOut, Diagnostic). The base implementation returns an undeclared policy that keeps the historical listed pop-out behavior, but the panel admission audit (test/unit/editor/panel_admission_test.cc) fails until the panel chooses. See docs/internal/architecture/editor-ui-module-pattern.md, "Panel admission".

Reimplemented from yaze::editor::WindowContent.

Definition at line 27 of file oracle_ram_panel.h.

References yaze::editor::WindowPresentationPolicy::OptionalPopOut().

Here is the call graph for this function:

◆ GetWindowLifecycle()

WindowLifecycle yaze::editor::OracleRamPanel::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 30 of file oracle_ram_panel.h.

References yaze::editor::CrossEditor.

◆ Draw()

void yaze::editor::OracleRamPanel::Draw ( bool * p_open )

overridevirtual

Draw the panel content.

Parameters

p_open Pointer 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 73 of file oracle_ram_panel.cc.

References auto_refresh_, DrawVariableTable(), ICON_MD_PAUSE, ICON_MD_PLAY_ARROW, ICON_MD_REFRESH, last_refresh_time_, and RefreshVariables().

Here is the call graph for this function:

◆ OnOpen()

void yaze::editor::OracleRamPanel::OnOpen ( )

overridevirtual

Called when panel becomes visible.

Use this to initialize state, load resources, or start animations. Called after the panel is shown but before first Draw().

Reimplemented from yaze::editor::WindowContent.

Definition at line 23 of file oracle_ram_panel.cc.

References RefreshVariables().

Here is the call graph for this function:

◆ InitializeVariables()

void yaze::editor::OracleRamPanel::InitializeVariables ( )

private

Definition at line 27 of file oracle_ram_panel.cc.

References variables_.

Referenced by OracleRamPanel().

◆ RefreshVariables()

void yaze::editor::OracleRamPanel::RefreshVariables ( )

private

Definition at line 50 of file oracle_ram_panel.cc.

References yaze::emu::mesen::MesenClientRegistry::GetOrCreate(), and variables_.

Referenced by Draw(), and OnOpen().

Here is the call graph for this function:

◆ DrawVariableTable()

void yaze::editor::OracleRamPanel::DrawVariableTable ( )

private

Definition at line 97 of file oracle_ram_panel.cc.

References variables_.

Referenced by Draw().

Member Data Documentation

◆ variables_

std::vector<RamVariable> yaze::editor::OracleRamPanel::variables_

private

Definition at line 50 of file oracle_ram_panel.h.

Referenced by DrawVariableTable(), InitializeVariables(), and RefreshVariables().

◆ last_refresh_time_

double yaze::editor::OracleRamPanel::last_refresh_time_ = 0.0

private

Definition at line 51 of file oracle_ram_panel.h.

Referenced by Draw().

◆ auto_refresh_

bool yaze::editor::OracleRamPanel::auto_refresh_ = true

private

Definition at line 52 of file oracle_ram_panel.h.

Referenced by Draw().

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

src/app/editor/agent/oracle_ram_panel.h
src/app/editor/agent/oracle_ram_panel.cc

	yaze 0.3.2 Link to the Past ROM Editor

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OracleRamPanel()

◆ ~OracleRamPanel()

Member Function Documentation

◆ GetId()

◆ GetDisplayName()

◆ GetIcon()

◆ GetEditorCategory()

◆ GetPresentationPolicy()

◆ GetWindowLifecycle()

◆ Draw()

◆ OnOpen()

◆ InitializeVariables()

◆ RefreshVariables()

◆ DrawVariableTable()

Member Data Documentation

◆ variables_

◆ last_refresh_time_

◆ auto_refresh_