#include <DebugRendererSimple.h>

Inheritance diagram for DebugRendererSimple:

Public Member Functions
JPH_OVERRIDE_NEW_DELETE	DebugRendererSimple ()
	Constructor. More...

void	SetCameraPos (RVec3Arg inCameraPos)

virtual void	DrawTriangle (RVec3Arg inV1, RVec3Arg inV2, RVec3Arg inV3, ColorArg inColor, ECastShadow inCastShadow) override
	Fallback implementation that uses DrawLine to draw a triangle (override this if you have a version that renders solid triangles) More...

Public Member Functions inherited from DebugRenderer
JPH_OVERRIDE_NEW_DELETE	DebugRenderer ()
	Constructor. More...

virtual	~DebugRenderer ()

void	NextFrame ()
	Call once after frame is complete. Releases unused dynamically generated geometry assets. More...

virtual void	DrawLine (RVec3Arg inFrom, RVec3Arg inTo, ColorArg inColor)=0
	Draw line. More...

void	DrawWireBox (const AABox &inBox, ColorArg inColor)
	Draw wireframe box. More...

void	DrawWireBox (const OrientedBox &inBox, ColorArg inColor)

void	DrawWireBox (RMat44Arg inMatrix, const AABox &inBox, ColorArg inColor)

void	DrawMarker (RVec3Arg inPosition, ColorArg inColor, float inSize)
	Draw a marker on a position. More...

void	DrawArrow (RVec3Arg inFrom, RVec3Arg inTo, ColorArg inColor, float inSize)
	Draw an arrow. More...

void	DrawCoordinateSystem (RMat44Arg inTransform, float inSize=1.0f)
	Draw coordinate system (3 arrows, x = red, y = green, z = blue) More...

void	DrawPlane (RVec3Arg inPoint, Vec3Arg inNormal, ColorArg inColor, float inSize)
	Draw a plane through inPoint with normal inNormal. More...

void	DrawWireTriangle (RVec3Arg inV1, RVec3Arg inV2, RVec3Arg inV3, ColorArg inColor)
	Draw wireframe triangle. More...

template<class VERTEX_ARRAY >
void	DrawWirePolygon (RMat44Arg inTransform, const VERTEX_ARRAY &inVertices, ColorArg inColor, float inArrowSize=0.0f)
	Draw a wireframe polygon. More...

void	DrawWireSphere (RVec3Arg inCenter, float inRadius, ColorArg inColor, int inLevel=3)
	Draw wireframe sphere. More...

void	DrawWireUnitSphere (RMat44Arg inMatrix, ColorArg inColor, int inLevel=3)

virtual void	DrawTriangle (RVec3Arg inV1, RVec3Arg inV2, RVec3Arg inV3, ColorArg inColor, ECastShadow inCastShadow=ECastShadow::Off)=0
	Draw a single back face culled triangle. More...

void	DrawBox (const AABox &inBox, ColorArg inColor, ECastShadow inCastShadow=ECastShadow::On, EDrawMode inDrawMode=EDrawMode::Solid)
	Draw a box. More...

void	DrawBox (RMat44Arg inMatrix, const AABox &inBox, ColorArg inColor, ECastShadow inCastShadow=ECastShadow::On, EDrawMode inDrawMode=EDrawMode::Solid)

void	DrawSphere (RVec3Arg inCenter, float inRadius, ColorArg inColor, ECastShadow inCastShadow=ECastShadow::On, EDrawMode inDrawMode=EDrawMode::Solid)
	Draw a sphere. More...

void	DrawUnitSphere (RMat44Arg inMatrix, ColorArg inColor, ECastShadow inCastShadow=ECastShadow::On, EDrawMode inDrawMode=EDrawMode::Solid)

void	DrawCapsule (RMat44Arg inMatrix, float inHalfHeightOfCylinder, float inRadius, ColorArg inColor, ECastShadow inCastShadow=ECastShadow::On, EDrawMode inDrawMode=EDrawMode::Solid)

void	DrawCylinder (RMat44Arg inMatrix, float inHalfHeight, float inRadius, ColorArg inColor, ECastShadow inCastShadow=ECastShadow::On, EDrawMode inDrawMode=EDrawMode::Solid)

