Manages loading and caching of custom object binary files. More...

#include <custom_object.h>

Collaboration diagram for yaze::zelda3::CustomObjectManager:

[legend]

Classes
struct	RuntimeContext

struct	State

Public Member Functions
void	Initialize (const std::string &custom_objects_folder)

void	SetObjectFileMap (const std::unordered_map< int, std::vector< std::string > > &map)

void	ClearObjectFileMap ()

bool	HasCustomFileMap () const

void	ActivateRuntimeContext (uint64_t context_id, const State &state)

void	ActivateStandaloneContext ()

void	RemoveRuntimeContext (uint64_t context_id)

std::optional< uint64_t >	active_runtime_context_id () const

absl::StatusOr< std::shared_ptr< CustomObject > >	LoadObject (const std::string &filename)

absl::StatusOr< std::shared_ptr< CustomObject > >	GetObjectInternal (int object_id, int subtype)

int	GetSubtypeCount (int object_id) const

void	ReloadAll ()

std::vector< std::string >	GetEffectiveFileList (int object_id) const

const std::string &	GetBasePath () const

uint64_t	asset_generation () const

absl::StatusOr< CustomObjectSlotBinding >	ResolveSlotBinding (int object_id, int subtype) const

std::string	ResolveFilename (int object_id, int subtype) const

State	SnapshotState () const

void	RestoreState (const State &state)

Static Public Member Functions
static CustomObjectManager &	Get ()

static int	RuntimeSubtypeCountForObject (int object_id)

static const std::array< int, 3 > &	RuntimeObjectIds ()

static const std::vector< std::string > &	DefaultSubtypeFilenamesForObject (int object_id)

Private Member Functions
	CustomObjectManager ()

RuntimeContext &	ActiveContext ()

const RuntimeContext &	ActiveContext () const

uint64_t	NextAssetGeneration ()

void	InvalidateCaches ()

const std::vector< std::string > *	ResolveFileList (int object_id) const

Private Attributes
RuntimeContext	standalone_context_

std::unordered_map< uint64_t, RuntimeContext >	runtime_contexts_

std::optional< uint64_t >	active_runtime_context_id_

uint64_t	next_asset_generation_ = 1

Static Private Attributes
static const std::vector< std::string >	kSubtype1Filenames

static const std::vector< std::string >	kSubtype2Filenames

static const std::vector< std::string >	kSubtype54Filenames

Detailed Description

Manages loading and caching of custom object binary files.

Definition at line 136 of file custom_object.h.

Constructor & Destructor Documentation

◆ CustomObjectManager()

yaze::zelda3::CustomObjectManager::CustomObjectManager ( )

private

Definition at line 529 of file custom_object.cc.

References yaze::zelda3::CustomObjectManager::RuntimeContext::asset_generation, NextAssetGeneration(), and standalone_context_.

Here is the call graph for this function:

Member Function Documentation

◆ Get()

CustomObjectManager & yaze::zelda3::CustomObjectManager::Get ( )

static

Definition at line 524 of file custom_object.cc.

Referenced by yaze::editor::ObjectTileEditorPanel::AnalyzeSourceImpactSnapshot(), yaze::editor::EditorManager::ApplyCurrentProjectRuntimeContext(), yaze::cli::resources::CommandContext::ApplyProjectRuntimeContext(), yaze::editor::ObjectTileEditorPanel::BuildSourceImpactProvenanceFingerprint(), yaze::zelda3::ObjectTileEditor::CaptureObjectLayout(), yaze::zelda3::draw_routines::CustomDraw(), yaze::editor::DungeonObjectSelector::DetachRuntimeContext(), yaze::zelda3::ObjectDrawer::DrawCustomObject(), yaze::editor::DungeonObjectSelector::DrawCustomObjectAssetBrowser(), yaze::editor::DungeonObjectSelector::DrawObjectAssetBrowser(), yaze::editor::workbench::DrawObjectSizeControls(), yaze::editor::DungeonObjectSelector::GetCustomObjectAssetStatus(), yaze::zelda3::ObjectDimensionTable::GetSelectionBounds(), yaze::editor::EditorManager::HandleSessionClosed(), yaze::editor::EditorManager::HandleSessionSwitched(), yaze::zelda3::HasActiveCustomObjectOverride(), yaze::zelda3::IsRoomObjectResizable(), yaze::zelda3::ObjectTileEditor::LoadCustomObjectLayout(), yaze::zelda3::ObjectGeometry::MeasureByObjectId(), yaze::cli::resources::CommandContext::RestoreProjectRuntimeContext(), yaze::editor::DungeonObjectSelector::SelectObject(), yaze::editor::DungeonEditorV2::SynchronizeCustomObjectAssets(), yaze::editor::DungeonObjectSelector::SynchronizeCustomObjectGeneration(), yaze::editor::TileObjectHandler::UpdateObjectsSize(), and yaze::zelda3::ObjectTileEditor::WriteBack().

