ezEngine  Release 25.03
ezQtEngineDocumentWindow Class Reference

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:

Public Member Functions

 ezQtEngineDocumentWindow (ezAssetDocument *pDocument)
 
ezEditorEngineConnectionGetEditorEngineConnection () const
 
const ezObjectPickingResultPickObject (ezUInt16 uiScreenPosX, ezUInt16 uiScreenPosY, ezQtEngineViewWidget *pView) const
 
ezAssetDocumentGetDocument () const
 
ezQtEngineViewWidgetGetHoveredViewWidget () const
 Returns the ezQtEngineViewWidget over which the mouse currently hovers.
 
ezQtEngineViewWidgetGetFocusedViewWidget () const
 Returns the ezQtEngineViewWidget that has the input focus.
 
ezQtEngineViewWidgetGetViewWidgetByID (ezUInt32 uiViewID) const
 
ezArrayPtr< ezQtEngineViewWidget *const > GetViewWidgets () const
 
void AddViewWidget (ezQtEngineViewWidget *pView)
 
- 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
 
virtual const char * GetWindowLayoutGroupName () const =0
 The 'GroupName' is used for serializing window layouts. It should be unique among different window types.
 
ezDocumentGetDocument () const
 
ezStatus SaveDocument ()
 
bool CanCloseWindow ()
 
void CloseDocumentWindow ()
 
void ScheduleRestoreWindowLayout ()
 
bool IsVisibleInContainer () const
 
void SetTargetFramerate (ezInt16 iTargetFPS)
 
void TriggerRedraw ()
 
virtual void RequestWindowTabContextMenu (const QPoint &globalPos)
 
ezQtContainerWindowGetContainerWindow () 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.
 
virtual void CreateImageCapture (const char *szOutputPath)
 For unit tests to take a screenshot of the window (may include multiple views) to do image comparisons.
 

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 ()
 

Protected Attributes

ezHybridArray< ezQtEngineViewWidget *, 4 > m_ViewWidgets
 

Friends

class ezQtEngineViewWidget
 

Additional Inherited Members

- Static Public Member Functions inherited from ezQtDocumentWindow
static const ezDynamicArray< ezQtDocumentWindow * > & GetAllDocumentWindows ()
 
static ezQtDocumentWindowFindWindowByDocument (const ezDocument *pDocument)
 
- Static Public Attributes inherited from ezQtDocumentWindow
static ezEvent< const ezQtDocumentWindowEvent & > s_Events
 
static bool s_bAllowRestoreWindowLayout = true
 In 'safe' mode we want to prevent the documents from using the stored window layout state.
 

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.


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