C++ namespace Rendering::Resources::Mesh::Mesh Builder::WireShapes
WireShapes

Description

Functions

Mesh *	createWireBox(const VertexDescription & vd, const Geometry::Box & box)
void	addWireBox( MeshBuilder & mb, const Geometry::Box & box) Adds a wireframe box to the given meshBuilder.
Mesh *	createWireRectangle(const VertexDescription & vd, const Geometry::Rect & rect)
void	addWireRectangle( MeshBuilder & mb, const Geometry::Rect & rect) Adds an rectangle to the given meshBuilder.
Mesh *	createWireSphere(const VertexDescription & vd, const Geometry::Sphere & sphere, uint8_t numSegments)
void	addWireSphere( MeshBuilder & mb, const Geometry::Sphere & sphere, uint8_t numSegments) Adds a shere to the given meshBuilder.
Mesh *	createWireCircle(const VertexDescription & vd, float radius, uint8_t numSegments)
void	addWireCircle( MeshBuilder & mb, float radius, uint8_t numSegments) Adds a wireframe circle to the given meshBuilder.
Mesh *	createWireFrustum(const VertexDescription & vd, const Geometry::Frustum & frustum)
void	addWireFrustum( MeshBuilder & mb, const Geometry::Frustum & frustum) Adds a wireframe frustum to the given meshBuilder.
Mesh *	createLine(const VertexDescription & vd, const Geometry::Vec3 & start, const Geometry::Vec3 & end)
void	addLine( MeshBuilder & mb, const Geometry::Vec3 & start, const Geometry::Vec3 & end) Adds a line to the given meshBuilder.

---

Documentation

function
Rendering::MeshUtils::WireShapes::createWireBox

public

Mesh * createWireBox(	const VertexDescription &	vd,
	const Geometry::Box &	box
)

Return the wireframe mesh of a three-dimensional, axis-aligned box.

Parameters

vd

Vertex description specifying the vertex information to generate

box

Geometric specification of the box

Returns

Mesh of the box

_{Defined in Rendering/MeshUtils/WireShapes.h:49}

---

function
Rendering::MeshUtils::WireShapes::addWireBox

public

void addWireBox(	MeshBuilder &	mb,
	const Geometry::Box &	box
)

Adds a wireframe box to the given meshBuilder.

See also: createWireBox (…)

_{Defined in Rendering/MeshUtils/WireShapes.h:52}

---

function
Rendering::MeshUtils::WireShapes::createWireRectangle

public

Mesh * createWireRectangle(	const VertexDescription &	vd,
	const Geometry::Rect &	rect
)

Returns a wireframe rectangle (oriented in x-y-plane)

Parameters

vd

Vertex description specifying the vertex information to generate

rect

the rectangle

Returns

Rectangle Mesh

_{Defined in Rendering/MeshUtils/WireShapes.h:61}

---

function
Rendering::MeshUtils::WireShapes::addWireRectangle

public

void addWireRectangle(	MeshBuilder &	mb,
	const Geometry::Rect &	rect
)

Adds an rectangle to the given meshBuilder.

See also: createWireRectangle (…)

_{Defined in Rendering/MeshUtils/WireShapes.h:64}

---

function
Rendering::MeshUtils::WireShapes::createWireSphere

public

Mesh * createWireSphere(	const VertexDescription &	vd,
	const Geometry::Sphere &	sphere,
	uint8_t	numSegments
)

Return a wireframe sphere, consisting of 3 axis-aligned circles.

See also: createWireCircle (…)

Parameters

vd

Vertex description specifying the vertex information to generate

sphere

the sphere

numSegments

Number of segments for each circle

Returns

Sphere Mesh

_{Defined in Rendering/MeshUtils/WireShapes.h:75}

---

function
Rendering::MeshUtils::WireShapes::addWireSphere

public

void addWireSphere(	MeshBuilder &	mb,
	const Geometry::Sphere &	sphere,
	uint8_t	numSegments
)

Adds a shere to the given meshBuilder.

See also: createWireSphere (…)

_{Defined in Rendering/MeshUtils/WireShapes.h:78}

---

function
Rendering::MeshUtils::WireShapes::createWireCircle

public

Mesh * createWireCircle(	const VertexDescription &	vd,
	float	radius,
	uint8_t	numSegments
)

Return a wireframe circle (oriented in x-y-plane).

Parameters

vd

Vertex description specifying the vertex information to generate

radius

radius of the circle

numSegments

Number of segments for the circle

Returns

Circle Mesh

_{Defined in Rendering/MeshUtils/WireShapes.h:88}

---

function
Rendering::MeshUtils::WireShapes::addWireCircle

public

void addWireCircle(	MeshBuilder &	mb,
	float	radius,
	uint8_t	numSegments
)

Adds a wireframe circle to the given meshBuilder.

See also: createWireCircle (…)

_{Defined in Rendering/MeshUtils/WireShapes.h:91}

---

function
Rendering::MeshUtils::WireShapes::createWireFrustum

public

Mesh * createWireFrustum(	const VertexDescription &	vd,
	const Geometry::Frustum &	frustum
)

Return a wireframe frustum.

Parameters

vd

Vertex description specifying the vertex information to generate

frustum

the frustum

Returns

frustum Mesh

_{Defined in Rendering/MeshUtils/WireShapes.h:100}

---

function
Rendering::MeshUtils::WireShapes::addWireFrustum

public

void addWireFrustum(	MeshBuilder &	mb,
	const Geometry::Frustum &	frustum
)

Adds a wireframe frustum to the given meshBuilder.

See also: createWireFrustum (…)

_{Defined in Rendering/MeshUtils/WireShapes.h:103}

---

function
Rendering::MeshUtils::WireShapes::createLine

public

Mesh * createLine(	const VertexDescription &	vd,
	const Geometry::Vec3 &	start,
	const Geometry::Vec3 &	end
)

Returns an line mesh.

Parameters

vd

Vertex description specifying the vertex information to generate

start

start of the line

end

end of the line

Returns

Line Mesh

_{Defined in Rendering/MeshUtils/WireShapes.h:113}

---

function
Rendering::MeshUtils::WireShapes::addLine

public

void addLine(	MeshBuilder &	mb,
	const Geometry::Vec3 &	start,
	const Geometry::Vec3 &	end
)

Adds a line to the given meshBuilder.

See also: createLine (…)

_{Defined in Rendering/MeshUtils/WireShapes.h:116}

---