GuiCanvas

Public Functions

clientToScreen(Point2I coordinate)

Translate a coordinate from canvas window-space to screen-space.

Parameters:

cursorClick(int buttonId, bool isDown)

cursorNudge(float x, float y)

cursorOff()

Turns on the mouse off.

Canvas.cursorOff();

cursorOn()

Turns on the mouse cursor.

Canvas.cursorOn();

findFirstMatchingMonitor(string name)

Find the first monitor index that matches the given name.

The actual match algorithm depends on the implementation. Parameters:

getContent()

Get the GuiControl which is being used as the content.

Canvas.getContent();

getCursorPos()

Get the current position of the cursor in screen-space. Note that this position might be outside the Torque window. If you want to get the position within the Canvas, call screenToClient on the result.

%cursorPos = Canvas.getCursorPos();

getExtent()

Returns the dimensions of the canvas.

%extent = Canvas.getExtent();

getMode(int modeId)

Gets information on the specified mode of this device.

Parameters:

getModeCount()

Gets the number of modes available on this device.

Parameters:

%modeCount = Canvas.getModeCount()

getMonitorCount()

Gets the number of monitors attached to the system.

getMonitorDesktopMode(int monitorIndex)

Gets the current desktop mode for the selected monitor.

getMonitorMode(int monitorIndex, int modeIndex)

Gets a video mode string from the selected monitor.

getMonitorModeCount(int monitorIndex)

Gets the number of video modes available on the selected monitor.

getMonitorName(int index)

Gets the name of the requested monitor.

Parameters:

getMonitorRect(int index)

Gets the region of the requested monitor.

Parameters:

getMonitorUsableRect(int index)

Use this function to get the usable desktop area represented by a display, with the primary display located at 0,0.

This is the same area as Canvas.getMonitorRect() reports, but with portions reserved by the system removed. For example, on Apple Mac OS X, this subtracts the area occupied by the menu bar and dock. Setting a window to be fullscreen generally bypasses these unusable areas, so these are good guidelines for the maximum space available to a non - fullscreen window.Parameters:

getMouseControl()

Gets the gui control under the mouse.

%underMouse = Canvas.getMouseControl();

getVideoMode()

Gets the current screen mode as a string.

The return string will contain 5 values (width, height, fullscreen, bitdepth, refreshRate). You will need to parse out each one for individual use.

%screenWidth = getWord(Canvas.getVideoMode(), 0);
%screenHeight = getWord(Canvas.getVideoMode(), 1);
%isFullscreen = getWord(Canvas.getVideoMode(), 2);
%bitdepth = getWord(Canvas.getVideoMode(), 3);
%refreshRate = getWord(Canvas.getVideoMode(), 4);

getWindowPosition()

Get the current position of the platform window associated with the canvas.

hideCursor()

Disable rendering of the cursor.

Canvas.hideCursor();

hideWindow()

isCursorOn()

Determines if mouse cursor is enabled.

// Is cursor on?
if(Canvas.isCursorOn())
  echo("Canvas cursor is on");

isCursorShown()

Determines if mouse cursor is rendering.

// Is cursor rendering?
if(Canvas.isCursorShown())
  echo("Canvas cursor is rendering");

isFullscreen()

Is this canvas currently fullscreen?

isMaximized()

isMinimized()

maximizeWindow()

maximize this canvas' window.

minimizeWindow()

minimize this canvas' window.

popDialog()

Removes a dialog at the front most layer.

// Pops whatever is on layer 0
Canvas.popDialog();

popDialog(GuiControl ctrl)

Removes a specific dialog control.

Parameters:

Canvas.popDialog(RecordingsDlg);

popLayer()

Removes the top most layer of dialogs.

Canvas.popLayer();

popLayer(S32 layer)

Removes a specified layer of dialogs.

Parameters:

Canvas.popLayer(1);

pushDialog(GuiControl ctrl, int layer, bool center)

Adds a dialog control onto the stack of dialogs.

Parameters:

Canvas.pushDialog(RecordingsDlg);

renderFront(bool enable)

This turns on/off front-buffer rendering.

Parameters:

Canvas.renderFront(false);

repaint(int elapsedMS)

Force canvas to redraw. If the elapsed time is greater than the time since the last paint then the repaint will be skipped.

Parameters:

Canvas.repaint();

reset()

Reset the update regions for the canvas.

Canvas.reset();

resetVideoMode()

restoreWindow()

restore this canvas' window.

screenToClient(Point2I coordinate)

Translate a coordinate from screen-space to canvas window-space.

Parameters:

setContent(GuiControl ctrl)

Set the content of the canvas to a specified control.

Parameters:

Canvas.setContent(PlayGui);

setCursor(GuiCursor cursor)

Sets the cursor for the canvas.

Parameters:

Canvas.setCursor("DefaultCursor");

setCursorPos(F32 posX, F32 posY)

Sets the position of the cursor.

Parameters:

Canvas.setCursorPos(0,0);

setCursorPos(Point2I pos)

Sets the position of the cursor.

Parameters:

Canvas.setCursorPos("0 0");

setFocus()

Claim OS input focus for this canvas' window.

setMenuBar(GuiControl menu)

Translate a coordinate from canvas window-space to screen-space.

Parameters:

setVideoMode(uint width, uint height, bool fullscreen, uint bitDepth, uint refreshRate, uint antialiasLevel)

Change the video mode of this canvas. This method has the side effect of setting the $pref::Video::mode to the new values.

Parameters:

setWindowPosition(Point2I position)

Set the position of the platform window associated with the canvas.

Parameters:

setWindowTitle(string newTitle)

Change the title of the OS window.

Parameters:

Canvas.setWindowTitle("Documentation Rocks!");

showCursor()

Enable rendering of the cursor.

Canvas.showCursor();

showWindow()

toggleFullscreen()

toggle canvas from fullscreen to windowed mode or back.

// If we are in windowed mode, the following will put is in fullscreen
Canvas.toggleFullscreen();