ezScene2Document Class Reference

Inheritance diagram for ezScene2Document:

Public Member Functions
	ezScene2Document (ezStringView sDocumentPath)
Scene Data Accessors
const ezDocumentObjectManager *	GetSceneObjectManager () const
ezDocumentObjectManager *	GetSceneObjectManager ()
ezSelectionManager *	GetSceneSelectionManager () const
ezCommandHistory *	GetSceneCommandHistory () const
ezObjectAccessorBase *	GetSceneObjectAccessor () const
const ezObjectMetaData< ezUuid, ezDocumentObjectMetaData > *	GetSceneDocumentObjectMetaData () const
ezObjectMetaData< ezUuid, ezDocumentObjectMetaData > *	GetSceneDocumentObjectMetaData ()
const ezObjectMetaData< ezUuid, ezGameObjectMetaData > *	GetSceneGameObjectMetaData () const
ezObjectMetaData< ezUuid, ezGameObjectMetaData > *	GetSceneGameObjectMetaData ()
Layer Functions
ezSelectionManager *	GetLayerSelectionManager () const
ezStatus	CreateLayer (const char *szName, ezUuid &out_layerGuid)
ezStatus	DeleteLayer (const ezUuid &layerGuid)
const ezUuid &	GetActiveLayer () const
ezStatus	SetActiveLayer (const ezUuid &layerGuid)
bool	IsLayerLoaded (const ezUuid &layerGuid) const
ezStatus	SetLayerLoaded (const ezUuid &layerGuid, bool bLoaded)
void	GetAllLayers (ezDynamicArray< ezUuid > &out_layerGuids)
void	GetLoadedLayers (ezDynamicArray< ezSceneDocument * > &out_layers) const
bool	IsLayerVisible (const ezUuid &layerGuid) const
ezStatus	SetLayerVisible (const ezUuid &layerGuid, bool bVisible)
const ezDocumentObject *	GetLayerObject (const ezUuid &layerGuid) const
ezSceneDocument *	GetLayerDocument (const ezUuid &layerGuid) const
virtual ezGameObjectDocument *	GetRedirectedGameObjectDoc () override
	In case a document consists of multiple layers, this redirection is necessary to execute actions on the active layer.
bool	IsAnyLayerModified () const
Base Class Functions
virtual void	InitializeAfterLoading (bool bFirstTimeCreation) override
virtual void	InitializeAfterLoadingAndSaving () override
virtual const ezDocumentObject *	GetSettingsObject () const override
virtual void	HandleEngineMessage (const ezEditorEngineDocumentMsg *pMsg) override
	Handles all messages received from the corresponding ezEngineProcessDocumentContext on the engine process.
virtual ezTaskGroupID	InternalSaveDocument (AfterSaveCallback callback) override
	Overrides the base function to call UpdateAssetDocumentInfo() to update the settings hash.
virtual void	SendGameWorldToEngine () override
	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.)
Selection Specific Functions
void	PreventDoubleSelectionChange (bool b)
virtual void	UndoSelection () override
Public Member Functions inherited from ezSceneDocument
	ezSceneDocument (ezStringView sDocumentPath, DocumentType documentType)
void	GroupSelection ()
	Creates a new object and attaches all currently selected objects to it.
void	SelectParentObject ()
	Changes the selection to the parent object.
void	SetSelectedAsActiveParent ()
	Sets the last selected object as the 'active parent'.
void	ClearActiveParent ()
	Clears the 'active parent' object.
void	DuplicateSpecial ()
	Opens the Duplicate Special dialog.
void	DeltaTransform ()
	Opens the 'Delta Transform' dialog.
void	SnapObjectToCamera ()
	Moves all selected objects to the editor camera position.
void	AttachToObject ()
	Attaches all selected objects to the selected object.
void	DetachFromParent ()
	Detaches all selected objects from their current parent.
void	CopyReference ()
	Puts the GUID of the single selected object into the clipboard.
ezStatus	CreateEmptyObject (bool bAttachToParent, bool bAtPickedPosition, bool bComponentSelectionMenu)
	Creates a new empty object, either top-level (selection empty) or as a child of the selected item.
void	DuplicateSelection ()
void	ShowOrHideSelectedObjects (ShowOrHide action)
void	ShowOrHideAllObjects (ShowOrHide action)
void	HideUnselectedObjects ()
bool	IsPrefab () const
	Whether this document represents a prefab or a scene.
