Protected Member Functions
Shape	AddBBox (vector min, vector max, int colour=DEFAULT_SHAPE_COLOUR, ShapeFlags additionalFlags=0)
Shape	AddLine (vector from, vector to, int colour=DEFAULT_SHAPE_COLOUR, ShapeFlags additionalFlags=0)
Shape	AddPolyLine (notnull array< vector > points, int colour=DEFAULT_SHAPE_COLOUR)
Shape	AddArrow (vector from, vector to, float customSize=0, int colour=DEFAULT_SHAPE_COLOUR, ShapeFlags additionalFlags=0)
Shape	AddCircleXZ (vector centre, float radius, int colour=DEFAULT_SHAPE_COLOUR)
Shape	AddCircleArcXZ (vector centre, float angleStartRad, float coveredAngleRad, float radius, int colour=DEFAULT_SHAPE_COLOUR)
Shape	AddCircleSliceXZ (vector centre, float angleStartRad, float coveredAngleRad, float radius, int colour=DEFAULT_SHAPE_COLOUR)
Shape	AddRectangle (vector origin, vector vectorDir, float length, float width, int colour=DEFAULT_SHAPE_COLOUR)
Shape	AddAABBRectangleXZ (vector min, vector max, int colour=DEFAULT_SHAPE_COLOUR)
Shape	AddRectangleXZ (vector origin, float directionRad, float length, float width, int colour=DEFAULT_SHAPE_COLOUR)
array< ref Shape >	AddParallelLines (vector origin, vector vectorDir, float length, float width, int colour=DEFAULT_SHAPE_COLOUR)
Shape	AddBounds (notnull array< vector > boundsPositionsWorldSpace, float height, vector upDirection=vector.Up, int colour=DEFAULT_SHAPE_COLOUR, ShapeFlags additionalFlags=0)
Shape	AddSphere (vector centre, float radius, int colour=DEFAULT_SHAPE_COLOUR, ShapeFlags additionalFlags=0)
Shape	AddTrapezoidalPrism (vector centerOfTopBasePos, vector directionUp, float smallBaseRadius, float largeBaseRadius, float height, int subdivisions=6, int colour=DEFAULT_SHAPE_COLOUR, ShapeFlags additionalFlags=0)
DebugTextWorldSpace	AddText (string text, vector worldPos, float size=2.0, int colour=DEFAULT_TEXT_COLOUR, int backgroundColour=DEFAULT_TEXT_BACKGROUND_COLOUR)
void	Add (notnull Shape shape)
void	Add (notnull DebugTextWorldSpace text)
void	Remove (notnull Shape shape)
void	Remove (notnull DebugTextWorldSpace text)
void	Clear ()
	Remove all stored shapes and texts.
void	ClearShapes ()
	Remove all stored shapes.
void	ClearTexts ()
	Remove all stored texts.

Protected Attributes
ref set< ref Shape >	m_Shapes = new set<ref Shape>()
ref set< ref DebugTextWorldSpace >	m_ScreenSpaceTexts = new set<ref DebugTextWorldSpace>()

Static Protected Attributes
static const int	DEFAULT_SHAPE_COLOUR = Color.RED
static const ShapeFlags	DEFAULT_SHAPE_FLAGS = ShapeFlags.NOZBUFFER \| ShapeFlags.TRANSP
static const int	DEFAULT_TEXT_COLOUR = Color.WHITE
static const int	DEFAULT_TEXT_BACKGROUND_COLOUR = 0x88000000
static const DebugTextFlags	DEFAULT_TEXT_FLAGS = DebugTextFlags.CENTER \| DebugTextFlags.FACE_CAMERA \| DebugTextFlags.IN_WORLD

Detailed Description

Definition at line 1 of file SCR_DebugShapeManager.c.

Member Function Documentation

◆ Add() [1/2]

void SCR_DebugShapeManager::Add ( notnull DebugTextWorldSpace text )

inlineprotected

Add an external text to be held by the manager

Parameters

[in] text

Definition at line 424 of file SCR_DebugShapeManager.c.

◆ Add() [2/2]

void SCR_DebugShapeManager::Add ( notnull Shape shape )

inlineprotected

Add an external shape to be held by the manager

Parameters

[in] shape

