XII Release 0.1.0
Loading...
Searching...
No Matches
xiiTextureCubeAssetDocumentManager Class Reference
Inheritance diagram for xiiTextureCubeAssetDocumentManager:
[legend]

Public Member Functions

virtual OutputReliability GetAssetTypeOutputReliability () const override
 
- Public Member Functions inherited from xiiAssetDocumentManager
virtual xiiStatus ReadAssetDocumentInfo (xiiUniquePtr< xiiAssetDocumentInfo > &out_pInfo, xiiStreamReader &inout_stream) const
 Opens the asset file and reads the "Header" into the given xiiAssetDocumentInfo.
 
virtual void FillOutSubAssetList (const xiiAssetDocumentInfo &assetInfo, xiiDynamicArray< xiiSubAssetData > &out_subAssets) const
 
virtual xiiStatus GetAdditionalOutputs (xiiDynamicArray< xiiString > &ref_files)
 
virtual xiiStatus CloneDocument (xiiStringView sPath, xiiStringView sClonePath, xiiUuid &inout_cloneGuid) override
 
virtual xiiResult OpenPickedDocument (const xiiDocumentObject *pPickedComponent, xiiUInt32 uiPartIndex)
 Called by the editor to try to open a document for the matching picking result.
 
xiiResult TryOpenAssetDocument (const char *szPathOrGuid)
 
virtual void GetAssetTypesRequiringTransformForSceneExport (xiiSet< xiiTempHashedString > &inout_assetTypes)
 
virtual xiiString GenerateResourceThumbnailPath (xiiStringView sDocumentPath, xiiStringView sSubAssetName=xiiStringView())
 Returns the absolute path to the thumbnail that belongs to the given document.
 
virtual bool IsThumbnailUpToDate (xiiStringView sDocumentPath, xiiStringView sSubAssetName, xiiUInt64 uiThumbnailHash, xiiUInt32 uiTypeVersion)
 
virtual void AddEntriesToAssetTable (xiiStringView sDataDirectory, const xiiPlatformProfile *pAssetProfile, xiiDelegate< void(xiiStringView sGuid, xiiStringView sPath, xiiStringView sType)> addEntry) const
 
virtual xiiString GetAssetTableEntry (const xiiSubAsset *pSubAsset, xiiStringView sDataDirectory, const xiiPlatformProfile *pAssetProfile) const
 
xiiString GetAbsoluteOutputFileName (const xiiAssetDocumentTypeDescriptor *pTypeDesc, xiiStringView sDocumentPath, xiiStringView sOutputTag, const xiiPlatformProfile *pAssetProfile=nullptr) const
 Calls GetRelativeOutputFileName and prepends [DataDir]/AssetCache/ .
 
virtual xiiString GetRelativeOutputFileName (const xiiAssetDocumentTypeDescriptor *pTypeDesc, xiiStringView sDataDirectory, xiiStringView sDocumentPath, xiiStringView sOutputTag, const xiiPlatformProfile *pAssetProfile=nullptr) const
 Relative to 'AssetCache' folder.
 
bool IsOutputUpToDate (xiiStringView sDocumentPath, const xiiDynamicArray< xiiString > &outputs, xiiUInt64 uiHash, const xiiAssetDocumentTypeDescriptor *pTypeDescriptor)
 
virtual bool IsOutputUpToDate (xiiStringView sDocumentPath, xiiStringView sOutputTag, xiiUInt64 uiHash, const xiiAssetDocumentTypeDescriptor *pTypeDescriptor)
 
void ComputeAssetProfileHash (const xiiPlatformProfile *pAssetProfile)
 Called by the xiiAssetCurator when the active asset profile changes to re-compute m_uiAssetProfileHash.
 
XII_ALWAYS_INLINE xiiUInt64 GetAssetProfileHash () const
 Returns the hash that was previously computed through ComputeAssetProfileHash().
 
- Public Member Functions inherited from xiiDocumentManager
xiiStatus CanOpenDocument (xiiStringView sFilePath) const
 
xiiStatus CreateDocument (xiiStringView sDocumentTypeName, xiiStringView sPath, xiiDocument *&out_pDocument, xiiBitflags< xiiDocumentFlags > flags=xiiDocumentFlags::None, const xiiDocumentObject *pOpenContext=nullptr)
 Creates a new document.
 
xiiStatus OpenDocument (xiiStringView sDocumentTypeName, xiiStringView sPath, xiiDocument *&out_pDocument, xiiBitflags< xiiDocumentFlags > flags=xiiDocumentFlags::AddToRecentFilesList|xiiDocumentFlags::RequestWindow, const xiiDocumentObject *pOpenContext=nullptr)
 Opens an existing document.
 
