|
|
| ezGameObjectDocument (ezStringView sDocumentPath, ezDocumentObjectManager *pObjectManager, ezAssetDocEngineConnection engineConnectionType=ezAssetDocEngineConnection::FullObjectMirroring) |
| |
|
virtual ezGameObjectDocument * | GetRedirectedGameObjectDoc () |
| | In case a document consists of multiple layers, this redirection is necessary to execute actions on the active layer.
|
| |
| virtual ezEditorInputContext * | GetEditorInputContextOverride () override |
| | Allows to return a single input context that currently overrides all others (in priority). More...
|
| |
|
void | SelectionManagerEventHandler (const ezSelectionManagerEvent &e) |
| |
|
void | ObjectPropertyEventHandler (const ezDocumentObjectPropertyEvent &e) |
| |
|
void | ObjectStructureEventHandler (const ezDocumentObjectStructureEvent &e) |
| |
|
void | ObjectEventHandler (const ezDocumentObjectEvent &e) |
| |
|
|
void | TriggerShowSelectionInScenegraph () const |
| |
|
void | TriggerFocusOnSelection (bool bAllViews) const |
| |
|
void | TriggerSnapPivotToGrid () const |
| |
|
void | TriggerSnapEachObjectToGrid () const |
| |
|
void | SnapCameraToObject () |
| | Moves the editor camera to the same position as the selected object.
|
| |
|
void | MoveCameraHere () |
| | Moves the camera to the current picking position.
|
| |
|
void | ScheduleSendObjectSelection () |
| |
|
void | SendObjectSelection () |
| | Sends the current object selection, but only if it was modified or specifically tagged for resending with ScheduleSendObjectSelection().
|
| |
|
|
void | DetermineNodeName (const ezDocumentObject *pObject, const ezUuid &prefabGuid, ezStringBuilder &out_sResult, QIcon *out_pIcon=nullptr) const |
| | Generates a good name for pObject. Queries the "Name" property, child components and asset properties, if necessary.
|
| |
|
void | QueryCachedNodeName (const ezDocumentObject *pObject, ezStringBuilder &out_sResult, ezUuid *out_pPrefabGuid=nullptr, QIcon *out_pIcon=nullptr) const |
| | Similar to DetermineNodeName() but prefers to return the last cached value from scene meta data. This is more efficient, but may give an outdated result.
|
| |
|
void | GenerateFullDisplayName (const ezDocumentObject *pRoot, ezStringBuilder &out_sFullPath) const |
| | Creates a full "path" to a scene object for display in UIs. No guarantee for uniqueness.
|
| |
|
| ezAssetDocument (ezStringView sDocumentPath, ezDocumentObjectManager *pObjectManager, ezAssetDocEngineConnection engineConnectionType) |
| |
|
ezAssetDocumentManager * | GetAssetDocumentManager () const |
| |
|
const ezAssetDocumentInfo * | GetAssetDocumentInfo () const |
| |
|
ezBitflags< ezAssetDocumentFlags > | GetAssetFlags () const |
| |
|
const ezAssetDocumentTypeDescriptor * | GetAssetDocumentTypeDescriptor () const |
| |
| ezTransformStatus | TransformAsset (ezBitflags< ezTransformFlags > transformFlags, const ezPlatformProfile *pAssetProfile=nullptr) |
| | Transforms an asset. Typically not called manually but by the curator which takes care of dependencies first. More...
|
| |
|
ezTransformStatus | CreateThumbnail () |
| | Updates the thumbnail of the asset. Should never be called manually. Called only by the curator which takes care of dependencies first.
|
| |
|
ezUInt16 | GetAssetTypeVersion () const |
| | Returns the RTTI type version of this asset document type. E.g. when the algorithm to transform an asset changes, Increase the RTTI version. This will ensure that assets get re-transformed, even though their settings and dependencies might not have changed.
|
| |
|
EngineStatus | GetEngineStatus () const |
| | Returns the current state of the engine process side of this document.
|
| |
|
virtual ezVariant | GetCreateEngineMetaData () const |
| | Passed into ezEngineProcessDocumentContext::Initialize on the engine process side. Allows the document to provide additional data to the engine process during context creation.
|
| |
|
bool | SendMessageToEngine (ezEditorEngineDocumentMsg *pMessage) const |
| | Sends a message to the corresponding ezEngineProcessDocumentContext on the engine process.
|
| |
|
ezEditorEngineConnection * | GetEditorEngineConnection () const |
| | Returns the ezEditorEngineConnection for this document.
|
| |
|
void | AddSyncObject (ezEditorEngineSyncObject *pSync) const |
| | Registers a sync object for this document. It will be mirrored to the ezEngineProcessDocumentContext on the engine process.
|
| |
|
void | RemoveSyncObject (ezEditorEngineSyncObject *pSync) const |
| | Removes a previously registered sync object. It will be removed on the engine process side.
|
| |
|
ezEditorEngineSyncObject * | FindSyncObject (const ezUuid &guid) const |
| | Returns the sync object registered under the given guid.
|
| |
|
ezEditorEngineSyncObject * | FindSyncObject (const ezRTTI *pType) const |
| | Returns the first sync object registered with the given type.
|
| |
|
void | SyncObjectsToEngine () const |
| | Sends messages to sync all sync objects to the engine process side.
|
| |
| void | SendDocumentOpenMessage (bool bOpen) |
| |
| virtual void | SetCommonAssetUiState (ezCommonAssetUiState::Enum state, double value) |
| | Override this to handle a change to a common asset state differently. More...
|
| |
|
virtual double | GetCommonAssetUiState (ezCommonAssetUiState::Enum state) const |
| | Override this to return custom values for a common asset state.
|
| |
|
| ezDocument (ezStringView sPath, ezDocumentObjectManager *pDocumentObjectManagerImpl) |
| |
|
bool | IsModified () const |
| |
|
bool | IsReadOnly () const |
| |
|
const ezUuid | GetGuid () const |
| |
|
const ezDocumentObjectManager * | GetObjectManager () const |
| |
|
ezDocumentObjectManager * | GetObjectManager () |
| |
|
ezSelectionManager * | GetSelectionManager () const |
| |
|
ezCommandHistory * | GetCommandHistory () const |
| |
|
virtual ezObjectAccessorBase * | GetObjectAccessor () const |
| |
|
virtual void | GetSupportedMimeTypesForPasting (ezHybridArray< ezString, 4 > &out_mimeTypes) const |
| | Whether this document supports pasting the given mime format into it.
|
| |
|
virtual bool | CopySelectedObjects (ezAbstractObjectGraph &out_objectGraph, ezStringBuilder &out_sMimeType) const |
| | Creates the abstract graph of data to be copied and returns the mime type for the clipboard to identify the data.
|
| |
|
virtual bool | Paste (const ezArrayPtr< PasteInfo > &info, const ezAbstractObjectGraph &objectGraph, bool bAllowPickedPosition, ezStringView sMimeType) |
| |
|
void | BroadcastInterDocumentMessage (ezReflectedClass *pMessage, ezDocument *pSender) |
| | This will deliver the message to all open documents. The documents may respond, e.g. by modifying the content of the message.
|
| |
| virtual void | OnInterDocumentMessage (ezReflectedClass *pMessage, ezDocument *pSender) |
| | Called on all documents when BroadcastInterDocumentMessage() is called. More...
|
| |
|
virtual void | DeleteSelectedObjects () const |
| |
|
const ezSet< ezString > & | GetUnknownObjectTypes () const |
| |
|
ezUInt32 | GetUnknownObjectTypeInstances () const |
| |
|
void | SetAddToResetFilesList (bool b) |
| | If disabled, this document will not be put into the recent files list.
|
| |
|
bool | GetAddToRecentFilesList () const |
| | Whether this document shall be put into the recent files list.
|
| |
|
void | ShowDocumentStatus (const ezFormatString &msg) const |
| | Broadcasts a status message event. The window that displays the document may show this in some form, e.g. in the status bar.
|
| |
| virtual ezManipulatorSearchStrategy | GetManipulatorSearchStrategy () const |
| | Needed by ezManipulatorManager to know where to look for the manipulator attributes. More...
|
| |
|
bool | IsMainDocument () const |
| | Returns whether this document is a main document, i.e. self contained.
|
| |
|
bool | IsSubDocument () const |
| | Returns whether this document is a sub-document, i.e. is part of another document.
|
| |
|
const ezDocument * | GetMainDocument () const |
| | In case this is a sub-document, returns the main document this belongs to. Otherwise 'this' is returned.
|
| |
|
const ezDocument * | GetActiveSubDocument () const |
| | At any given time, only the active sub-document can be edited. This returns the active sub-document which can also be this document itself. Changes to the active sub-document are generally triggered by ezDocumentObjectStructureEvent::Type::AfterReset.
|
| |
|
ezDocument * | GetMainDocument () |
| |
|
ezDocument * | GetActiveSubDocument () |
| |
|
ezStringView | GetDocumentPath () const |
| | Returns the absolute path to the document.
|
| |
|
ezStatus | SaveDocument (bool bForce=false) |
| | Saves the document, if it is modified. If bForce is true, the document will be written, even if it is not considered modified.
|
| |
|
ezTaskGroupID | SaveDocumentAsync (AfterSaveCallback callback, bool bForce=false) |
| |
|
void | DocumentRenamed (ezStringView sNewDocumentPath) |
| |
|
ezStatus | LoadDocument () |
| |
|
void | EnsureVisible () |
| | Brings the corresponding window to the front.
|
| |
|
ezDocumentManager * | GetDocumentManager () const |
| |
|
bool | HasWindowBeenRequested () const |
| |
|
const ezDocumentTypeDescriptor * | GetDocumentTypeDescriptor () const |
| |
|
ezStringView | GetDocumentTypeName () const |
| | Returns the document's type name. Same as GetDocumentTypeDescriptor()->m_sDocumentTypeName.
|
| |
|
const ezDocumentInfo * | GetDocumentInfo () const |
| |
| virtual bool | CanEngineProcessBeRestarted () const |
| | Asks the document whether a restart of the engine process is allowed at this time. More...
|
| |
|
virtual bool | ArePrefabsAllowed () const |
| | Whether the document allows to create prefabs in it. This may note be allowed for prefab documents themselves, to prevent nested prefabs.
|
| |
|
virtual void | UpdatePrefabs () |
| | Updates ALL prefabs in the document with the latest changes. Merges the current prefab templates with the instances in the document.
|
| |
|
void | RevertPrefabs (ezArrayPtr< const ezDocumentObject * > selection) |
| | Resets the given objects to their template prefab state, if they have local modifications.
|
| |
|
virtual void | UnlinkPrefabs (ezArrayPtr< const ezDocumentObject * > selection) |
| | Removes the link between a prefab instance and its template, turning the instance into a regular object.
|
| |
|
virtual ezStatus | CreatePrefabDocumentFromSelection (ezStringView sFile, const ezRTTI *pRootType, ezDelegate< void(ezAbstractObjectNode *)> adjustGraphNodeCB={}, ezDelegate< void(ezDocumentObject *)> adjustNewNodesCB={}, ezDelegate< void(ezAbstractObjectGraph &graph, ezDynamicArray< ezAbstractObjectNode * > &graphRootNodes)> finalizeGraphCB={}) |
| |
|
virtual ezStatus | CreatePrefabDocument (ezStringView sFile, ezArrayPtr< const ezDocumentObject * > rootObjects, const ezUuid &invPrefabSeed, ezUuid &out_newDocumentGuid, ezDelegate< void(ezAbstractObjectNode *)> adjustGraphNodeCB={}, bool bKeepOpen=false, ezDelegate< void(ezAbstractObjectGraph &graph, ezDynamicArray< ezAbstractObjectNode * > &graphRootNodes)> finalizeGraphCB={}) |
| |
|
virtual ezUuid | ReplaceByPrefab (const ezDocumentObject *pRootObject, ezStringView sPrefabFile, const ezUuid &prefabAsset, const ezUuid &prefabSeed, bool bEnginePrefab) |
| |
|
virtual ezUuid | RevertPrefab (const ezDocumentObject *pObject) |
| |
|
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.
|
| |
|
|
void | SubscribeGameObjectEventHandlers () |
| |
|
void | UnsubscribeGameObjectEventHandlers () |
| |
|
void | GameObjectDocumentEventHandler (const ezGameObjectDocumentEvent &e) |
| |
| void | InvalidateGlobalTransformValue (const ezDocumentObject *pObject) const |
| |
|
virtual void | SendGameWorldToEngine () |
| | Sends the current state of the scene to the engine process. This is typically done after scene load or when the world might have deviated on the engine side (after play the game etc.)
|
| |
|
virtual void | InitializeAfterLoading (bool bFirstTimeCreation) override |
| |
|
virtual void | AttachMetaDataBeforeSaving (ezAbstractObjectGraph &graph) const override |
| |
|
virtual void | RestoreMetaDataAfterLoading (const ezAbstractObjectGraph &graph, bool bUndoable) override |
| |
|
void | EngineConnectionEventHandler (const ezEditorEngineProcessConnection::Event &e) |
| |
|
void | AddPrefabDependencies (const ezDocumentObject *pObject, ezAssetDocumentInfo *pInfo) const |
| | Adds all prefab dependencies to the ezAssetDocumentInfo object. Called automatically by UpdateAssetDocumentInfo()
|
| |
|
void | AddReferences (const ezDocumentObject *pObject, ezAssetDocumentInfo *pInfo, bool bInsidePrefab) const |
| | Crawls through all asset properties of pObject and adds all string properties that have a ezAssetBrowserAttribute as a dependency to pInfo. Automatically called by UpdateAssetDocumentInfo()
|
| |
|
virtual ezDocumentInfo * | CreateDocumentInfo () override |
| |
|
ezTransformStatus | DoTransformAsset (const ezPlatformProfile *pAssetProfile, ezBitflags< ezTransformFlags > transformFlags) |
| |
|
ezUInt64 | GetDocumentHash () const |
| | Computes the hash from all document objects.
|
| |
|
void | GetChildHash (const ezDocumentObject *pObject, ezUInt64 &inout_uiHash) const |
| | Computes the hash for one document object and combines it with the given hash.
|
| |
|
virtual void | InternalGetMetaDataHash (const ezDocumentObject *pObject, ezUInt64 &inout_uiHash) const |
| | Computes the hash for transform relevant meta data of the given document object and combines it with the given hash.
|
| |
|
virtual ezTaskGroupID | InternalSaveDocument (AfterSaveCallback callback) override |
| | Overrides the base function to call UpdateAssetDocumentInfo() to update the settings hash.
|
| |
| virtual void | InternalAfterSaveDocument () override |
| | Implements auto transform on save. More...
|
| |
|
virtual void | InitializeAfterLoadingAndSaving () override |
| |
|
virtual ezTransformStatus | InternalCreateThumbnail (const ThumbnailInfo &thumbnailInfo) |
| | Override this function to generate a thumbnail. Only called if GetAssetFlags returns ezAssetDocumentFlags::SupportsThumbnail.
|
| |
|
ezString | GetThumbnailFilePath (ezStringView sSubAssetName=ezStringView()) const |
| | Returns the full path to the jpg file in which the thumbnail for this asset is supposed to be.
|
| |
|
void | InvalidateAssetThumbnail (ezStringView sSubAssetName=ezStringView()) const |
| | Should be called after manually changing the thumbnail, such that the system will reload it.
|
| |
|
ezStatus | RemoteCreateThumbnail (const ThumbnailInfo &thumbnailInfo, ezArrayPtr< ezStringView > viewExclusionTags) const |
| | Requests the engine side to render a thumbnail, will call SaveThumbnail on success.
|
| |
|
ezStatus | RemoteCreateThumbnail (const ThumbnailInfo &thumbnailInfo) const |
| |
| ezStatus | SaveThumbnail (const ezImage &img, const ThumbnailInfo &thumbnailInfo) const |
| | Saves the given image as the new thumbnail for the asset. More...
|
| |
|
ezStatus | SaveThumbnail (const QImage &img, const ThumbnailInfo &thumbnailInfo) const |
| | Saves the given image as the new thumbnail for the asset.
|
| |
|
void | AppendThumbnailInfo (ezStringView sThumbnailFile, const ThumbnailInfo &thumbnailInfo) const |
| | Appends an asset header containing the thumbnail hash to the file. Each thumbnail is appended by it to check up-to-date state.
|
| |
| virtual void | UpdateAssetDocumentInfo (ezAssetDocumentInfo *pInfo) const |
| | Override this to add custom data (e.g. additional file dependencies) to the info struct. More...
|
| |
| virtual ezTransformStatus | InternalTransformAsset (ezStreamWriter &stream, ezStringView sOutputTag, const ezPlatformProfile *pAssetProfile, const ezAssetFileHeader &AssetHeader, ezBitflags< ezTransformFlags > transformFlags)=0 |
| | Override this and write the transformed file for the given szOutputTag into the given stream. More...
|
| |
| virtual ezTransformStatus | InternalTransformAsset (const char *szTargetFile, ezStringView sOutputTag, const ezPlatformProfile *pAssetProfile, const ezAssetFileHeader &AssetHeader, ezBitflags< ezTransformFlags > transformFlags) |
| | Only override this function, if the transformed file for the given szOutputTag must be written from another process. More...
|
| |
|
ezStatus | RemoteExport (const ezAssetFileHeader &header, const char *szOutputTarget) const |
| |
|
void | SetModified (bool b) |
| |
|
void | SetReadOnly (bool b) |
| |
|
virtual ezStatus | InternalLoadDocument () |
| |
|
virtual void | BeforeClosing () |
| |
|
void | SetUnknownObjectTypes (const ezSet< ezString > &Types, ezUInt32 uiInstances) |
| |
|
virtual void | UpdatePrefabsRecursive (ezDocumentObject *pObject) |
| |
|
virtual void | UpdatePrefabObject (ezDocumentObject *pObject, const ezUuid &PrefabAsset, const ezUuid &PrefabSeed, ezStringView sBasePrefab) |
| |
Public Member Functions inherited from ezAssetDocument
1.8.17