Handles object selection, preview, and editing UI. More...

#include <dungeon_object_selector.h>

Public Member Functions
	DungeonObjectSelector (Rom *rom=nullptr)

	~DungeonObjectSelector ()

void	SetContext (EditorContext ctx)

EditorContext	context () const

void	SetRom (Rom *rom)

Rom *	rom () const

void	SetGameData (zelda3::GameData *game_data)

zelda3::GameData *	game_data () const

void	set_rooms (DungeonRoomStore *rooms)

DungeonRoomStore *	get_rooms ()

void	set_current_room_id (int room_id)

void	SetCurrentPaletteGroup (const gfx::PaletteGroup &palette_group)

void	SetObjectSelectedCallback (std::function< void(const zelda3::RoomObject &)> callback)

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

const zelda3::RoomObject &	GetPreviewObject () const

bool	IsObjectLoaded () const

void	DrawObjectAssetBrowser (float minimum_grid_height=1.0f)

bool	DrawMinecartPalette ()

void	SelectObject (int obj_id, int subtype=-1)

void	SetEditObjectTilesCallback (std::function< absl::Status(int, const zelda3::RoomObject &)> callback)

void	SetTileEditorPanel (ObjectTileEditorPanel *panel)

void	SetOpenTileEditorWindowCallback (std::function< bool()> callback)

void	SetOpenMinecartEditorWindowCallback (std::function< bool()> callback)

void	InvalidatePreviewCache ()

void	SynchronizeCustomObjectGeneration ()

void	DetachRuntimeContext ()

std::size_t	preview_cache_invalidations_for_testing () const

bool	object_previews_enabled_for_testing () const

int	selected_object_id_for_testing () const

bool	matches_object_filter_for_testing (int obj_id, int filter_type)

std::string	object_type_symbol_for_testing (int object_id)

Static Public Member Functions
static bool	IsRepresentableChestObjectId (int object_id)

Private Types
enum class	BrowserMode { kObjects , kCustomAssets }

Private Member Functions
bool	MatchesObjectFilter (int obj_id, int filter_type)

bool	MatchesRoomUsage (int obj_id) const

bool	MatchesObjectSearch (int obj_id, const std::string &name, int subtype=-1) const

void	CalculateObjectDimensions (const zelda3::RoomObject &object, int &width, int &height)

bool	DrawObjectPreview (const zelda3::RoomObject &object, ImVec2 top_left, ImVec2 box_size)

zelda3::RoomObject	MakePreviewObject (int obj_id) const

void	EnsureRegistryInitialized ()

ImU32	GetObjectTypeColor (int object_id)

std::string	GetObjectTypeSymbol (int object_id)

absl::Status	GetCustomObjectAssetStatus (int object_id, int subtype)

void	DrawCustomObjectAssetBrowser ()

absl::Status	OpenExistingCustomObjectEditor (int16_t object_id, int subtype, int room_id)

void	DrawObjectContextMenu (int object_id, int subtype=-1)

void	RetirePreviewCache ()

void	SynchronizePreviewCacheRoomContext (const zelda3::Room &room)

bool	GetOrCreatePreview (const zelda3::RoomObject &object, gfx::BackgroundBuffer **out)

Static Private Member Functions
static uint32_t	MakeLayoutCacheKey (int object_id, uint8_t preview_size, const zelda3::Room *room)

Private Attributes
BrowserMode	browser_mode_ = BrowserMode::kObjects

int	custom_asset_family_id_ = 0x31

int	custom_asset_subtype_ = 0

std::function< absl::Status(int, const zelda3::RoomObject &)	edit_object_tiles_callback_ )

ObjectTileEditorPanel *	tile_editor_panel_ = nullptr

std::function< bool()>	open_tile_editor_window_callback_

std::function< bool()>	open_minecart_editor_window_callback_

std::string	custom_object_action_error_

Rom *	rom_ = nullptr

zelda3::GameData *	game_data_ = nullptr

uint64_t	observed_custom_object_generation_ = 0

bool	observed_custom_objects_enabled_ = false

std::map< uint32_t, absl::Status >	custom_asset_status_cache_

DungeonRoomStore *	rooms_ = nullptr

int	current_room_id_ = 0

gfx::PaletteGroup	current_palette_group_

zelda3::DungeonObjectRegistry	object_registry_

zelda3::RoomObject	preview_object_ {0, 0, 0, 0, 0}

bool	object_loaded_ = false

bool	preview_uses_custom_override_ = false

std::function< void(const zelda3::RoomObject &)	object_selected_callback_ )

std::function< void()>	placement_invalidated_callback_

int	selected_object_id_ = -1

int	object_type_filter_ = 0

int	object_stream_filter_ = 0

bool	used_here_only_ = false

int	object_grid_density_ = 0

char	object_search_buffer_ [64] = {0}

bool	registry_initialized_ = false

bool	enable_object_previews_ = true

std::map< uint64_t, std::unique_ptr< gfx::BackgroundBuffer > >	preview_cache_

std::set< uint64_t >	failed_preview_keys_

uint8_t	cached_preview_blockset_ = 0xFF

uint8_t	cached_preview_entrance_blockset_ = 0xFF

uint8_t	cached_preview_palette_ = 0xFF

uint8_t	cached_preview_floor1_ = 0xFF

uint8_t	cached_preview_floor2_ = 0xFF

int	cached_preview_room_id_ = -1

uint64_t	cached_preview_graphics_revision_ = 0

std::map< uint32_t, zelda3::ObjectTileLayout >	layout_cache_

std::size_t	preview_cache_invalidations_ = 0

Friends
struct	DungeonObjectSelectorTestAccess

Detailed Description

Handles object selection, preview, and editing UI.

Definition at line 63 of file dungeon_object_selector.h.

Member Enumeration Documentation

