Visual dashboard of Oracle game state from SRAM data. More...

#include <progression_dashboard_panel.h>

Inheritance diagram for yaze::editor::ProgressionDashboardPanel:

Collaboration diagram for yaze::editor::ProgressionDashboardPanel:

[legend]

Public Member Functions
	~ProgressionDashboardPanel () override

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.

PanelCategory	GetPanelCategory () const override
	Get the lifecycle category for this panel.

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::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 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 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	DrawSrmImportControls ()

void	DrawLiveSyncControls ()

void	PushStateToManifestIfNeeded ()

void	DrawCrystalTracker ()

void	DrawGameState ()

void	DrawDungeonGrid ()

void	DrawStoryFlags ()

void	DrawManualControls ()

void	RefreshLiveClientBinding ()

void	EnsureLiveSubscription ()

void	ProcessPendingLiveRefresh ()

bool	RefreshStateFromLiveSram ()

void	DetachLiveListener ()

Static Private Member Functions
static bool	StatesEqual (const core::OracleProgressionState &a, const core::OracleProgressionState &b)

static void	DrawBitGrid (const char id_prefix, uint8_t value, const char const *labels)

Private Attributes
core::OracleProgressionState	state_

int	game_state_slider_ = 0

core::HackManifest *	manifest_ = nullptr

std::string	loaded_srm_path_

std::string	last_srm_error_

std::shared_ptr< emu::mesen::MesenSocketClient >	live_client_

emu::mesen::EventListenerId	live_listener_id_ = 0

bool	live_sync_enabled_ = true

bool	live_subscription_active_ = false

std::atomic< bool >	live_refresh_pending_ {false}

float	live_refresh_interval_seconds_ = 0.10f

double	last_live_refresh_time_ = 0.0

double	last_subscribe_attempt_time_ = 0.0

std::string	live_sync_error_

Static Private Attributes
static constexpr const char *	oosprog_labels_ [8]

static constexpr const char *	oosprog2_labels_ [8]

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

Visual dashboard of Oracle game state from SRAM data.

Shows crystal tracker, game state phase, story flags, and dungeon completion grid. Supports .srm file import and manual bit toggles for testing.

Definition at line 33 of file progression_dashboard_panel.h.

Constructor & Destructor Documentation

◆ ~ProgressionDashboardPanel()

yaze::editor::ProgressionDashboardPanel::~ProgressionDashboardPanel ( )

inlineoverride

Definition at line 35 of file progression_dashboard_panel.h.

References DetachLiveListener().

Here is the call graph for this function:

Member Function Documentation

◆ GetId()

std::string yaze::editor::ProgressionDashboardPanel::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 37 of file progression_dashboard_panel.h.

◆ GetDisplayName()

std::string yaze::editor::ProgressionDashboardPanel::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 38 of file progression_dashboard_panel.h.

◆ GetIcon()

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

inlineoverridevirtual

Material Design icon for this panel.

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

Implements yaze::editor::EditorPanel.

Definition at line 41 of file progression_dashboard_panel.h.

References ICON_MD_DASHBOARD.

◆ GetEditorCategory()

std::string yaze::editor::ProgressionDashboardPanel::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 42 of file progression_dashboard_panel.h.

◆ GetPanelCategory()

PanelCategory yaze::editor::ProgressionDashboardPanel::GetPanelCategory ( ) const

inlineoverridevirtual

Get the lifecycle category for this panel.

Returns: PanelCategory determining visibility behavior on editor switch

Default is EditorBound (hidden when switching editors).

Reimplemented from yaze::editor::EditorPanel.

Definition at line 43 of file progression_dashboard_panel.h.

References yaze::editor::CrossEditor.

◆ GetPreferredWidth()

float yaze::editor::ProgressionDashboardPanel::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::EditorPanel.

Definition at line 46 of file progression_dashboard_panel.h.

◆ Draw()

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

inlineoverridevirtual

Draw the panel content.

Parameters

p_open Pointer 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 48 of file progression_dashboard_panel.h.

References yaze::editor::ContentRegistry::Context::current_project(), DrawCrystalTracker(), DrawDungeonGrid(), DrawGameState(), DrawManualControls(), DrawSrmImportControls(), DrawStoryFlags(), EnsureLiveSubscription(), manifest_, ProcessPendingLiveRefresh(), PushStateToManifestIfNeeded(), and RefreshLiveClientBinding().

