#include <AuxGeomDrawQueue.h>

Inherits AZ::RPI::AuxGeomDraw.

Public Member Functions
	AZ_CLASS_ALLOCATOR (AuxGeomDrawQueue, AZ::SystemAllocator)

int32_t	AddViewProjOverride (const AZ::Matrix4x4 &viewProj) override

int32_t	GetOrAdd2DViewProjOverride () override

void	SetPointSize (float pointSize) override

float	GetPointSize () override

void	DrawPoints (const AuxGeomDynamicDrawArguments &args) override

void	DrawLines (const AuxGeomDynamicDrawArguments &args) override

void	DrawLines (const AuxGeomDynamicIndexedDrawArguments &args) override

void	DrawPolylines (const AuxGeomDynamicDrawArguments &args, PolylineEnd end=PolylineEnd::Open) override

void	DrawTriangles (const AuxGeomDynamicDrawArguments &args, FaceCullMode faceCull=FaceCullMode::None) override

void	DrawTriangles (const AuxGeomDynamicIndexedDrawArguments &args, FaceCullMode faceCull=FaceCullMode::None) override

void	DrawQuad (float width, float height, const AZ::Matrix3x4 &transform, const AZ::Color &color, DrawStyle style, DepthTest depthTest, DepthWrite depthWrite, FaceCullMode faceCull, int32_t viewProjOverrideIndex) override

void	DrawSphere (const AZ::Vector3 &center, float radius, const AZ::Color &color, DrawStyle style, DepthTest depthTest, DepthWrite depthWrite, FaceCullMode faceCull, int32_t viewProjOverrideIndex) override

void	DrawSphere (const AZ::Vector3 &center, const AZ::Vector3 &direction, float radius, const AZ::Color &color, DrawStyle style, DepthTest depthTest, DepthWrite depthWrite, FaceCullMode faceCull, int32_t viewProjOverrideIndex) override

void	DrawHemisphere (const AZ::Vector3 &center, const AZ::Vector3 &direction, float radius, const AZ::Color &color, DrawStyle style, DepthTest depthTest, DepthWrite depthWrite, FaceCullMode faceCull, int32_t viewProjOverrideIndex) override

void	DrawDisk (const AZ::Vector3 &center, const AZ::Vector3 &direction, float radius, const AZ::Color &color, DrawStyle style, DepthTest depthTest, DepthWrite depthWrite, FaceCullMode faceCull, int32_t viewProjOverrideIndex) override

void	DrawCone (const AZ::Vector3 &center, const AZ::Vector3 &direction, float radius, float height, const AZ::Color &color, DrawStyle style, DepthTest depthTest, DepthWrite depthWrite, FaceCullMode faceCull, int32_t viewProjOverrideIndex) override

void	DrawCylinder (const AZ::Vector3 &center, const AZ::Vector3 &direction, float radius, float height, const AZ::Color &color, DrawStyle style, DepthTest depthTest, DepthWrite depthWrite, FaceCullMode faceCull, int32_t viewProjOverrideIndex) override

void	DrawCylinderNoEnds (const AZ::Vector3 &center, const AZ::Vector3 &direction, float radius, float height, const AZ::Color &color, DrawStyle style, DepthTest depthTest, DepthWrite depthWrite, FaceCullMode faceCull, int32_t viewProjOverrideIndex) override

void	DrawAabb (const AZ::Aabb &aabb, const AZ::Color &color, DrawStyle style, DepthTest depthTest, DepthWrite depthWrite, FaceCullMode faceCull, int32_t viewProjOverrideIndex) override

void	DrawAabb (const AZ::Aabb &aabb, const AZ::Matrix3x4 &transform, const AZ::Color &color, DrawStyle style, DepthTest depthTest, DepthWrite depthWrite, FaceCullMode faceCull, int32_t viewProjOverrideIndex) override

void	DrawObb (const AZ::Obb &obb, const AZ::Vector3 &position, const AZ::Color &color, DrawStyle style, DepthTest depthTest, DepthWrite depthWrite, FaceCullMode faceCull, int32_t viewProjOverrideIndex) override

