Base class for all document windows that need a connection to the engine process, and might want to render 3D content. More...

#include <EngineDocumentWindow.moc.h>

Inheritance diagram for ezQtEngineDocumentWindow:

[legend]

Public Member Functions
	ezQtEngineDocumentWindow (ezAssetDocument *pDocument)

ezEditorEngineConnection *	GetEditorEngineConnection () const

const ezObjectPickingResult &	PickObject (ezUInt16 uiScreenPosX, ezUInt16 uiScreenPosY, ezQtEngineViewWidget *pView) const

ezAssetDocument *	GetDocument () const

ezQtEngineViewWidget *	GetHoveredViewWidget () const
	Returns the ezQtEngineViewWidget over which the mouse currently hovers.

ezQtEngineViewWidget *	GetFocusedViewWidget () const
	Returns the ezQtEngineViewWidget that has the input focus.

ezQtEngineViewWidget *	GetViewWidgetByID (ezUInt32 uiViewID) const

ezArrayPtr< ezQtEngineViewWidget *const >	GetViewWidgets () const

void	AddViewWidget (ezQtEngineViewWidget *pView)

virtual void	CreateImageCapture (const char *szOutputPath) override
	For unit tests to take a screenshot of the window (may include multiple views) to do image comparisons.

virtual int	GetCameraMode () const
	Returns the active camera mode index, or -1 if the window does not support camera mode switching.

virtual void	SetCameraMode (int iMode)
	Sets the active camera mode by index. Override together with GetCameraMode() and GetCameraModeNames().

virtual void	GetCameraModeNames (ezDynamicArray< ezString > &out_names) const
	Returns the display names for each supported camera mode, in order matching the indices used by GetCameraMode() and SetCameraMode().

Public Member Functions inherited from ezQtDocumentWindow
	ezQtDocumentWindow (ezDocument *pDocument)

	ezQtDocumentWindow (const char *szUniqueName)

void	EnsureVisible ()

virtual ezString	GetWindowIcon () const

virtual ezString	GetDisplayName () const

virtual ezString	GetDisplayNameShort () const

const char *	GetUniqueName () const

ezDocument *	GetDocument () const

ezStatus	SaveDocument ()

bool	CanCloseWindow ()

void	CloseDocumentWindow ()

bool	IsVisibleInContainer () const

void	SetTargetFramerate (ezInt16 iTargetFPS)

void	TriggerRedraw ()

virtual void	RequestWindowTabContextMenu (const QPoint &globalPos)

ezQtContainerWindow *	GetContainerWindow () const

void	ShowTemporaryStatusBarMsg (const ezFormatString &text, ezTime duration=ezTime::MakeFromSeconds(5))
	Shows the given message for the given duration in the statusbar, then shows the permanent message again.

void	SetPermanentStatusBarMsg (const ezFormatString &text)
	Sets which text to show permanently in the statusbar. Set an empty string to clear the message.

Public Attributes
ezEvent< const ezEngineWindowEvent & >	m_EngineWindowEvent

Public Attributes inherited from ezQtDocumentWindow
ads::CDockManager *	m_pDockManager = nullptr

Protected Member Functions
virtual void	CommonAssetUiEventHandler (const ezCommonAssetUiState &e)

virtual void	ProcessMessageEventHandler (const ezEditorEngineDocumentMsg *pMsg)

void	RemoveViewWidget (ezQtEngineViewWidget *pView)

void	DestroyAllViews ()

virtual void	InternalRedraw () override

Protected Member Functions inherited from ezQtDocumentWindow
virtual void	showEvent (QShowEvent *event) override

virtual void	hideEvent (QHideEvent *event) override

virtual bool	event (QEvent *event) override

virtual bool	eventFilter (QObject obj, QEvent e) override

void	FinishWindowCreation ()

virtual void	OnAfterDocumentLayoutRestored ()

Protected Attributes
ezHybridArray< ezQtEngineViewWidget *, 4 >	m_ViewWidgets

ezQtCuratorControl *	m_pCuratorControl = nullptr

Friends
class	ezQtEngineViewWidget

Additional Inherited Members
Static Public Member Functions inherited from ezQtDocumentWindow
static const ezDynamicArray< ezQtDocumentWindow * > &	GetAllDocumentWindows ()

static ezQtDocumentWindow *	FindWindowByDocument (const ezDocument *pDocument)
	Returns the document window for the given document, if there is any. nullptr otherwise.

Static Public Attributes inherited from ezQtDocumentWindow
static ezEvent< const ezQtDocumentWindowEvent & >	s_Events

Detailed Description

Base class for all document windows that need a connection to the engine process, and might want to render 3D content.

This class has an ezEditorEngineConnection object for sending messages between the editor and the engine process. It also allows to embed ezQtEngineViewWidget objects into the UI, which enable 3D rendering by the engine process.

Member Function Documentation

◆ CreateImageCapture()

void ezQtEngineDocumentWindow::CreateImageCapture ( const char * szOutputPath )

overridevirtual

For unit tests to take a screenshot of the window (may include multiple views) to do image comparisons.

Reimplemented from ezQtDocumentWindow.

Reimplemented in ezQtSceneDocumentWindowBase.

◆ GetCameraMode()

virtual int ezQtEngineDocumentWindow::GetCameraMode ( ) const

inlinevirtual

Returns the active camera mode index, or -1 if the window does not support camera mode switching.

Reimplemented in ezQtAnimatedMeshAssetDocumentWindow, ezQtMeshAssetDocumentWindow, and ezQtJoltCollisionMeshAssetDocumentWindow.

◆ InternalRedraw()

void ezQtEngineDocumentWindow::InternalRedraw ( )

overrideprotectedvirtual

Reimplemented from ezQtDocumentWindow.

◆ SetCameraMode()

virtual void ezQtEngineDocumentWindow::SetCameraMode ( int iMode )

inlinevirtual

Sets the active camera mode by index. Override together with GetCameraMode() and GetCameraModeNames().

Reimplemented in ezQtAnimatedMeshAssetDocumentWindow, ezQtMeshAssetDocumentWindow, and ezQtJoltCollisionMeshAssetDocumentWindow.

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

/home/runner/work/ezEngine/ezEngine/Code/Editor/EditorFramework/DocumentWindow/EngineDocumentWindow.moc.h
/home/runner/work/ezEngine/ezEngine/Code/Editor/EditorFramework/DocumentWindow/Implementation/EngineDocumentWindow.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes