IPersistantDebug

Public Member Functions | List of all members

IPersistantDebugabstract

#include

Public Member Functions
virtual void	Begin (const char *szName, bool clear)=0

virtual void	AddSphere (const Vec3 &pos, float radius, ColorF clr, float timeout)=0

virtual void	AddDirection (const Vec3 &pos, float radius, const Vec3 &dir, ColorF clr, float timeout)=0

virtual void	AddLine (const Vec3 &pos1, const Vec3 &pos2, ColorF clr, float timeout)=0

virtual void	AddPlanarDisc (const Vec3 &pos, float innerRadius, float outerRadius, ColorF clr, float timeout)=0

virtual void	AddCone (const Vec3 &pos, const Vec3 &dir, float baseRadius, float height, ColorF clr, float timeout)=0

virtual void	AddCylinder (const Vec3 &pos, const Vec3 &dir, float radius, float height, ColorF clr, float timeout)=0

virtual void	Add2DText (const char *szText, float size, ColorF clr, float timeout)=0

virtual void	AddText (float x, float y, float size, ColorF clr, float timeout, const char *fmt,...)=0

virtual void	AddText3D (const Vec3 &pos, float size, ColorF clr, float timeout, const char *fmt,...)=0

virtual void	Add2DLine (float x1, float y1, float x2, float y2, ColorF clr, float timeout)=0

virtual void	AddQuat (const Vec3 &pos, const Quat &q, float r, ColorF clr, float timeout)=0

virtual void	AddAABB (const Vec3 &min, const Vec3 &max, ColorF clr, float timeout)=0

virtual void	AddEntityTag (const SEntityTagParams &params, const char *tagContext="")=0

virtual void	ClearEntityTags (EntityId entityId)=0
	Clears all entity tags for the specified entity.

virtual void	ClearStaticTag (EntityId entityId, const char *staticId)=0
	Clears a specific tag for the specified entity.

virtual void	ClearTagContext (const char *tagContext)=0
	Clears all entity tags by context.

virtual void	ClearTagContext (const char *tagContext, EntityId entityId)=0
	Clears all entity tags by context, for a specific entity instance.

virtual void	Update (float frameTime)=0

virtual void	PostUpdate (float frameTime)=0

virtual void	Reset ()=0

Detailed Description

Persistent debug exposes functionality for drawing debug geometry over a specific period of time, without having to continuously re-render manually each frmae. This can be extremely useful to debug gameplay logic.

Member Function Documentation

◆ Add2DLine()

virtual void IPersistantDebug::Add2DLine	(	float	x1,
		float	y1,
		float	x2,
		float	y2,
		ColorF	clr,
		float	timeout
	)

pure virtual

Adds a 2D line on screen

Parameters

x1	X axis coordinate in screen space where the line starts
y1	Y axis coordinate in screen space where the line starts
x2	X axis coordinate in screen space where the line ends
y2	Y axis coordinate in screen space where the line ends
clr	Color of the debug geometry
timeout	Timeout in seconds after which the item will stop rendering

◆ Add2DText()

virtual void IPersistantDebug::Add2DText	(	const char *	szText,
		float	size,
		ColorF	clr,
		float	timeout
	)

pure virtual

Adds 2D text on screen

Parameters

szText	Text message to draw
size	Size of the text
clr	Color of the debug geometry
timeout	Timeout in seconds after which the item will stop rendering

◆ AddAABB()

virtual void IPersistantDebug::AddAABB	(	const Vec3 &	min,
		const Vec3 &	max,
		ColorF	clr,
		float	timeout
	)

pure virtual

Adds an axis-aligned bounding box

Parameters

min	Starting coordinates of the bounding box
min	End coordinates of the bounding box
clr	Color of the debug geometry
timeout	Timeout in seconds after which the item will stop rendering

◆ AddCone()

virtual void IPersistantDebug::AddCone	(	const Vec3 &	pos,
		const Vec3 &	dir,
		float	baseRadius,
		float	height,
		ColorF	clr,
		float	timeout
	)

pure virtual

Parameters

pos	The world coordinates to draw this object at
dir	The direction in which the cone will point
baseRadius	Radius of the cone at its base
height	Height of the cone
clr	Color of the debug geometry
timeout	Timeout in seconds after which the item will stop rendering

◆ AddCylinder()

