WindowContent wrapper for the piano roll view. More...

#include <music_piano_roll_panel.h>

Inheritance diagram for yaze::editor::MusicPianoRollPanel:

Collaboration diagram for yaze::editor::MusicPianoRollPanel:

[legend]

Public Member Functions
	MusicPianoRollPanel (zelda3::music::MusicBank music_bank, int current_song_index, int current_segment_index, int current_channel_index, music::PianoRollView piano_roll_view, music::MusicPlayer music_player)

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.

int	GetPriority () const override
	Get display priority for menu ordering.

void	SetOnEditCallback (std::function< void()> callback)

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 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 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 Attributes
zelda3::music::MusicBank *	music_bank_ = nullptr

int *	current_song_index_ = nullptr

int *	current_segment_index_ = nullptr

int *	current_channel_index_ = nullptr

music::PianoRollView *	piano_roll_view_ = nullptr

music::MusicPlayer *	music_player_ = nullptr

std::function< void()>	on_edit_

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

WindowContent wrapper for the piano roll view.

Delegates to PianoRollView for the actual UI drawing.

Definition at line 23 of file music_piano_roll_panel.h.

Constructor & Destructor Documentation

◆ MusicPianoRollPanel()

yaze::editor::MusicPianoRollPanel::MusicPianoRollPanel	(	zelda3::music::MusicBank *	music_bank,
		int *	current_song_index,
		int *	current_segment_index,
		int *	current_channel_index,
		music::PianoRollView *	piano_roll_view,
		music::MusicPlayer *	music_player )

inline

Definition at line 25 of file music_piano_roll_panel.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::MusicPianoRollPanel::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 41 of file music_piano_roll_panel.h.

◆ GetDisplayName()

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

◆ GetIcon()

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

inlineoverridevirtual

Material Design icon for this panel.

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

Implements yaze::editor::WindowContent.

Definition at line 43 of file music_piano_roll_panel.h.

References ICON_MD_PIANO.

◆ GetEditorCategory()

std::string yaze::editor::MusicPianoRollPanel::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 44 of file music_piano_roll_panel.h.

◆ GetPresentationPolicy()

WindowPresentationPolicy yaze::editor::MusicPianoRollPanel::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 45 of file music_piano_roll_panel.h.

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

Here is the call graph for this function:

◆ GetPriority()

int yaze::editor::MusicPianoRollPanel::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 48 of file music_piano_roll_panel.h.

◆ SetOnEditCallback()

void yaze::editor::MusicPianoRollPanel::SetOnEditCallback ( std::function< void()> callback )

inline

Definition at line 54 of file music_piano_roll_panel.h.

References on_edit_, piano_roll_view_, and yaze::editor::music::PianoRollView::SetOnEditCallback().

Here is the call graph for this function:

◆ Draw()

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

inlineoverridevirtual

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 64 of file music_piano_roll_panel.h.

Member Data Documentation

◆ music_bank_

zelda3::music::MusicBank* yaze::editor::MusicPianoRollPanel::music_bank_ = nullptr

private

Definition at line 113 of file music_piano_roll_panel.h.

Referenced by Draw().

◆ current_song_index_

int* yaze::editor::MusicPianoRollPanel::current_song_index_ = nullptr

private

Definition at line 114 of file music_piano_roll_panel.h.

Referenced by Draw().

◆ current_segment_index_

int* yaze::editor::MusicPianoRollPanel::current_segment_index_ = nullptr

private

Definition at line 115 of file music_piano_roll_panel.h.

Referenced by Draw().

◆ current_channel_index_

int* yaze::editor::MusicPianoRollPanel::current_channel_index_ = nullptr

private

Definition at line 116 of file music_piano_roll_panel.h.

Referenced by Draw().

◆ piano_roll_view_

music::PianoRollView* yaze::editor::MusicPianoRollPanel::piano_roll_view_ = nullptr

private

Definition at line 117 of file music_piano_roll_panel.h.

Referenced by Draw(), and SetOnEditCallback().

◆ music_player_

music::MusicPlayer* yaze::editor::MusicPianoRollPanel::music_player_ = nullptr

private

Definition at line 118 of file music_piano_roll_panel.h.

Referenced by Draw().

◆ on_edit_

std::function<void()> yaze::editor::MusicPianoRollPanel::on_edit_

private

Definition at line 119 of file music_piano_roll_panel.h.

Referenced by SetOnEditCallback().

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

src/app/editor/music/ui/window/music_piano_roll_panel.h

	yaze 0.3.2 Link to the Past ROM Editor

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MusicPianoRollPanel()

Member Function Documentation

◆ GetId()

◆ GetDisplayName()

◆ GetIcon()

◆ GetEditorCategory()

◆ GetPresentationPolicy()

◆ GetPriority()

◆ SetOnEditCallback()

◆ Draw()

Member Data Documentation

◆ music_bank_

◆ current_song_index_

◆ current_segment_index_

◆ current_channel_index_

◆ piano_roll_view_

◆ music_player_

◆ on_edit_