◆ BrowserMode

enum class yaze::editor::DungeonObjectSelector::BrowserMode

strongprivate

Enumerator
kObjects
kCustomAssets

Definition at line 164 of file dungeon_object_selector.h.

Constructor & Destructor Documentation

◆ DungeonObjectSelector()

yaze::editor::DungeonObjectSelector::DungeonObjectSelector ( Rom * rom = nullptr )

inlineexplicit

Definition at line 65 of file dungeon_object_selector.h.

◆ ~DungeonObjectSelector()

yaze::editor::DungeonObjectSelector::~DungeonObjectSelector ( )

Definition at line 210 of file dungeon_object_selector.cc.

References RetirePreviewCache().

Here is the call graph for this function:

Member Function Documentation

◆ SetContext()

void yaze::editor::DungeonObjectSelector::SetContext ( EditorContext ctx )

inline

Definition at line 69 of file dungeon_object_selector.h.

References yaze::editor::EditorContext::game_data, game_data_, yaze::editor::EditorContext::rom, and rom_.

Referenced by yaze::editor::ObjectSelectorContent::SetContext().

◆ context()

EditorContext yaze::editor::DungeonObjectSelector::context ( ) const

inline

Definition at line 73 of file dungeon_object_selector.h.

References game_data_, and rom_.

◆ SetRom()

void yaze::editor::DungeonObjectSelector::SetRom ( Rom * rom )

inline

Definition at line 76 of file dungeon_object_selector.h.

References rom(), and rom_.

Here is the call graph for this function:

◆ rom()

Rom * yaze::editor::DungeonObjectSelector::rom ( ) const

inline

Definition at line 77 of file dungeon_object_selector.h.

References rom_.

Referenced by SetRom().

◆ SetGameData()

void yaze::editor::DungeonObjectSelector::SetGameData ( zelda3::GameData * game_data )

inline

Definition at line 78 of file dungeon_object_selector.h.

References game_data(), and game_data_.

Referenced by yaze::editor::ObjectSelectorContent::SetGameData().

Here is the call graph for this function:

◆ game_data()

zelda3::GameData * yaze::editor::DungeonObjectSelector::game_data ( ) const

inline

Definition at line 79 of file dungeon_object_selector.h.

References game_data_.

Referenced by SetGameData().

◆ set_rooms()

void yaze::editor::DungeonObjectSelector::set_rooms ( DungeonRoomStore * rooms )

inline

Definition at line 82 of file dungeon_object_selector.h.

References rooms_.

Referenced by yaze::editor::ObjectSelectorContent::SetRooms().

◆ get_rooms()

DungeonRoomStore * yaze::editor::DungeonObjectSelector::get_rooms ( )

inline

Definition at line 83 of file dungeon_object_selector.h.

References rooms_.

Referenced by yaze::editor::ObjectSelectorContent::DrawInteractionSummary().

◆ set_current_room_id()

void yaze::editor::DungeonObjectSelector::set_current_room_id ( int room_id )

inline

Definition at line 84 of file dungeon_object_selector.h.

References current_room_id_.

Referenced by yaze::editor::ObjectSelectorContent::SetCurrentRoom().

◆ SetCurrentPaletteGroup()

void yaze::editor::DungeonObjectSelector::SetCurrentPaletteGroup ( const gfx::PaletteGroup & palette_group )

inline

Definition at line 94 of file dungeon_object_selector.h.

References current_palette_group_, and InvalidatePreviewCache().

Referenced by yaze::editor::ObjectSelectorContent::SetCurrentPaletteGroup().

Here is the call graph for this function:

◆ SetObjectSelectedCallback()

void yaze::editor::DungeonObjectSelector::SetObjectSelectedCallback ( std::function< void(const zelda3::RoomObject &)> callback )

inline

Definition at line 99 of file dungeon_object_selector.h.

References object_selected_callback_.

Referenced by yaze::editor::ObjectSelectorContent::ObjectSelectorContent().

◆ SetPlacementInvalidatedCallback()

void yaze::editor::DungeonObjectSelector::SetPlacementInvalidatedCallback ( std::function< void()> callback )

inline

Definition at line 103 of file dungeon_object_selector.h.

References placement_invalidated_callback_.

Referenced by yaze::editor::ObjectSelectorContent::ObjectSelectorContent().

◆ GetPreviewObject()

const zelda3::RoomObject & yaze::editor::DungeonObjectSelector::GetPreviewObject ( ) const

inline

Definition at line 108 of file dungeon_object_selector.h.

References preview_object_.

◆ IsObjectLoaded()

bool yaze::editor::DungeonObjectSelector::IsObjectLoaded ( ) const

inline

Definition at line 109 of file dungeon_object_selector.h.

References object_loaded_.

◆ DrawObjectAssetBrowser()

void yaze::editor::DungeonObjectSelector::DrawObjectAssetBrowser ( float minimum_grid_height = 1.0f )

Definition at line 379 of file dungeon_object_selector.cc.