void	DrawObb (const AZ::Obb &obb, const AZ::Matrix3x4 &transform, const AZ::Color &color, DrawStyle style, DepthTest depthTest, DepthWrite depthWrite, FaceCullMode faceCull, int32_t viewProjOverrideIndex) override

void	DrawFrustum (const AZ::Frustum &frustum, const AZ::Color &color, bool drawNormals, DrawStyle style, DepthTest depthTest, DepthWrite depthWrite, FaceCullMode faceCull, int32_t viewProjOverrideIndex) override

AuxGeomBufferData *	Commit ()
	Switch clients of AuxGeom to using a different buffer and return the filled buffer for processing.

Additional Inherited Members
Public Types inherited from AZ::RPI::AuxGeomDraw
enum class	DrawStyle : uint8_t { Point , Line , Solid , Shaded }

enum class	DepthTest : uint8_t { On , Off }

enum class	DepthWrite : uint8_t { On , Off }

enum class	FaceCullMode : uint8_t { None , Front , Back }

enum class	PolylineEnd : uint8_t { Open , Closed }

enum class	OpacityType : uint8_t { Opaque , Translucent }

Detailed Description

Class that stores up AuxGeom draw requests for one RPI scene. This acts somewhat like a render proxy in that it stores data that is consumed by the feature processor.

Member Function Documentation

◆ AddViewProjOverride()

int32_t AZ::Render::AuxGeomDrawQueue::AddViewProjOverride ( const AZ::Matrix4x4 & viewProj )

overridevirtual

Implements AZ::RPI::AuxGeomDraw.

◆ DrawAabb() [1/2]

void AZ::Render::AuxGeomDrawQueue::DrawAabb	(	const AZ::Aabb &	aabb,
		const AZ::Color &	color,
		DrawStyle	style,
		DepthTest	depthTest,
		DepthWrite	depthWrite,
		FaceCullMode	faceCull,
		int32_t	viewProjOverrideIndex
	)

overridevirtual

Draw an axis-aligned bounding box with no transform.

Parameters

aabb	The AABB (typically the bounding box of a set of world space points).
color	The color to draw the box.
style	The draw style (point, wireframe, solid, shaded etc).
depthTest	If depth testing should be enabled
depthWrite	If depth writing should be enabled
faceCull	Which (if any) facing triangles should be culled
viewProjOverrideIndex	Which view projection override entry to use, -1 if unused

Implements AZ::RPI::AuxGeomDraw.

◆ DrawAabb() [2/2]

void AZ::Render::AuxGeomDrawQueue::DrawAabb	(	const AZ::Aabb &	aabb,
		const AZ::Matrix3x4 &	transform,
		const AZ::Color &	color,
		DrawStyle	style,
		DepthTest	depthTest,
		DepthWrite	depthWrite,
		FaceCullMode	faceCull,
		int32_t	viewProjOverrideIndex
	)

overridevirtual

Parameters

style	The draw style (point, wireframe, solid, shaded etc).
depthTest	If depth testing should be enabled
depthWrite	If depth writing should be enabled
faceCull	Which (if any) facing triangles should be culled
viewProjOverrideIndex	Which view projection override entry to use, -1 if unused

Implements AZ::RPI::AuxGeomDraw.

◆ DrawCone()

void AZ::Render::AuxGeomDrawQueue::DrawCone	(	const AZ::Vector3 &	center,
		const AZ::Vector3 &	direction,
		float	radius,
		float	height,
		const AZ::Color &	color,
		DrawStyle	style,
		DepthTest	depthTest,
		DepthWrite	depthWrite,
		FaceCullMode	faceCull,
		int32_t	viewProjOverrideIndex
	)

overridevirtual

Draw a cone.

Parameters

center	The center of the cone base.
direction	The direction vector. This is the vector from the center of the base to the point at the tip.
radius	The radius.
height	The height of the cone (the distance from the base center to the tip).
color	The color to draw the cone.
style	The draw style (point, wireframe, solid, shaded etc).
depthTest	If depth testing should be enabled
depthWrite	If depth writing should be enabled
faceCull	Which (if any) facing triangles should be culled
viewProjOverrideIndex	Which view projection override entry to use, -1 if unused

Implements AZ::RPI::AuxGeomDraw.

◆ DrawCylinder()