bool	IsObjectEditorPrefab (const ezUuid &object, ezUuid *out_pPrefabAssetGuid=nullptr) const
	Determines whether the given object is an editor prefab.
bool	IsObjectEnginePrefab (const ezUuid &object, ezUuid *out_pPrefabAssetGuid=nullptr) const
	Determines whether the given object is an engine prefab.
virtual bool	ArePrefabsAllowed () const override
	Nested prefabs are not allowed.
virtual void	GetSupportedMimeTypesForPasting (ezHybridArray< ezString, 4 > &out_mimeTypes) const override
	Whether this document supports pasting the given mime format into it.
virtual bool	CopySelectedObjects (ezAbstractObjectGraph &out_objectGraph, ezStringBuilder &out_sMimeType) const override
	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) override
bool	DuplicateSelectedObjects (const ezArrayPtr< PasteInfo > &info, const ezAbstractObjectGraph &objectGraph, bool bSetSelected)
bool	CopySelectedObjects (ezAbstractObjectGraph &ref_graph, ezMap< ezUuid, ezUuid > *out_pParents) const
bool	PasteAt (const ezArrayPtr< PasteInfo > &info, const ezAbstractObjectGraph &objectGraph, const ezVec3 &vPos)
bool	PasteAtOrignalPosition (const ezArrayPtr< PasteInfo > &info, const ezAbstractObjectGraph &objectGraph)
virtual void	UpdatePrefabs () override
	Updates ALL prefabs in the document with the latest changes. Merges the current prefab templates with the instances in the document.
virtual void	UnlinkPrefabs (ezArrayPtr< const ezDocumentObject * > selection) override
	Removes the link to the prefab template, making the editor prefab a simple object.
virtual ezUuid	ReplaceByPrefab (const ezDocumentObject *pRootObject, ezStringView sPrefabFile, const ezUuid &prefabAsset, const ezUuid &prefabSeed, bool bEnginePrefab) override
virtual ezUuid	RevertPrefab (const ezDocumentObject *pObject) override
	Reverts all selected editor prefabs to their original template state.
virtual void	ConvertToEditorPrefab (ezArrayPtr< const ezDocumentObject * > selection)
	Converts all objects in the selection that are engine prefabs to their respective editor prefab representation.
virtual void	ConvertToEnginePrefab (ezArrayPtr< const ezDocumentObject * > selection)
	Converts all objects in the selection that are editor prefabs to their respective engine prefab representation.
virtual ezStatus	CreatePrefabDocumentFromSelection (ezStringView sFile, const ezRTTI *pRootType, ezDelegate< void(ezAbstractObjectNode *)> adjustGraphNodeCB={}, ezDelegate< void(ezDocumentObject *)> adjustNewNodesCB={}, ezDelegate< void(ezAbstractObjectGraph &graph, ezDynamicArray< ezAbstractObjectNode * > &graphRootNodes)> finalizeGraphCB={}) override
GameMode::Enum	GetGameMode () const
virtual bool	CanEngineProcessBeRestarted () const override
	Asks the document whether a restart of the engine process is allowed at this time. More...
void	StartSimulateWorld ()
void	TriggerGameModePlay (bool bUsePickedPositionAsStart)
bool	StopGameMode ()
	Stops the world simulation, if it is running. Returns true, when the simulation needed to be stopped.
ezTransformStatus	ExportScene (bool bCreateThumbnail)
void	ExportSceneGeometry (const char *szFile, bool bOnlySelection, int iExtractionMode, const ezMat3 &mTransform)
void	HandleGameModeMsg (const ezGameModeMsgToEditor *pMsg)
void	HandleObjectStateFromEngineMsg (const ezPushObjectStateMsgToEditor *pMsg)
void	SendObjectMsg (const ezDocumentObject *pObj, ezObjectTagMsgToEngine *pMsg)
void	SendObjectMsgRecursive (const ezDocumentObject *pObj, ezObjectTagMsgToEngine *pMsg)
bool	CanUndoSelection () const
const ezSceneDocumentSettingsBase *	GetSettingsBase () const
template<typename T >
const T *	GetSettings () const
ezStatus	CreateExposedProperty (const ezDocumentObject *pObject, const ezAbstractProperty *pProperty, ezVariant index, ezExposedSceneProperty &out_key) const
ezStatus	AddExposedParameter (const char *szName, const ezDocumentObject *pObject, const ezAbstractProperty *pProperty, ezVariant index)
ezInt32	FindExposedParameter (const ezDocumentObject *pObject, const ezAbstractProperty *pProperty, ezVariant index)
ezStatus	RemoveExposedParameter (ezInt32 iIndex)
void	StoreFavoriteCamera (ezUInt8 uiSlot)
	Stores the current editor camera position in a user preference. Slot can be 0 to 9. More...
