plGameStateWindow Class Reference

A window class that expands a little on plWindow. Default type used by plGameState to create a window. More...

#include <GameStateWindow.h>

Inheritance diagram for plGameStateWindow:

Public Member Functions
	plGameStateWindow (const plWindowCreationDesc &windowdesc, plDelegate< void()> onClickClose={})
void	ResetOnClickClose (plDelegate< void()> onClickClose)
Public Member Functions inherited from plWindow
	plWindow ()
	Creates empty window instance with standard settings.
virtual	~plWindow ()
	Destroys the window if not already done.
const plWindowCreationDesc &	GetCreationDescription () const
	Returns the currently active description struct.
virtual plSizeU32	GetClientAreaSize () const override
	Returns the size of the client area / ie. the window resolution.
virtual plWindowHandle	GetNativeWindowHandle () const override
	Returns the platform specific window handle.
virtual bool	IsFullscreenWindow (bool bOnlyProperFullscreenMode=false) const override
	Returns whether the window covers an entire monitor.
virtual bool	IsVisible () const override
	Whether the window can potentially be seen by the user. Windows that are minimized or hidden are not visible.
virtual void	AddReference () override
virtual void	RemoveReference () override
virtual void	ProcessWindowMessages () override
	Runs the platform specific message pump.
plResult	Initialize ()
	Creates a new platform specific window with the current settings.
plResult	Initialize (const plWindowCreationDesc &creationDescription)
	Creates a new platform specific window with the given settings.
bool	IsInitialized () const
	Gets if the window is up and running.
plResult	Destroy ()
	Destroys the window.
plResult	Resize (const plSizeU32 &newWindowSize)
	Tries to resize the window. Override OnResize to get the actual new window size.
virtual void	OnWindowMove (const plInt32 iNewPosX, const plInt32 iNewPosY)
	Called when the window position is changed. Not possible on all OSes.
virtual void	OnFocus (bool bHasFocus)
	Called when the window gets focus or loses focus.
virtual void	OnVisibleChange (bool bVisible)
	Called when the window gets focus or loses focus.
plStandardInputDevice *	GetInputDevice () const
	Returns the input device that is attached to this window and typically provides mouse / keyboard input.

Private Member Functions
virtual void	OnResize (const plSizeU32 &newWindowSize) override
	Called on window resize messages.
virtual void	OnClickClose () override
	Called when the close button of the window is clicked. Does nothing by default.

Additional Inherited Members
Static Public Member Functions inherited from plWindow
static plUInt8	GetNextUnusedWindowNumber ()
	Returns a number that can be used as a window number in plWindowCreationDesc.
Protected Attributes inherited from plWindow
plWindowCreationDesc	m_CreationDescription

Detailed Description

A window class that expands a little on plWindow. Default type used by plGameState to create a window.

Member Function Documentation

OnClickClose()

void plGameStateWindow::OnClickClose ( )

overrideprivatevirtual

Called when the close button of the window is clicked. Does nothing by default.

Reimplemented from plWindow.

OnResize()

void plGameStateWindow::OnResize ( const plSizeU32 & newWindowSize )

overrideprivatevirtual

Called on window resize messages.

Parameters

newWindowSize

New window size in pixel.

See also

OnWindowMessage

Reimplemented from plWindow.

---

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

• Code/Engine/Core/GameState/GameStateWindow.h
• Code/Engine/Core/GameState/Implementation/GameStateWindow.cpp