◆ Initialize()

void yaze::zelda3::CustomObjectManager::Initialize ( const std::string & custom_objects_folder )

Definition at line 559 of file custom_object.cc.

References ActiveContext(), yaze::zelda3::CustomObjectManager::State::base_path, GetBasePath(), InvalidateCaches(), LOG_INFO, ResolveFileList(), and yaze::zelda3::CustomObjectManager::RuntimeContext::state.

Referenced by yaze::cli::resources::CommandContext::ApplyProjectRuntimeContext().

Here is the call graph for this function:

◆ SetObjectFileMap()

void yaze::zelda3::CustomObjectManager::SetObjectFileMap ( const std::unordered_map< int, std::vector< std::string > > & map )

Definition at line 572 of file custom_object.cc.

References ActiveContext(), yaze::zelda3::CustomObjectManager::State::custom_file_map, InvalidateCaches(), and yaze::zelda3::CustomObjectManager::RuntimeContext::state.

Referenced by yaze::cli::resources::CommandContext::ApplyProjectRuntimeContext().

Here is the call graph for this function:

◆ ClearObjectFileMap()

void yaze::zelda3::CustomObjectManager::ClearObjectFileMap ( )

Definition at line 578 of file custom_object.cc.

References ActiveContext(), yaze::zelda3::CustomObjectManager::State::custom_file_map, InvalidateCaches(), and yaze::zelda3::CustomObjectManager::RuntimeContext::state.

Referenced by yaze::cli::resources::CommandContext::ApplyProjectRuntimeContext().

Here is the call graph for this function:

◆ HasCustomFileMap()

bool yaze::zelda3::CustomObjectManager::HasCustomFileMap ( ) const

Definition at line 583 of file custom_object.cc.

References ActiveContext(), yaze::zelda3::CustomObjectManager::State::custom_file_map, and yaze::zelda3::CustomObjectManager::RuntimeContext::state.

Here is the call graph for this function:

◆ ActivateRuntimeContext()

void yaze::zelda3::CustomObjectManager::ActivateRuntimeContext	(	uint64_t	context_id,
		const State &	state )

Definition at line 587 of file custom_object.cc.

References active_runtime_context_id_, yaze::zelda3::ObjectGeometry::ClearCache(), yaze::zelda3::ObjectGeometry::Get(), NextAssetGeneration(), and runtime_contexts_.

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

Here is the call graph for this function:

◆ ActivateStandaloneContext()

void yaze::zelda3::CustomObjectManager::ActivateStandaloneContext ( )

Definition at line 600 of file custom_object.cc.

References active_runtime_context_id_.

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

◆ RemoveRuntimeContext()

void yaze::zelda3::CustomObjectManager::RemoveRuntimeContext ( uint64_t context_id )

Definition at line 604 of file custom_object.cc.

References active_runtime_context_id_, and runtime_contexts_.

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

◆ active_runtime_context_id()

std::optional< uint64_t > yaze::zelda3::CustomObjectManager::active_runtime_context_id ( ) const

inline

Definition at line 162 of file custom_object.h.

References active_runtime_context_id_.

◆ LoadObject()

absl::StatusOr< std::shared_ptr< CustomObject > > yaze::zelda3::CustomObjectManager::LoadObject ( const std::string & filename )

Definition at line 630 of file custom_object.cc.

References ActiveContext(), yaze::zelda3::CustomObjectManager::RuntimeContext::cache, GetBasePath(), yaze::zelda3::LoadCustomObjectAsset(), and LOG_ERROR.

Referenced by GetObjectInternal().

Here is the call graph for this function:

◆ GetObjectInternal()

absl::StatusOr< std::shared_ptr< CustomObject > > yaze::zelda3::CustomObjectManager::GetObjectInternal	(	int	object_id,
		int	subtype )

Definition at line 652 of file custom_object.cc.