void AZ::Render::AuxGeomDrawQueue::DrawCylinder	(	const AZ::Vector3 &	center,
		const AZ::Vector3 &	direction,
		float	radius,
		float	height,
		const AZ::Color &	color,
		DrawStyle	style,
		DepthTest	depthTest,
		DepthWrite	depthWrite,
		FaceCullMode	faceCull,
		int32_t	viewProjOverrideIndex
	)

overridevirtual

Draw a cylinder (with flat disks on the end).

Parameters

center	The center of the base circle.
direction	The direction vector. The top end cap of the cylinder will face along this vector.
radius	The radius.
height	The height of the cylinder.
color	The color to draw the cylinder.
style	The draw style (point, wireframe, solid, shaded etc).
depthTest	If depth testing should be enabled
depthWrite	If depth writing should be enabled
faceCull	Which (if any) facing triangles should be culled
viewProjOverrideIndex	Which view projection override entry to use, -1 if unused

Implements AZ::RPI::AuxGeomDraw.

◆ DrawCylinderNoEnds()

void AZ::Render::AuxGeomDrawQueue::DrawCylinderNoEnds	(	const AZ::Vector3 &	center,
		const AZ::Vector3 &	direction,
		float	radius,
		float	height,
		const AZ::Color &	color,
		DrawStyle	style,
		DepthTest	depthTest,
		DepthWrite	depthWrite,
		FaceCullMode	faceCull,
		int32_t	viewProjOverrideIndex
	)

overridevirtual

Draw a cylinder without flat disk on the end.

Parameters

center	The center of the base circle.
direction	The direction vector. The top end cap of the cylinder will face along this vector.
radius	The radius.
height	The height of the cylinder.
color	The color to draw the cylinder.
style	The draw style (point, wireframe, solid, shaded etc).
depthTest	If depth testing should be enabled
depthWrite	If depth writing should be enabled
faceCull	Which (if any) facing triangles should be culled
viewProjOverrideIndex	Which view projection override entry to use, -1 if unused

Implements AZ::RPI::AuxGeomDraw.

◆ DrawDisk()

void AZ::Render::AuxGeomDrawQueue::DrawDisk	(	const AZ::Vector3 &	center,
		const AZ::Vector3 &	direction,
		float	radius,
		const AZ::Color &	color,
		DrawStyle	style,
		DepthTest	depthTest,
		DepthWrite	depthWrite,
		FaceCullMode	faceCull,
		int32_t	viewProjOverrideIndex
	)

overridevirtual

Draw a disk.

Parameters

center	The center of the disk.
direction	The direction vector. The disk will be orthogonal this vector.
radius	The radius of the disk.
color	The color to draw the disk.
style	The draw style (point, wireframe, solid, shaded etc).
depthTest	If depth testing should be enabled
depthWrite	If depth writing should be enabled
faceCull	Which (if any) facing triangles should be culled
viewProjOverrideIndex	Which view projection override entry to use, -1 if unused

Implements AZ::RPI::AuxGeomDraw.

◆ DrawFrustum()

void AZ::Render::AuxGeomDrawQueue::DrawFrustum	(	const AZ::Frustum &	frustum,
		const AZ::Color &	color,
		bool	drawNormals,
		DrawStyle	style,
		DepthTest	depthTest,
		DepthWrite	depthWrite,
		FaceCullMode	faceCull,
		int32_t	viewProjOverrideIndex
	)

overridevirtual

Draw a frustum.

Parameters

frustum	The frustum
color	The color to draw the frustum
drawNormals	If true, frustum plane normals will be drawn as lines
style	The draw style (point, wireframe, solid) Shaded not currently supported.
depthTest	If depth testing should be enabled
depthWrite	If depth writing should be enabled
faceCull	Which (if any) facing triangles should be culled
viewProjOverrideIndex	Which view projection override entry to use, -1 if unused

Implements AZ::RPI::AuxGeomDraw.

◆ DrawHemisphere()

void AZ::Render::AuxGeomDrawQueue::DrawHemisphere	(	const AZ::Vector3 &	center,
		const AZ::Vector3 &	direction,
		float	radius,
		const AZ::Color &	color,
		DrawStyle	style,
		DepthTest	depthTest,
		DepthWrite	depthWrite,
		FaceCullMode	faceCull,
		int32_t	viewProjOverrideIndex
	)

