PathEngine home previous: iConnectionTestCallBack::testJumpCandidatePair()next: iTestBed::addConstExternalRef()
Contents, API Reference, Interfaces, iTestBed

Interface iTestBed

Description

Interface to the PathEngine testbed.

Defined in SDKRoot/code/externalAPI/i_testbed.h.

This interface is only available when linking with the PathEngine testbed.

Construction and deletion

A pointer to the iTestBed interface is passed into a test application when it is loaded by the testbed (see Linking with the TestBed).

There is only one instance of the object that provides this interface. This object cannot be deleted so operator delete has been made private.

Methods:

addConstExternalRef

Increments the internal reference count for this API object.

addExternalRef

Increments the internal reference count for this API object.

createImage

Processes image file contents, to prepare for rendering.

createSound

Loads the contents of a wav file into memory to be later played by iTestBed::playSound().

displaySplashImage_BottomLeft

Displays a 2D image in front of the scene, touching the bottom left corner of the viewport.

displaySplashImage_Centred

Displays a 2D image in front of the scene, and centred in the viewport.

drawLine2D

Draws a line in screen space.

enter2DMode

Switch to 2D rendering mode.

enterAdditiveBlendingPhase

Switches to additive blending rendering mode.

exit2DMode

Switch back 2D rendering mode.

getCameraPosition

Queries the current camera position.

getCommandLineArgument

Used to query testbed command line arguments.

getInterfaceMajorVersion

Returns the major version number for the code supporting this interface.

getInterfaceMinorVersion

Returns the minor version number for the code supporting this interface.

getKeyState

Tells you whether or not a specified key is down.

getLeftMouseState

Tells you whether or not the left mouse button is down.

getMouseScreenDelta

Retrieves a movement delta for the mouse in screen coordinates.

getMouseScreenPosition

Retrieves the current position of the mouse within the testbed window.

getNumberOfCommandLineArguments

Used to query testbed command line arguments.

getRightMouseState

Tells you whether or not the right mouse button is down.

getVersionAttributes

Obtains a set of attributes for the object that provides this interface.

getWindowSize

Query the current rendering viewport size.

handleError

Report an error.

hasRefs

Enables you to check whether there are any outstanding references on this object, other than the interface reference through which you are calling, and therefore whether this object will actually be deleted if you call its release method.

loadCameraPosition

Loads camera position and orientation back from persistence.

lookAt

Points the camera at a target. Can be used for a chase camera.

newRenderGeometry

Creates an Interface iRenderGeometry object (which can be used for rendering lines and polygons).

playSound

Plays a sound.

printTextLine

Prints a horizontal line of text at a y position that is incremented with each call in a given frame.

receiveKeyMessage

Used to obtain messages about any keys that went up or down since the last frame.

release

Releases the API object pointer.

render

Render geometry such as lines and polygons.

render_Offset

Render geometry such as lines and polygons, with a world offset.

reportError

Report an error.

saveCameraPosition

Saves current camera position and orientation.

screenToWorld

Reverse project a position to world coordinates from screen space, based on the current camera position and orientation.

setAdditiveBlendingAlpha

Sets the multiplier value to be applied in additive blending mode.

setBackgroundColour

Sets the background colour, by colour name.

setBackgroundColourRGB

Sets the background colour.

setCameraControlState

Set control state for built in testbed controls, based on mouse movement.

setCameraControlTarget

Supply a target position that can be used to adjust camera target distance during camera control interactions, for more intuitive behaviour.

setColour

Sets colour for rendered elements that do not have their own colour information, such as render geometry and text, by colour name.

setColourRGB

Sets colour for rendered elements that do not have their own colour information, such as render geometry and text.

update

Process application events and advance to the next rendering frame.

worldToScreen

Project a position in world coordinates into screen space, based on the current camera position and orientation.

zoomExtents

Position the camera at a position zoomed out enough to make a given set of points visible.


Documentation for PathEngine release 6.04 - Copyright © 2002-2024 PathEnginenext: iTestBed::addConstExternalRef()