References LoadObject(), ResolveFileList(), and RuntimeSubtypeCountForObject().

Referenced by yaze::zelda3::ObjectTileEditor::CaptureObjectLayout(), yaze::zelda3::draw_routines::CustomDraw(), yaze::editor::DungeonObjectSelector::GetCustomObjectAssetStatus(), yaze::zelda3::ObjectDimensionTable::GetSelectionBounds(), yaze::zelda3::HasActiveCustomObjectOverride(), and yaze::editor::DungeonObjectSelector::SelectObject().

Here is the call graph for this function:

◆ GetSubtypeCount()

int yaze::zelda3::CustomObjectManager::GetSubtypeCount ( int object_id ) const

Definition at line 667 of file custom_object.cc.

References ResolveFileList(), and RuntimeSubtypeCountForObject().

Referenced by yaze::zelda3::IsRoomObjectResizable().

Here is the call graph for this function:

◆ RuntimeSubtypeCountForObject()

int yaze::zelda3::CustomObjectManager::RuntimeSubtypeCountForObject ( int object_id )

static

Definition at line 678 of file custom_object.cc.

References DefaultSubtypeFilenamesForObject().

Referenced by yaze::editor::DungeonObjectSelector::DrawObjectAssetBrowser(), yaze::editor::workbench::DrawObjectSizeControls(), yaze::editor::DungeonCanvasViewer::DrawRoomCanvasOverlays(), GetObjectInternal(), GetSubtypeCount(), yaze::editor::IsDungeonCustomObjectRuntimeSlot(), yaze::zelda3::ObjectTileEditor::LoadCustomObjectLayout(), ResolveFilename(), ResolveSlotBinding(), yaze::editor::DungeonObjectSelector::SelectObject(), and yaze::zelda3::ObjectTileEditor::WriteBack().

Here is the call graph for this function:

◆ RuntimeObjectIds()

const std::array< int, 3 > & yaze::zelda3::CustomObjectManager::RuntimeObjectIds ( )

static

Definition at line 682 of file custom_object.cc.

Referenced by yaze::editor::ObjectTileEditorPanel::AnalyzeSourceImpactSnapshot(), yaze::editor::DungeonObjectSelector::DrawCustomObjectAssetBrowser(), and yaze::editor::DungeonObjectSelector::DrawObjectAssetBrowser().

◆ ReloadAll()

void yaze::zelda3::CustomObjectManager::ReloadAll ( )

Definition at line 710 of file custom_object.cc.

References InvalidateCaches().

Here is the call graph for this function:

◆ GetEffectiveFileList()

std::vector< std::string > yaze::zelda3::CustomObjectManager::GetEffectiveFileList ( int object_id ) const

Definition at line 687 of file custom_object.cc.

References ResolveFileList().

Here is the call graph for this function:

◆ DefaultSubtypeFilenamesForObject()

const std::vector< std::string > & yaze::zelda3::CustomObjectManager::DefaultSubtypeFilenamesForObject ( int object_id )

static

Definition at line 696 of file custom_object.cc.

References kSubtype1Filenames, kSubtype2Filenames, and kSubtype54Filenames.

Referenced by ResolveSlotBinding(), RuntimeSubtypeCountForObject(), yaze::editor::anonymous_namespace{editor_manager.cc}::SeedLegacyTrackObjectMapping(), and yaze::cli::resources::anonymous_namespace{command_context.cc}::SeedLegacyTrackObjectMapping().

◆ GetBasePath()

const std::string & yaze::zelda3::CustomObjectManager::GetBasePath ( ) const

Definition at line 765 of file custom_object.cc.

References ActiveContext(), yaze::zelda3::CustomObjectManager::State::base_path, and yaze::zelda3::CustomObjectManager::RuntimeContext::state.

Referenced by Initialize(), and LoadObject().

Here is the call graph for this function:

◆ asset_generation()

uint64_t yaze::zelda3::CustomObjectManager::asset_generation ( ) const

Definition at line 769 of file custom_object.cc.

References ActiveContext(), and yaze::zelda3::CustomObjectManager::RuntimeContext::asset_generation.

Referenced by yaze::editor::DungeonObjectSelector::DetachRuntimeContext(), yaze::zelda3::ObjectGeometry::MeasureByObjectId(), yaze::editor::DungeonEditorV2::SynchronizeCustomObjectAssets(), and yaze::editor::DungeonObjectSelector::SynchronizeCustomObjectGeneration().