overridevirtual

Draw a hemisphere.

Parameters

center	The center of the sphere.
direction	The direction vector. The Pole of the hemisphere will point along this vector.
radius	The radius.
color	The color to draw the sphere.
style	The draw style (point, wireframe, solid, shaded etc).
depthTest	If depth testing should be enabled
depthWrite	If depth writing should be enabled
faceCull	Which (if any) facing triangles should be culled
viewProjOverrideIndex	Which view projection override entry to use, -1 if unused

Implements AZ::RPI::AuxGeomDraw.

◆ DrawLines() [1/2]

void AZ::Render::AuxGeomDrawQueue::DrawLines ( const AuxGeomDynamicDrawArguments & args )

overridevirtual

Implements AZ::RPI::AuxGeomDraw.

◆ DrawLines() [2/2]

void AZ::Render::AuxGeomDrawQueue::DrawLines ( const AuxGeomDynamicIndexedDrawArguments & args )

overridevirtual

Implements AZ::RPI::AuxGeomDraw.

◆ DrawObb() [1/2]

void AZ::Render::AuxGeomDrawQueue::DrawObb	(	const AZ::Obb &	obb,
		const AZ::Matrix3x4 &	transform,
		const AZ::Color &	color,
		DrawStyle	style,
		DepthTest	depthTest,
		DepthWrite	depthWrite,
		FaceCullMode	faceCull,
		int32_t	viewProjOverrideIndex
	)

overridevirtual

Parameters

style	The draw style (point, wireframe, solid, shaded etc).
depthTest	If depth testing should be enabled
depthWrite	If depth writing should be enabled
faceCull	Which (if any) facing triangles should be culled
viewProjOverrideIndex	Which view projection override entry to use, -1 if unused

Implements AZ::RPI::AuxGeomDraw.

◆ DrawObb() [2/2]

void AZ::Render::AuxGeomDrawQueue::DrawObb	(	const AZ::Obb &	obb,
		const AZ::Vector3 &	position,
		const AZ::Color &	color,
		DrawStyle	style,
		DepthTest	depthTest,
		DepthWrite	depthWrite,
		FaceCullMode	faceCull,
		int32_t	viewProjOverrideIndex
	)

overridevirtual

Draw an oriented bounding box with a given position.

Parameters

obb	The OBB (typically an oriented bounding box in model space).
position	The position to translate the origin of the OBB to.
color	The color to draw the box.
style	The draw style (point, wireframe, solid, shaded etc).
depthTest	If depth testing should be enabled
depthWrite	If depth writing should be enabled
faceCull	Which (if any) facing triangles should be culled
viewProjOverrideIndex	Which view projection override entry to use, -1 if unused

Implements AZ::RPI::AuxGeomDraw.

◆ DrawPoints()

void AZ::Render::AuxGeomDrawQueue::DrawPoints ( const AuxGeomDynamicDrawArguments & args )

overridevirtual

Implements AZ::RPI::AuxGeomDraw.

◆ DrawPolylines()

void AZ::Render::AuxGeomDrawQueue::DrawPolylines	(	const AuxGeomDynamicDrawArguments &	args,
		PolylineEnd	end = `PolylineEnd::Open`
	)

overridevirtual

Parameters

closed If true then a line will be drawn from the last point to the first.

Implements AZ::RPI::AuxGeomDraw.

◆ DrawQuad()

void AZ::Render::AuxGeomDrawQueue::DrawQuad	(	float	width,
		float	height,
		const AZ::Matrix3x4 &	transform,
		const AZ::Color &	color,
		DrawStyle	style,
		DepthTest	depthTest,
		DepthWrite	depthWrite,
		FaceCullMode	faceCull,
		int32_t	viewProjOverrideIndex
	)

overridevirtual

Draw a quad.

Parameters

width	The width of the quad.
height	The height of the quad.
transform	The world space transform for the quad.
color	The color to draw the quad.
style	The draw style (point, wireframe, solid, shaded etc).
depthTest	If depth testing should be enabled
depthWrite	If depth writing should be enabled
faceCull	Which (if any) facing triangles should be culled
viewProjOverrideIndex	Which view projection override entry to use, -1 if unused