References yaze::zelda3::DrawRoutineSymbology::badge, yaze::gui::BeginRoomObjectDragSource(), browser_mode_, yaze::zelda3::ObjectTileEditor::CaptureObjectLayout(), current_palette_group_, current_room_id_, custom_object_action_error_, yaze::Rom::data(), yaze::zelda3::DefaultRoomObjectSizeForPlacement(), DrawCustomObjectAssetBrowser(), DrawObjectContextMenu(), DrawObjectPreview(), yaze::zelda3::DrawRoutineSymbology::dual_layer, enable_object_previews_, yaze::zelda3::DrawRoutineSymbology::family, yaze::core::FeatureFlags::get(), yaze::zelda3::CustomObjectManager::Get(), yaze::zelda3::ObjectDrawer::GetDrawRoutineId(), yaze::zelda3::GetObjectName(), yaze::zelda3::GetObjectSubtype(), GetObjectTypeColor(), GetObjectTypeSymbol(), yaze::zelda3::GetSymbologyForObject(), yaze::editor::AgentUI::GetTheme(), kCustomAssets, yaze::core::FeatureFlags::Flags::kEnableCustomObjects, yaze::zelda3::kNumberOfRooms, kObjects, layout_cache_, MakeLayoutCacheKey(), MakePreviewObject(), yaze::editor::MatchesDungeonObjectStreamFilter(), MatchesObjectFilter(), MatchesObjectSearch(), MatchesRoomUsage(), object_grid_density_, object_search_buffer_, object_stream_filter_, object_type_filter_, yaze::editor::ResolveDungeonObjectSelectorGridLayout(), rom_, rooms_, yaze::zelda3::CustomObjectManager::RuntimeObjectIds(), yaze::zelda3::CustomObjectManager::RuntimeSubtypeCountForObject(), selected_object_id_, SelectObject(), SynchronizeCustomObjectGeneration(), and used_here_only_.

Referenced by yaze::editor::ObjectSelectorContent::DrawObjectSelector().

◆ DrawMinecartPalette()

bool yaze::editor::DungeonObjectSelector::DrawMinecartPalette ( )

Definition at line 313 of file dungeon_object_selector.cc.

References yaze::gui::AutoRegisterLastItem(), DrawObjectPreview(), yaze::core::FeatureFlags::get(), GetCustomObjectAssetStatus(), yaze::editor::GetDungeonCustomObjectSlotName(), yaze::zelda3::RoomObject::id_, MakePreviewObject(), object_loaded_, preview_object_, yaze::editor::ResolveDungeonObjectSelectorGridLayout(), SelectObject(), yaze::zelda3::RoomObject::size_, and SynchronizeCustomObjectGeneration().

Referenced by yaze::editor::ObjectSelectorContent::DrawMinecartPalette().

◆ SelectObject()

void yaze::editor::DungeonObjectSelector::SelectObject	(	int	obj_id,
		int	subtype = -1 )

Definition at line 262 of file dungeon_object_selector.cc.

References yaze::zelda3::CanonicalRoomObjectSize(), yaze::zelda3::DefaultRoomObjectSizeForPlacement(), yaze::core::FeatureFlags::get(), yaze::zelda3::CustomObjectManager::Get(), GetCustomObjectAssetStatus(), yaze::zelda3::CustomObjectManager::GetObjectInternal(), yaze::editor::IsDungeonCustomObjectRuntimeSlot(), yaze::core::FeatureFlags::Flags::kEnableCustomObjects, object_loaded_, object_selected_callback_, preview_object_, preview_uses_custom_override_, rom_, yaze::zelda3::CustomObjectManager::RuntimeSubtypeCountForObject(), selected_object_id_, yaze::zelda3::RoomObject::SetRom(), yaze::zelda3::RoomObject::size_, and SynchronizeCustomObjectGeneration().

Referenced by DrawCustomObjectAssetBrowser(), DrawMinecartPalette(), DrawObjectAssetBrowser(), and yaze::editor::ObjectSelectorContent::SelectObject().

◆ SetEditObjectTilesCallback()

void yaze::editor::DungeonObjectSelector::SetEditObjectTilesCallback ( std::function< absl::Status(int, const zelda3::RoomObject &)> callback )

inline

Definition at line 120 of file dungeon_object_selector.h.

References edit_object_tiles_callback_.

Referenced by yaze::editor::DungeonEditorV2::Load().

◆ SetTileEditorPanel()

void yaze::editor::DungeonObjectSelector::SetTileEditorPanel ( ObjectTileEditorPanel * panel )

inline

Definition at line 126 of file dungeon_object_selector.h.

References tile_editor_panel_.

Referenced by yaze::editor::DungeonEditorV2::Load().

◆ SetOpenTileEditorWindowCallback()

void yaze::editor::DungeonObjectSelector::SetOpenTileEditorWindowCallback ( std::function< bool()> callback )

inline

Definition at line 129 of file dungeon_object_selector.h.

References open_tile_editor_window_callback_.

Referenced by yaze::editor::DungeonEditorV2::Load().

◆ SetOpenMinecartEditorWindowCallback()

void yaze::editor::DungeonObjectSelector::SetOpenMinecartEditorWindowCallback ( std::function< bool()> callback )

inline

Definition at line 132 of file dungeon_object_selector.h.

References open_minecart_editor_window_callback_.

Referenced by yaze::editor::DungeonEditorV2::Load().

◆ InvalidatePreviewCache()

void yaze::editor::DungeonObjectSelector::InvalidatePreviewCache ( )

Definition at line 1024 of file dungeon_object_selector.cc.

References custom_asset_status_cache_, layout_cache_, preview_cache_invalidations_, and RetirePreviewCache().

Referenced by DetachRuntimeContext(), yaze::editor::DungeonEditorV2::Load(), yaze::editor::DungeonEditorV2::RefreshRomBackedState(), SetCurrentPaletteGroup(), SynchronizeCustomObjectGeneration(), and SynchronizePreviewCacheRoomContext().

Here is the call graph for this function:

◆ SynchronizeCustomObjectGeneration()

void yaze::editor::DungeonObjectSelector::SynchronizeCustomObjectGeneration ( )

Definition at line 899 of file dungeon_object_selector.cc.

