DebugDrawer

Engine/source/gfx/sim/debugDraw.h

Inheritance diagram for DebugDrawer ↕

Debug output class.

More...

Classes:

class

DebugDrawer::DebugPrim

ddrawmeth Debug Draw Methods

enum

_Anonymous_ {  DD_INFINITE = U32_MAX
}

Set the TTL for the last item we entered...

void

drawBoxOutline(const Point3F & a, const Point3F & b, const LinearColorF & color)

void

drawTransformedBoxOutline(const Point3F & a, const Point3F & b, const LinearColorF & color, const MatrixF & transform)

void

drawBox(const Point3F & a, const Point3F & b, const LinearColorF & color)

void

drawLine(const Point3F & a, const Point3F & b, const LinearColorF & color)

void

drawTri(const Point3F & a, const Point3F & b, const Point3F & c, const LinearColorF & color)

void

drawText(const Point3F & pos, const String & text, const LinearColorF & color)

void

drawCapsule(const Point3F & a, const F32 & radius, const F32 & height, const LinearColorF & color)

void

drawDirectionLine(const Point3F & a, const Point3F & b, const LinearColorF & color)

void

drawOutlinedText(const Point3F & pos, const String & text, const LinearColorF & color, const LinearColorF & colorOutline)

void

drawPolyhedron(const AnyPolyhedron & polyhedron, const LinearColorF & color)

Render a wireframe view of the given polyhedron.

void

drawPolyhedronDebugInfo(const AnyPolyhedron & polyhedron, const MatrixF & transform, const Point3F & scale)

Render the plane indices, edge indices, edge direction indicators, and point coordinates of the given polyhedron for debugging.

void

setLastTTL(U32 ms)

void

setLastZTest(bool enabled)

Disable/enable z testing on the last primitive.

Private Types

SimObject

Parent

Private Static Attributes

DebugDrawer *

sgDebugDrawer

Private Attributes

bool

isDrawing

bool

isFrozen

Resource< GFont >

mFont

DebugPrim *

mHead

FreeListChunker< DebugPrim >

mPrimChunker

GFXStateBlockRef

mRenderAlpha

GFXStateBlockRef

mRenderZOffSB

GFXStateBlockRef

mRenderZOnSB

bool

shouldToggleFreeze

Public Functions

DebugDrawer()

~DebugDrawer()

DECLARE_CONOBJECT(DebugDrawer )

void

render(bool clear)

Called globally to render debug draw state. Also does state updates.

void

toggleDrawing()

void

toggleFreeze()

bool

willDraw()

Public Static Functions

DebugDrawer *

get()

void

init()

Called at engine init to set up the global debug draw object.

Private Functions

void

setupStateBlocks()

Detailed Description

Debug output class.

This class provides you with a flexible means of drawing debug output. It is often useful when debugging collision code or complex 3d algorithms to have them draw debug information, like culling hulls or bounding volumes, normals, simple lines, and so forth. In TGE1.2, which was based directly on a simple OpenGL rendering layer, it was a simple matter to do debug rendering directly inline.

Unfortunately, this doesn't hold true with more complex rendering scenarios, where render modes and targets may be in abritrary states. In addition, it is often useful to be able to freeze frame debug information for closer inspection.

Therefore, Torque provides a global DebugDrawer instance, called gDebugDraw, which you can use to draw debug information. It exposes a number of methods for drawing a variety of debug primitives, including lines, triangles and boxes. Internally, DebugDrawer maintains a list of active debug primitives, and draws the contents of the list after each frame is done rendering. This way, you can be assured that your debug rendering won't interfere with TSE's various effect rendering passes or render-to-target calls.

The DebugDrawer can also be used for more interesting uses, like freezing its primitive list so you can look at a situation more closely, or dumping the primitive list to disk for closer analysis.

DebugDrawer is accessible by script under the name DebugDrawer, and by C++ under the symbol gDebugDraw. There are a variety of methods available for drawing different sorts of output; see the class reference for more information.

DebugDrawer works solely in worldspace. Primitives are rendered with cull mode of none.