Inheritance diagram for ezAssetDocumentManager:

[legend]

Public Member Functions
virtual ezStatus	ReadAssetDocumentInfo (ezUniquePtr< ezAssetDocumentInfo > &out_pInfo, ezStreamReader &inout_stream) const
	Opens the asset file and reads the "Header" into the given ezAssetDocumentInfo.

virtual void	FillOutSubAssetList (const ezAssetDocumentInfo &assetInfo, ezDynamicArray< ezSubAssetData > &out_subAssets) const

virtual ezStatus	GetAdditionalOutputs (ezDynamicArray< ezString > &ref_files)

virtual ezStatus	CloneDocument (ezStringView sPath, ezStringView sClonePath, ezUuid &inout_cloneGuid) override

virtual ezResult	OpenPickedDocument (const ezDocumentObject *pPickedComponent, ezUInt32 uiPartIndex)
	Called by the editor to try to open a document for the matching picking result.

virtual void	GetAssetTypesRequiringTransformForSceneExport (ezSet< ezTempHashedString > &inout_assetTypes)

Thumbnail Functions
virtual ezString	GenerateResourceThumbnailPath (ezStringView sDocumentPath, ezStringView sSubAssetName=ezStringView())
	Returns the absolute path to the thumbnail that belongs to the given document.

virtual bool	IsThumbnailUpToDate (ezStringView sDocumentPath, ezStringView sSubAssetName, ezUInt64 uiThumbnailHash, ezUInt32 uiTypeVersion)

Public Member Functions inherited from ezDocumentManager
ezStatus	CanOpenDocument (ezStringView sFilePath) const

ezStatus	CreateDocument (ezStringView sDocumentTypeName, ezStringView sPath, ezDocument &out_pDocument, ezBitflags< ezDocumentFlags > flags=ezDocumentFlags::None, const ezDocumentObject pOpenContext=nullptr)
	Creates a new document.

ezStatus	OpenDocument (ezStringView sDocumentTypeName, ezStringView sPath, ezDocument &out_pDocument, ezBitflags< ezDocumentFlags > flags=ezDocumentFlags::AddToRecentFilesList\|ezDocumentFlags::RequestWindow, const ezDocumentObject pOpenContext=nullptr)
	Opens an existing document.

void	CloseDocument (ezDocument *pDocument)

void	EnsureWindowRequested (ezDocument pDocument, const ezDocumentObject pOpenContext=nullptr)

const ezDynamicArray< ezDocument * > &	GetAllOpenDocuments () const
	Returns a list of all currently open documents that are managed by this document manager.

ezDocument *	GetDocumentByPath (ezStringView sPath) const

bool	EnsureDocumentIsClosed (ezStringView sPath)
	If the given document is open, it will be closed. User is not asked about it, unsaved changes are discarded. Returns true if the document was open and needed to be closed. This function only operates on documents opened by this manager. Use EnsureDocumentIsClosedInAllManagers() to close documents of any type.

void	CloseAllDocumentsOfManager ()

void	GetSupportedDocumentTypes (ezDynamicArray< const ezDocumentTypeDescriptor * > &inout_documentTypes) const

Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () const

