yaze::editor::RomLoadOptionsDialog Class Reference

ROM load options and ZSCustomOverworld upgrade dialog. More...

#include <rom_load_options_dialog.h>

Collaboration diagram for yaze::editor::RomLoadOptionsDialog:

Classes
struct	LoadOptions

Public Member Functions
	RomLoadOptionsDialog ()
	~RomLoadOptionsDialog ()=default
void	Open (Rom *rom, const std::string &rom_filename)
	Open the dialog after ROM detection.
void	Open (Rom *rom, const std::string &rom_filename, bool suggest_project_creation)
void	Open (Rom *rom)
	Open the dialog with just ROM pointer (filename from ROM)
void	Open (Rom *rom, bool suggest_project_creation)
bool	Show (bool *p_open)
	Show the dialog.
void	Draw (bool *p_open)
	Draw the dialog (wrapper around Show)
const LoadOptions &	GetOptions () const
	Get the selected load options.
bool	WasConfirmed () const
	Check if dialog resulted in confirmation.
void	ResetConfirmation ()
	Reset confirmation state.
void	SetConfirmCallback (std::function< void(const LoadOptions &)> callback)
	Set callback for when options are confirmed.
void	SetUpgradeCallback (std::function< absl::Status(int version)> callback)
	Set callback for ZSO upgrade.
bool	ShouldPromptUpgrade () const
	Check if ROM needs upgrade prompt.
zelda3::OverworldVersion	GetDetectedVersion () const
	Get detected ROM version.

Private Member Functions
void	DrawVersionInfo ()
void	DrawUpgradeOptions ()
void	DrawFeatureFlagPresets ()
void	DrawFeatureFlagDetails ()
void	DrawProjectOptions ()
void	DrawActionButtons ()
void	ApplyPreset (const std::string &preset_name)
void	ApplyOptionsToFeatureFlags ()

Private Attributes
Rom *	rom_ = nullptr
std::string	rom_filename_
zelda3::OverworldVersion	detected_version_
bool	is_open_ = false
bool	confirmed_ = false
bool	show_advanced_ = false
LoadOptions	options_
int	selected_preset_index_ = 0
std::function< void(const LoadOptions &)	confirm_callback_ )
std::function< absl::Status(int version)>	upgrade_callback_
char	project_name_buffer_ [256] = {}
char	project_path_buffer_ [512] = {}

Static Private Attributes
static constexpr int	kNumPresets = 4
static const char *	kPresetNames [kNumPresets]
static const char *	kPresetDescriptions [kNumPresets]

Detailed Description

ROM load options and ZSCustomOverworld upgrade dialog.

Shown after ROM detection to offer:

• ZSCustomOverworld version upgrade options
• Feature flag presets
• Project creation integration

Flow:

1. ROM loaded -> Detect version
2. If vanilla, offer upgrade to v2/v3
3. Show feature flag presets based on version
4. Optionally create associated project

Definition at line 32 of file rom_load_options_dialog.h.

Constructor & Destructor Documentation

RomLoadOptionsDialog()

yaze::editor::RomLoadOptionsDialog::RomLoadOptionsDialog

(

)

Definition at line 27 of file rom_load_options_dialog.cc.

References options_, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_entrances, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_exits, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_items, and yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_maps.

~RomLoadOptionsDialog()

yaze::editor::RomLoadOptionsDialog::~RomLoadOptionsDialog ( )

default

Member Function Documentation

Open() [1/4]

void yaze::editor::RomLoadOptionsDialog::Open	(	Rom *	rom,
		const std::string &	rom_filename )

Open the dialog after ROM detection.

Parameters

rom	Pointer to loaded ROM for version detection
rom_filename	Filename for display and project naming

Definition at line 51 of file rom_load_options_dialog.cc.

References Open().

Referenced by yaze::editor::EditorManager::LoadRom(), Open(), Open(), and Open().

Here is the call graph for this function:

Open() [2/4]

void yaze::editor::RomLoadOptionsDialog::Open	(	Rom *	rom,
		const std::string &	rom_filename,
		bool	suggest_project_creation )

Definition at line 55 of file rom_load_options_dialog.cc.

References ApplyPreset(), confirmed_, yaze::editor::RomLoadOptionsDialog::LoadOptions::create_project, detected_version_, yaze::zelda3::OverworldVersionHelper::GetVersion(), yaze::Rom::is_loaded(), is_open_, kPresetNames, yaze::zelda3::kVanilla, yaze::zelda3::kZSCustomV1, yaze::zelda3::kZSCustomV2, yaze::zelda3::kZSCustomV3, options_, project_name_buffer_, rom_, rom_filename_, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_entrances, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_exits, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_items, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_maps, selected_preset_index_, show_advanced_, yaze::editor::RomLoadOptionsDialog::LoadOptions::target_zso_version, and yaze::editor::RomLoadOptionsDialog::LoadOptions::upgrade_to_zscustom.

