PURE API 0.5
PR00F's Ultimate Rendering Engine full documentation
Loading...
Searching...
No Matches
PureWindow Class Referenceabstract

Our main window, this is where we render to. More...

Detailed Description

Our main window, this is where we render to.

Only have one window, so it is singleton.

Definition at line 35 of file PureWindow.h.

#include <PureWindow.h>

+ Inheritance diagram for PureWindow:

Public Member Functions

virtual TPureBool initialize (TPureUInt width, TPureUInt height, TPureBool bFullscreen, const char *caption, HWND window=NULL)=0
 This creates the window actually.
 
virtual void Deinitialize ()=0
 This deletes the window, then initialize() can be called again later.
 
virtual TPureBool isInitialized () const =0
 Gets whether the window is initialized.
 
virtual void ResetDefaults ()=0
 Resets the default settings.
 
virtual TPureUInt getWidth () const =0
 Gets window width.
 
virtual void SetWidth (TPureUInt newwidth)=0
 Sets window width.
 
virtual TPureUInt getClientWidth () const =0
 Gets window client width.
 
virtual void SetClientWidth (TPureUInt newwidth)=0
 Sets window client width.
 
virtual TPureUInt getHeight () const =0
 Gets window height.
 
virtual void SetHeight (TPureUInt newheight)=0
 Sets window height.
 
virtual TPureUInt getClientHeight () const =0
 Gets window client height.
 
virtual void SetClientHeight (TPureUInt newheight)=0
 Sets window client height.
 
virtual TPureUInt getSideFrameWidth () const =0
 Gets window side frame width.
 
virtual TPureUInt getBottomFrameHeight () const =0
 Gets window bottom frame height.
 
virtual TPureUInt getCaptionHeight () const =0
 Gets window caption area height.
 
virtual TPureUInt getTitleBarHeight () const =0
 Gets window title bar height.
 
virtual TPureUInt getX () const =0
 Gets window X-coordinate.
 
virtual void SetX (TPureUInt newx)=0
 Sets window X-coordinate.
 
virtual TPureUInt getY () const =0
 Gets window Y-coordinate.
 
virtual void SetY (TPureUInt newy)=0
 Sets window Y-coordinate.
 
virtual HWND getWndHandle () const =0
 Gets window handle.
 
virtual HDC getWndDC () const =0
 Gets window Device Context.
 
virtual TPureBool isActive () const =0
 Gets whether window is active or not.
 
virtual void SetActive ()=0
 Sets the window active.
 
virtual TPureBool isTopMost () const =0
 Gets whether window is topmost or not.
 
virtual void SetTopMost (TPureBool state)=0
 Sets the window topmost property.
 
virtual const std::string & getCaption () const =0
 Gets the window caption.
 
virtual void SetCaption (const std::string &newcaption)=0
 Sets the window caption.
 
virtual TPureBool isResizableH () const =0
 Gets whether window is resizable horizontally.
 
virtual void SetResizableH (TPureBool state)=0
 Sets whether window is resizable horizontally.
 
virtual TPureBool isResizableV () const =0
 Gets whether window is resizable vertically.
 
virtual void SetResizableV (TPureBool state)=0
 Sets whether window is resizable vertically.
 
virtual TPureBool isResizable () const =0
 Gets whether window is fully resizable.
 
virtual void SetResizable (TPureBool state)=0
 Sets whether window is fully resizable.
 
virtual TPureBool hasBorder () const =0
 Gets whether window has border or not.
 
virtual void SetBorder (TPureBool state)=0
 Sets whether window has border or not.
 
virtual TPureBool hasSysMenu () const =0
 Gets whether window has sysmenu or not.
 
virtual void SetSysMenu (TPureBool state)=0
 Sets whether window has sysmenu or not.
 
virtual TPureBool hasMinButton () const =0
 Gets whether window has minimize button or not.
 
virtual void SetMinButton (TPureBool state)=0
 Sets whether window has minimize button or not.
 
virtual TPureBool hasMaxButton () const =0
 Gets whether window has maximize/restore button or not.
 
virtual void SetMaxButton (TPureBool state)=0
 Sets whether window has maximize button or not.
 
virtual TPureBool isEnabled () const =0
 Gets whether window is enabled or not.
 
virtual void SetEnabled (TPureBool state)=0
 Sets whether window is enabled or not.
 
virtual WNDPROC getWindowProc () const =0
 Gets the message handling window procedure of this window.
 
virtual void SetWindowProc (const WNDPROC windowproc)=0
 Sets the message handling window procedure of this window.
 
virtual void ProcessMessages ()=0
 Processes the queued window messages.
 