◆ StatesEqual()

static bool yaze::editor::ProgressionDashboardPanel::StatesEqual	(	const core::OracleProgressionState &	a,
		const core::OracleProgressionState &	b )

inlinestaticprivate

Definition at line 80 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::crystal_bitfield, yaze::core::OracleProgressionState::game_state, yaze::core::OracleProgressionState::oosprog, yaze::core::OracleProgressionState::oosprog2, yaze::core::OracleProgressionState::pendants, and yaze::core::OracleProgressionState::side_quest.

Referenced by PushStateToManifestIfNeeded().

◆ DrawSrmImportControls()

void yaze::editor::ProgressionDashboardPanel::DrawSrmImportControls ( )

inlineprivate

Definition at line 88 of file progression_dashboard_panel.h.

References yaze::core::HackManifest::ClearOracleProgressionState(), DrawLiveSyncControls(), yaze::util::FileDialogOptions::filters, yaze::core::OracleProgressionState::game_state, game_state_slider_, last_srm_error_, loaded_srm_path_, yaze::core::LoadOracleProgressionFromSrmFile(), manifest_, yaze::util::FileDialogWrapper::ShowOpenFileDialog(), and state_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawLiveSyncControls()

void yaze::editor::ProgressionDashboardPanel::DrawLiveSyncControls ( )

inlineprivate

Definition at line 142 of file progression_dashboard_panel.h.

References live_client_, live_refresh_interval_seconds_, live_refresh_pending_, live_sync_enabled_, live_sync_error_, and RefreshStateFromLiveSram().

Referenced by DrawSrmImportControls().

Here is the call graph for this function:

◆ PushStateToManifestIfNeeded()

void yaze::editor::ProgressionDashboardPanel::PushStateToManifestIfNeeded ( )

inlineprivate

Definition at line 177 of file progression_dashboard_panel.h.

References yaze::core::HackManifest::loaded(), manifest_, yaze::core::HackManifest::oracle_progression_state(), yaze::core::HackManifest::SetOracleProgressionState(), state_, and StatesEqual().

Referenced by Draw().

Here is the call graph for this function:

◆ DrawCrystalTracker()

void yaze::editor::ProgressionDashboardPanel::DrawCrystalTracker ( )

inlineprivate

Definition at line 189 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::crystal_bitfield, yaze::core::OracleProgressionState::GetCrystalCount(), yaze::core::OracleProgressionState::GetCrystalMask(), and state_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawGameState()

void yaze::editor::ProgressionDashboardPanel::DrawGameState ( )

inlineprivate

Definition at line 223 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::game_state, yaze::core::OracleProgressionState::GetGameStateName(), and state_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawDungeonGrid()

void yaze::editor::ProgressionDashboardPanel::DrawDungeonGrid ( )

inlineprivate

Definition at line 258 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::IsDungeonComplete(), and state_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawStoryFlags()

void yaze::editor::ProgressionDashboardPanel::DrawStoryFlags ( )

inlineprivate

Definition at line 296 of file progression_dashboard_panel.h.

References DrawBitGrid(), yaze::core::OracleProgressionState::oosprog, yaze::core::OracleProgressionState::oosprog2, oosprog2_labels_, oosprog_labels_, yaze::core::OracleProgressionState::side_quest, and state_.

Referenced by Draw().

Here is the call graph for this function:

◆ DrawBitGrid()

static void yaze::editor::ProgressionDashboardPanel::DrawBitGrid	(	const char *	id_prefix,
		uint8_t	value,
		const char const	labels )

inlinestaticprivate

Definition at line 317 of file progression_dashboard_panel.h.

Referenced by DrawStoryFlags().

◆ DrawManualControls()

void yaze::editor::ProgressionDashboardPanel::DrawManualControls ( )

inlineprivate

Definition at line 335 of file progression_dashboard_panel.h.

References yaze::core::OracleProgressionState::crystal_bitfield, yaze::core::OracleProgressionState::game_state, game_state_slider_, and state_.

Referenced by Draw().

◆ RefreshLiveClientBinding()

void yaze::editor::ProgressionDashboardPanel::RefreshLiveClientBinding ( )

