IRenderAuxGeom

Auxiliary geometry render interface.

C++

struct IRenderAuxGeom {
};

File

IRenderAuxGeom.h

Description

Used mostly for debugging, editor purposes, the Auxiliary geometry render interface provide functions to render 2d geometry and also text.

IRenderAuxGeom::~IRenderAuxGeom Destructor

C++

virtual ~IRenderAuxGeom();

IRenderAuxGeom::DrawAABB Method (AABB&, Matrix34&, bool, ColorB&, EBoundingBoxDrawStyle&)

C++

virtual void DrawAABB(const AABB& aabb, const Matrix34& matWorld, bool bSolid, const ColorB& col, const EBoundingBoxDrawStyle& bbDrawStyle) = 0;

IRenderAuxGeom::DrawAABB Method (AABB&, bool, ColorB&, EBoundingBoxDrawStyle&)

Draws a Axis-aligned Bounding Boxes (AABB).

C++

virtual void DrawAABB(const AABB& aabb, bool bSolid, const ColorB& col, const EBoundingBoxDrawStyle& bbDrawStyle) = 0;

IRenderAuxGeom::DrawAABBs Method

C++

virtual void DrawAABBs(const AABB* aabbs, uint32 aabbCount, bool bSolid, const ColorB& col, const EBoundingBoxDrawStyle& bbDrawStyle) = 0;

IRenderAuxGeom::DrawBone Method

Draws bones.

C++

virtual void DrawBone(const Vec3& rParent, const Vec3& rBone, ColorB col) = 0;

IRenderAuxGeom::DrawCone Method

Draws a cone.

C++

virtual void DrawCone(const Vec3& pos, const Vec3& dir, float radius, float height, const ColorB& col, bool drawShaded = true) = 0;

Parameters

Parameters	Description
const Vec3& pos	Center of the base of the cone.
const Vec3& dir	Direction of the cone.
float radius	Radius of the base of the cone.
float height	Height of the cone.
const ColorB& col	Color of the cone.
bool drawShaded = true	True if you want to draw the cone shaded, false otherwise.

IRenderAuxGeom::DrawCylinder Method

Draws a cylinder.

C++

virtual void DrawCylinder(const Vec3& pos, const Vec3& dir, float radius, float height, const ColorB& col, bool drawShaded = true) = 0;

Parameters

Parameters	Description
const Vec3& pos	Center of the base of the cylinder.
const Vec3& dir	Direction of the cylinder.
float radius	Radius of the base of the cylinder.
float height	Height of the cylinder.
const ColorB& col	Color of the cylinder.
bool drawShaded = true	True if you want to draw the cylinder shaded, false otherwise.

IRenderAuxGeom::DrawLine Method

Draws a line.

C++

virtual void DrawLine(const Vec3& v0, const ColorB& colV0, const Vec3& v1, const ColorB& colV1, float thickness = 1.0f) = 0;

Parameters

Parameters	Description
const Vec3& v0	Starting vertex of the line.
const ColorB& colV0	Color of the first vertex.
const Vec3& v1	Ending vertex of the line.
const ColorB& colV1	Color of the second vertex.
float thickness = 1.0f	Thickness of the line.

IRenderAuxGeom::DrawLines Method (Vec3*, uint32, ColorB&, float)

Draws n lines.

C++

virtual void DrawLines(const Vec3* v, uint32 numPoints, const ColorB& col, float thickness = 1.0f) = 0;

Parameters

Parameters	Description
const Vec3* v	List of vertexes belonging to the lines we want to draw.
uint32 numPoints	Number of the points we will find starting from the area memory defined by v.
const ColorB& col	Color of the vertexes.
float thickness = 1.0f	Thickness of the line.

IRenderAuxGeom::DrawLines Method (Vec3*, uint32, ColorB*, float)

C++

virtual void DrawLines(const Vec3* v, uint32 numPoints, const ColorB* col, float thickness = 1.0f) = 0;

IRenderAuxGeom::DrawLines Method (Vec3*, uint32, vtx_idx*, uint32, ColorB&, float)

Draws n lines.

C++

virtual void DrawLines(const Vec3* v, uint32 numPoints, const vtx_idx* ind, uint32 numIndices, const ColorB& col, float thickness = 1.0f) = 0;

Parameters

Parameters	Description
const Vec3* v	List of vertexes belonging to the lines we want to draw.
uint32 numPoints	Number of the points we will find starting from the area memory defined by v.
const vtx_idx* ind	numIndices -
const ColorB& col	Color of the vertexes.
float thickness = 1.0f	Thickness of the line.

IRenderAuxGeom::DrawLines Method (Vec3*, uint32, vtx_idx*, uint32, ColorB*, float)

C++

virtual void DrawLines(const Vec3* v, uint32 numPoints, const vtx_idx* ind, uint32 numIndices, const ColorB* col, float thickness = 1.0f) = 0;

IRenderAuxGeom::DrawOBB Method (OBB&, Matrix34&, bool, ColorB&, EBoundingBoxDrawStyle&)

C++

virtual void DrawOBB(const OBB& obb, const Matrix34& matWorld, bool bSolid, const ColorB& col, const EBoundingBoxDrawStyle& bbDrawStyle) = 0;

IRenderAuxGeom::DrawOBB Method (OBB&, Vec3&, bool, ColorB&, EBoundingBoxDrawStyle&)