References yaze::zelda3::CustomObjectManager::asset_generation(), yaze::editor::DungeonRoomStore::ForEachMaterialized(), yaze::core::FeatureFlags::get(), yaze::zelda3::CustomObjectManager::Get(), GetCustomObjectAssetStatus(), yaze::zelda3::RoomObject::id_, InvalidatePreviewCache(), yaze::editor::IsDungeonCustomObjectRuntimeSlot(), yaze::core::FeatureFlags::Flags::kEnableCustomObjects, yaze::zelda3::Room::MarkObjectsDirty(), object_loaded_, object_selected_callback_, observed_custom_object_generation_, observed_custom_objects_enabled_, placement_invalidated_callback_, preview_object_, preview_uses_custom_override_, rooms_, selected_object_id_, and yaze::zelda3::RoomObject::size_.

Referenced by DrawCustomObjectAssetBrowser(), DrawMinecartPalette(), DrawObjectAssetBrowser(), GetOrCreatePreview(), SelectObject(), and yaze::editor::DungeonEditorV2::SynchronizeCustomObjectAssets().

◆ DetachRuntimeContext()

void yaze::editor::DungeonObjectSelector::DetachRuntimeContext ( )

◆ preview_cache_invalidations_for_testing()

std::size_t yaze::editor::DungeonObjectSelector::preview_cache_invalidations_for_testing ( ) const

inline

Definition at line 147 of file dungeon_object_selector.h.

References preview_cache_invalidations_.

◆ object_previews_enabled_for_testing()

bool yaze::editor::DungeonObjectSelector::object_previews_enabled_for_testing ( ) const

inline

Definition at line 150 of file dungeon_object_selector.h.

References enable_object_previews_.

◆ selected_object_id_for_testing()

int yaze::editor::DungeonObjectSelector::selected_object_id_for_testing ( ) const

inline

Definition at line 153 of file dungeon_object_selector.h.

References selected_object_id_.

◆ matches_object_filter_for_testing()

bool yaze::editor::DungeonObjectSelector::matches_object_filter_for_testing	(	int	obj_id,
		int	filter_type )

inline

Definition at line 154 of file dungeon_object_selector.h.

References MatchesObjectFilter().

Here is the call graph for this function:

◆ object_type_symbol_for_testing()

std::string yaze::editor::DungeonObjectSelector::object_type_symbol_for_testing ( int object_id )

inline

Definition at line 157 of file dungeon_object_selector.h.

References GetObjectTypeSymbol().

Here is the call graph for this function:

◆ IsRepresentableChestObjectId()

bool yaze::editor::DungeonObjectSelector::IsRepresentableChestObjectId ( int object_id )

static

Definition at line 214 of file dungeon_object_selector.cc.

References yaze::zelda3::ObjectCategories::GetObjectCategory().

Here is the call graph for this function:

◆ MatchesObjectFilter()

bool yaze::editor::DungeonObjectSelector::MatchesObjectFilter	(	int	obj_id,
		int	filter_type )

private

Definition at line 833 of file dungeon_object_selector.cc.

References yaze::zelda3::ObjectCategories::GetObjectCategory().

Referenced by DrawObjectAssetBrowser(), and matches_object_filter_for_testing().

Here is the call graph for this function:

◆ MatchesRoomUsage()

bool yaze::editor::DungeonObjectSelector::MatchesRoomUsage ( int obj_id ) const

private

Definition at line 821 of file dungeon_object_selector.cc.

References current_room_id_, yaze::editor::DungeonRoomStore::GetIfLoaded(), yaze::zelda3::Room::GetTileObjects(), rooms_, and used_here_only_.

Referenced by DrawObjectAssetBrowser().

Here is the call graph for this function:

◆ MatchesObjectSearch()

bool yaze::editor::DungeonObjectSelector::MatchesObjectSearch	(	int	obj_id,
		const std::string &	name,
		int	subtype = -1 ) const

private

Definition at line 843 of file dungeon_object_selector.cc.

References object_search_buffer_.

Referenced by DrawObjectAssetBrowser().

◆ CalculateObjectDimensions()

void yaze::editor::DungeonObjectSelector::CalculateObjectDimensions	(	const zelda3::RoomObject &	object,
		int &	width,
		int &	height )

private

Definition at line 885 of file dungeon_object_selector.cc.

References yaze::zelda3::DimensionService::Get(), and yaze::zelda3::DimensionService::GetPixelDimensions().

Here is the call graph for this function:

◆ DrawObjectPreview()

bool yaze::editor::DungeonObjectSelector::DrawObjectPreview	(	const zelda3::RoomObject &	object,
		ImVec2	top_left,
		ImVec2	box_size )

private

Definition at line 1190 of file dungeon_object_selector.cc.

References yaze::gfx::BackgroundBuffer::bitmap(), GetOrCreatePreview(), yaze::editor::DungeonObjectPreviewFit::height, yaze::editor::ResolveDungeonObjectPreviewFit(), yaze::editor::DungeonObjectPreviewFit::valid, yaze::editor::DungeonObjectPreviewFit::width, yaze::editor::DungeonObjectPreviewFit::x, and yaze::editor::DungeonObjectPreviewFit::y.

Referenced by DrawCustomObjectAssetBrowser(), DrawMinecartPalette(), and DrawObjectAssetBrowser().

Here is the call graph for this function:

◆ MakePreviewObject()

zelda3::RoomObject yaze::editor::DungeonObjectSelector::MakePreviewObject ( int obj_id ) const

private

Definition at line 1017 of file dungeon_object_selector.cc.

References yaze::zelda3::DefaultRoomObjectSizeForPlacement(), rom_, and yaze::zelda3::RoomObject::SetRom().

Referenced by DrawCustomObjectAssetBrowser(), DrawMinecartPalette(), DrawObjectAssetBrowser(), and DrawObjectContextMenu().

Here is the call graph for this function:

◆ EnsureRegistryInitialized()

void yaze::editor::DungeonObjectSelector::EnsureRegistryInitialized ( )

private

Definition at line 892 of file dungeon_object_selector.cc.

References object_registry_, yaze::zelda3::DungeonObjectRegistry::RegisterVanillaRange(), and registry_initialized_.