void	DrawOpenCone (RVec3Arg inTop, Vec3Arg inAxis, Vec3Arg inPerpendicular, float inHalfAngle, float inLength, ColorArg inColor, ECastShadow inCastShadow=ECastShadow::On, EDrawMode inDrawMode=EDrawMode::Solid)

void	DrawSwingConeLimits (RMat44Arg inMatrix, float inSwingYHalfAngle, float inSwingZHalfAngle, float inEdgeLength, ColorArg inColor, ECastShadow inCastShadow=ECastShadow::On, EDrawMode inDrawMode=EDrawMode::Solid)

void	DrawSwingPyramidLimits (RMat44Arg inMatrix, float inMinSwingYAngle, float inMaxSwingYAngle, float inMinSwingZAngle, float inMaxSwingZAngle, float inEdgeLength, ColorArg inColor, ECastShadow inCastShadow=ECastShadow::On, EDrawMode inDrawMode=EDrawMode::Solid)

void	DrawPie (RVec3Arg inCenter, float inRadius, Vec3Arg inNormal, Vec3Arg inAxis, float inMinAngle, float inMaxAngle, ColorArg inColor, ECastShadow inCastShadow=ECastShadow::On, EDrawMode inDrawMode=EDrawMode::Solid)

virtual Batch	CreateTriangleBatch (const Triangle *inTriangles, int inTriangleCount)=0
	Create a batch of triangles that can be drawn efficiently. More...

virtual Batch	CreateTriangleBatch (const Vertex inVertices, int inVertexCount, const uint32 inIndices, int inIndexCount)=0

Batch	CreateTriangleBatch (const Array< Triangle > &inTriangles)

Batch	CreateTriangleBatch (const Array< Vertex > &inVertices, const Array< uint32 > &inIndices)

Batch	CreateTriangleBatch (const VertexList &inVertices, const IndexedTriangleNoMaterialList &inTriangles)

Batch	CreateTriangleBatchForConvex (SupportFunction inGetSupport, int inLevel, AABox *outBounds=nullptr)

GeometryRef	CreateTriangleGeometryForConvex (SupportFunction inGetSupport)

virtual void	DrawGeometry (RMat44Arg inModelMatrix, const AABox &inWorldSpaceBounds, float inLODScaleSq, ColorArg inModelColor, const GeometryRef &inGeometry, ECullMode inCullMode=ECullMode::CullBackFace, ECastShadow inCastShadow=ECastShadow::On, EDrawMode inDrawMode=EDrawMode::Solid)=0

void	DrawGeometry (RMat44Arg inModelMatrix, ColorArg inModelColor, const GeometryRef &inGeometry, ECullMode inCullMode=ECullMode::CullBackFace, ECastShadow inCastShadow=ECastShadow::On, EDrawMode inDrawMode=EDrawMode::Solid)

virtual void	DrawText3D (RVec3Arg inPosition, const string_view &inString, ColorArg inColor=Color::sWhite, float inHeight=0.5f)=0
	Draw text. More...

Public Member Functions inherited from NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

void	operator= (const NonCopyable &)=delete

Protected Member Functions
virtual Batch	CreateTriangleBatch (const Triangle *inTriangles, int inTriangleCount) override
	Implementation of DebugRenderer interface. More...

virtual Batch	CreateTriangleBatch (const Vertex inVertices, int inVertexCount, const uint32 inIndices, int inIndexCount) override

virtual void	DrawGeometry (RMat44Arg inModelMatrix, const AABox &inWorldSpaceBounds, float inLODScaleSq, ColorArg inModelColor, const GeometryRef &inGeometry, ECullMode inCullMode, ECastShadow inCastShadow, EDrawMode inDrawMode) override

Protected Member Functions inherited from DebugRenderer
void	Initialize ()
	Initialize the system, must be called from the constructor of the DebugRenderer implementation. More...

Additional Inherited Members
Public Types inherited from DebugRenderer
enum class	ECastShadow { On , Off }
	Enum that determines if a shadow should be cast or not. More...

enum class	EDrawMode { Solid , Wireframe }
	Determines how triangles are drawn. More...

enum class	ECullMode { CullBackFace , CullFrontFace , Off }
	Determines which polygons are culled. More...

using	Batch = Ref< RefTargetVirtual >
	Handle for a batch of triangles. More...

using	GeometryRef = Ref< Geometry >
	Handle for a lodded triangle batch. More...