Definition at line 416 of file SCR_DebugShapeManager.c.

◆ AddAABBRectangleXZ()

Shape SCR_DebugShapeManager::AddAABBRectangleXZ	(	vector	min,
		vector	max,
		int	colour = DEFAULT_SHAPE_COLOUR )

inlineprotected

Create an axis-aligned horizontal rectangle

Parameters

[in]	min
[in]	max
[in]	colour	the shape's colour

Returns: the created horizontal rectangle

Definition at line 193 of file SCR_DebugShapeManager.c.

◆ AddArrow()

Shape SCR_DebugShapeManager::AddArrow	(	vector	from,
		vector	to,
		float	customSize = 0,
		int	colour = DEFAULT_SHAPE_COLOUR,
		ShapeFlags	additionalFlags = 0 )

inlineprotected

Create an arrow

Parameters

[in]	from	arrow's origin
[in]	to	arrrow's destination, the pointy thing
[in]	customSize	if set above zero arrow will use this value instead of 1/3 of arrow length - for a relative width, use vector.Distance(from, to) * wantedRatio
[in]	colour	the shape's colour
[in]	additionalFlags	additional Shape flags

Returns: the created arrow

Definition at line 75 of file SCR_DebugShapeManager.c.

◆ AddBBox()

Shape SCR_DebugShapeManager::AddBBox	(	vector	min,
		vector	max,
		int	colour = DEFAULT_SHAPE_COLOUR,
		ShapeFlags	additionalFlags = 0 )

inlineprotected

Create an axis-aligned bounding box

Parameters

[in]	min
[in]	max
[in]	colour	the shape's colour
[in]	additionalFlags	additional Shape flags

Returns: the created bounding box

Definition at line 20 of file SCR_DebugShapeManager.c.

◆ AddBounds()

Shape SCR_DebugShapeManager::AddBounds	(	notnull array< vector >	boundsPositionsWorldSpace,
		float	height,
		vector	upDirection = vector.Up,
		int	colour = DEFAULT_SHAPE_COLOUR,
		ShapeFlags	additionalFlags = 0 )

inlineprotected

Method used to create a boundary shape

Parameters

[in]	boundsPositionsWorldSpace	list points defining the base of the boundary
[in]	height	of the walls
[in]	upDirection
[in]	colour
[in]	additionalFlags

Returns: created shape

Definition at line 265 of file SCR_DebugShapeManager.c.

◆ AddCircleArcXZ()

Shape SCR_DebugShapeManager::AddCircleArcXZ	(	vector	centre,
		float	angleStartRad,
		float	coveredAngleRad,
		float	radius,
		int	colour = DEFAULT_SHAPE_COLOUR )

inlineprotected

Create a horizontal arc (portion of a circle)

Parameters

[in]	centre
[in]	angleStartRad	counter-clockwise radians
[in]	coveredAngleRad	counter-clockwise radians - can be negative
[in]	radius
[in]	colour	the shape's colour

Returns: the created arc

Definition at line 106 of file SCR_DebugShapeManager.c.

◆ AddCircleSliceXZ()

Shape SCR_DebugShapeManager::AddCircleSliceXZ	(	vector	centre,
		float	angleStartRad,
		float	coveredAngleRad,
		float	radius,
		int	colour = DEFAULT_SHAPE_COLOUR )

inlineprotected

Create a horizontal circle slice

Parameters

[in]	centre
[in]	angleStartRad	counter-clockwise radians
[in]	coveredAngleRad	counter-clockwise radians
[in]	radius
[in]	colour	the shape's colour

Returns: the created pie slice

Definition at line 135 of file SCR_DebugShapeManager.c.

◆ AddCircleXZ()

Shape SCR_DebugShapeManager::AddCircleXZ	(	vector	centre,
		float	radius,
		int	colour = DEFAULT_SHAPE_COLOUR )

inlineprotected

Create a horizontal circle

Parameters

[in]	centre
[in]	radius
[in]	colour	the shape's colour

Returns: the created circle

Definition at line 91 of file SCR_DebugShapeManager.c.

◆ AddLine()

Shape SCR_DebugShapeManager::AddLine	(	vector	from,
		vector	to,
		int	colour = DEFAULT_SHAPE_COLOUR,
		ShapeFlags	additionalFlags = 0 )