Here is the call graph for this function:

◆ GetObjectTypeColor()

ImU32 yaze::editor::DungeonObjectSelector::GetObjectTypeColor ( int object_id )

private

Definition at line 219 of file dungeon_object_selector.cc.

References yaze::zelda3::ObjectCategories::GetObjectCategory(), and yaze::editor::AgentUI::GetTheme().

Referenced by DrawObjectAssetBrowser().

Here is the call graph for this function:

◆ GetObjectTypeSymbol()

std::string yaze::editor::DungeonObjectSelector::GetObjectTypeSymbol ( int object_id )

private

Definition at line 241 of file dungeon_object_selector.cc.

References yaze::zelda3::ObjectCategories::GetObjectCategory().

Referenced by DrawObjectAssetBrowser(), and object_type_symbol_for_testing().

Here is the call graph for this function:

◆ GetCustomObjectAssetStatus()

absl::Status yaze::editor::DungeonObjectSelector::GetCustomObjectAssetStatus	(	int	object_id,
		int	subtype )

private

Definition at line 996 of file dungeon_object_selector.cc.

References custom_asset_status_cache_, yaze::zelda3::CustomObjectManager::Get(), yaze::zelda3::CustomObjectManager::GetObjectInternal(), and yaze::editor::IsDungeonCustomObjectRuntimeSlot().

Referenced by DrawCustomObjectAssetBrowser(), DrawMinecartPalette(), DrawObjectContextMenu(), SelectObject(), and SynchronizeCustomObjectGeneration().

Here is the call graph for this function:

◆ DrawCustomObjectAssetBrowser()

void yaze::editor::DungeonObjectSelector::DrawCustomObjectAssetBrowser ( )

private

Definition at line 1245 of file dungeon_object_selector.cc.

References yaze::gui::BeginRoomObjectDragSource(), yaze::zelda3::CanonicalRoomObjectSize(), current_room_id_, custom_asset_family_id_, custom_asset_subtype_, custom_object_action_error_, DrawObjectContextMenu(), DrawObjectPreview(), enable_object_previews_, yaze::core::FeatureFlags::get(), yaze::zelda3::CustomObjectManager::Get(), GetCustomObjectAssetStatus(), yaze::editor::GetDungeonCustomObjectSlotName(), yaze::editor::DungeonRoomStore::GetIfLoaded(), yaze::editor::AgentUI::GetTheme(), ICON_MD_ADD, ICON_MD_CHECK_CIRCLE, ICON_MD_EDIT, ICON_MD_ERROR, ICON_MD_FOLDER, ICON_MD_INFO, ICON_MD_PRECISION_MANUFACTURING, ICON_MD_REFRESH, ICON_MD_TRAIN, ICON_MD_WARNING, yaze::editor::IsMinecartGraphicsRuntimeSlot(), yaze::zelda3::kConfiguredFilename, MakePreviewObject(), object_grid_density_, open_minecart_editor_window_callback_, OpenExistingCustomObjectEditor(), yaze::zelda3::ResolveCustomObjectAssetPath(), yaze::editor::ResolveDungeonObjectSelectorGridLayout(), rooms_, yaze::zelda3::CustomObjectManager::RuntimeObjectIds(), SelectObject(), SynchronizeCustomObjectGeneration(), and tile_editor_panel_.

Referenced by DrawObjectAssetBrowser().

◆ OpenExistingCustomObjectEditor()

absl::Status yaze::editor::DungeonObjectSelector::OpenExistingCustomObjectEditor	(	int16_t	object_id,
		int	subtype,
		int	room_id )

private

Definition at line 1221 of file dungeon_object_selector.cc.

References yaze::editor::ObjectTileEditorPanel::Close(), current_palette_group_, yaze::editor::ObjectTileEditorPanel::IsOpen(), open_tile_editor_window_callback_, yaze::editor::ObjectTileEditorPanel::OpenForCustomObject(), rooms_, and tile_editor_panel_.

Referenced by DrawCustomObjectAssetBrowser(), and DrawObjectContextMenu().

Here is the call graph for this function:

◆ DrawObjectContextMenu()

void yaze::editor::DungeonObjectSelector::DrawObjectContextMenu	(	int	object_id,
		int	subtype = -1 )

private

Definition at line 791 of file dungeon_object_selector.cc.

References current_room_id_, custom_object_action_error_, edit_object_tiles_callback_, GetCustomObjectAssetStatus(), yaze::editor::DungeonRoomStore::GetIfLoaded(), yaze::zelda3::ObjectTileEditor::IsEditableStandardObject(), MakePreviewObject(), OpenExistingCustomObjectEditor(), rooms_, and tile_editor_panel_.

Referenced by DrawCustomObjectAssetBrowser(), and DrawObjectAssetBrowser().

◆ RetirePreviewCache()

void yaze::editor::DungeonObjectSelector::RetirePreviewCache ( )

private

Definition at line 1031 of file dungeon_object_selector.cc.

References failed_preview_keys_, yaze::gfx::Arena::Get(), and preview_cache_.

Referenced by InvalidatePreviewCache(), and ~DungeonObjectSelector().

Here is the call graph for this function:

◆ SynchronizePreviewCacheRoomContext()

void yaze::editor::DungeonObjectSelector::SynchronizePreviewCacheRoomContext ( const zelda3::Room & room )

private

Definition at line 1043 of file dungeon_object_selector.cc.

References yaze::zelda3::Room::blockset(), cached_preview_blockset_, cached_preview_entrance_blockset_, cached_preview_floor1_, cached_preview_floor2_, cached_preview_graphics_revision_, cached_preview_palette_, cached_preview_room_id_, current_room_id_, yaze::zelda3::Room::floor1(), yaze::zelda3::Room::floor2(), yaze::zelda3::Room::graphics_revision(), InvalidatePreviewCache(), yaze::zelda3::Room::palette(), and yaze::zelda3::Room::render_entrance_blockset().