using	SupportFunction = function< Vec3(Vec3Arg inDirection)>
	Create a primitive for a convex shape using its support function. More...

Static Public Member Functions inherited from DebugRenderer
static AABox	sCalculateBounds (const Vertex *inVertices, int inVertexCount)
	Calculate bounding box for a batch of triangles. More...

Static Public Attributes inherited from DebugRenderer
static DebugRenderer *	sInstance = nullptr
	Singleton instance. More...

Detailed Description

Inherit from this class to simplify implementing a debug renderer, start with this implementation:

class MyDebugRenderer : public JPH::DebugRendererSimple
{
public:
    virtual void DrawLine(JPH::RVec3Arg inFrom, JPH::RVec3Arg inTo, JPH::ColorArg inColor) override
    {
        // Implement
    }

    virtual void DrawTriangle(JPH::RVec3Arg inV1, JPH::RVec3Arg inV2, JPH::RVec3Arg inV3, JPH::ColorArg inColor, ECastShadow inCastShadow) override
    {
        // Implement
    }

    virtual void DrawText3D(JPH::RVec3Arg inPosition, const string_view &inString, JPH::ColorArg inColor, float inHeight) override
    {
        // Implement
    }
};

Note that this class is meant to be a quick start for implementing a debug renderer, it is not the most efficient way to implement a debug renderer.

Constructor & Destructor Documentation

◆ DebugRendererSimple()

JPH_NAMESPACE_BEGIN DebugRendererSimple::DebugRendererSimple ( )

Constructor.

Member Function Documentation

◆ CreateTriangleBatch() [1/2]

DebugRenderer::Batch DebugRendererSimple::CreateTriangleBatch	(	const Triangle *	inTriangles,
		int	inTriangleCount
	)

overrideprotectedvirtual

Implementation of DebugRenderer interface.

Implements DebugRenderer.

◆ CreateTriangleBatch() [2/2]

DebugRenderer::Batch DebugRendererSimple::CreateTriangleBatch	(	const Vertex *	inVertices,
		int	inVertexCount,
		const uint32 *	inIndices,
		int	inIndexCount
	)

overrideprotectedvirtual

Implements DebugRenderer.

◆ DrawGeometry()

void DebugRendererSimple::DrawGeometry	(	RMat44Arg	inModelMatrix,
		const AABox &	inWorldSpaceBounds,
		float	inLODScaleSq,
		ColorArg	inModelColor,
		const GeometryRef &	inGeometry,
		ECullMode	inCullMode,
		ECastShadow	inCastShadow,
		EDrawMode	inDrawMode
	)

overrideprotectedvirtual

Draw some geometry

Parameters

inModelMatrix	is the matrix that transforms the geometry to world space.
inWorldSpaceBounds	is the bounding box of the geometry after transforming it into world space.
inLODScaleSq	is the squared scale of the model matrix, it is multiplied with the LOD distances in inGeometry to calculate the real LOD distance (so a number > 1 will force a higher LOD).
inModelColor	is the color with which to multiply the vertex colors in inGeometry.
inGeometry	The geometry to draw.
inCullMode	determines which polygons are culled.
inCastShadow	determines if this geometry should cast a shadow or not.
inDrawMode	determines if we draw the geometry solid or in wireframe.

Implements DebugRenderer.

◆ DrawTriangle()

virtual void DebugRendererSimple::DrawTriangle	(	RVec3Arg	inV1,
		RVec3Arg	inV2,
		RVec3Arg	inV3,
		ColorArg	inColor,
		ECastShadow	inCastShadow
	)

inlineoverridevirtual

Fallback implementation that uses DrawLine to draw a triangle (override this if you have a version that renders solid triangles)

Implements DebugRenderer.

◆ SetCameraPos()

void DebugRendererSimple::SetCameraPos ( RVec3Arg inCameraPos )

inline

Should be called every frame by the application to provide the camera position. This is used to determine the correct LOD for rendering.

The documentation for this class was generated from the following files:

Jolt/Renderer/DebugRendererSimple.h
Jolt/Renderer/DebugRendererSimple.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DebugRendererSimple()

Member Function Documentation

◆ CreateTriangleBatch() [1/2]

◆ CreateTriangleBatch() [2/2]

◆ DrawGeometry()

◆ DrawTriangle()

◆ SetCameraPos()