virtual void IPersistantDebug::AddCylinder	(	const Vec3 &	pos,
		const Vec3 &	dir,
		float	radius,
		float	height,
		ColorF	clr,
		float	timeout
	)

pure virtual

Adds a cylinder at the specified coordinates

Parameters

pos	The world coordinates to draw this object at
dir	Direction in which the cylinder will point
radius	Radius of the cylinder
height	Height of the cylinder
clr	Color of the debug geometry
timeout	Timeout in seconds after which the item will stop rendering

◆ AddDirection()

virtual void IPersistantDebug::AddDirection	(	const Vec3 &	pos,
		float	radius,
		const Vec3 &	dir,
		ColorF	clr,
		float	timeout
	)

pure virtual

Adds a persistent direction indicator at the specified location

Parameters

pos	The world coordinates to draw this object at
radius	Radius of the directional indicator
dir	Directional vector we want to visualize
clr	Color of the debug geometry
timeout	Timeout in seconds after which the item will stop rendering

◆ AddEntityTag()

virtual void IPersistantDebug::AddEntityTag	(	const SEntityTagParams &	params,
		const char *	tagContext = `""`
	)

pure virtual

Adds a tag above the specified entity, using the specified parameters

Parameters

params	Parameters describing the tag
The	context in which we'll add the tag

◆ AddLine()

virtual void IPersistantDebug::AddLine	(	const Vec3 &	pos1,
		const Vec3 &	pos2,
		ColorF	clr,
		float	timeout
	)

pure virtual

Adds a persistent line at the specified coordinates

Parameters

pos1	Origin of the line, in world coordinates
pos2	End point of the line, in world coordinates
clr	Color of the debug geometry
timeout	Timeout in seconds after which the item will stop rendering

◆ AddPlanarDisc()

virtual void IPersistantDebug::AddPlanarDisc	(	const Vec3 &	pos,
		float	innerRadius,
		float	outerRadius,
		ColorF	clr,
		float	timeout
	)

pure virtual

Adds a planar disc to the specified coordinates

Parameters

pos	The world coordinates to draw this object at
innerRadius	The inner radius of the disc
outerRadius	The outer radius of the disc
clr	Color of the debug geometry
timeout	Timeout in seconds after which the item will stop rendering

◆ AddQuat()

virtual void IPersistantDebug::AddQuat	(	const Vec3 &	pos,
		const Quat &	q,
		float	r,
		ColorF	clr,
		float	timeout
	)

pure virtual

Adds a visualized quaternion to the specified coordinates

Parameters

pos	The world coordinates to draw this object at
q	The quaternion to visualize
r	Radius of the helper
clr	Color of the debug geometry
timeout	Timeout in seconds after which the item will stop rendering

◆ AddSphere()

virtual void IPersistantDebug::AddSphere	(	const Vec3 &	pos,
		float	radius,
		ColorF	clr,
		float	timeout
	)

pure virtual

Adds a persistent sphere at the specified location

Parameters

pos	The world coordinates to draw this object at
radius	Radius of the sphere
clr	Color of the debug geometry
timeout	Timeout in seconds after which the item will stop rendering

◆ AddText()

virtual void IPersistantDebug::AddText	(	float	x,
		float	y,
		float	size,
		ColorF	clr,
		float	timeout,
		const char *	fmt,
			...
	)

pure virtual

Adds 2D text to the specified screen coordinates

Parameters

x	X axis coordinate in screen space
y	Y axis coordinate in screen space
size	Size of the text
clr	Color of the debug geometry
timeout	Timeout in seconds after which the item will stop rendering
fmt...	printf style text message to be drawn on screen

◆ AddText3D()

virtual void IPersistantDebug::AddText3D	(	const Vec3 &	pos,
		float	size,
		ColorF	clr,
		float	timeout,
		const char *	fmt,
			...
	)

pure virtual

Adds 3D text to the specified world coordinates

Parameters

pos	The world coordinates to draw this object at
size	Size of the text
clr	Color of the debug geometry
timeout	Timeout in seconds after which the item will stop rendering
fmt...	printf style text message to be drawn on screen

◆ Begin()

virtual void IPersistantDebug::Begin	(	const char *	szName,
		bool	clear
	)

pure virtual

Starts a persistent debug drawing group It is mandatory to call this function before invoking any of the Add* functions!

Parameters

szName	The name of the group
clear	Whether or not to clear any persistent drawing done to the specified group before