void	RestoreFavoriteCamera (ezUInt8 uiSlot)
	Applies the previously stored camera position from slot 0 to 9 to the current camera position. More...
ezResult	JumpToLevelCamera (ezUInt8 uiSlot, bool bImmediate)
	Searches for an ezCameraComponent with the 'EditorShortcut' property set to uiSlot and moves the editor camera to that position.
ezResult	CreateLevelCamera (ezUInt8 uiSlot)
	Creates an object with an ezCameraComponent at the current editor camera position and sets the 'EditorShortcut' property to uiSlot.
virtual ezManipulatorSearchStrategy	GetManipulatorSearchStrategy () const override
	Needed by ezManipulatorManager to know where to look for the manipulator attributes. More...
Public Member Functions inherited from ezGameObjectDocument
	ezGameObjectDocument (ezStringView sDocumentPath, ezDocumentObjectManager *pObjectManager, ezAssetDocEngineConnection engineConnectionType=ezAssetDocEngineConnection::FullObjectMirroring)
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.
void	SetActiveEditTool (const ezRTTI *pEditToolType)
	Makes an edit tool of the given type active. Allocates a new one, if necessary. Only works when SetEditToolConfigDelegate() is set.
ezGameObjectEditTool *	GetActiveEditTool () const
	Returns the currently active edit tool (nullptr for none).
bool	IsActiveEditTool (const ezRTTI *pEditToolType) const
	Checks whether an edit tool of the given type, or nullptr for none, is active.
void	SetEditToolConfigDelegate (ezDelegate< void(ezGameObjectEditTool *)> configDelegate)
	Needs to be called by some higher level code (usually the DocumentWindow) to react to newly created edit tools to configure them (call ezGameObjectEditTool::ConfigureTool()).
void	SetGizmoWorldSpace (bool bWorldSpace)
bool	GetGizmoWorldSpace () const
void	SetGizmoMoveParentOnly (bool bMoveParent)
bool	GetGizmoMoveParentOnly () const
void	ComputeTopLevelSelectedGameObjects (ezDeque< ezSelectedGameObject > &out_selection)
	Finds all objects that are selected at the top level, ie. none of their parents is selected. More...
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 (ezUuid object)
	Specifies which object is the 'active parent', which is the object under which newly created objects should be parented.
ezUuid	GetActiveParent () const
	Returns the object under which newly created objects should be parented. More...
void	SetGlobalTransform (const ezDocumentObject *pObject, const ezTransform &t, ezUInt8 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 ezDocumentObject *pObject, const ezTransform &t, ezUInt8 uiTransformationChanges) const
	Same as SetGlobalTransform, except that all children will keep their current global transform (thus their local transforms are adjusted)
ezTransform	GetGlobalTransform (const ezDocumentObject *pObject) const
	Returns a cached value for the global transform of the given object, if available. Otherwise it calls ComputeGlobalTransform().
ezTransform	ComputeGlobalTransform (const ezDocumentObject *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 ezResult	ComputeObjectTransformation (const ezDocumentObject *pObject, ezTransform &out_result) const override
	Traverses the pObject hierarchy up until it hits an ezGameObject, then computes the global transform of that.
Public Member Functions inherited from ezAssetDocument
	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.
Public Member Functions inherited from ezDocument
	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
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	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.
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
void	RevertPrefabs (ezArrayPtr< const ezDocumentObject * > selection)
	Resets the given objects to their template prefab state, if they have local modifications.
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={})
Public Member Functions inherited from ezReflectedClass
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.