Here is the call graph for this function:

Open() [3/4]

void yaze::editor::RomLoadOptionsDialog::Open

(

Rom *

rom

)

Open the dialog with just ROM pointer (filename from ROM)

Parameters

rom	Pointer to loaded ROM

Definition at line 35 of file rom_load_options_dialog.cc.

References yaze::Rom::filename(), and Open().

Here is the call graph for this function:

Open() [4/4]

void yaze::editor::RomLoadOptionsDialog::Open	(	Rom *	rom,
		bool	suggest_project_creation )

Definition at line 41 of file rom_load_options_dialog.cc.

References yaze::Rom::filename(), and Open().

Here is the call graph for this function:

Show()

bool yaze::editor::RomLoadOptionsDialog::Show

(

bool *

p_open

)

Show the dialog.

Parameters

p_open

Pointer to open state

Returns

True if user confirmed options

Definition at line 115 of file rom_load_options_dialog.cc.

References confirmed_, DrawActionButtons(), DrawFeatureFlagDetails(), DrawFeatureFlagPresets(), DrawProjectOptions(), DrawUpgradeOptions(), DrawVersionInfo(), ICON_MD_SETTINGS, is_open_, and show_advanced_.

Referenced by Draw().

Draw()

void yaze::editor::RomLoadOptionsDialog::Draw

(

bool *

p_open

)

Draw the dialog (wrapper around Show)

Parameters

p_open

Pointer to open state

Definition at line 47 of file rom_load_options_dialog.cc.

References Show().

Referenced by yaze::editor::EditorManager::DrawInterface().

Here is the call graph for this function:

GetOptions()

const LoadOptions & yaze::editor::RomLoadOptionsDialog::GetOptions ( ) const

inline

Get the selected load options.

Definition at line 94 of file rom_load_options_dialog.h.

References options_.

WasConfirmed()

bool yaze::editor::RomLoadOptionsDialog::WasConfirmed ( ) const

inline

Check if dialog resulted in confirmation.

Definition at line 99 of file rom_load_options_dialog.h.

References confirmed_.

ResetConfirmation()

void yaze::editor::RomLoadOptionsDialog::ResetConfirmation ( )

inline

Reset confirmation state.

Definition at line 104 of file rom_load_options_dialog.h.

References confirmed_.

SetConfirmCallback()

void yaze::editor::RomLoadOptionsDialog::SetConfirmCallback ( std::function< void(const LoadOptions &)> callback )

inline

Set callback for when options are confirmed.

Definition at line 109 of file rom_load_options_dialog.h.

References confirm_callback_.

Referenced by yaze::editor::EditorManager::SetupDialogCallbacks().

SetUpgradeCallback()

void yaze::editor::RomLoadOptionsDialog::SetUpgradeCallback ( std::function< absl::Status(int version)> callback )

inline

Set callback for ZSO upgrade.

Definition at line 116 of file rom_load_options_dialog.h.

References upgrade_callback_.

ShouldPromptUpgrade()

bool yaze::editor::RomLoadOptionsDialog::ShouldPromptUpgrade

(

)

const

Check if ROM needs upgrade prompt.

Definition at line 466 of file rom_load_options_dialog.cc.

References detected_version_, and yaze::zelda3::kVanilla.

GetDetectedVersion()

zelda3::OverworldVersion yaze::editor::RomLoadOptionsDialog::GetDetectedVersion ( ) const

inline

Get detected ROM version.

Definition at line 128 of file rom_load_options_dialog.h.

References detected_version_.

DrawVersionInfo()

void yaze::editor::RomLoadOptionsDialog::DrawVersionInfo ( )

private

Definition at line 159 of file rom_load_options_dialog.cc.

References yaze::gui::ConvertColorToImVec4(), detected_version_, yaze::gui::ThemeManager::Get(), yaze::gui::ThemeManager::GetCurrentTheme(), yaze::zelda3::OverworldVersionHelper::GetVersionName(), ICON_MD_INFO, ICON_MD_UPGRADE, ICON_MD_VERIFIED, yaze::zelda3::kVanilla, yaze::zelda3::kZSCustomV1, yaze::zelda3::kZSCustomV2, yaze::zelda3::kZSCustomV3, and rom_filename_.