Implements AZ::RPI::AuxGeomDraw.

◆ DrawSphere() [1/2]

void AZ::Render::AuxGeomDrawQueue::DrawSphere	(	const AZ::Vector3 &	center,
		const AZ::Vector3 &	direction,
		float	radius,
		const AZ::Color &	color,
		DrawStyle	style,
		DepthTest	depthTest,
		DepthWrite	depthWrite,
		FaceCullMode	faceCull,
		int32_t	viewProjOverrideIndex
	)

overridevirtual

Draw a sphere.

Parameters

center	The center of the sphere.
direction	The direction vector. The Pole of the hemisphere will point along this vector.
radius	The radius.
color	The color to draw the sphere.
style	The draw style (point, wireframe, solid, shaded etc).
depthTest	If depth testing should be enabled
depthWrite	If depth writing should be enabled
faceCull	Which (if any) facing triangles should be culled
viewProjOverrideIndex	Which view projection override entry to use, -1 if unused

Implements AZ::RPI::AuxGeomDraw.

◆ DrawSphere() [2/2]

void AZ::Render::AuxGeomDrawQueue::DrawSphere	(	const AZ::Vector3 &	center,
		float	radius,
		const AZ::Color &	color,
		DrawStyle	style,
		DepthTest	depthTest,
		DepthWrite	depthWrite,
		FaceCullMode	faceCull,
		int32_t	viewProjOverrideIndex
	)

overridevirtual

Draw a sphere.

Parameters

center	The center of the sphere.
radius	The radius.
color	The color to draw the sphere.
style	The draw style (point, wireframe, solid, shaded etc).
depthTest	If depth testing should be enabled
depthWrite	If depth writing should be enabled
faceCull	Which (if any) facing triangles should be culled
viewProjOverrideIndex	Which view projection override entry to use, -1 if unused

Implements AZ::RPI::AuxGeomDraw.

◆ DrawTriangles() [1/2]

void AZ::Render::AuxGeomDrawQueue::DrawTriangles	(	const AuxGeomDynamicDrawArguments &	args,
		FaceCullMode	faceCull = `FaceCullMode::None`
	)

overridevirtual

Parameters

faceCull Which (if any) facing triangles should be culled

Implements AZ::RPI::AuxGeomDraw.

◆ DrawTriangles() [2/2]

void AZ::Render::AuxGeomDrawQueue::DrawTriangles	(	const AuxGeomDynamicIndexedDrawArguments &	args,
		FaceCullMode	faceCull = `FaceCullMode::None`
	)

overridevirtual

Implements AZ::RPI::AuxGeomDraw.

◆ GetOrAdd2DViewProjOverride()

int32_t AZ::Render::AuxGeomDrawQueue::GetOrAdd2DViewProjOverride ( )

overridevirtual

Implements AZ::RPI::AuxGeomDraw.

◆ GetPointSize()

float AZ::Render::AuxGeomDrawQueue::GetPointSize ( )

overridevirtual

Implements AZ::RPI::AuxGeomDraw.

◆ SetPointSize()

void AZ::Render::AuxGeomDrawQueue::SetPointSize ( float pointSize )

overridevirtual

Implements AZ::RPI::AuxGeomDraw.

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

Gems/Atom/Feature/Common/Code/Source/AuxGeom/AuxGeomDrawQueue.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddViewProjOverride()

◆ DrawAabb() [1/2]

◆ DrawAabb() [2/2]

◆ DrawCone()

◆ DrawCylinder()

◆ DrawCylinderNoEnds()

◆ DrawDisk()

◆ DrawFrustum()

◆ DrawHemisphere()

◆ DrawLines() [1/2]

◆ DrawLines() [2/2]

◆ DrawObb() [1/2]

◆ DrawObb() [2/2]

◆ DrawPoints()

◆ DrawPolylines()

◆ DrawQuad()

◆ DrawSphere() [1/2]

◆ DrawSphere() [2/2]

◆ DrawTriangles() [1/2]

◆ DrawTriangles() [2/2]

◆ GetOrAdd2DViewProjOverride()

◆ GetPointSize()

◆ SetPointSize()