virtual TPureBool hasCloseRequest () const =0
 Gets whether the window has a close request or not.
 
virtual TPureBool isAutoRedrawAllOnPosChange () const =0
 Gets whether automatic redraw of window contents on position change is enabled or not.
 
virtual void SetAutoRedrawAllOnPosChange (TPureBool state)=0
 Sets whether automatic redraw of window contents on position change is enabled or not.
 
virtual TPureBool isAutoCleanupOnQuitOn () const =0
 Gets whether automatic cleanup of window on close request is enabled or not.
 
virtual void SetAutoCleanupOnQuitOn (TPureBool state)=0
 Sets whether automatic cleanup of window on close request is enabled or not.
 
virtual TPureBool getAutoCameraWarningState () const =0
 Gets whether automatic camera warning on resize is enabled or not.
 
virtual void SetAutoCameraWarningState (TPureBool state)=0
 Sets whether automatic camera warning on resize is enabled or not.
 
virtual void Show ()=0
 Shows the window.
 
virtual void ShowFull ()=0
 Shows and brings the window to front and sets the focus to it.
 
virtual void Hide ()=0
 Hides the window.
 
virtual void Minimize ()=0
 Minimizes the window, so it will be visible only on the Taskbar.
 
virtual void Maximize ()=0
 Maximizes the window.
 
virtual void Restore ()=0
 Restores the window to the previous state.
 
virtual void Close ()=0
 Closes the window.
 
virtual TPureBool isCursorVisible () const =0
 Gets whether the mouse cursor is visible or not within the window area.
 
virtual void SetCursorVisible (TPureBool state)=0
 Sets whether the mouse cursor is visible or not within the window area.
 
virtual void WriteSettings ()=0
 Writes the window properties to the console window.
 

Static Public Member Functions

static PureWindowcreateAndGet (PGEcfgProfiles &cfgProfiles, PGEInputHandler &inputHandler)
 Creates and gets the singleton instance.
 

Member Function Documentation

◆ Close()

virtual void PureWindow::Close ( )
pure virtual

Closes the window.

Implemented in PureWindowImpl.

◆ createAndGet()

PureWindow & PureWindow::createAndGet ( PGEcfgProfiles & cfgProfiles,
PGEInputHandler & inputHandler )
static

Creates and gets the singleton instance.

Returns
Window instance.

Definition at line 1812 of file PureWindow.cpp.

◆ Deinitialize()

virtual void PureWindow::Deinitialize ( )
pure virtual

This deletes the window, then initialize() can be called again later.

Implemented in PureWindowImpl.

◆ getAutoCameraWarningState()

virtual TPureBool PureWindow::getAutoCameraWarningState ( ) const
pure virtual

Gets whether automatic camera warning on resize is enabled or not.

Implemented in PureWindowImpl.

◆ getBottomFrameHeight()

virtual TPureUInt PureWindow::getBottomFrameHeight ( ) const
pure virtual

Gets window bottom frame height.

Implemented in PureWindowImpl.

◆ getCaption()

virtual const std::string & PureWindow::getCaption ( ) const
pure virtual

Gets the window caption.

Implemented in PureWindowImpl.

◆ getCaptionHeight()

virtual TPureUInt PureWindow::getCaptionHeight ( ) const
pure virtual

Gets window caption area height.

Implemented in PureWindowImpl.

◆ getClientHeight()

virtual TPureUInt PureWindow::getClientHeight ( ) const
pure virtual

Gets window client height.

Implemented in PureWindowImpl.

◆ getClientWidth()

virtual TPureUInt PureWindow::getClientWidth ( ) const
pure virtual

Gets window client width.

Implemented in PureWindowImpl.

◆ getHeight()

virtual TPureUInt PureWindow::getHeight ( ) const
pure virtual

Gets window height.

Implemented in PureWindowImpl.

◆ getSideFrameWidth()

virtual TPureUInt PureWindow::getSideFrameWidth ( ) const
pure virtual

Gets window side frame width.

Implemented in PureWindowImpl.

◆ getTitleBarHeight()

virtual TPureUInt PureWindow::getTitleBarHeight ( ) const
pure virtual

Gets window title bar height.

Implemented in PureWindowImpl.

◆ getWidth()

virtual TPureUInt PureWindow::getWidth ( ) const
pure virtual

Gets window width.

Implemented in PureWindowImpl.

◆ getWindowProc()

virtual WNDPROC PureWindow::getWindowProc ( ) const
pure virtual

Gets the message handling window procedure of this window.

Implemented in PureWindowImpl.

◆ getWndDC()

virtual HDC PureWindow::getWndDC ( ) const
pure virtual