Referenced by Show().

Here is the call graph for this function:

DrawUpgradeOptions()

void yaze::editor::RomLoadOptionsDialog::DrawUpgradeOptions ( )

private

Definition at line 201 of file rom_load_options_dialog.cc.

References detected_version_, yaze::editor::RomLoadOptionsDialog::LoadOptions::enable_custom_overworld, yaze::editor::RomLoadOptionsDialog::LoadOptions::enable_tail_expansion, yaze::zelda3::OverworldVersionHelper::GetVersionName(), ICON_MD_AUTO_FIX_HIGH, ICON_MD_CHECK_CIRCLE, yaze::zelda3::kVanilla, options_, yaze::editor::RomLoadOptionsDialog::LoadOptions::target_zso_version, and yaze::editor::RomLoadOptionsDialog::LoadOptions::upgrade_to_zscustom.

Referenced by Show().

Here is the call graph for this function:

DrawFeatureFlagPresets()

void yaze::editor::RomLoadOptionsDialog::DrawFeatureFlagPresets ( )

private

Definition at line 266 of file rom_load_options_dialog.cc.

References ApplyPreset(), ICON_MD_TUNE, kNumPresets, kPresetDescriptions, kPresetNames, selected_preset_index_, and show_advanced_.

Referenced by Show().

Here is the call graph for this function:

DrawFeatureFlagDetails()

void yaze::editor::RomLoadOptionsDialog::DrawFeatureFlagDetails ( )

private

Definition at line 303 of file rom_load_options_dialog.cc.

References ICON_MD_FLAG, options_, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_all_palettes, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_dungeon_maps, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_gfx_groups, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_entrances, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_exits, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_items, and yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_maps.

Referenced by Show().

DrawProjectOptions()

void yaze::editor::RomLoadOptionsDialog::DrawProjectOptions ( )

private

Definition at line 330 of file rom_load_options_dialog.cc.

References yaze::editor::RomLoadOptionsDialog::LoadOptions::create_project, ICON_MD_FOLDER, options_, yaze::editor::RomLoadOptionsDialog::LoadOptions::project_name, and project_name_buffer_.

Referenced by Show().

DrawActionButtons()

void yaze::editor::RomLoadOptionsDialog::DrawActionButtons ( )

private

Definition at line 353 of file rom_load_options_dialog.cc.

References ApplyOptionsToFeatureFlags(), confirm_callback_, confirmed_, yaze::gui::ConvertColorToImVec4(), yaze::gui::ThemeManager::Get(), yaze::gui::ThemeManager::GetCurrentTheme(), ICON_MD_CHECK, is_open_, kPresetNames, options_, yaze::editor::RomLoadOptionsDialog::LoadOptions::selected_preset, selected_preset_index_, yaze::editor::RomLoadOptionsDialog::LoadOptions::target_zso_version, upgrade_callback_, and yaze::editor::RomLoadOptionsDialog::LoadOptions::upgrade_to_zscustom.

Referenced by Show().

Here is the call graph for this function:

ApplyPreset()

void yaze::editor::RomLoadOptionsDialog::ApplyPreset ( const std::string & preset_name )

private

Definition at line 404 of file rom_load_options_dialog.cc.

References detected_version_, yaze::editor::RomLoadOptionsDialog::LoadOptions::enable_custom_overworld, yaze::zelda3::kVanilla, options_, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_all_palettes, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_dungeon_maps, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_gfx_groups, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_entrances, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_exits, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_items, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_maps, yaze::editor::RomLoadOptionsDialog::LoadOptions::target_zso_version, and yaze::editor::RomLoadOptionsDialog::LoadOptions::upgrade_to_zscustom.

Referenced by DrawFeatureFlagPresets(), and Open().

ApplyOptionsToFeatureFlags()

void yaze::editor::RomLoadOptionsDialog::ApplyOptionsToFeatureFlags ( )

private

Definition at line 452 of file rom_load_options_dialog.cc.

References yaze::editor::RomLoadOptionsDialog::LoadOptions::enable_custom_overworld, yaze::editor::RomLoadOptionsDialog::LoadOptions::enable_tail_expansion, yaze::core::FeatureFlags::get(), options_, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_all_palettes, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_dungeon_maps, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_gfx_groups, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_entrances, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_exits, yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_items, and yaze::editor::RomLoadOptionsDialog::LoadOptions::save_overworld_maps.

Referenced by DrawActionButtons().

Here is the call graph for this function:

Member Data Documentation