Public Attributes
ezEvent< const ezScene2LayerEvent & >	m_LayerEvents
Public Attributes inherited from ezGameObjectDocument
ezEvent< const ezGameObjectEvent & >	m_GameObjectEvents
ezUniquePtr< ezObjectMetaData< ezUuid, ezGameObjectMetaData > >	m_GameObjectMetaData
Public Attributes inherited from ezAssetDocument
ezEvent< const ezEditorEngineDocumentMsg * >	m_ProcessMessageEvent
ezEvent< const ezCommonAssetUiState & >	m_CommonAssetUiChangeEvent
	Used to broadcast state change events for common asset states.
Public Attributes inherited from ezDocument
ezUniquePtr< ezObjectMetaData< ezUuid, ezDocumentObjectMetaData > >	m_DocumentObjectMetaData
ezEvent< const ezDocumentEvent & >	m_EventsOne
ezEvent< const ezObjectAccessorChangeEvent & >	m_ObjectAccessorChangeEvents

Friends
class	ezSceneLayer

Additional Inherited Members
Public Types inherited from ezSceneDocument
enum	DocumentType { Scene, Prefab, Layer }
enum	ShowOrHide { Show, Hide }
Public Types inherited from ezAssetDocument
enum	EngineStatus { EngineStatus::Unsupported, EngineStatus::Disconnected, EngineStatus::Initializing, EngineStatus::Loaded }
Public Types inherited from ezDocument
using	AfterSaveCallback = ezDelegate< void(ezDocument *, ezStatus)>
Static Public Member Functions inherited from ezGameObjectDocument
static ezTransform	QueryLocalTransform (const ezDocumentObject *pObject)
	Retrieves the local transform property values from the object and combines it into one ezTransform.
static ezSimdTransform	QueryLocalTransformSimd (const ezDocumentObject *pObject)
Static Public Member Functions inherited from ezDocument
static ezStatus	ReadDocument (ezStringView sDocumentPath, ezUniquePtr< ezAbstractObjectGraph > &ref_pHeader, ezUniquePtr< ezAbstractObjectGraph > &ref_pObjects, ezUniquePtr< ezAbstractObjectGraph > &ref_pTypes)
static ezStatus	ReadAndRegisterTypes (const ezAbstractObjectGraph &types)
Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()
Static Public Attributes inherited from ezGameObjectDocument
static ezEvent< const ezGameObjectDocumentEvent & >	s_GameObjectDocumentEvents
Static Public Attributes inherited from ezDocument
static ezEvent< const ezDocumentEvent & >	s_EventsAny
Protected Member Functions inherited from ezSceneDocument
void	SetGameMode (GameMode::Enum mode)
virtual void	UpdatePrefabObject (ezDocumentObject *pObject, const ezUuid &PrefabAsset, const ezUuid &PrefabSeed, ezStringView sBasePrefab) override
virtual void	UpdateAssetDocumentInfo (ezAssetDocumentInfo *pInfo) const override
	Override this to add custom data (e.g. additional file dependencies) to the info struct. More...
template<typename Func >
void	ApplyRecursive (const ezDocumentObject *pObject, Func f)
void	EnsureSettingsObjectExist ()
void	DocumentObjectMetaDataEventHandler (const ezObjectMetaData< ezUuid, ezDocumentObjectMetaData >::EventData &e)
void	EngineConnectionEventHandler (const ezEditorEngineProcessConnection::Event &e)
void	ToolsProjectEventHandler (const ezToolsProjectEvent &e)
ezStatus	RequestExportScene (const char *szTargetFile, const ezAssetFileHeader &header)
virtual ezTransformStatus	InternalTransformAsset (const char *szTargetFile, ezStringView sOutputTag, const ezPlatformProfile *pAssetProfile, const ezAssetFileHeader &AssetHeader, ezBitflags< ezTransformFlags > transformFlags) override
	Only override this function, if the transformed file for the given szOutputTag must be written from another process. More...
virtual ezTransformStatus	InternalTransformAsset (ezStreamWriter &stream, ezStringView sOutputTag, const ezPlatformProfile *pAssetProfile, const ezAssetFileHeader &AssetHeader, ezBitflags< ezTransformFlags > transformFlags) override
	Override this and write the transformed file for the given szOutputTag into the given stream. More...
ezTransformStatus	InternalCreateThumbnail (const ThumbnailInfo &ThumbnailInfo) override
	Override this function to generate a thumbnail. Only called if GetAssetFlags returns ezAssetDocumentFlags::SupportsThumbnail.