Referenced by GetOrCreatePreview().

◆ MakeLayoutCacheKey()

uint32_t yaze::editor::DungeonObjectSelector::MakeLayoutCacheKey	(	int	object_id,
		uint8_t	preview_size,
		const zelda3::Room *	room )

staticprivate

Definition at line 1065 of file dungeon_object_selector.cc.

References yaze::zelda3::Room::floor1(), and yaze::zelda3::Room::floor2().

Referenced by DrawObjectAssetBrowser().

Here is the call graph for this function:

◆ GetOrCreatePreview()

bool yaze::editor::DungeonObjectSelector::GetOrCreatePreview	(	const zelda3::RoomObject &	object,
		gfx::BackgroundBuffer **	out )

private

Definition at line 1081 of file dungeon_object_selector.cc.

References yaze::gfx::BackgroundBuffer::bitmap(), cached_preview_blockset_, cached_preview_floor1_, cached_preview_floor2_, cached_preview_palette_, yaze::zelda3::CanonicalRoomObjectSize(), yaze::zelda3::ObjectTileEditor::CaptureObjectLayout(), yaze::gfx::Arena::CREATE, current_palette_group_, current_room_id_, failed_preview_keys_, yaze::gfx::Arena::Get(), yaze::zelda3::Room::get_gfx_buffer(), yaze::editor::DungeonRoomStore::GetIfLoaded(), yaze::Rom::is_loaded(), preview_cache_, yaze::gfx::Arena::ProcessTextureQueue(), yaze::gfx::Arena::QueueTextureCommand(), yaze::zelda3::ObjectTileEditor::RenderLayoutToBitmap(), yaze::gfx::Arena::RetireBitmap(), rom_, rooms_, SynchronizeCustomObjectGeneration(), and SynchronizePreviewCacheRoomContext().

Referenced by DrawObjectPreview().

Friends And Related Symbol Documentation

◆ DungeonObjectSelectorTestAccess

friend struct DungeonObjectSelectorTestAccess

friend

Definition at line 163 of file dungeon_object_selector.h.

Member Data Documentation

◆ browser_mode_

BrowserMode yaze::editor::DungeonObjectSelector::browser_mode_ = BrowserMode::kObjects

private

Definition at line 186 of file dungeon_object_selector.h.

Referenced by DrawObjectAssetBrowser().

◆ custom_asset_family_id_

int yaze::editor::DungeonObjectSelector::custom_asset_family_id_ = 0x31

private

Definition at line 187 of file dungeon_object_selector.h.

Referenced by DrawCustomObjectAssetBrowser().

◆ custom_asset_subtype_

int yaze::editor::DungeonObjectSelector::custom_asset_subtype_ = 0

private

Definition at line 188 of file dungeon_object_selector.h.

Referenced by DrawCustomObjectAssetBrowser().

◆ edit_object_tiles_callback_

std::function<absl::Status(int, const zelda3::RoomObject&) yaze::editor::DungeonObjectSelector::edit_object_tiles_callback_)

private

Definition at line 192 of file dungeon_object_selector.h.

Referenced by DetachRuntimeContext(), DrawObjectContextMenu(), and SetEditObjectTilesCallback().

◆ tile_editor_panel_

ObjectTileEditorPanel* yaze::editor::DungeonObjectSelector::tile_editor_panel_ = nullptr

private

Definition at line 194 of file dungeon_object_selector.h.

Referenced by DetachRuntimeContext(), DrawCustomObjectAssetBrowser(), DrawObjectContextMenu(), OpenExistingCustomObjectEditor(), and SetTileEditorPanel().

◆ open_tile_editor_window_callback_

std::function<bool()> yaze::editor::DungeonObjectSelector::open_tile_editor_window_callback_

private

Definition at line 195 of file dungeon_object_selector.h.

Referenced by DetachRuntimeContext(), OpenExistingCustomObjectEditor(), and SetOpenTileEditorWindowCallback().

◆ open_minecart_editor_window_callback_

std::function<bool()> yaze::editor::DungeonObjectSelector::open_minecart_editor_window_callback_

private

Definition at line 196 of file dungeon_object_selector.h.

Referenced by DetachRuntimeContext(), DrawCustomObjectAssetBrowser(), and SetOpenMinecartEditorWindowCallback().

◆ custom_object_action_error_

std::string yaze::editor::DungeonObjectSelector::custom_object_action_error_

private

Definition at line 197 of file dungeon_object_selector.h.

Referenced by DetachRuntimeContext(), DrawCustomObjectAssetBrowser(), DrawObjectAssetBrowser(), and DrawObjectContextMenu().

◆ rom_

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

private

Definition at line 199 of file dungeon_object_selector.h.

Referenced by context(), DetachRuntimeContext(), DrawObjectAssetBrowser(), GetOrCreatePreview(), MakePreviewObject(), rom(), SelectObject(), SetContext(), and SetRom().

◆ game_data_

zelda3::GameData* yaze::editor::DungeonObjectSelector::game_data_ = nullptr

private

Definition at line 200 of file dungeon_object_selector.h.

Referenced by context(), DetachRuntimeContext(), game_data(), SetContext(), and SetGameData().

◆ observed_custom_object_generation_

uint64_t yaze::editor::DungeonObjectSelector::observed_custom_object_generation_ = 0

private

Definition at line 201 of file dungeon_object_selector.h.

Referenced by DetachRuntimeContext(), and SynchronizeCustomObjectGeneration().

◆ observed_custom_objects_enabled_

bool yaze::editor::DungeonObjectSelector::observed_custom_objects_enabled_ = false

private