Here is the call graph for this function:

◆ ResolveSlotBinding()

absl::StatusOr< CustomObjectSlotBinding > yaze::zelda3::CustomObjectManager::ResolveSlotBinding	(	int	object_id,
		int	subtype ) const

Definition at line 714 of file custom_object.cc.

References ActiveContext(), yaze::zelda3::CustomObjectManager::State::custom_file_map, DefaultSubtypeFilenamesForObject(), yaze::zelda3::CustomObjectSlotBinding::filename, yaze::zelda3::kConfiguredFilename, yaze::zelda3::kConfiguredSlotUnmapped, yaze::zelda3::kDefaultFilename, yaze::zelda3::CustomObjectSlotBinding::origin, RuntimeSubtypeCountForObject(), and yaze::zelda3::CustomObjectManager::RuntimeContext::state.

Referenced by ResolveFilename().

Here is the call graph for this function:

◆ ResolveFilename()

std::string yaze::zelda3::CustomObjectManager::ResolveFilename	(	int	object_id,
		int	subtype ) const

Definition at line 741 of file custom_object.cc.

References ResolveFileList(), ResolveSlotBinding(), and RuntimeSubtypeCountForObject().

Referenced by yaze::zelda3::ObjectTileEditor::CaptureObjectLayout().

Here is the call graph for this function:

◆ SnapshotState()

CustomObjectManager::State yaze::zelda3::CustomObjectManager::SnapshotState ( ) const

Definition at line 756 of file custom_object.cc.

References ActiveContext(), and yaze::zelda3::CustomObjectManager::RuntimeContext::state.

Referenced by yaze::cli::resources::CommandContext::ApplyProjectRuntimeContext().

Here is the call graph for this function:

◆ RestoreState()

void yaze::zelda3::CustomObjectManager::RestoreState ( const State & state )

Definition at line 760 of file custom_object.cc.

References ActiveContext(), InvalidateCaches(), and yaze::zelda3::CustomObjectManager::RuntimeContext::state.

Referenced by yaze::cli::resources::CommandContext::RestoreProjectRuntimeContext().

Here is the call graph for this function:

◆ ActiveContext() [1/2]

CustomObjectManager::RuntimeContext & yaze::zelda3::CustomObjectManager::ActiveContext ( )

private

Definition at line 533 of file custom_object.cc.

References active_runtime_context_id_, runtime_contexts_, and standalone_context_.

Referenced by asset_generation(), ClearObjectFileMap(), GetBasePath(), HasCustomFileMap(), Initialize(), InvalidateCaches(), LoadObject(), ResolveFileList(), ResolveSlotBinding(), RestoreState(), SetObjectFileMap(), and SnapshotState().

◆ ActiveContext() [2/2]

const CustomObjectManager::RuntimeContext & yaze::zelda3::CustomObjectManager::ActiveContext ( ) const

private

Definition at line 540 of file custom_object.cc.

References active_runtime_context_id_, runtime_contexts_, and standalone_context_.

◆ NextAssetGeneration()

uint64_t yaze::zelda3::CustomObjectManager::NextAssetGeneration ( )

private

Definition at line 548 of file custom_object.cc.

References next_asset_generation_.

Referenced by ActivateRuntimeContext(), CustomObjectManager(), and InvalidateCaches().

◆ InvalidateCaches()

void yaze::zelda3::CustomObjectManager::InvalidateCaches ( )

private

Definition at line 552 of file custom_object.cc.

References ActiveContext(), yaze::zelda3::ObjectGeometry::ClearCache(), yaze::zelda3::ObjectGeometry::Get(), and NextAssetGeneration().

Referenced by ClearObjectFileMap(), Initialize(), ReloadAll(), RestoreState(), and SetObjectFileMap().

Here is the call graph for this function:

◆ ResolveFileList()

const std::vector< std::string > * yaze::zelda3::CustomObjectManager::ResolveFileList ( int object_id ) const

private

Definition at line 611 of file custom_object.cc.

References ActiveContext(), yaze::zelda3::CustomObjectManager::State::custom_file_map, kSubtype1Filenames, kSubtype2Filenames, kSubtype54Filenames, and yaze::zelda3::CustomObjectManager::RuntimeContext::state.