void CloseDocument (xiiDocument *pDocument)
 
void EnsureWindowRequested (xiiDocument *pDocument, const xiiDocumentObject *pOpenContext=nullptr)
 
const xiiDynamicArray< xiiDocument * > & GetAllOpenDocuments () const
 Returns a list of all currently open documents that are managed by this document manager.
 
xiiDocumentGetDocumentByPath (xiiStringView sPath) const
 
bool EnsureDocumentIsClosed (xiiStringView 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 (xiiDynamicArray< const xiiDocumentTypeDescriptor * > &inout_documentTypes) const
 
- Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTIGetDynamicRTTI () const
 
bool IsInstanceOf (const xiiRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T>
XII_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 xiiAssetDocumentManager
enum  OutputReliability : xiiUInt8 { Unknown = 0 , Good = 1 , Perfect = 2 }
 
- Public Types inherited from xiiDocumentManager
using CustomAction = xiiVariant (*)(const xiiDocument*)
 
static const xiiPlatformProfileDetermineFinalTargetProfile (const xiiPlatformProfile *pAssetProfile)
 Returns pAssetProfile, or if that is null, xiiAssetCurator::GetSingleton()->GetActiveAssetProfile().
 
- Static Public Member Functions inherited from xiiDocumentManager
static const xiiHybridArray< xiiDocumentManager *, 16 > & GetAllDocumentManagers ()
 
static xiiResult FindDocumentTypeFromPath (xiiStringView sPath, bool bForCreation, const xiiDocumentTypeDescriptor *&out_pTypeDesc)
 
static xiiDocumentGetDocumentByGuid (const xiiUuid &guid)
 
static bool EnsureDocumentIsClosedInAllManagers (xiiStringView 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 xiiDocumentTypeDescriptorGetDescriptorForDocumentType (xiiStringView sDocumentType)
 
static const xiiMap< xiiString, const xiiDocumentTypeDescriptor * > & GetAllDocumentDescriptors ()
 
- Static Public Member Functions inherited from xiiNoBase
static const xiiRTTIGetStaticRTTI ()
 
- Static Public Attributes inherited from xiiDocumentManager
static xiiCopyOnBroadcastEvent< const Event & > s_Events
 
static xiiEvent< Request & > s_Requests
 
static xiiMap< xiiString, CustomAction > s_CustomActions
 
- Protected Member Functions inherited from xiiDocumentManager
virtual void InternalCloneDocument (xiiStringView sPath, xiiStringView sClonePath, const xiiUuid &documentId, const xiiUuid &seedGuid, const xiiUuid &cloneGuid, xiiAbstractObjectGraph *pHeader, xiiAbstractObjectGraph *pObjects, xiiAbstractObjectGraph *pTypes)
 
- Static Protected Member Functions inherited from xiiAssetDocumentManager
static bool IsResourceUpToDate (const char *szResourceFile, xiiUInt64 uiHash, xiiUInt16 uiTypeVersion)
 
static void GenerateOutputFilename (xiiStringBuilder &inout_sRelativeDocumentPath, const xiiPlatformProfile *pAssetProfile, const char *szExtension, bool bPlatformSpecific)
 

Member Function Documentation

◆ ComputeAssetProfileHashImpl()

xiiUInt64 xiiTextureCubeAssetDocumentManager::ComputeAssetProfileHashImpl ( const xiiPlatformProfile * pAssetProfile) const
overrideprivatevirtual

Reimplemented from xiiAssetDocumentManager.

◆ GeneratesProfileSpecificAssets()

virtual bool xiiTextureCubeAssetDocumentManager::GeneratesProfileSpecificAssets ( ) const
inlineoverrideprivatevirtual

◆ GetAssetTypeOutputReliability()

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

Reimplemented from xiiAssetDocumentManager.

◆ InternalCreateDocument()

void xiiTextureCubeAssetDocumentManager::InternalCreateDocument ( xiiStringView sDocumentTypeName,
xiiStringView sPath,
bool bCreateNewDocument,
xiiDocument *& out_pDocument,
const xiiDocumentObject * pOpenContext )
overrideprivatevirtual

Implements xiiDocumentManager.

◆ InternalGetSupportedDocumentTypes()

void xiiTextureCubeAssetDocumentManager::InternalGetSupportedDocumentTypes ( xiiDynamicArray< const xiiDocumentTypeDescriptor * > & inout_DocumentTypes) const
overrideprivatevirtual

Implements xiiDocumentManager.


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