Definition at line 202 of file dungeon_object_selector.h.

Referenced by DetachRuntimeContext(), and SynchronizeCustomObjectGeneration().

◆ custom_asset_status_cache_

std::map<uint32_t, absl::Status> yaze::editor::DungeonObjectSelector::custom_asset_status_cache_

private

Definition at line 203 of file dungeon_object_selector.h.

Referenced by GetCustomObjectAssetStatus(), and InvalidatePreviewCache().

◆ rooms_

DungeonRoomStore* yaze::editor::DungeonObjectSelector::rooms_ = nullptr

private

Definition at line 206 of file dungeon_object_selector.h.

Referenced by DetachRuntimeContext(), DrawCustomObjectAssetBrowser(), DrawObjectAssetBrowser(), DrawObjectContextMenu(), get_rooms(), GetOrCreatePreview(), MatchesRoomUsage(), OpenExistingCustomObjectEditor(), set_rooms(), and SynchronizeCustomObjectGeneration().

◆ current_room_id_

int yaze::editor::DungeonObjectSelector::current_room_id_ = 0

private

Definition at line 207 of file dungeon_object_selector.h.

Referenced by DrawCustomObjectAssetBrowser(), DrawObjectAssetBrowser(), DrawObjectContextMenu(), GetOrCreatePreview(), MatchesRoomUsage(), set_current_room_id(), and SynchronizePreviewCacheRoomContext().

◆ current_palette_group_

gfx::PaletteGroup yaze::editor::DungeonObjectSelector::current_palette_group_

private

Definition at line 210 of file dungeon_object_selector.h.

Referenced by DrawObjectAssetBrowser(), GetOrCreatePreview(), OpenExistingCustomObjectEditor(), and SetCurrentPaletteGroup().

◆ object_registry_

zelda3::DungeonObjectRegistry yaze::editor::DungeonObjectSelector::object_registry_

private

Definition at line 212 of file dungeon_object_selector.h.

Referenced by EnsureRegistryInitialized().

◆ preview_object_

zelda3::RoomObject yaze::editor::DungeonObjectSelector::preview_object_ {0, 0, 0, 0, 0}

private

Definition at line 215 of file dungeon_object_selector.h.

Referenced by DrawMinecartPalette(), GetPreviewObject(), SelectObject(), and SynchronizeCustomObjectGeneration().

◆ object_loaded_

bool yaze::editor::DungeonObjectSelector::object_loaded_ = false

private

Definition at line 216 of file dungeon_object_selector.h.

Referenced by DetachRuntimeContext(), DrawMinecartPalette(), IsObjectLoaded(), SelectObject(), and SynchronizeCustomObjectGeneration().

◆ preview_uses_custom_override_

bool yaze::editor::DungeonObjectSelector::preview_uses_custom_override_ = false

private

Definition at line 217 of file dungeon_object_selector.h.

Referenced by DetachRuntimeContext(), SelectObject(), and SynchronizeCustomObjectGeneration().

◆ object_selected_callback_

std::function<void(const zelda3::RoomObject&) yaze::editor::DungeonObjectSelector::object_selected_callback_)

private

Definition at line 220 of file dungeon_object_selector.h.

Referenced by SelectObject(), SetObjectSelectedCallback(), and SynchronizeCustomObjectGeneration().

◆ placement_invalidated_callback_

std::function<void()> yaze::editor::DungeonObjectSelector::placement_invalidated_callback_

private

Definition at line 221 of file dungeon_object_selector.h.

Referenced by DetachRuntimeContext(), SetPlacementInvalidatedCallback(), and SynchronizeCustomObjectGeneration().

◆ selected_object_id_

int yaze::editor::DungeonObjectSelector::selected_object_id_ = -1

private

Definition at line 224 of file dungeon_object_selector.h.

Referenced by DetachRuntimeContext(), DrawObjectAssetBrowser(), selected_object_id_for_testing(), SelectObject(), and SynchronizeCustomObjectGeneration().

◆ object_type_filter_

int yaze::editor::DungeonObjectSelector::object_type_filter_ = 0

private

Definition at line 227 of file dungeon_object_selector.h.

Referenced by DrawObjectAssetBrowser().

◆ object_stream_filter_

int yaze::editor::DungeonObjectSelector::object_stream_filter_ = 0

private

Definition at line 228 of file dungeon_object_selector.h.

Referenced by DrawObjectAssetBrowser().

◆ used_here_only_

bool yaze::editor::DungeonObjectSelector::used_here_only_ = false

private

Definition at line 229 of file dungeon_object_selector.h.

Referenced by DrawObjectAssetBrowser(), and MatchesRoomUsage().

◆ object_grid_density_

int yaze::editor::DungeonObjectSelector::object_grid_density_ = 0

private

Definition at line 230 of file dungeon_object_selector.h.

Referenced by DrawCustomObjectAssetBrowser(), and DrawObjectAssetBrowser().

◆ object_search_buffer_

char yaze::editor::DungeonObjectSelector::object_search_buffer_[64] = {0}

private

Definition at line 231 of file dungeon_object_selector.h.

Referenced by DrawObjectAssetBrowser(), and MatchesObjectSearch().

◆ registry_initialized_

bool yaze::editor::DungeonObjectSelector::registry_initialized_ = false

private

Definition at line 234 of file dungeon_object_selector.h.

Referenced by EnsureRegistryInitialized().

◆ enable_object_previews_

bool yaze::editor::DungeonObjectSelector::enable_object_previews_ = true

private

Definition at line 237 of file dungeon_object_selector.h.

Referenced by DrawCustomObjectAssetBrowser(), DrawObjectAssetBrowser(), and object_previews_enabled_for_testing().

◆ preview_cache_

std::map<uint64_t, std::unique_ptr<gfx::BackgroundBuffer> > yaze::editor::DungeonObjectSelector::preview_cache_