Referenced by GetEffectiveFileList(), GetObjectInternal(), GetSubtypeCount(), Initialize(), and ResolveFilename().

Here is the call graph for this function:

Member Data Documentation

◆ standalone_context_

RuntimeContext yaze::zelda3::CustomObjectManager::standalone_context_

private

Definition at line 225 of file custom_object.h.

Referenced by ActiveContext(), ActiveContext(), and CustomObjectManager().

◆ runtime_contexts_

std::unordered_map<uint64_t, RuntimeContext> yaze::zelda3::CustomObjectManager::runtime_contexts_

private

Definition at line 226 of file custom_object.h.

Referenced by ActivateRuntimeContext(), ActiveContext(), ActiveContext(), and RemoveRuntimeContext().

◆ active_runtime_context_id_

std::optional<uint64_t> yaze::zelda3::CustomObjectManager::active_runtime_context_id_

private

Definition at line 227 of file custom_object.h.

Referenced by ActivateRuntimeContext(), ActivateStandaloneContext(), active_runtime_context_id(), ActiveContext(), ActiveContext(), and RemoveRuntimeContext().

◆ next_asset_generation_

uint64_t yaze::zelda3::CustomObjectManager::next_asset_generation_ = 1

private

Definition at line 228 of file custom_object.h.

Referenced by NextAssetGeneration().

◆ kSubtype1Filenames

const std::vector< std::string > yaze::zelda3::CustomObjectManager::kSubtype1Filenames

staticprivate

Initial value:

= {
    "track_LR.bin",               
    "track_UD.bin",               
    "track_corner_TL.bin",        
    "track_corner_TR.bin",        
    "track_corner_BL.bin",        
    "track_corner_BR.bin",        
    "track_floor_UD.bin",         
    "track_floor_LR.bin",         
    "track_floor_corner_TL.bin",  
    "track_floor_corner_TR.bin",  
    "track_floor_corner_BL.bin",  
    "track_floor_corner_BR.bin",  
    "track_floor_any.bin",        
    "wall_sword_house.bin",       
    "track_any.bin",              
    "small_statue.bin",           
}

Definition at line 231 of file custom_object.h.

Referenced by DefaultSubtypeFilenamesForObject(), and ResolveFileList().

◆ kSubtype2Filenames

const std::vector< std::string > yaze::zelda3::CustomObjectManager::kSubtype2Filenames

staticprivate

Initial value:

= {
    "furnace.bin",    
    "firewood.bin",   
    "ice_chair.bin",  
}

Definition at line 233 of file custom_object.h.

Referenced by DefaultSubtypeFilenamesForObject(), and ResolveFileList().

◆ kSubtype54Filenames

const std::vector< std::string > yaze::zelda3::CustomObjectManager::kSubtype54Filenames

staticprivate

Initial value:

= {
    "kydreeok_body.bin",      
    "manhandla_body_1a.bin",  
}

Definition at line 235 of file custom_object.h.

Referenced by DefaultSubtypeFilenamesForObject(), and ResolveFileList().

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

src/zelda3/dungeon/custom_object.h
src/zelda3/dungeon/custom_object.cc

	yaze 0.3.2 Link to the Past ROM Editor

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CustomObjectManager()

Member Function Documentation

◆ Get()

◆ Initialize()

◆ SetObjectFileMap()

◆ ClearObjectFileMap()

◆ HasCustomFileMap()

◆ ActivateRuntimeContext()

◆ ActivateStandaloneContext()

◆ RemoveRuntimeContext()

◆ active_runtime_context_id()

◆ LoadObject()

◆ GetObjectInternal()

◆ GetSubtypeCount()

◆ RuntimeSubtypeCountForObject()

◆ RuntimeObjectIds()

◆ ReloadAll()

◆ GetEffectiveFileList()

◆ DefaultSubtypeFilenamesForObject()

◆ GetBasePath()

◆ asset_generation()

◆ ResolveSlotBinding()

◆ ResolveFilename()

◆ SnapshotState()

◆ RestoreState()

◆ ActiveContext() [1/2]

◆ ActiveContext() [2/2]

◆ NextAssetGeneration()

◆ InvalidateCaches()

◆ ResolveFileList()

Member Data Documentation

◆ standalone_context_

◆ runtime_contexts_

◆ active_runtime_context_id_

◆ next_asset_generation_

◆ kSubtype1Filenames

◆ kSubtype2Filenames

◆ kSubtype54Filenames