xiiSceneDocumentManager Class Reference

Copyright (c) Theophilus Eriata. All Rights Reserved. More...

#include <SceneDocumentManager.h>

Inheritance diagram for xiiSceneDocumentManager:

Private Member Functions
virtual xiiStatus	InternalCreateDocument (xiiStringView sDocumentTypeName, xiiStringView sPath, bool bCreateNewDocument, xiiDocument *&out_pDocument, const xiiDocumentObject *pOpenContext) override

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*)
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, const xiiPlatformProfile *pAssetProfile=nullptr)
virtual bool	IsOutputUpToDate (xiiStringView sDocumentPath, xiiStringView sOutputTag, xiiUInt64 uiHash, const xiiAssetDocumentTypeDescriptor *pTypeDescriptor, const xiiPlatformProfile *pAssetProfile=nullptr)
virtual OutputReliability	GetAssetTypeOutputReliability () const
xiiUInt64	GetAssetProfileHash (const xiiPlatformProfile *pAssetProfile=nullptr) const
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)
xiiStatus	OpenDocument (xiiStringView sDocumentTypeName, xiiStringView sPath, xiiDocument *&out_pDocument, xiiBitflags< xiiDocumentFlags > flags=xiiDocumentFlags::AddToRecentFilesList|xiiDocumentFlags::RequestWindow, const xiiDocumentObject *pOpenContext=nullptr)
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.
xiiDocument *	GetDocumentByPath (xiiStringView sPath) const
bool	EnsureDocumentIsClosed (xiiStringView sPath)
void	CloseAllDocumentsOfManager ()
void	GetSupportedDocumentTypes (xiiDynamicArray< const xiiDocumentTypeDescriptor * > &inout_documentTypes) const
Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI *	GetDynamicRTTI () 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.
static const xiiPlatformProfile *	DetermineFinalTargetProfile (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 xiiDocument *	GetDocumentByGuid (const xiiUuid &guid)
static bool	EnsureDocumentIsClosedInAllManagers (xiiStringView sPath)
static void	CloseAllDocuments ()
static const xiiDocumentTypeDescriptor *	GetDescriptorForDocumentType (xiiStringView sDocumentType)
static const xiiMap< xiiString, const xiiDocumentTypeDescriptor * > &	GetAllDocumentDescriptors ()
Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()
Static Public Attributes inherited from xiiDocumentManager
static xiiCopyOnBroadcastEvent< const Event & >	s_Events
static xiiEvent< Request & >	s_Requests
static xiiMap< xiiString, CustomAction >	s_CustomActions
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)

Detailed Description

Copyright (c) Theophilus Eriata. All Rights Reserved.

Member Function Documentation

GeneratesProfileSpecificAssets()

virtual bool xiiSceneDocumentManager::GeneratesProfileSpecificAssets ( ) const

inlineoverrideprivatevirtual

Implements xiiAssetDocumentManager.

InternalCloneDocument()

void xiiSceneDocumentManager::InternalCloneDocument ( xiiStringView sPath, xiiStringView sClonePath, const xiiUuid & documentId, const xiiUuid & seedGuid, const xiiUuid & cloneGuid, xiiAbstractObjectGraph * pHeader, xiiAbstractObjectGraph * pObjects, xiiAbstractObjectGraph * pTypes )

overrideprivatevirtual

Reimplemented from xiiDocumentManager.

InternalCreateDocument()

xiiStatus xiiSceneDocumentManager::InternalCreateDocument ( xiiStringView sDocumentTypeName, xiiStringView sPath, bool bCreateNewDocument, xiiDocument *& out_pDocument, const xiiDocumentObject * pOpenContext )

overrideprivatevirtual

Constructs a document, including its initial content. On failure the manager destroys any returned document. A successful factory must return a non-null document. Loading, registration and window events follow only on success.

Implements xiiDocumentManager.

InternalGetSupportedDocumentTypes()

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

overrideprivatevirtual

Implements xiiDocumentManager.

---

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

• /home/runner/work/XII/XII/Source/EditorPlugins/Scene/EditorPluginScene/Scene/SceneDocumentManager.h
• /home/runner/work/XII/XII/Source/EditorPlugins/Scene/EditorPluginScene/Scene/SceneDocumentManager.cpp