ezEngine  Release 25.03
ezSurfaceAssetDocumentManager Class Reference
Inheritance diagram for ezSurfaceAssetDocumentManager:

Public Member Functions

virtual OutputReliability GetAssetTypeOutputReliability () const override
 
- Public Member Functions inherited from ezAssetDocumentManager
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.
 
ezResult TryOpenAssetDocument (const char *szPathOrGuid)
 
virtual void GetAssetTypesRequiringTransformForSceneExport (ezSet< ezTempHashedString > &inout_assetTypes)
 
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)
 
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().
 
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.
 
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)
 
- 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. More...
 
ezStatus OpenDocument (ezStringView sDocumentTypeName, ezStringView sPath, ezDocument *&out_pDocument, ezBitflags< ezDocumentFlags > flags=ezDocumentFlags::AddToRecentFilesList|ezDocumentFlags::RequestWindow, const ezDocumentObject *pOpenContext=nullptr)
 Opens an existing document. More...
 
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.
 
ezDocumentGetDocumentByPath (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 ezRTTIGetDynamicRTTI () 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.
 

Additional Inherited Members

- Public Types inherited from ezAssetDocumentManager
enum  OutputReliability : ezUInt8 { Unknown = 0, Good = 1, Perfect = 2 }
 
- Public Types inherited from ezDocumentManager
using CustomAction = ezVariant(*)(const ezDocument *)
 
- Static Public Member Functions inherited from ezAssetDocumentManager
static const ezPlatformProfileDetermineFinalTargetProfile (const ezPlatformProfile *pAssetProfile)
 Returns pAssetProfile, or if that is null, ezAssetCurator::GetSingleton()->GetActiveAssetProfile().
 
- 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 ezDocumentGetDocumentByGuid (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 ezDocumentTypeDescriptorGetDescriptorForDocumentType (ezStringView sDocumentType)
 
static const ezMap< ezString, const ezDocumentTypeDescriptor * > & GetAllDocumentDescriptors ()
 
- Static Public Member Functions inherited from ezNoBase
static const ezRTTIGetStaticRTTI ()
 
- 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)
 
- Static Protected Member Functions inherited from ezAssetDocumentManager
static bool IsResourceUpToDate (const char *szResourceFile, ezUInt64 uiHash, ezUInt16 uiTypeVersion)
 
static void GenerateOutputFilename (ezStringBuilder &inout_sRelativeDocumentPath, const ezPlatformProfile *pAssetProfile, const char *szExtension, bool bPlatformSpecific)
 

Member Function Documentation

◆ GetAssetTypeOutputReliability()

virtual OutputReliability ezSurfaceAssetDocumentManager::GetAssetTypeOutputReliability ( ) const
inlineoverridevirtual
See also
OutputReliability

Reimplemented from ezAssetDocumentManager.


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