Torque3D Documentation / _generateds / PlatformWindowManager

PlatformWindowManager

Engine/source/windowManager/platformWindowMgr.h

Abstract representation of a manager for native OS windows.

More...

Private Attributes

Protected Functions

Get the next available window Id.

Public Static Functions

Public Functions

Create a new window, appropriate for the specified device and mode.

Retrieve the currently set desktop bit depth.

Retrieve the currently set desktop resolution.

Get the first window in the window list.

Get the window that currently has the input focus or NULL.

getMonitorMode(U32 monitorIndex, U32 modeIndex)
getMonitorModeCount(U32 monitorIndex)
const char *

Populate a vector with all monitors and their extents in window space.

void *

Get the parent window.

Return the extents in window coordinates of the primary desktop area.

Get a window from a device ID.

Populate a list with references to all the windows created from this manager.

This method cues the appearance of that window ("lowering the curtain").

setDisplayWindow(bool set)

This method indicates to created windows to show as normal.

setParentWindow(void * newParent)

Set the parent window.

Private Functions

_processCmdLineArgs(const S32 argc, const char ** argv)

Process command line arguments from StandardMainLoop.

Detailed Description

Abstract representation of a manager for native OS windows.

The PlatformWindowManager interface provides a variety of methods for querying the current desktop configuration, as well as allocating and retrieving existing windows. It may also manage application-level event handling.

Private Attributes

S32 mIdSource 

Protected Functions

getNextId()

Get the next available window Id.

Public Static Functions

get()

Get Global Singleton.

processCmdLineArgs(const S32 argc, const char ** argv)

Public Functions

PlatformWindowManager()

~PlatformWindowManager()

buildMonitorsList()

Reimplemented by: Win32WindowManager

createWindow(GFXDevice * device, const GFXVideoMode & mode)

Create a new window, appropriate for the specified device and mode.

return:

Pointer to the new window.

Reimplemented by: MacWindowManager, PlatformWindowManagerSDL, Win32WindowManager

findFirstMatchingMonitor(const char * name)

Reimplemented by: PlatformWindowManagerSDL, Win32WindowManager

getDesktopBitDepth()

Retrieve the currently set desktop bit depth.

return:

The current desktop bit depth, or -1 if an error occurred

Reimplemented by: MacWindowManager, PlatformWindowManagerSDL, Win32WindowManager

getDesktopResolution()

Retrieve the currently set desktop resolution.

return:

The current desktop bit depth, or Point2I(-1,-1) if an error occurred

Reimplemented by: MacWindowManager, PlatformWindowManagerSDL, Win32WindowManager

getFirstWindow()

Get the first window in the window list.

return:

The first window in the list, or NULL if no windows found

Reimplemented by: MacWindowManager, PlatformWindowManagerSDL, Win32WindowManager

getFocusedWindow()

Get the window that currently has the input focus or NULL.

Reimplemented by: MacWindowManager, PlatformWindowManagerSDL, Win32WindowManager

getMonitorCount()

Reimplemented by: PlatformWindowManagerSDL, Win32WindowManager

getMonitorDesktopMode(U32 monitorIndex)

Reimplemented by: PlatformWindowManagerSDL

getMonitorMode(U32 monitorIndex, U32 modeIndex)

Reimplemented by: PlatformWindowManagerSDL

getMonitorModeCount(U32 monitorIndex)

Reimplemented by: PlatformWindowManagerSDL

getMonitorName(U32 index)

Reimplemented by: PlatformWindowManagerSDL, Win32WindowManager

getMonitorRect(U32 index)

Reimplemented by: PlatformWindowManagerSDL, Win32WindowManager

getMonitorRegions(Vector< RectI > & regions)

Populate a vector with all monitors and their extents in window space.

Reimplemented by: MacWindowManager, PlatformWindowManagerSDL, Win32WindowManager

getMonitorUsableRect(U32 index)

Reimplemented by: PlatformWindowManagerSDL

getParentWindow()

Get the parent window.

Reimplemented by: MacWindowManager, PlatformWindowManagerSDL, Win32WindowManager

getPrimaryDesktopArea()

Return the extents in window coordinates of the primary desktop area.

On a single monitor system this is just the display extents. On a multimon system this is the primary monitor (which Torque should launch on).

Reimplemented by: MacWindowManager, PlatformWindowManagerSDL, Win32WindowManager

getWindowById(WindowId id)

Get a window from a device ID.

return:

The window associated with the specified ID, or NULL if no match was found.

Reimplemented by: MacWindowManager, PlatformWindowManagerSDL, Win32WindowManager

getWindows(VectorPtr< PlatformWindow * > & windows)

Populate a list with references to all the windows created from this manager.

Reimplemented by: MacWindowManager, PlatformWindowManagerSDL, Win32WindowManager

lowerCurtain()

This method cues the appearance of that window ("lowering the curtain").

Reimplemented by: MacWindowManager, PlatformWindowManagerSDL, Win32WindowManager

raiseCurtain()

This method removes the curtain window.

Reimplemented by: MacWindowManager, PlatformWindowManagerSDL, Win32WindowManager

setDisplayWindow(bool set)

This method indicates to created windows to show as normal.

Reimplemented by: PlatformWindowManagerSDL, Win32WindowManager

setParentWindow(void * newParent)

Set the parent window.

This can be used to render in a child window.

Reimplemented by: MacWindowManager, PlatformWindowManagerSDL, Win32WindowManager

Private Functions

_processCmdLineArgs(const S32 argc, const char ** argv)

Process command line arguments from StandardMainLoop.

This is done to allow web plugin functionality, where we are passed platform-specific information allowing us to set ourselves up in the web browser, to occur in a platform-neutral way.

Reimplemented by: MacWindowManager, PlatformWindowManagerSDL, Win32WindowManager