private

Definition at line 242 of file dungeon_object_selector.h.

Referenced by GetOrCreatePreview(), and RetirePreviewCache().

◆ failed_preview_keys_

std::set<uint64_t> yaze::editor::DungeonObjectSelector::failed_preview_keys_

private

Definition at line 243 of file dungeon_object_selector.h.

Referenced by GetOrCreatePreview(), and RetirePreviewCache().

◆ cached_preview_blockset_

uint8_t yaze::editor::DungeonObjectSelector::cached_preview_blockset_ = 0xFF

private

Definition at line 244 of file dungeon_object_selector.h.

Referenced by GetOrCreatePreview(), and SynchronizePreviewCacheRoomContext().

◆ cached_preview_entrance_blockset_

uint8_t yaze::editor::DungeonObjectSelector::cached_preview_entrance_blockset_ = 0xFF

private

Definition at line 245 of file dungeon_object_selector.h.

Referenced by SynchronizePreviewCacheRoomContext().

◆ cached_preview_palette_

uint8_t yaze::editor::DungeonObjectSelector::cached_preview_palette_ = 0xFF

private

Definition at line 246 of file dungeon_object_selector.h.

Referenced by GetOrCreatePreview(), and SynchronizePreviewCacheRoomContext().

◆ cached_preview_floor1_

uint8_t yaze::editor::DungeonObjectSelector::cached_preview_floor1_ = 0xFF

private

Definition at line 247 of file dungeon_object_selector.h.

Referenced by GetOrCreatePreview(), and SynchronizePreviewCacheRoomContext().

◆ cached_preview_floor2_

uint8_t yaze::editor::DungeonObjectSelector::cached_preview_floor2_ = 0xFF

private

Definition at line 248 of file dungeon_object_selector.h.

Referenced by GetOrCreatePreview(), and SynchronizePreviewCacheRoomContext().

◆ cached_preview_room_id_

int yaze::editor::DungeonObjectSelector::cached_preview_room_id_ = -1

private

Definition at line 249 of file dungeon_object_selector.h.

Referenced by SynchronizePreviewCacheRoomContext().

◆ cached_preview_graphics_revision_

uint64_t yaze::editor::DungeonObjectSelector::cached_preview_graphics_revision_ = 0

private

Definition at line 250 of file dungeon_object_selector.h.

Referenced by SynchronizePreviewCacheRoomContext().

◆ layout_cache_

std::map<uint32_t, zelda3::ObjectTileLayout> yaze::editor::DungeonObjectSelector::layout_cache_

private

Definition at line 252 of file dungeon_object_selector.h.

Referenced by DrawObjectAssetBrowser(), and InvalidatePreviewCache().

◆ preview_cache_invalidations_

std::size_t yaze::editor::DungeonObjectSelector::preview_cache_invalidations_ = 0

private

Definition at line 256 of file dungeon_object_selector.h.

Referenced by InvalidatePreviewCache(), and preview_cache_invalidations_for_testing().

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

src/app/editor/dungeon/dungeon_object_selector.h
src/app/editor/dungeon/dungeon_object_selector.cc

	yaze 0.3.2 Link to the Past ROM Editor

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ BrowserMode

Constructor & Destructor Documentation

◆ DungeonObjectSelector()

◆ ~DungeonObjectSelector()

Member Function Documentation

◆ SetContext()

◆ context()

◆ SetRom()

◆ rom()

◆ SetGameData()

◆ game_data()

◆ set_rooms()

◆ get_rooms()

◆ set_current_room_id()

◆ SetCurrentPaletteGroup()

◆ SetObjectSelectedCallback()

◆ SetPlacementInvalidatedCallback()

◆ GetPreviewObject()

◆ IsObjectLoaded()

◆ DrawObjectAssetBrowser()

◆ DrawMinecartPalette()

◆ SelectObject()

◆ SetEditObjectTilesCallback()

◆ SetTileEditorPanel()

◆ SetOpenTileEditorWindowCallback()

◆ SetOpenMinecartEditorWindowCallback()

◆ InvalidatePreviewCache()

◆ SynchronizeCustomObjectGeneration()

◆ DetachRuntimeContext()

◆ preview_cache_invalidations_for_testing()

◆ object_previews_enabled_for_testing()

◆ selected_object_id_for_testing()

◆ matches_object_filter_for_testing()

◆ object_type_symbol_for_testing()

◆ IsRepresentableChestObjectId()

◆ MatchesObjectFilter()

◆ MatchesRoomUsage()

◆ MatchesObjectSearch()

◆ CalculateObjectDimensions()

◆ DrawObjectPreview()

◆ MakePreviewObject()

◆ EnsureRegistryInitialized()

◆ GetObjectTypeColor()

◆ GetObjectTypeSymbol()

◆ GetCustomObjectAssetStatus()

◆ DrawCustomObjectAssetBrowser()

◆ OpenExistingCustomObjectEditor()

◆ DrawObjectContextMenu()

◆ RetirePreviewCache()

◆ SynchronizePreviewCacheRoomContext()

◆ MakeLayoutCacheKey()

◆ GetOrCreatePreview()

Friends And Related Symbol Documentation

◆ DungeonObjectSelectorTestAccess

Member Data Documentation

◆ browser_mode_

◆ custom_asset_family_id_

◆ custom_asset_subtype_

◆ edit_object_tiles_callback_

◆ tile_editor_panel_

◆ open_tile_editor_window_callback_

◆ open_minecart_editor_window_callback_

◆ custom_object_action_error_

◆ rom_

◆ game_data_

◆ observed_custom_object_generation_

◆ observed_custom_objects_enabled_

◆ custom_asset_status_cache_

◆ rooms_

◆ current_room_id_

◆ current_palette_group_