Torque Game Engine Documentation
TGE Version 1.5.2

Viewing Volume Functions

Detailed Description

These functions set up the view cube of the window.

Functions

void dglSetViewport (const RectI &aViewPort)

sets the viewport for the window

void dglGetViewport (RectI *outViewport)

gets the current viewport of the window

void dglSetFrustum (F64 left, F64 right, F64 bottom, F64 top, F64 nearDist, F64 farDist, bool ortho=false)

Sets the viewing frustrum.

void dglGetFrustum (F64 *left, F64 *right, F64 *bottom, F64 *top, F64 *nearDist, F64 *farDist)

Returns the parameters for the current viewing frustrum.

bool dglIsOrtho ()

returns whether or not the coordinate system is orthographic (if it is not projected)

void dglSetClipRect (const RectI &clipRect)

Sets up an orthographical viewport and clipping region.

const RectI & dglGetClipRect ()

Gets the last clip rect specified by a call to dglSetClipRect.

void dglSetViewport ( const RectI & aViewPort )

sets the viewport for the window

void dglGetViewport ( RectI * outViewport )

gets the current viewport of the window

Sets the viewing frustrum.

This effectively creates the view volume and sets up the 6 clipping planes (near, far, left, right, top, bottom)

Parameters:

	left	This is the position of the left vertical clipping plane
	right	This is the position of the right vertical clipping plane
	top	This is the position of the top horizontal clipping plane
	bottom	This is the position of the bottom horizontal clipping plane
	nearDist	This is the distance between the eye and the near clipping plane
	farDist	This is the distance between the eye and the far clipping plane
	ortho	(optional, default is false) If left false, calling this function will create a projection viewing volume. If true, it will be orthographic

Returns the parameters for the current viewing frustrum.

bool dglIsOrtho ( )

returns whether or not the coordinate system is orthographic (if it is not projected)

void dglSetClipRect ( const RectI & clipRect )

Sets up an orthographical viewport and clipping region.

This is best used for guis

Parameters:

clipRect

The bounds of the coordinate system

const RectI& dglGetClipRect ( )

Gets the last clip rect specified by a call to dglSetClipRect.