bool	IsInstanceOf (const ezRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.

template<typename T >
EZ_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Static Public Member Functions
static ezResult	TryOpenAssetDocument (const char *szPathOrGuid)

Static Public Member Functions inherited from ezDocumentManager
static const ezHybridArray< ezDocumentManager *, 16 > &	GetAllDocumentManagers ()

static ezResult	FindDocumentTypeFromPath (ezStringView sPath, bool bForCreation, const ezDocumentTypeDescriptor *&out_pTypeDesc)

static ezDocument *	GetDocumentByGuid (const ezUuid &guid)

static bool	EnsureDocumentIsClosedInAllManagers (ezStringView sPath)
	If the given document is open, it will be closed. User is not asked about it, unsaved changes are discarded. Returns true if the document was open and needed to be closed.

static void	CloseAllDocuments ()

static const ezDocumentTypeDescriptor *	GetDescriptorForDocumentType (ezStringView sDocumentType)

static const ezMap< ezString, const ezDocumentTypeDescriptor * > &	GetAllDocumentDescriptors ()

Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()

Static Protected Member Functions
static bool	IsResourceUpToDate (const char *szResourceFile, ezUInt64 uiHash, ezUInt16 uiTypeVersion)

static void	GenerateOutputFilename (ezStringBuilder &inout_sRelativeDocumentPath, const ezPlatformProfile pAssetProfile, const char szExtension, bool bPlatformSpecific)

Output Functions
enum	OutputReliability : ezUInt8 { Unknown = 0 , Good = 1 , Perfect = 2 }

virtual void	AddEntriesToAssetTable (ezStringView sDataDirectory, const ezPlatformProfile *pAssetProfile, ezDelegate< void(ezStringView sGuid, ezStringView sPath, ezStringView sType)> addEntry) const

virtual ezString	GetAssetTableEntry (const ezSubAsset pSubAsset, ezStringView sDataDirectory, const ezPlatformProfile pAssetProfile) const

ezString	GetAbsoluteOutputFileName (const ezAssetDocumentTypeDescriptor pTypeDesc, ezStringView sDocumentPath, ezStringView sOutputTag, const ezPlatformProfile pAssetProfile=nullptr) const
	Calls GetRelativeOutputFileName and prepends [DataDir]/AssetCache/ .

virtual ezString	GetRelativeOutputFileName (const ezAssetDocumentTypeDescriptor pTypeDesc, ezStringView sDataDirectory, ezStringView sDocumentPath, ezStringView sOutputTag, const ezPlatformProfile pAssetProfile=nullptr) const
	Relative to 'AssetCache' folder.

virtual ezStringView	GetOutputDocumentType (const ezAssetDocumentTypeDescriptor pTypeDesc, ezStringView sOutputTag, const ezPlatformProfile pAssetProfile=nullptr) const
	Should return the document type of the given sOutputTag.

virtual bool	GeneratesProfileSpecificAssets () const =0

bool	IsOutputUpToDate (ezStringView sDocumentPath, const ezDynamicArray< ezString > &outputs, ezUInt64 uiHash, const ezAssetDocumentTypeDescriptor *pTypeDescriptor)

virtual bool	IsOutputUpToDate (ezStringView sDocumentPath, ezStringView sOutputTag, ezUInt64 uiHash, const ezAssetDocumentTypeDescriptor *pTypeDescriptor)

virtual OutputReliability	GetAssetTypeOutputReliability () const

Asset Profile Functions
void	ComputeAssetProfileHash (const ezPlatformProfile *pAssetProfile)
	Called by the ezAssetCurator when the active asset profile changes to re-compute m_uiAssetProfileHash.

EZ_ALWAYS_INLINE ezUInt64	GetAssetProfileHash () const
	Returns the hash that was previously computed through ComputeAssetProfileHash().

static const ezPlatformProfile *	DetermineFinalTargetProfile (const ezPlatformProfile *pAssetProfile)
	Returns pAssetProfile, or if that is null, ezAssetCurator::GetSingleton()->GetActiveAssetProfile().

Additional Inherited Members
Public Types inherited from ezDocumentManager
using	CustomAction = ezVariant()(const ezDocument )

Static Public Attributes inherited from ezDocumentManager
static ezCopyOnBroadcastEvent< const Event & >	s_Events

static ezEvent< Request & >	s_Requests

static ezMap< ezString, CustomAction >	s_CustomActions

Protected Member Functions inherited from ezDocumentManager
virtual void	InternalCloneDocument (ezStringView sPath, ezStringView sClonePath, const ezUuid &documentId, const ezUuid &seedGuid, const ezUuid &cloneGuid, ezAbstractObjectGraph pHeader, ezAbstractObjectGraph pObjects, ezAbstractObjectGraph *pTypes)

Member Enumeration Documentation

◆ OutputReliability

enum ezAssetDocumentManager::OutputReliability : ezUInt8

Describes how likely it is that a generated file is 'corrupted', due to dependency issues and such. For example a prefab may not work correctly, if it was written with a very different C++ plugin state, but this can't be detected later. Whereas a texture always produces exactly the same output and is thus perfectly reliable. This is used to clear asset caches selectively, and keep things that are unlikely to be in a broken state.

Member Function Documentation

◆ CloneDocument()

ezStatus ezAssetDocumentManager::CloneDocument	(	ezStringView	sPath,
		ezStringView	sClonePath,
		ezUuid &	inout_cloneGuid
	)

overridevirtual

Reimplemented from ezDocumentManager.

◆ GetAdditionalOutputs()

virtual ezStatus ezAssetDocumentManager::GetAdditionalOutputs ( ezDynamicArray< ezString > & ref_files )

inlinevirtual

If this asset type has additional output files that need to be generated (like a texture atlas that combines outputs from multiple assets) this function should make sure those files are all generated and return the list of relative file paths (from the data directory root).

◆ GetAssetTypeOutputReliability()

virtual OutputReliability ezAssetDocumentManager::GetAssetTypeOutputReliability ( ) const

inlinevirtual

See also: OutputReliability

Reimplemented in ezColorGradientAssetDocumentManager, ezCurve1DAssetDocumentManager, ezCustomDataAssetDocumentManager, ezImageDataAssetDocumentManager, ezLUTAssetDocumentManager, ezRenderPipelineAssetManager, ezStateMachineAssetManager, ezSurfaceAssetDocumentManager, ezTextureAssetDocumentManager, ezTextureCubeAssetDocumentManager, ezSoundBankAssetDocumentManager, ezSoundEventAssetDocumentManager, and ezMiniAudioSoundAssetDocumentManager.

◆ GetAssetTypesRequiringTransformForSceneExport()

virtual void ezAssetDocumentManager::GetAssetTypesRequiringTransformForSceneExport ( ezSet< ezTempHashedString > & inout_assetTypes )

inlinevirtual

In case this manager deals with types that need to be force transformed on scene export, it can add the asset type names to this list. This is only needed for assets that have such special dependencies for their transform step, that the regular dependency tracking doesn't work for them. Currently the only known case are Collection assets, because they have to manually go through the Package dependencies transitively, which means that the asset curator can't know when they need to be updated.

Reimplemented in ezCollectionAssetDocumentManager.

◆ GetOutputDocumentType()

virtual ezStringView ezAssetDocumentManager::GetOutputDocumentType	(	const ezAssetDocumentTypeDescriptor *	pTypeDesc,
		ezStringView	sOutputTag,
		const ezPlatformProfile *	pAssetProfile = `nullptr`
	)		const

inlinevirtual

Should return the document type of the given sOutputTag.

Reimplemented in ezMaterialAssetDocumentManager.

◆ GetRelativeOutputFileName()

ezString ezAssetDocumentManager::GetRelativeOutputFileName	(	const ezAssetDocumentTypeDescriptor *	pTypeDesc,
		ezStringView	sDataDirectory,
		ezStringView	sDocumentPath,
		ezStringView	sOutputTag,
		const ezPlatformProfile *	pAssetProfile = `nullptr`
	)		const

virtual

Relative to 'AssetCache' folder.

Reimplemented in ezMaterialAssetDocumentManager, and ezTextureAssetDocumentManager.

◆ OpenPickedDocument()

virtual ezResult ezAssetDocumentManager::OpenPickedDocument	(	const ezDocumentObject *	pPickedComponent,
		ezUInt32	uiPartIndex
	)

inlinevirtual

Called by the editor to try to open a document for the matching picking result.

Reimplemented in ezMeshAssetDocumentManager, and ezSceneDocumentManager.

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

/home/runner/work/ezEngine/ezEngine/Code/Editor/EditorFramework/Assets/AssetDocumentManager.h
/home/runner/work/ezEngine/ezEngine/Code/Editor/EditorFramework/Assets/Implementation/AssetDocumentManager.cpp

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Output Functions

Asset Profile Functions

Additional Inherited Members

Member Enumeration Documentation

◆ OutputReliability

Member Function Documentation

◆ CloneDocument()

◆ GetAdditionalOutputs()

◆ GetAssetTypeOutputReliability()

◆ GetAssetTypesRequiringTransformForSceneExport()

◆ GetOutputDocumentType()

◆ GetRelativeOutputFileName()

◆ OpenPickedDocument()