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

EditorPanel wrapper for the sample editor. More...

#include <music_sample_editor_panel.h>

Inheritance diagram for yaze::editor::MusicSampleEditorPanel:
Collaboration diagram for yaze::editor::MusicSampleEditorPanel:

Public Member Functions

 MusicSampleEditorPanel (zelda3::music::MusicBank *music_bank, music::SampleEditorView *sample_view)
 
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.
 
void Draw (bool *p_open) override
 Draw the panel content.
 
void SetOnEditCallback (std::function< void()> callback)
 
void SetOnPreviewCallback (std::function< void(int)> callback)
 
- Public Member Functions inherited from yaze::editor::EditorPanel
virtual ~EditorPanel ()=default
 
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 PanelCategory GetPanelCategory () const
 Get the lifecycle category 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 float GetPreferredWidth () const
 Get preferred width for this panel (optional)
 
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.
 

Private Attributes

zelda3::music::MusicBankmusic_bank_ = nullptr
 
music::SampleEditorViewsample_view_ = nullptr
 

Detailed Description

EditorPanel wrapper for the sample editor.

Delegates to SampleEditorView for the actual UI drawing.

Definition at line 21 of file music_sample_editor_panel.h.

Constructor & Destructor Documentation

◆ MusicSampleEditorPanel()

yaze::editor::MusicSampleEditorPanel::MusicSampleEditorPanel ( zelda3::music::MusicBank * music_bank,
music::SampleEditorView * sample_view )
inline

Definition at line 23 of file music_sample_editor_panel.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::MusicSampleEditorPanel::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 31 of file music_sample_editor_panel.h.

◆ GetDisplayName()

std::string yaze::editor::MusicSampleEditorPanel::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 32 of file music_sample_editor_panel.h.

◆ GetIcon()

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

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::EditorPanel.

Definition at line 33 of file music_sample_editor_panel.h.

References ICON_MD_WAVES.

◆ GetEditorCategory()

std::string yaze::editor::MusicSampleEditorPanel::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 34 of file music_sample_editor_panel.h.

◆ GetPriority()

int yaze::editor::MusicSampleEditorPanel::GetPriority ( ) const
inlineoverridevirtual

Get display priority for menu ordering.

Returns
Priority value (lower = higher in list, default 50)

Reimplemented from yaze::editor::EditorPanel.

Definition at line 35 of file music_sample_editor_panel.h.

◆ Draw()

void yaze::editor::MusicSampleEditorPanel::Draw ( bool * p_open)
inlineoverridevirtual

Draw the panel content.

Parameters
p_openPointer 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 41 of file music_sample_editor_panel.h.

References yaze::editor::music::SampleEditorView::Draw(), music_bank_, and sample_view_.

Here is the call graph for this function:

◆ SetOnEditCallback()

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

Definition at line 54 of file music_sample_editor_panel.h.

References sample_view_, and yaze::editor::music::SampleEditorView::SetOnEditCallback().

Here is the call graph for this function:

◆ SetOnPreviewCallback()

void yaze::editor::MusicSampleEditorPanel::SetOnPreviewCallback ( std::function< void(int)> callback)
inline

Definition at line 58 of file music_sample_editor_panel.h.

References sample_view_, and yaze::editor::music::SampleEditorView::SetOnPreviewCallback().

Here is the call graph for this function:

Member Data Documentation

◆ music_bank_

zelda3::music::MusicBank* yaze::editor::MusicSampleEditorPanel::music_bank_ = nullptr
private

Definition at line 63 of file music_sample_editor_panel.h.

Referenced by Draw().

◆ sample_view_

music::SampleEditorView* yaze::editor::MusicSampleEditorPanel::sample_view_ = nullptr
private

Definition at line 64 of file music_sample_editor_panel.h.

Referenced by Draw(), SetOnEditCallback(), and SetOnPreviewCallback().


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