rom_

Rom* yaze::editor::RomLoadOptionsDialog::rom_ = nullptr

private

Definition at line 144 of file rom_load_options_dialog.h.

Referenced by Open().

rom_filename_

std::string yaze::editor::RomLoadOptionsDialog::rom_filename_

private

Definition at line 145 of file rom_load_options_dialog.h.

Referenced by DrawVersionInfo(), and Open().

detected_version_

zelda3::OverworldVersion yaze::editor::RomLoadOptionsDialog::detected_version_

private

Initial value:

=
      zelda3::OverworldVersion::kVanilla

Definition at line 146 of file rom_load_options_dialog.h.

Referenced by ApplyPreset(), DrawUpgradeOptions(), DrawVersionInfo(), GetDetectedVersion(), Open(), and ShouldPromptUpgrade().

is_open_

bool yaze::editor::RomLoadOptionsDialog::is_open_ = false

private

Definition at line 148 of file rom_load_options_dialog.h.

Referenced by DrawActionButtons(), Open(), and Show().

confirmed_

bool yaze::editor::RomLoadOptionsDialog::confirmed_ = false

private

Definition at line 149 of file rom_load_options_dialog.h.

Referenced by DrawActionButtons(), Open(), ResetConfirmation(), Show(), and WasConfirmed().

show_advanced_

bool yaze::editor::RomLoadOptionsDialog::show_advanced_ = false

private

Definition at line 150 of file rom_load_options_dialog.h.

Referenced by DrawFeatureFlagPresets(), Open(), and Show().

options_

LoadOptions yaze::editor::RomLoadOptionsDialog::options_

private

Definition at line 153 of file rom_load_options_dialog.h.

Referenced by ApplyOptionsToFeatureFlags(), ApplyPreset(), DrawActionButtons(), DrawFeatureFlagDetails(), DrawProjectOptions(), DrawUpgradeOptions(), GetOptions(), Open(), and RomLoadOptionsDialog().

kNumPresets

constexpr int yaze::editor::RomLoadOptionsDialog::kNumPresets = 4

staticconstexprprivate

Definition at line 156 of file rom_load_options_dialog.h.

Referenced by DrawFeatureFlagPresets().

kPresetNames

const char * yaze::editor::RomLoadOptionsDialog::kPresetNames

staticprivate

Initial value:

= {
    "Vanilla ROM Hack", "ZSCustomOverworld v2",
    "ZSCustomOverworld v3 (Recommended)", "Randomizer Compatible"}

Definition at line 157 of file rom_load_options_dialog.h.

Referenced by DrawActionButtons(), DrawFeatureFlagPresets(), and Open().

kPresetDescriptions

const char * yaze::editor::RomLoadOptionsDialog::kPresetDescriptions

staticprivate

Initial value:

= {
    "Standard ROM editing without custom ASM. Limited to vanilla features.",
    "Basic overworld expansion: custom BG colors, main palettes, parent "
    "system.",
    "Full overworld expansion: wide/tall areas, animated GFX, overlays, all "
    "features.",
    "Compatible with ALttP Randomizer. Minimal custom features."}

Definition at line 158 of file rom_load_options_dialog.h.

Referenced by DrawFeatureFlagPresets().

selected_preset_index_

int yaze::editor::RomLoadOptionsDialog::selected_preset_index_ = 0

private

Definition at line 159 of file rom_load_options_dialog.h.

Referenced by DrawActionButtons(), DrawFeatureFlagPresets(), and Open().

confirm_callback_

std::function<void(const LoadOptions&) yaze::editor::RomLoadOptionsDialog::confirm_callback_)

private

Definition at line 162 of file rom_load_options_dialog.h.

Referenced by DrawActionButtons(), and SetConfirmCallback().

upgrade_callback_

std::function<absl::Status(int version)> yaze::editor::RomLoadOptionsDialog::upgrade_callback_

private

Definition at line 163 of file rom_load_options_dialog.h.

Referenced by DrawActionButtons(), and SetUpgradeCallback().

project_name_buffer_

char yaze::editor::RomLoadOptionsDialog::project_name_buffer_[256] = {}

private

Definition at line 166 of file rom_load_options_dialog.h.

Referenced by DrawProjectOptions(), and Open().

project_path_buffer_

char yaze::editor::RomLoadOptionsDialog::project_path_buffer_[512] = {}

private

Definition at line 167 of file rom_load_options_dialog.h.

---

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

• src/app/editor/ui/rom_load_options_dialog.h
• src/app/editor/ui/rom_load_options_dialog.cc