PathEngine home previous: iConnectionTestCallBack::testJumpCandidatePair()next: iTestBed::createSound()
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:

createSound

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

deleteRenderPreprocess

Deletes render preprocess.

displaySplashImage

Displays a 2d image in front of the testbed scene.

displaySplashImage_Centred

Displays a 2d image in front of the testbed scene.

drawAgent

Draws a polygonal object to represent an agent on the testbed's current mesh.

drawAgentExpansion

Draws the edge of the expanded region for a specified agent with a specified shape.

drawAgentHeading

Draws and indicator to show which way an agent is facing.

drawAgentHeadingWithPrecision

Version of drawAgentHeading() accepting extra precision.

drawAgentWithPrecision

Draws an agent with taking into account extra precision for the agent's position.

drawAgentsInContext

Draws all agents in the specified collision context.

drawAgentsInObstacleSet

Draws all agents in the specified obstacle set.

drawBurntInObstacles

Draws any obstacles burnt in to the current mesh.

drawLine

Draws a line on the testbed's current mesh.

drawMesh

Draws the testbed's current mesh.

drawMeshEdges

Draws lines at the edges of the testbed's current mesh.

drawMeshExpansion

Draws the result of minkowski expansion for a specified shape on the testbed's current mesh.

drawPath

Draws a path on the testbed's current mesh.

drawPosition

Draws a position on the testbed's current mesh.

drawRangeBounds

Draws the boundaries of a rectangular two dimensional region.

drawRenderPreprocess

Draws preprocessed geometry.

drawRenderPreprocessAtPosition

Draws preprocessed geometry, translated to a specified position.

drawShape

Draws a polygonal object to represent an object with the specified collision shape on the testbed's current mesh.

drawSplitBoundaries

Draws the part of the minkowski expansion (for the specified shape and on the testbed's current mesh), that got split off by the small convex obstacles optimisation.

drawSquareBounds

Draws the boundaries of an axis aligned square region, as specified for some queries.

drawUnsplitBoundaries

Draws the part of the minkowski expansion (for the specified shape and on the testbed's current mesh), that was not split off by the small convex obstacles optimisation.

enterAdditiveBlendingPhase

Turns on additive blending rendering.

finishGeneratingPreprocess

Finish caching information from rendering calls for drawing later through a render preprocess object.

freeBuffer

Frees a buffer previously allocated internally by PathEngine.

getActiveMeshSlot

Helper method to retrieve the currently active 'mesh slot' (when mesh slots are being used).

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.

getMesh

A helper method to teturns the testbed's current mesh.

getMeshAtSlot

A helper method to teturns the testbed's current mesh, at a specified 'mesh slot'.

getMouseScreenDelta

Retrieves a vector for the current movement of 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.

getReleaseNumber

Returns the major release number for the code supporting this interface. This method is depreciated.

getRightMouseState

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

getTestBedProgressCallBack

Gets a pointer to an internal progress bar callback object.

getVersionAttributes

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

isInAdditiveBlendingPhase

Helper method to test whether additive blending rendering has been turned on.

loadBinary

Loads a file, allocating a buffer.

loadSplashImage

Loads an image file into memory to be later played by iTestBed::displaySplashImage().

lookAt

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

lookAtWithPrecision

Version of lookAt() accepting extra precision.

meshObstructsCamera

Tells you whether or not the current mesh blocks the camera's view to it's target.

playSound

Plays a sound.

positionAtMouse

Return a position on the current mesh beneath the mouse.

preprocessFaceVertexMesh

Used to draw arbitrary face vertex mesh geometry.

preprocessFaceVertexMeshEdges

Used to draw arbitrary face vertex mesh geometry.

preprocessFaceVertexMeshExternalEdges

Used to draw arbitrary face vertex mesh geometry.

preprocessShapeWithHeight

Used to speed up rendering of large numbers of dynamic agents.

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.

releaseMesh

Releases a mesh previously set with iTestBed::setMesh().

reportError

Calls the current error handler.

setActiveMeshSlot

Sets the active 'mesh slot' (when mesh slots are being used).

setAdditiveBlendingAlpha

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

setColour

Sets the testbed's current rendering colour, specified as a colour string.

setColourRGB

Sets the testbed's current rendering colour, specified as RGB components.

setMesh

Sets the testbed's current mesh.

setMeshAtSlot

Sets the testbed's current mesh (at a given 'mesh slot').

startGeneratingPreprocess

Start caching information from rendering calls for drawing later through a render preprocess object.

update

Advances the testbed to the next rendering frame.

update_ExitIfRequested

Advances the testbed to the next rendering frame (exits process instead of flagging an exit request).

zoomExtents

Positions the testbed camera to ensure that the current mesh is completely visible.

zoomExtents_FaceVertex

Sets up the camera to ensure a set of face vertex components is completely within the view frustrum.


Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iTestBed::createSound()