inlineprotected

Create a straight line

Parameters

[in]	from	origin
[in]	to	destination
[in]	colour	the shape's colour
[in]	additionalFlags	additional Shape flags

Returns: the created line

Definition at line 34 of file SCR_DebugShapeManager.c.

◆ AddParallelLines()

array< ref Shape > SCR_DebugShapeManager::AddParallelLines	(	vector	origin,
		vector	vectorDir,
		float	length,
		float	width,
		int	colour = DEFAULT_SHAPE_COLOUR )

inlineprotected

Create two parallel lines on the left and on the right of the provided virtual line

Parameters

[in]	origin
[in]	vectorDir	can be non-normalised
[in]	length
[in]	width
[in]	colour	the shape's colour

Returns: an array with the two created lines

Definition at line 242 of file SCR_DebugShapeManager.c.

◆ AddPolyLine()

Shape SCR_DebugShapeManager::AddPolyLine	(	notnull array< vector >	points,
		int	colour = DEFAULT_SHAPE_COLOUR )

inlineprotected

Create a polyline

Parameters

[in]	points	from 2 up to 50 points (array will be clipped)
[in]	colour	the shape's colour

Returns: the created polyline or null on error (e.g not enough points)

Definition at line 47 of file SCR_DebugShapeManager.c.

◆ AddRectangle()

Shape SCR_DebugShapeManager::AddRectangle	(	vector	origin,
		vector	vectorDir,
		float	length,
		float	width,
		int	colour = DEFAULT_SHAPE_COLOUR )

inlineprotected

Create a rectangle

Parameters

[in]	origin
[in]	vectorDir
[in]	length
[in]	width
[in]	colour	the shape's colour

Returns: the created rectangle

Definition at line 165 of file SCR_DebugShapeManager.c.

◆ AddRectangleXZ()

Shape SCR_DebugShapeManager::AddRectangleXZ	(	vector	origin,
		float	directionRad,
		float	length,
		float	width,
		int	colour = DEFAULT_SHAPE_COLOUR )

inlineprotected

Create a horizontal rectangle

Parameters

[in]	origin
[in]	directionRad	in counter-clockwise radians
[in]	length
[in]	width
[in]	colour	the shape's colour

Returns: the created horizontal rectangle

Definition at line 214 of file SCR_DebugShapeManager.c.

◆ AddSphere()

Shape SCR_DebugShapeManager::AddSphere	(	vector	centre,
		float	radius,
		int	colour = DEFAULT_SHAPE_COLOUR,
		ShapeFlags	additionalFlags = 0 )

inlineprotected

Create a sphere

Parameters

[in]	centre	world position of the sphere's centre
[in]	radius	radius in metres
[in]	colour	the shape's colour
[in]	additionalFlags	additional Shape flags

Returns: the created sphere

Definition at line 305 of file SCR_DebugShapeManager.c.

◆ AddText()

DebugTextWorldSpace SCR_DebugShapeManager::AddText	(	string	text,
		vector	worldPos,
		float	size = 2.0,
		int	colour = DEFAULT_TEXT_COLOUR,
		int	backgroundColour = DEFAULT_TEXT_BACKGROUND_COLOUR )

inlineprotected

Create a world space debug text label

Parameters

[in]	text
[in]	worldPos
[in]	size	in metres
[in]	colour
[in]	backgroundColour

Returns

Definition at line 387 of file SCR_DebugShapeManager.c.

◆ AddTrapezoidalPrism()

Shape SCR_DebugShapeManager::AddTrapezoidalPrism	(	vector	centerOfTopBasePos,
		vector	directionUp,
		float	smallBaseRadius,
		float	largeBaseRadius,
		float	height,
		int	subdivisions = 6,
		int	colour = DEFAULT_SHAPE_COLOUR,
		ShapeFlags	additionalFlags = 0 )

inlineprotected

Create a trapezoidal prism

Parameters

[in]	centerOfTopBasePos	position in worldspace that is the center of the smaller (top) base
[in]	directionUp	normalized direction in worldspace that points toward larger (bottom) base
[in]	smallBaseRadius
[in]	largeBaseRadius
[in]	height	distance between smaller (top) base and center of larger (bottom) base
[in]	subdivisions	min 2, max 50 (will be clamped if needed)
[in]	colour	the shape's colour
[in]	additionalFlags	additional Shape flags