inlineprivate

Definition at line 362 of file progression_dashboard_panel.h.

References DetachLiveListener(), yaze::emu::mesen::MesenClientRegistry::GetClient(), live_client_, live_refresh_pending_, live_subscription_active_, and live_sync_error_.

Referenced by Draw().

Here is the call graph for this function:

◆ EnsureLiveSubscription()

void yaze::editor::ProgressionDashboardPanel::EnsureLiveSubscription ( )

inlineprivate

Definition at line 378 of file progression_dashboard_panel.h.

References last_subscribe_attempt_time_, live_client_, live_listener_id_, live_refresh_pending_, live_subscription_active_, live_sync_enabled_, live_sync_error_, and yaze::emu::mesen::MesenEvent::type.

Referenced by Draw().

◆ ProcessPendingLiveRefresh()

void yaze::editor::ProgressionDashboardPanel::ProcessPendingLiveRefresh ( )

inlineprivate

Definition at line 418 of file progression_dashboard_panel.h.

References last_live_refresh_time_, live_refresh_interval_seconds_, live_refresh_pending_, live_sync_enabled_, and RefreshStateFromLiveSram().

Referenced by Draw().

Here is the call graph for this function:

◆ RefreshStateFromLiveSram()

bool yaze::editor::ProgressionDashboardPanel::RefreshStateFromLiveSram ( )

inlineprivate

Definition at line 435 of file progression_dashboard_panel.h.

Referenced by DrawLiveSyncControls(), and ProcessPendingLiveRefresh().

◆ DetachLiveListener()

void yaze::editor::ProgressionDashboardPanel::DetachLiveListener ( )

inlineprivate

Definition at line 476 of file progression_dashboard_panel.h.

References live_client_, live_listener_id_, and live_subscription_active_.

Referenced by RefreshLiveClientBinding(), and ~ProgressionDashboardPanel().

Member Data Documentation

◆ state_

core::OracleProgressionState yaze::editor::ProgressionDashboardPanel::state_

private

Definition at line 484 of file progression_dashboard_panel.h.

Referenced by DrawCrystalTracker(), DrawDungeonGrid(), DrawGameState(), DrawManualControls(), DrawSrmImportControls(), DrawStoryFlags(), PushStateToManifestIfNeeded(), and RefreshStateFromLiveSram().

◆ game_state_slider_

int yaze::editor::ProgressionDashboardPanel::game_state_slider_ = 0

private

Definition at line 485 of file progression_dashboard_panel.h.

Referenced by DrawManualControls(), DrawSrmImportControls(), and RefreshStateFromLiveSram().

◆ manifest_

core::HackManifest* yaze::editor::ProgressionDashboardPanel::manifest_ = nullptr

private

Definition at line 487 of file progression_dashboard_panel.h.

Referenced by Draw(), DrawSrmImportControls(), and PushStateToManifestIfNeeded().

◆ loaded_srm_path_

std::string yaze::editor::ProgressionDashboardPanel::loaded_srm_path_

private

Definition at line 488 of file progression_dashboard_panel.h.

Referenced by DrawSrmImportControls(), and RefreshStateFromLiveSram().

◆ last_srm_error_

std::string yaze::editor::ProgressionDashboardPanel::last_srm_error_

private

Definition at line 489 of file progression_dashboard_panel.h.

Referenced by DrawSrmImportControls(), and RefreshStateFromLiveSram().

◆ live_client_

std::shared_ptr<emu::mesen::MesenSocketClient> yaze::editor::ProgressionDashboardPanel::live_client_

private

Definition at line 491 of file progression_dashboard_panel.h.

Referenced by DetachLiveListener(), DrawLiveSyncControls(), EnsureLiveSubscription(), RefreshLiveClientBinding(), and RefreshStateFromLiveSram().

◆ live_listener_id_

emu::mesen::EventListenerId yaze::editor::ProgressionDashboardPanel::live_listener_id_ = 0

private

Definition at line 492 of file progression_dashboard_panel.h.

Referenced by DetachLiveListener(), and EnsureLiveSubscription().

◆ live_sync_enabled_

bool yaze::editor::ProgressionDashboardPanel::live_sync_enabled_ = true

private

Definition at line 493 of file progression_dashboard_panel.h.