void	SyncObjectHiddenState ()
void	SyncObjectHiddenState (ezDocumentObject *pObject)
void	UpdateObjectDebugTargets ()
	Finds all objects that are actively being 'debugged' (or visualized) by the editor and thus should get the debug visualization flag in the runtime.
void	SelectionManagerEventHandler (const ezSelectionManagerEvent &e)
virtual void	OnInterDocumentMessage (ezReflectedClass *pMessage, ezDocument *pSender) override
	Communication with other document types.
void	GatherObjectsOfType (ezDocumentObject *pRoot, ezGatherObjectsOfTypeMsgInterDoc *pMsg) const
Protected Member Functions inherited from ezGameObjectDocument
void	SubscribeGameObjectEventHandlers ()
void	UnsubscribeGameObjectEventHandlers ()
void	GameObjectDocumentEventHandler (const ezGameObjectDocumentEvent &e)
void	InvalidateGlobalTransformValue (const ezDocumentObject *pObject) const
virtual void	AttachMetaDataBeforeSaving (ezAbstractObjectGraph &graph) const override
virtual void	RestoreMetaDataAfterLoading (const ezAbstractObjectGraph &graph, bool bUndoable) override
Protected Member Functions inherited from ezAssetDocument
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 void	InternalAfterSaveDocument () override
	Implements auto transform on save. More...
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.
ezStatus	RemoteExport (const ezAssetFileHeader &header, const char *szOutputTarget) const
Protected Member Functions inherited from ezDocument
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)
Protected Attributes inherited from ezSceneDocument
DocumentType	m_DocumentType = DocumentType::Scene
GameMode::Enum	m_GameMode
GameModeData	m_GameModeData [3]
ezDocumentObjectMirror	m_ObjectMirror
ezRttiConverterContext	m_Context
bool	m_bStoreSelectionChange = true
ezInt8	m_iAllowSelectionChanges = -1
ezCopyOnBroadcastEvent< const ezSelectionManagerEvent & >::Unsubscriber	m_SelectionHandlerUnsubscriber
ezDeque< SelectionHistory >	m_SelectionStack
Protected Attributes inherited from ezGameObjectDocument
GameModeData	m_CurrentMode
ezEventSubscriptionID	m_SelectionManagerEventHandlerID
ezEventSubscriptionID	m_ObjectPropertyEventHandlerID
ezEventSubscriptionID	m_ObjectStructureEventHandlerID
ezEventSubscriptionID	m_ObjectEventHandlerID
Protected Attributes inherited from ezAssetDocument
ezUniquePtr< ezIPCObjectMirrorEditor >	m_pMirror
EngineStatus	m_EngineStatus
ezAssetDocEngineConnection	m_EngineConnectionType = ezAssetDocEngineConnection::None
ezEditorEngineConnection *	m_pEngineConnection
ezHashTable< ezUuid, ezEditorEngineSyncObject * >	m_AllSyncObjects
ezDeque< ezEditorEngineSyncObject * >	m_SyncObjects
ezHybridArray< ezUuid, 32 >	m_DeletedObjects
ezUInt32	m_uiCommonAssetStateFlags = 0
Protected Attributes inherited from ezDocument
ezUniquePtr< ezDocumentObjectManager >	m_pObjectManager
ezUniquePtr< ezCommandHistory >	m_pCommandHistory
ezUniquePtr< ezSelectionManager >	m_pSelectionManager
ezUniquePtr< ezObjectCommandAccessor >	m_pObjectAccessor
	Default object accessor used by every doc.
ezDocumentInfo *	m_pDocumentInfo = nullptr
const ezDocumentTypeDescriptor *	m_pTypeDescriptor = nullptr
ezDocument *	m_pHostDocument = nullptr
ezDocument *	m_pActiveSubDocument = nullptr

Member Function Documentation

GetSettingsObject()

const ezDocumentObject * ezScene2Document::GetSettingsObject ( ) const

overridevirtual

This function is overwritten so that after redirecting to the active document this still accesses the original content and is not redirected.

Reimplemented from ezSceneDocument.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/EditorPlugins/Scene/EditorPluginScene/Scene/Scene2Document.h
• /home/runner/work/ezEngine/ezEngine/Code/EditorPlugins/Scene/EditorPluginScene/Scene/Scene2Document.cpp