|
|
| xiiGameObjectContextDocument (xiiStringView sDocumentPath, xiiDocumentObjectManager *pObjectManager, xiiAssetDocEngineConnection engineConnectionType=xiiAssetDocEngineConnection::FullObjectMirroring) |
| |
|
xiiStatus | SetContext (xiiUuid documentGuid, xiiUuid objectGuid) |
| |
|
xiiUuid | GetContextDocumentGuid () const |
| |
|
xiiUuid | GetContextObjectGuid () const |
| |
|
const xiiDocumentObject * | GetContextObject () const |
| |
|
| xiiGameObjectDocument (xiiStringView sDocumentPath, xiiDocumentObjectManager *pObjectManager, xiiAssetDocEngineConnection engineConnectionType=xiiAssetDocEngineConnection::FullObjectMirroring) |
| |
| virtual xiiGameObjectDocument * | GetRedirectedGameObjectDoc () |
| | In case a document consists of multiple layers, this redirection is necessary to execute actions on the active layer.
|
| |
| virtual xiiEditorInputContext * | GetEditorInputContextOverride () override |
| | Allows to return a single input context that currently overrides all others (in priority).
|
| |
|
void | SelectionManagerEventHandler (const xiiSelectionManagerEvent &e) |
| |
|
void | ObjectPropertyEventHandler (const xiiDocumentObjectPropertyEvent &e) |
| |
|
void | ObjectStructureEventHandler (const xiiDocumentObjectStructureEvent &e) |
| |
|
void | ObjectEventHandler (const xiiDocumentObjectEvent &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 xiiDocumentObject *pObject, const xiiUuid &prefabGuid, xiiStringBuilder &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 xiiDocumentObject *pObject, xiiStringBuilder &out_sResult, xiiUuid *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 xiiDocumentObject *pRoot, xiiStringBuilder &out_sFullPath) const |
| | Creates a full "path" to a scene object for display in UIs. No guarantee for uniqueness.
|
| |
|
void | SetActiveEditTool (const xiiRTTI *pEditToolType) |
| | Makes an edit tool of the given type active. Allocates a new one, if necessary. Only works when SetEditToolConfigDelegate() is set.
|
| |
|
xiiGameObjectEditTool * | GetActiveEditTool () const |
| | Returns the currently active edit tool (nullptr for none).
|
| |
|
bool | IsActiveEditTool (const xiiRTTI *pEditToolType) const |
| | Checks whether an edit tool of the given type, or nullptr for none, is active.
|
| |
|
void | SetEditToolConfigDelegate (xiiDelegate< void(xiiGameObjectEditTool *)> configDelegate) |
| | Needs to be called by some higher level code (usually the DocumentWindow) to react to newly created edit tools to configure them (call xiiGameObjectEditTool::ConfigureTool()).
|
| |
|
void | SetGizmoWorldSpace (bool bWorldSpace) |
| |
|
bool | GetGizmoWorldSpace () const |
| |
|
void | SetGizmoMoveParentOnly (bool bMoveParent) |
| |
|
bool | GetGizmoMoveParentOnly () const |
| |
| void | ComputeTopLevelSelectedGameObjects (xiiDeque< xiiSelectedGameObject > &out_selection) |
| | Finds all objects that are selected at the top level, ie. none of their parents is selected.
|
| |
| virtual void | HandleEngineMessage (const xiiEditorEngineDocumentMsg *pMsg) override |
| | Handles all messages received from the corresponding xiiEngineProcessDocumentContext on the engine process.
|
| |
|
bool | GetAddAmbientLight () const |
| |
|
void | SetAddAmbientLight (bool b) |
| |
|
float | GetSimulationSpeed () const |
| |
|
void | SetSimulationSpeed (float f) |
| |
|
bool | GetRenderSelectionOverlay () const |
| |
|
void | SetRenderSelectionOverlay (bool b) |
| |
|
bool | GetRenderVisualizers () const |
| |
|
void | SetRenderVisualizers (bool b) |
| |
|
bool | GetRenderShapeIcons () const |
| |
|
void | SetRenderShapeIcons (bool b) |
| |
|
bool | GetPickTransparent () const |
| |
|
void | SetPickTransparent (bool b) |
| |
|
void | SetActiveParent (xiiUuid object) |
| | Specifies which object is the 'active parent', which is the object under which newly created objects should be parented.
|
| |
| xiiUuid | GetActiveParent () const |
| | Returns the object under which newly created objects should be parented.
|
| |
|
void | SetGlobalTransform (const xiiDocumentObject *pObject, const xiiTransform &t, xiiUInt8 uiTransformationChanges) const |
| | Sets the new global transformation of the given object. The transformationChanges bitmask (of type TransformationChanges) allows to tell the system that, e.g. only translation has changed and thus some work can be spared.
|
| |
|
void | SetGlobalTransformParentOnly (const xiiDocumentObject *pObject, const xiiTransform &t, xiiUInt8 uiTransformationChanges) const |
| | Same as SetGlobalTransform, except that all children will keep their current global transform (thus their local transforms are adjusted)
|
| |
|
xiiTransform | GetGlobalTransform (const xiiDocumentObject *pObject) const |
| | Returns a cached value for the global transform of the given object, if available. Otherwise it calls ComputeGlobalTransform().
|
| |
|
xiiTransform | ComputeGlobalTransform (const xiiDocumentObject *pObject) const |
| | Computes the global transform of the parent and combines it with the local transform of the given object. This function does not return a cached value, but always computes it. It does update the internal cache for later reads though.
|
| |
| virtual xiiResult | ComputeObjectTransformation (const xiiDocumentObject *pObject, xiiTransform &out_result) const override |
| | Traverses the pObject hierarchy up until it hits a xiiGameObject, then computes the global transform of that.
|
| |
|
| xiiAssetDocument (xiiStringView sDocumentPath, xiiDocumentObjectManager *pObjectManager, xiiAssetDocEngineConnection engineConnectionType) |
| |
|
EngineStatus | GetEngineStatus () const |
| | Returns the current state of the engine process side of this document.
|
| |
|
xiiStatus | WaitForEngineStatusLoaded () const |
| | Waits for GetEngineStatus to return Loaded or returns a failure reason.
|
| |
| virtual xiiVariant | GetCreateEngineMetaData () const |
| | Passed into xiiEngineProcessDocumentContext::Initialize on the engine process side. Allows the document to provide additional data to the engine process during context creation.
|
| |
|
bool | SendMessageToEngine (xiiEditorEngineDocumentMsg *pMessage) const |
| | Sends a message to the corresponding xiiEngineProcessDocumentContext on the engine process.
|
| |
|
xiiEditorEngineConnection * | GetEditorEngineConnection () const |
| | Returns the xiiEditorEngineConnection for this document.
|
| |
|
void | AddSyncObject (xiiEditorEngineSyncObject *pSync) const |
| | Registers a sync object for this document. It will be mirrored to the xiiEngineProcessDocumentContext on the engine process.
|
| |
|
void | RemoveSyncObject (xiiEditorEngineSyncObject *pSync) const |
| | Removes a previously registered sync object. It will be removed on the engine process side.
|
| |
|
xiiEditorEngineSyncObject * | FindSyncObject (const xiiUuid &guid) const |
| | Returns the sync object registered under the given guid.
|
| |
|
xiiEditorEngineSyncObject * | FindSyncObject (const xiiRTTI *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 (xiiCommonAssetUiState::Enum state, double value) |
| | Override this to handle a change to a common asset state differently.
|
| |
| virtual double | GetCommonAssetUiState (xiiCommonAssetUiState::Enum state) const |
| | Override this to return custom values for a common asset state.
|
| |
|
xiiAssetDocumentManager * | GetAssetDocumentManager () const |
| |
|
const xiiAssetDocumentInfo * | GetAssetDocumentInfo () const |
| |
|
xiiBitflags< xiiAssetDocumentFlags > | GetAssetFlags () const |
| |
|
const xiiAssetDocumentTypeDescriptor * | GetAssetDocumentTypeDescriptor () const |
| |
| xiiTransformStatus | TransformAsset (xiiBitflags< xiiTransformFlags > transformFlags, const xiiPlatformProfile *pAssetProfile=nullptr) |
| | Transforms an asset. Typically not called manually but by the curator which takes care of dependencies first.
|
| |
|
xiiTransformStatus | CreateThumbnail () |
| | Updates the thumbnail of the asset. Should never be called manually. Called only by the curator which takes care of dependencies first.
|
| |
|
xiiUInt16 | 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.
|
| |
|
| xiiDocument (xiiStringView sPath, xiiDocumentObjectManager *pDocumentObjectManagerImpl) |
| |
|
bool | IsModified () const |
| |
|
bool | IsReadOnly () const |
| |
|
const xiiUuid | GetGuid () const |
| |
|
const xiiDocumentObjectManager * | GetObjectManager () const |
| |
|
xiiDocumentObjectManager * | GetObjectManager () |
| |
|
xiiSelectionManager * | GetSelectionManager () const |
| |
|
xiiCommandHistory * | GetCommandHistory () const |
| |
|
virtual xiiObjectAccessorBase * | GetObjectAccessor () const |
| |
| virtual void | GetSupportedMimeTypesForPasting (xiiHybridArray< xiiString, 4 > &out_mimeTypes) const |
| | Whether this document supports pasting the given mime format into it.
|
| |
| virtual bool | CopySelectedObjects (xiiAbstractObjectGraph &out_objectGraph, xiiStringBuilder &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 xiiArrayPtr< PasteInfo > &info, const xiiAbstractObjectGraph &objectGraph, bool bAllowPickedPosition, xiiStringView sMimeType) |
| |
|
void | BroadcastInterDocumentMessage (xiiReflectedClass *pMessage, xiiDocument *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 (xiiReflectedClass *pMessage, xiiDocument *pSender) |
| | Called on all documents when BroadcastInterDocumentMessage() is called.
|
| |
|
virtual void | DeleteSelectedObjects () const |
| |
|
const xiiSet< xiiString > & | GetUnknownObjectTypes () const |
| |
|
xiiUInt32 | 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 xiiFormatString &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 xiiManipulatorSearchStrategy | GetManipulatorSearchStrategy () const |
| | Needed by xiiManipulatorManager to know where to look for the manipulator attributes.
|
| |
|
xiiStringView | GetDocumentPath () const |
| | Returns the absolute path to the document.
|
| |
|
xiiStatus | 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.
|
| |
|
xiiTaskGroupID | SaveDocumentAsync (AfterSaveCallback callback, bool bForce=false) |
| |
|
void | DocumentRenamed (xiiStringView sNewDocumentPath) |
| |
|
xiiStatus | LoadDocument () |
| |
|
void | EnsureVisible () |
| | Brings the corresponding window to the front.
|
| |
|
xiiDocumentManager * | GetDocumentManager () const |
| |
|
bool | HasWindowBeenRequested () const |
| |
|
const xiiDocumentTypeDescriptor * | GetDocumentTypeDescriptor () const |
| |
|
xiiStringView | GetDocumentTypeName () const |
| | Returns the document's type name. Same as GetDocumentTypeDescriptor()->m_sDocumentTypeName.
|
| |
|
const xiiDocumentInfo * | GetDocumentInfo () const |
| |
| virtual bool | CanEngineProcessBeRestarted () const |
| | Asks the document whether a restart of the engine process is allowed at this time.
|
| |
|
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 xiiDocument * | GetMainDocument () const |
| | In case this is a sub-document, returns the main document this belongs to. Otherwise 'this' is returned.
|
| |
|
const xiiDocument * | 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 xiiDocumentObjectStructureEvent::Type::AfterReset.
|
| |
|
xiiDocument * | GetMainDocument () |
| |
|
xiiDocument * | GetActiveSubDocument () |
| |
| 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 (xiiArrayPtr< const xiiDocumentObject * > selection) |
| | Resets the given objects to their template prefab state, if they have local modifications.
|
| |
| virtual void | UnlinkPrefabs (xiiArrayPtr< const xiiDocumentObject * > selection) |
| | Removes the link between a prefab instance and its template, turning the instance into a regular object.
|
| |
|
virtual xiiStatus | CreatePrefabDocumentFromSelection (xiiStringView sFile, const xiiRTTI *pRootType, xiiDelegate< void(xiiAbstractObjectNode *)> adjustGraphNodeCB={}, xiiDelegate< void(xiiDocumentObject *)> adjustNewNodesCB={}, xiiDelegate< void(xiiAbstractObjectGraph &graph, xiiDynamicArray< xiiAbstractObjectNode * > &graphRootNodes)> finalizeGraphCB={}) |
| |
|
virtual xiiStatus | CreatePrefabDocument (xiiStringView sFile, xiiArrayPtr< const xiiDocumentObject * > rootObjects, const xiiUuid &invPrefabSeed, xiiUuid &out_newDocumentGuid, xiiDelegate< void(xiiAbstractObjectNode *)> adjustGraphNodeCB={}, bool bKeepOpen=false, xiiDelegate< void(xiiAbstractObjectGraph &graph, xiiDynamicArray< xiiAbstractObjectNode * > &graphRootNodes)> finalizeGraphCB={}) |
| |
|
virtual xiiUuid | ReplaceByPrefab (const xiiDocumentObject *pRootObject, xiiStringView sPrefabFile, const xiiUuid &prefabAsset, const xiiUuid &prefabSeed, bool bEnginePrefab) |
| |
| virtual xiiUuid | RevertPrefab (const xiiDocumentObject *pObject) |
| |
|
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.
|
| |
|
| virtual void | InitializeAfterLoading (bool bFirstTimeCreation) override |
| |
|
void | SubscribeGameObjectEventHandlers () |
| |
|
void | UnsubscribeGameObjectEventHandlers () |
| |
|
void | GameObjectDocumentEventHandler (const xiiGameObjectDocumentEvent &e) |
| |
| void | InvalidateGlobalTransformValue (const xiiDocumentObject *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 | AttachMetaDataBeforeSaving (xiiAbstractObjectGraph &graph) const override |
| |
| virtual void | RestoreMetaDataAfterLoading (const xiiAbstractObjectGraph &graph, bool bUndoable) override |
| |
|
void | EngineConnectionEventHandler (const xiiEditorEngineProcessConnection::Event &e) |
| |
|
void | AddPrefabDependencies (const xiiDocumentObject *pObject, xiiAssetDocumentInfo *pInfo) const |
| | Adds all prefab dependencies to the xiiAssetDocumentInfo object. Called automatically by UpdateAssetDocumentInfo()
|
| |
|
void | AddReferences (const xiiDocumentObject *pObject, xiiAssetDocumentInfo *pInfo, bool bInsidePrefab) const |
| | Crawls through all asset properties of pObject and adds all string properties that have a xiiAssetBrowserAttribute as a dependency to pInfo. Automatically called by UpdateAssetDocumentInfo()
|
| |
| virtual xiiDocumentInfo * | CreateDocumentInfo () override |
| |
|
xiiTransformStatus | DoTransformAsset (const xiiPlatformProfile *pAssetProfile, xiiBitflags< xiiTransformFlags > transformFlags) |
| |
|
xiiUInt64 | GetDocumentHash () const |
| | Computes the hash from all document objects.
|
| |
|
void | GetChildHash (const xiiDocumentObject *pObject, xiiUInt64 &inout_uiHash) const |
| | Computes the hash for one document object and combines it with the given hash.
|
| |
| virtual void | InternalGetMetaDataHash (const xiiDocumentObject *pObject, xiiUInt64 &inout_uiHash) const |
| | Computes the hash for transform relevant meta data of the given document object and combines it with the given hash.
|
| |
| virtual xiiTaskGroupID | 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.
|
| |
| virtual void | InitializeAfterLoadingAndSaving () override |
| |
| virtual xiiTransformStatus | InternalCreateThumbnail (const ThumbnailInfo &thumbnailInfo) |
| | Override this function to generate a thumbnail. Only called if GetAssetFlags returns xiiAssetDocumentFlags::SupportsThumbnail.
|
| |
|
xiiString | GetThumbnailFilePath (xiiStringView sSubAssetName=xiiStringView()) const |
| | Returns the full path to the jpg file in which the thumbnail for this asset is supposed to be.
|
| |
|
void | InvalidateAssetThumbnail (xiiStringView sSubAssetName=xiiStringView()) const |
| | Should be called after manually changing the thumbnail, such that the system will reload it.
|
| |
|
xiiStatus | RemoteCreateThumbnail (const ThumbnailInfo &thumbnailInfo, xiiArrayPtr< xiiStringView > viewExclusionTags) const |
| | Requests the engine side to render a thumbnail, will call SaveThumbnail on success.
|
| |
|
xiiStatus | RemoteCreateThumbnail (const ThumbnailInfo &thumbnailInfo) const |
| |
| xiiStatus | SaveThumbnail (const xiiImage &img, const ThumbnailInfo &thumbnailInfo) const |
| | Saves the given image as the new thumbnail for the asset.
|
| |
|
xiiStatus | SaveThumbnail (const QImage &img, const ThumbnailInfo &thumbnailInfo) const |
| | Saves the given image as the new thumbnail for the asset.
|
| |
|
void | AppendThumbnailInfo (xiiStringView 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 (xiiAssetDocumentInfo *pInfo) const |
| | Override this to add custom data (e.g. additional file dependencies) to the info struct.
|
| |
| virtual xiiTransformStatus | InternalTransformAsset (xiiStreamWriter &stream, xiiStringView sOutputTag, const xiiPlatformProfile *pAssetProfile, const xiiAssetFileHeader &AssetHeader, xiiBitflags< xiiTransformFlags > transformFlags)=0 |
| | Override this and write the transformed file for the given szOutputTag into the given stream.
|
| |
| virtual xiiTransformStatus | InternalTransformAsset (xiiStringView sTargetFile, xiiStringView sOutputTag, const xiiPlatformProfile *pAssetProfile, const xiiAssetFileHeader &AssetHeader, xiiBitflags< xiiTransformFlags > transformFlags) |
| | Only override this function, if the transformed file for the given szOutputTag must be written from another process.
|
| |
|
xiiStatus | RemoteExport (const xiiAssetFileHeader &header, xiiStringView sOutputTarget) const |
| |
|
void | SetModified (bool b) |
| |
|
void | SetReadOnly (bool b) |
| |
|
virtual xiiStatus | InternalLoadDocument () |
| |
|
virtual void | BeforeClosing () |
| |
|
void | SetUnknownObjectTypes (const xiiSet< xiiString > &Types, xiiUInt32 uiInstances) |
| |
|
virtual void | UpdatePrefabsRecursive (xiiDocumentObject *pObject) |
| |
|
virtual void | UpdatePrefabObject (xiiDocumentObject *pObject, const xiiUuid &PrefabAsset, const xiiUuid &PrefabSeed, xiiStringView sBasePrefab) |
| |
Public Member Functions inherited from xiiGameObjectDocument
1.13.2