Referenced by DrawLiveSyncControls(), EnsureLiveSubscription(), and ProcessPendingLiveRefresh().

◆ live_subscription_active_

bool yaze::editor::ProgressionDashboardPanel::live_subscription_active_ = false

private

Definition at line 494 of file progression_dashboard_panel.h.

Referenced by DetachLiveListener(), EnsureLiveSubscription(), and RefreshLiveClientBinding().

◆ live_refresh_pending_

std::atomic<bool> yaze::editor::ProgressionDashboardPanel::live_refresh_pending_ {false}

private

Definition at line 495 of file progression_dashboard_panel.h.

Referenced by DrawLiveSyncControls(), EnsureLiveSubscription(), ProcessPendingLiveRefresh(), and RefreshLiveClientBinding().

◆ live_refresh_interval_seconds_

float yaze::editor::ProgressionDashboardPanel::live_refresh_interval_seconds_ = 0.10f

private

Definition at line 496 of file progression_dashboard_panel.h.

Referenced by DrawLiveSyncControls(), and ProcessPendingLiveRefresh().

◆ last_live_refresh_time_

double yaze::editor::ProgressionDashboardPanel::last_live_refresh_time_ = 0.0

private

Definition at line 497 of file progression_dashboard_panel.h.

Referenced by ProcessPendingLiveRefresh().

◆ last_subscribe_attempt_time_

double yaze::editor::ProgressionDashboardPanel::last_subscribe_attempt_time_ = 0.0

private

Definition at line 498 of file progression_dashboard_panel.h.

Referenced by EnsureLiveSubscription().

◆ live_sync_error_

std::string yaze::editor::ProgressionDashboardPanel::live_sync_error_

private

Definition at line 499 of file progression_dashboard_panel.h.

Referenced by DrawLiveSyncControls(), EnsureLiveSubscription(), RefreshLiveClientBinding(), and RefreshStateFromLiveSram().

◆ oosprog_labels_

constexpr const char* yaze::editor::ProgressionDashboardPanel::oosprog_labels_[8]

staticconstexprprivate

Initial value:

= {
      "Bit0", "HallOfSecrets", "PendantQuest", "Bit3",
      "ElderMet", "Bit5",       "Bit6",         "FortressComplete",
  }

Definition at line 502 of file progression_dashboard_panel.h.

Referenced by DrawStoryFlags().

◆ oosprog2_labels_

constexpr const char* yaze::editor::ProgressionDashboardPanel::oosprog2_labels_[8]

staticconstexprprivate

Initial value:

= {
      "Bit0",           "Bit1",          "KydrogEncounter", "Bit3",
      "DekuSoulFreed",  "BookOfSecrets", "Bit6",            "Bit7",
  }

Definition at line 507 of file progression_dashboard_panel.h.

Referenced by DrawStoryFlags().

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

src/app/editor/oracle/panels/progression_dashboard_panel.h

	yaze 0.3.2 Link to the Past ROM Editor

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ProgressionDashboardPanel()

Member Function Documentation

◆ GetId()

◆ GetDisplayName()

◆ GetIcon()

◆ GetEditorCategory()

◆ GetPanelCategory()

◆ GetPreferredWidth()

◆ Draw()

◆ StatesEqual()

◆ DrawSrmImportControls()

◆ DrawLiveSyncControls()

◆ PushStateToManifestIfNeeded()

◆ DrawCrystalTracker()

◆ DrawGameState()

◆ DrawDungeonGrid()

◆ DrawStoryFlags()

◆ DrawBitGrid()

◆ DrawManualControls()

◆ RefreshLiveClientBinding()

◆ EnsureLiveSubscription()

◆ ProcessPendingLiveRefresh()

◆ RefreshStateFromLiveSram()

◆ DetachLiveListener()

Member Data Documentation

◆ state_

◆ game_state_slider_

◆ manifest_

◆ loaded_srm_path_

◆ last_srm_error_

◆ live_client_

◆ live_listener_id_

◆ live_sync_enabled_

◆ live_subscription_active_

◆ live_refresh_pending_

◆ live_refresh_interval_seconds_

◆ last_live_refresh_time_

◆ last_subscribe_attempt_time_

◆ live_sync_error_

◆ oosprog_labels_

◆ oosprog2_labels_