Draws a Oriented Bounding Boxes (AABB).

C++

virtual void DrawOBB(const OBB& obb, const Vec3& pos, bool bSolid, const ColorB& col, const EBoundingBoxDrawStyle& bbDrawStyle) = 0;

IRenderAuxGeom::DrawPoint Method

Draws a point.

C++

virtual void DrawPoint(const Vec3& v, const ColorB& col, uint8 size = 1) = 0;

Parameters

Parameters	Description
const Vec3& v	Vector storing the position of the point.
const ColorB& col	Color used to draw the point.
uint8 size = 1	Size of the point drawn.

IRenderAuxGeom::DrawPoints Method (Vec3*, uint32, ColorB&, uint8)

Draws n points.

C++

virtual void DrawPoints(const Vec3* v, uint32 numPoints, const ColorB& col, uint8 size = 1) = 0;

Parameters

Parameters	Description
const Vec3* v	Pointer to a list of vector storing the position of the points.
uint32 numPoints	Number of point we will find starting from the area memory defined by v.
const ColorB& col	Color used to draw the points.
uint8 size = 1	Size of the points drawn.

IRenderAuxGeom::DrawPoints Method (Vec3*, uint32, ColorB*, uint8)

C++

virtual void DrawPoints(const Vec3* v, uint32 numPoints, const ColorB* col, uint8 size = 1) = 0;

IRenderAuxGeom::DrawPolyline Method (Vec3*, uint32, bool, ColorB&, float)

Draws a polyline.

C++

virtual void DrawPolyline(const Vec3* v, uint32 numPoints, bool closed, const ColorB& col, float thickness = 1.0f) = 0;

Parameters

Parameters	Description
const Vec3* v	List of vertexes belonging to the polyline we want to draw.
uint32 numPoints	Number of the points we will find starting from the area memory defined by v.
bool closed	If true a line between the last vertex and the first one is drawn.
const ColorB& col	Color of the vertexes.
float thickness = 1.0f	Thickness of the line.

IRenderAuxGeom::DrawPolyline Method (Vec3*, uint32, bool, ColorB*, float)

C++

virtual void DrawPolyline(const Vec3* v, uint32 numPoints, bool closed, const ColorB* col, float thickness = 1.0f) = 0;

IRenderAuxGeom::DrawSphere Method

Draws a sphere.

C++

virtual void DrawSphere(const Vec3& pos, float radius, const ColorB& col, bool drawShaded = true) = 0;

Parameters

Parameters	Description
const Vec3& pos	Center of the sphere.
float radius	Radius of the sphere.
const ColorB& col	Color of the sphere.
bool drawShaded = true	True if you want to draw the sphere shaded, false otherwise.

IRenderAuxGeom::DrawTriangle Method

Draws a triangle.

C++

virtual void DrawTriangle(const Vec3& v0, const ColorB& colV0, const Vec3& v1, const ColorB& colV1, const Vec3& v2, const ColorB& colV2) = 0;

Parameters

Parameters	Description
const Vec3& v0	First vertex of the triangle.
const ColorB& colV0	Color of the first vertex of the triangle.
const Vec3& v1	Second vertex of the triangle.
const ColorB& colV1	Color of the second vertex of the triangle.
const Vec3& v2	Third vertex of the triangle.
const ColorB& colV2	Color of the third vertex of the triangle.

IRenderAuxGeom::DrawTriangles Method (Vec3*, uint32, ColorB&)

Draws n triangles.

C++

virtual void DrawTriangles(const Vec3* v, uint32 numPoints, const ColorB& col) = 0;

Parameters

Parameters	Description
const Vec3* v	List of vertexes belonging to the sequence of triangles we have to draw.
uint32 numPoints	Number of the points we will find starting from the area memory defined by v.
const ColorB& col	Color of the vertexes.

IRenderAuxGeom::DrawTriangles Method (Vec3*, uint32, ColorB*)

C++

virtual void DrawTriangles(const Vec3* v, uint32 numPoints, const ColorB* col) = 0;

IRenderAuxGeom::DrawTriangles Method (Vec3*, uint32, vtx_idx*, uint32, ColorB&)

Draws n triangles.

C++

virtual void DrawTriangles(const Vec3* v, uint32 numPoints, const vtx_idx* ind, uint32 numIndices, const ColorB& col) = 0;

Parameters

Parameters	Description
const Vec3* v	List of vertexes belonging to the sequence of triangles we have to draw.
uint32 numPoints	Number of the points we will find starting from the area memory defined by v.
const vtx_idx* ind	numIndices -
const ColorB& col	Color of the vertexes.

IRenderAuxGeom::DrawTriangles Method (Vec3*, uint32, vtx_idx*, uint32, ColorB*)

C++

virtual void DrawTriangles(const Vec3* v, uint32 numPoints, const vtx_idx* ind, uint32 numIndices, const ColorB* col) = 0;

IRenderAuxGeom::Flush Method

Flushes elements stored on the buffer to the screen.

C++

virtual void Flush() = 0;

IRenderAuxGeom::GetRenderFlags Method

Gets render flags.

C++

virtual SAuxGeomRenderFlags GetRenderFlags() = 0;

IRenderAuxGeom::SetRenderFlags Method

Sets render flags.

C++

virtual void SetRenderFlags(const SAuxGeomRenderFlags& renderFlags) = 0;

Documentation

IRenderAuxGeom