Gets window Device Context.

Implemented in PureWindowImpl.

◆ getWndHandle()

virtual HWND PureWindow::getWndHandle ( ) const
pure virtual

Gets window handle.

Implemented in PureWindowImpl.

◆ getX()

virtual TPureUInt PureWindow::getX ( ) const
pure virtual

Gets window X-coordinate.

Implemented in PureWindowImpl.

◆ getY()

virtual TPureUInt PureWindow::getY ( ) const
pure virtual

Gets window Y-coordinate.

Implemented in PureWindowImpl.

◆ hasBorder()

virtual TPureBool PureWindow::hasBorder ( ) const
pure virtual

Gets whether window has border or not.

Implemented in PureWindowImpl.

◆ hasCloseRequest()

virtual TPureBool PureWindow::hasCloseRequest ( ) const
pure virtual

Gets whether the window has a close request or not.

Implemented in PureWindowImpl.

◆ hasMaxButton()

virtual TPureBool PureWindow::hasMaxButton ( ) const
pure virtual

Gets whether window has maximize/restore button or not.

Implemented in PureWindowImpl.

◆ hasMinButton()

virtual TPureBool PureWindow::hasMinButton ( ) const
pure virtual

Gets whether window has minimize button or not.

Implemented in PureWindowImpl.

◆ hasSysMenu()

virtual TPureBool PureWindow::hasSysMenu ( ) const
pure virtual

Gets whether window has sysmenu or not.

Implemented in PureWindowImpl.

◆ Hide()

virtual void PureWindow::Hide ( )
pure virtual

Hides the window.

Implemented in PureWindowImpl.

◆ initialize()

virtual TPureBool PureWindow::initialize ( TPureUInt width,
TPureUInt height,
TPureBool bFullscreen,
const char * caption,
HWND window = NULL )
pure virtual

This creates the window actually.

Implemented in PureWindowImpl.

◆ isActive()

virtual TPureBool PureWindow::isActive ( ) const
pure virtual

Gets whether window is active or not.

Implemented in PureWindowImpl.

◆ isAutoCleanupOnQuitOn()

virtual TPureBool PureWindow::isAutoCleanupOnQuitOn ( ) const
pure virtual

Gets whether automatic cleanup of window on close request is enabled or not.

Implemented in PureWindowImpl.

◆ isAutoRedrawAllOnPosChange()

virtual TPureBool PureWindow::isAutoRedrawAllOnPosChange ( ) const
pure virtual

Gets whether automatic redraw of window contents on position change is enabled or not.

Implemented in PureWindowImpl.

◆ isCursorVisible()

virtual TPureBool PureWindow::isCursorVisible ( ) const
pure virtual

Gets whether the mouse cursor is visible or not within the window area.

Implemented in PureWindowImpl.

◆ isEnabled()

virtual TPureBool PureWindow::isEnabled ( ) const
pure virtual

Gets whether window is enabled or not.

Implemented in PureWindowImpl.

◆ isInitialized()

virtual TPureBool PureWindow::isInitialized ( ) const
pure virtual

Gets whether the window is initialized.

Implemented in PureWindowImpl.

◆ isResizable()

virtual TPureBool PureWindow::isResizable ( ) const
pure virtual

Gets whether window is fully resizable.

Implemented in PureWindowImpl.

◆ isResizableH()

virtual TPureBool PureWindow::isResizableH ( ) const
pure virtual

Gets whether window is resizable horizontally.

Implemented in PureWindowImpl.

◆ isResizableV()

virtual TPureBool PureWindow::isResizableV ( ) const
pure virtual

Gets whether window is resizable vertically.

Implemented in PureWindowImpl.

◆ isTopMost()

virtual TPureBool PureWindow::isTopMost ( ) const
pure virtual

Gets whether window is topmost or not.

Implemented in PureWindowImpl.

◆ Maximize()

virtual void PureWindow::Maximize ( )
pure virtual

Maximizes the window.

Implemented in PureWindowImpl.

◆ Minimize()

virtual void PureWindow::Minimize ( )
pure virtual

Minimizes the window, so it will be visible only on the Taskbar.

Implemented in PureWindowImpl.

◆ ProcessMessages()

virtual void PureWindow::ProcessMessages ( )
pure virtual

Processes the queued window messages.

Implemented in PureWindowImpl.

◆ ResetDefaults()

virtual void PureWindow::ResetDefaults ( )
pure virtual

Resets the default settings.

Implemented in PureWindowImpl.

◆ Restore()

virtual void PureWindow::Restore ( )
pure virtual

Restores the window to the previous state.

Implemented in PureWindowImpl.

