xiiQtEngineDocumentWindow Class Reference

#include <EngineDocumentWindow.moc.h>

Inheritance diagram for xiiQtEngineDocumentWindow:

Public Member Functions
	xiiQtEngineDocumentWindow (xiiAssetDocument *pDocument)
	Copyright (c) Theophilus Eriata. All Rights Reserved.
xiiEditorEngineConnection *	GetEditorEngineConnection () const
const xiiObjectPickingResult &	PickObject (xiiUInt16 uiScreenPosX, xiiUInt16 uiScreenPosY, xiiQtEngineViewWidget *pView) const
xiiAssetDocument *	GetDocument () const
xiiQtEngineViewWidget *	GetHoveredViewWidget () const
	Returns the xiiQtEngineViewWidget over which the mouse currently hovers.
xiiQtEngineViewWidget *	GetFocusedViewWidget () const
	Returns the xiiQtEngineViewWidget that has the input focus.
xiiQtEngineViewWidget *	GetViewWidgetByID (xiiUInt32 uiViewID) const
xiiArrayPtr< xiiQtEngineViewWidget *const >	GetViewWidgets () const
void	AddViewWidget (xiiQtEngineViewWidget *pView)
virtual void	CreateImageCapture (xiiStringView sOutputPath) override
	For unit tests to take a screenshot of the window (may include multiple views) to do image comparisons.
Public Member Functions inherited from xiiQtDocumentWindow
	xiiQtDocumentWindow (xiiDocument *pDocument)
	xiiQtDocumentWindow (xiiStringView sUniqueName)
void	EnsureVisible ()
virtual xiiString	GetWindowIcon () const
virtual xiiString	GetDisplayName () const
virtual xiiString	GetDisplayNameShort () const
xiiStringView	GetUniqueName () const
virtual xiiStringView	GetWindowLayoutGroupName () const =0
	The 'GroupName' is used for serializing window layouts. It should be unique among different window types.
xiiDocument *	GetDocument () const
xiiStatus	SaveDocument ()
bool	CanCloseWindow ()
void	CloseDocumentWindow ()
void	ScheduleRestoreWindowLayout ()
bool	IsVisibleInContainer () const
void	SetTargetFrameRate (xiiUInt16 uiTargetFPS)
void	SetTargetFrameRateUnfocused (xiiUInt16 uiTargetFPS)
void	TriggerRedraw ()
virtual void	RequestWindowTabContextMenu (const QPoint &globalPos)
xiiQtContainerWindow *	GetContainerWindow () const
void	ShowTemporaryStatusBarMsg (const xiiFormatString &text, xiiTime duration=xiiTime::MakeFromSeconds(5))
	Shows the given message for the given duration in the statusbar, then shows the permanent message again.
void	SetPermanentStatusBarMsg (const xiiFormatString &text)
	Sets which text to show permanently in the statusbar. Set an empty string to clear the message.

Public Attributes
xiiEvent< const xiiEngineWindowEvent & >	m_EngineWindowEvent
Public Attributes inherited from xiiQtDocumentWindow
ads::CDockManager *	m_pDockManager = nullptr

Protected Member Functions
virtual void	CommonAssetUiEventHandler (const xiiCommonAssetUiState &e)
virtual void	ProcessMessageEventHandler (const xiiEditorEngineDocumentMsg *pMsg)
void	RemoveViewWidget (xiiQtEngineViewWidget *pView)
void	DestroyAllViews ()
virtual void	InternalRedraw () override
Protected Member Functions inherited from xiiQtDocumentWindow
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
xiiHybridArray< xiiQtEngineViewWidget *, 4 >	m_ViewWidgets

Friends
class	xiiQtEngineViewWidget

Additional Inherited Members
Static Public Member Functions inherited from xiiQtDocumentWindow
static const xiiDynamicArray< xiiQtDocumentWindow * > &	GetAllDocumentWindows ()
static xiiQtDocumentWindow *	FindWindowByDocument (const xiiDocument *pDocument)
Static Public Attributes inherited from xiiQtDocumentWindow
static xiiEvent< const xiiQtDocumentWindowEvent & >	s_Events
	Copyright (c) Theophilus Eriata. All Rights Reserved.
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 a xiiEditorEngineConnection object for sending messages between the editor and the engine process. It also allows to embed xiiQtEngineViewWidget objects into the UI, which enable 3D rendering by the engine process.

Member Function Documentation

CreateImageCapture()

void xiiQtEngineDocumentWindow::CreateImageCapture ( xiiStringView sOutputPath )

overridevirtual

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

Reimplemented from xiiQtDocumentWindow.

Reimplemented in xiiQtSceneDocumentWindowBase.

InternalRedraw()

void xiiQtEngineDocumentWindow::InternalRedraw ( )

overrideprotectedvirtual

Reimplemented from xiiQtDocumentWindow.

---

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

• /home/runner/work/XII/XII/Source/Editor/EditorFramework/DocumentWindow/EngineDocumentWindow.moc.h
• /home/runner/work/XII/XII/Source/Editor/EditorFramework/DocumentWindow/Implementation/EngineDocumentWindow.cpp