Definition at line 322 of file SCR_DebugShapeManager.c.

◆ Clear()

void SCR_DebugShapeManager::Clear ( )

inlineprotected

Remove all stored shapes and texts.

Definition at line 447 of file SCR_DebugShapeManager.c.

◆ ClearShapes()

void SCR_DebugShapeManager::ClearShapes ( )

inlineprotected

Remove all stored shapes.

Definition at line 455 of file SCR_DebugShapeManager.c.

◆ ClearTexts()

void SCR_DebugShapeManager::ClearTexts ( )

inlineprotected

Remove all stored texts.

Definition at line 462 of file SCR_DebugShapeManager.c.

◆ Remove() [1/2]

void SCR_DebugShapeManager::Remove ( notnull DebugTextWorldSpace text )

inlineprotected

Remove the provided text, if managed

Parameters

[in] shape

Definition at line 440 of file SCR_DebugShapeManager.c.

◆ Remove() [2/2]

void SCR_DebugShapeManager::Remove ( notnull Shape shape )

inlineprotected

Remove the provided shape, if managed

Parameters

[in] shape

Definition at line 432 of file SCR_DebugShapeManager.c.

Member Data Documentation

◆ DEFAULT_SHAPE_COLOUR

const int SCR_DebugShapeManager::DEFAULT_SHAPE_COLOUR = Color.RED

staticprotected

Definition at line 6 of file SCR_DebugShapeManager.c.

◆ DEFAULT_SHAPE_FLAGS

const ShapeFlags SCR_DebugShapeManager::DEFAULT_SHAPE_FLAGS = ShapeFlags.NOZBUFFER | ShapeFlags.TRANSP

staticprotected

Definition at line 7 of file SCR_DebugShapeManager.c.

◆ DEFAULT_TEXT_BACKGROUND_COLOUR

const int SCR_DebugShapeManager::DEFAULT_TEXT_BACKGROUND_COLOUR = 0x88000000

staticprotected

Definition at line 10 of file SCR_DebugShapeManager.c.

◆ DEFAULT_TEXT_COLOUR

const int SCR_DebugShapeManager::DEFAULT_TEXT_COLOUR = Color.WHITE

staticprotected

Definition at line 9 of file SCR_DebugShapeManager.c.

◆ DEFAULT_TEXT_FLAGS

const DebugTextFlags SCR_DebugShapeManager::DEFAULT_TEXT_FLAGS = DebugTextFlags.CENTER | DebugTextFlags.FACE_CAMERA | DebugTextFlags.IN_WORLD

staticprotected

Definition at line 11 of file SCR_DebugShapeManager.c.

◆ m_ScreenSpaceTexts

ref set<ref DebugTextWorldSpace> SCR_DebugShapeManager::m_ScreenSpaceTexts = new set<ref DebugTextWorldSpace>()

protected

Definition at line 4 of file SCR_DebugShapeManager.c.

◆ m_Shapes

ref set<ref Shape> SCR_DebugShapeManager::m_Shapes = new set<ref Shape>()

protected

Definition at line 3 of file SCR_DebugShapeManager.c.

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

scripts/Game/Generators/Common/SCR_DebugShapeManager.c

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ AddAABBRectangleXZ()

◆ AddArrow()

◆ AddBBox()

◆ AddBounds()

◆ AddCircleArcXZ()

◆ AddCircleSliceXZ()

◆ AddCircleXZ()

◆ AddLine()

◆ AddParallelLines()

◆ AddPolyLine()

◆ AddRectangle()

◆ AddRectangleXZ()

◆ AddSphere()

◆ AddText()

◆ AddTrapezoidalPrism()

◆ Clear()

◆ ClearShapes()

◆ ClearTexts()

◆ Remove() [1/2]

◆ Remove() [2/2]

Member Data Documentation

◆ DEFAULT_SHAPE_COLOUR

◆ DEFAULT_SHAPE_FLAGS

◆ DEFAULT_TEXT_BACKGROUND_COLOUR

◆ DEFAULT_TEXT_COLOUR

◆ DEFAULT_TEXT_FLAGS

◆ m_ScreenSpaceTexts

◆ m_Shapes