◆ SetActive()

virtual void PureWindow::SetActive ( )
pure virtual

Sets the window active.

Implemented in PureWindowImpl.

◆ SetAutoCameraWarningState()

virtual void PureWindow::SetAutoCameraWarningState ( TPureBool state)
pure virtual

Sets whether automatic camera warning on resize is enabled or not.

Implemented in PureWindowImpl.

◆ SetAutoCleanupOnQuitOn()

virtual void PureWindow::SetAutoCleanupOnQuitOn ( TPureBool state)
pure virtual

Sets whether automatic cleanup of window on close request is enabled or not.

Implemented in PureWindowImpl.

◆ SetAutoRedrawAllOnPosChange()

virtual void PureWindow::SetAutoRedrawAllOnPosChange ( TPureBool state)
pure virtual

Sets whether automatic redraw of window contents on position change is enabled or not.

Implemented in PureWindowImpl.

◆ SetBorder()

virtual void PureWindow::SetBorder ( TPureBool state)
pure virtual

Sets whether window has border or not.

Implemented in PureWindowImpl.

◆ SetCaption()

virtual void PureWindow::SetCaption ( const std::string & newcaption)
pure virtual

Sets the window caption.

Implemented in PureWindowImpl.

◆ SetClientHeight()

virtual void PureWindow::SetClientHeight ( TPureUInt newheight)
pure virtual

Sets window client height.

Implemented in PureWindowImpl.

◆ SetClientWidth()

virtual void PureWindow::SetClientWidth ( TPureUInt newwidth)
pure virtual

Sets window client width.

Implemented in PureWindowImpl.

◆ SetCursorVisible()

virtual void PureWindow::SetCursorVisible ( TPureBool state)
pure virtual

Sets whether the mouse cursor is visible or not within the window area.

Implemented in PureWindowImpl.

◆ SetEnabled()

virtual void PureWindow::SetEnabled ( TPureBool state)
pure virtual

Sets whether window is enabled or not.

Implemented in PureWindowImpl.

◆ SetHeight()

virtual void PureWindow::SetHeight ( TPureUInt newheight)
pure virtual

Sets window height.

Implemented in PureWindowImpl.

◆ SetMaxButton()

virtual void PureWindow::SetMaxButton ( TPureBool state)
pure virtual

Sets whether window has maximize button or not.

Implemented in PureWindowImpl.

◆ SetMinButton()

virtual void PureWindow::SetMinButton ( TPureBool state)
pure virtual

Sets whether window has minimize button or not.

Implemented in PureWindowImpl.

◆ SetResizable()

virtual void PureWindow::SetResizable ( TPureBool state)
pure virtual

Sets whether window is fully resizable.

Implemented in PureWindowImpl.

◆ SetResizableH()

virtual void PureWindow::SetResizableH ( TPureBool state)
pure virtual

Sets whether window is resizable horizontally.

Implemented in PureWindowImpl.

◆ SetResizableV()

virtual void PureWindow::SetResizableV ( TPureBool state)
pure virtual

Sets whether window is resizable vertically.

Implemented in PureWindowImpl.

◆ SetSysMenu()

virtual void PureWindow::SetSysMenu ( TPureBool state)
pure virtual

Sets whether window has sysmenu or not.

Implemented in PureWindowImpl.

◆ SetTopMost()

virtual void PureWindow::SetTopMost ( TPureBool state)
pure virtual

Sets the window topmost property.

Implemented in PureWindowImpl.

◆ SetWidth()

virtual void PureWindow::SetWidth ( TPureUInt newwidth)
pure virtual

Sets window width.

Implemented in PureWindowImpl.

◆ SetWindowProc()

virtual void PureWindow::SetWindowProc ( const WNDPROC windowproc)
pure virtual

Sets the message handling window procedure of this window.

Implemented in PureWindowImpl.

◆ SetX()

virtual void PureWindow::SetX ( TPureUInt newx)
pure virtual

Sets window X-coordinate.

Implemented in PureWindowImpl.

◆ SetY()

virtual void PureWindow::SetY ( TPureUInt newy)
pure virtual

Sets window Y-coordinate.

Implemented in PureWindowImpl.

◆ Show()

virtual void PureWindow::Show ( )
pure virtual

Shows the window.

Implemented in PureWindowImpl.

◆ ShowFull()

virtual void PureWindow::ShowFull ( )
pure virtual

Shows and brings the window to front and sets the focus to it.

Implemented in PureWindowImpl.

◆ WriteSettings()

virtual void PureWindow::WriteSettings ( )
pure virtual

Writes the window properties to the console window.

Implemented in PureWindowImpl.


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