Plasma Engine  2.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
plQtEngineDocumentWindow 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 plQtEngineDocumentWindow:
Inheritance graph
[legend]

Public Member Functions

 plQtEngineDocumentWindow (plAssetDocument *pDocument)
 
plEditorEngineConnection * GetEditorEngineConnection () const
 
const plObjectPickingResult & PickObject (plUInt16 uiScreenPosX, plUInt16 uiScreenPosY, plQtEngineViewWidget *pView) const
 
plAssetDocument * GetDocument () const
 
plQtEngineViewWidget * GetHoveredViewWidget () const
 Returns the plQtEngineViewWidget over which the mouse currently hovers.
 
plQtEngineViewWidget * GetFocusedViewWidget () const
 Returns the plQtEngineViewWidget that has the input focus.
 
plQtEngineViewWidget * GetViewWidgetByID (plUInt32 uiViewID) const
 
plArrayPtr< plQtEngineViewWidget *const > GetViewWidgets () const
 
void AddViewWidget (plQtEngineViewWidget *pView)
 
- Public Member Functions inherited from plQtDocumentWindow
 plQtDocumentWindow (plDocument *pDocument)
 
 plQtDocumentWindow (const char *szUniqueName)
 
void EnsureVisible ()
 
virtual plString GetWindowIcon () const
 
virtual plString GetDisplayName () const
 
virtual plString 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.
 
plDocument * GetDocument () const
 
plStatus SaveDocument ()
 
bool CanCloseWindow ()
 
void CloseDocumentWindow ()
 
void ScheduleRestoreWindowLayout ()
 
bool IsVisibleInContainer () const
 
void SetTargetFramerate (plInt16 iTargetFPS)
 
void TriggerRedraw ()
 
virtual void RequestWindowTabContextMenu (const QPoint &globalPos)
 
plQtContainerWindow * GetContainerWindow () const
 
void ShowTemporaryStatusBarMsg (const plFormatString &text, plTime duration=plTime::MakeFromSeconds(5))
 Shows the given message for the given duration in the statusbar, then shows the permanent message again.
 
void SetPermanentStatusBarMsg (const plFormatString &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

plEvent< const plEngineWindowEvent & > m_EngineWindowEvent
 

Protected Member Functions

virtual void CommonAssetUiEventHandler (const plCommonAssetUiState &e)
 
virtual void ProcessMessageEventHandler (const plEditorEngineDocumentMsg *pMsg)
 
void RemoveViewWidget (plQtEngineViewWidget *pView)
 
void DestroyAllViews ()
 
virtual void InternalRedraw () override
 
- Protected Member Functions inherited from plQtDocumentWindow
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

plHybridArray< plQtEngineViewWidget *, 4 > m_ViewWidgets
 

Friends

class plQtEngineViewWidget
 

Additional Inherited Members

- Static Public Member Functions inherited from plQtDocumentWindow
static const plDynamicArray< plQtDocumentWindow * > & GetAllDocumentWindows ()
 
static plQtDocumentWindow * FindWindowByDocument (const plDocument *pDocument)
 
- Static Public Attributes inherited from plQtDocumentWindow
static plEvent< const plQtDocumentWindowEvent & > 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 plEditorEngineConnection object for sending messages between the editor and the engine process. It also allows to embed plQtEngineViewWidget objects into the UI, which enable 3D rendering by the engine process.

Member Function Documentation

◆ InternalRedraw()

void plQtEngineDocumentWindow::InternalRedraw ( )
overrideprotectedvirtual

Reimplemented from plQtDocumentWindow.

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