Class to control vertex container and GPU with possibility of emulating old-style OpenGL 1.0 state machine using modern OpenGL methods. More...

#include <vertex_manager.h>

Public Member Functions
	VERTEX_MANAGER (bool aCached)

	VERTEX_MANAGER (std::shared_ptr< VERTEX_CONTAINER > aContainer)
	Build a manager around a container made elsewhere and no GPU manager, so it can hold vertices but not draw them.

void	Abandon ()
	Give up ownership of the container's GL objects without deleting them.

void	Map ()
	Map vertex buffer.

void	Unmap ()
	Unmap vertex buffer.

bool	Reserve (unsigned int aSize)
	Allocate space for vertices, so it will be used with subsequent Vertex() calls.

bool	Vertex (const VERTEX &aVertex)
	Add a vertex with the given coordinates to the currently set item.

bool	Vertex (GLfloat aX, GLfloat aY, GLfloat aZ)
	Add a vertex with the given coordinates to the currently set item.

bool	Vertex (const VECTOR2D &aXY, GLfloat aZ)
	Add a vertex with the given coordinates to the currently set item.

bool	Vertices (const VERTEX aVertices[], unsigned int aSize)
	Add one or more vertices to the currently set item.

void	Color (const COLOR4D &aColor)
	Change currently used color that will be applied to newly added vertices.

void	Color (GLfloat aRed, GLfloat aGreen, GLfloat aBlue, GLfloat aAlpha)
	Change currently used color that will be applied to newly added vertices.

void	Shader (GLfloat aShaderType, GLfloat aParam1=0.0f, GLfloat aParam2=0.0f, GLfloat aParam3=0.0f)
	Change currently used shader and its parameters that will be applied to newly added vertices.

void	Translate (GLfloat aX, GLfloat aY, GLfloat aZ)
	Multiply the current matrix by a translation matrix, so newly vertices will be translated by the given vector.

void	Rotate (GLfloat aAngle, GLfloat aX, GLfloat aY, GLfloat aZ)
	Multiply the current matrix by a rotation matrix, so the newly vertices will be rotated by the given angles.

void	Scale (GLfloat aX, GLfloat aY, GLfloat aZ)
	Multiply the current matrix by a scaling matrix, so the newly vertices will be scaled by the given factors.

void	PushMatrix ()
	Push the current transformation matrix stack.

void	PopMatrix ()
	Pop the current transformation matrix stack.

void	SetItem (VERTEX_ITEM &aItem) const
	Set an item to start its modifications.

void	FinishItem () const
	Clean after adding an item.

void	FreeItem (VERTEX_ITEM &aItem) const
	Free the memory occupied by the item, so it is no longer stored in the container.

void	ChangeItemColor (const VERTEX_ITEM &aItem, const COLOR4D &aColor) const
	Change the color of all vertices owned by an item.

void	ChangeItemDepth (const VERTEX_ITEM &aItem, GLfloat aDepth) const
	Change the depth of all vertices owned by an item.

VERTEX *	GetVertices (const VERTEX_ITEM &aItem) const
	Return a pointer to the vertices owned by an item.

const glm::mat4 &	GetTransformation () const

void	SetShader (SHADER &aShader) const
	Set a shader program that is going to be used during rendering.

void	Clear () const
	Remove all the stored vertices from the container.

void	BeginDrawing () const
	Prepare buffers and items to start drawing.

void	DrawItem (const VERTEX_ITEM &aItem) const
	Draw an item to the buffer.

void	EndDrawing () const
	Finish drawing operations.

void	EnableDepthTest (bool aEnabled)
	Enable/disable Z buffer depth test.

Protected Member Functions
void	putVertex (VERTEX &aTarget, GLfloat aX, GLfloat aY, GLfloat aZ) const
	Apply all transformation to the given coordinates and store them at the specified target.

Protected Attributes
std::shared_ptr< VERTEX_CONTAINER >	m_container
	Container for vertices, may be cached or noncached.

std::shared_ptr< GPU_MANAGER >	m_gpu
	GPU manager for data transfers and drawing operations.

bool	m_noTransform
	State machine variables True in case there is no need to transform vertices.

glm::mat4	m_transform
	Currently used transform matrix.

std::stack< glm::mat4 >	m_transformStack
	Stack of transformation matrices, used for Push/PopMatrix.

GLubyte	m_color [COLOR_STRIDE]
	Currently used color.

GLfloat	m_shader [SHADER_STRIDE]
	Currently used shader and its parameters.

VERTEX *	m_reserved
	Currently reserved chunk to store vertices.

unsigned int	m_reservedSpace
	Currently available reserved space.

Detailed Description

Class to control vertex container and GPU with possibility of emulating old-style OpenGL 1.0 state machine using modern OpenGL methods.

Definition at line 50 of file vertex_manager.h.

Constructor & Destructor Documentation

◆ VERTEX_MANAGER() [1/2]

VERTEX_MANAGER::VERTEX_MANAGER ( bool aCached )

Parameters

aCached says if vertices should be cached in GPU or system memory. For data that does not change every frame, it is better to store vertices in GPU memory.

Definition at line 48 of file vertex_manager.cpp.

References m_container, m_gpu, m_noTransform, m_reserved, m_reservedSpace, m_shader, m_transform, KIGFX::VERTEX_CONTAINER::MakeContainer(), KIGFX::GPU_MANAGER::MakeManager(), and KIGFX::SHADER_STRIDE.

◆ VERTEX_MANAGER() [2/2]

VERTEX_MANAGER::VERTEX_MANAGER ( std::shared_ptr< VERTEX_CONTAINER > aContainer )

explicit

Build a manager around a container made elsewhere and no GPU manager, so it can hold vertices but not draw them.

Lets the containers be tested without an OpenGL context.

Definition at line 63 of file vertex_manager.cpp.

References m_container, m_noTransform, m_reserved, m_reservedSpace, m_shader, m_transform, move, and KIGFX::SHADER_STRIDE.

Member Function Documentation

◆ Abandon()

void VERTEX_MANAGER::Abandon ( )

Give up ownership of the container's GL objects without deleting them.

See also: VERTEX_CONTAINER::Abandon()

Definition at line 75 of file vertex_manager.cpp.

References m_container.

◆ BeginDrawing()

void VERTEX_MANAGER::BeginDrawing ( ) const

Prepare buffers and items to start drawing.

Definition at line 276 of file vertex_manager.cpp.

References m_gpu.

◆ ChangeItemColor()

void VERTEX_MANAGER::ChangeItemColor	(	const VERTEX_ITEM &	aItem,
		const COLOR4D &	aColor ) const

Change the color of all vertices owned by an item.

Parameters

aItem	is the item to change.
aColor	is the new color to be applied.

Definition at line 218 of file vertex_manager.cpp.

References KIGFX::COLOR4D::a, KIGFX::VERTEX::a, KIGFX::COLOR4D::b, KIGFX::VERTEX::b, KIGFX::COLOR4D::g, KIGFX::VERTEX::g, KIGFX::VERTEX_ITEM::GetOffset(), KIGFX::VERTEX_ITEM::GetSize(), m_container, KIGFX::COLOR4D::r, and KIGFX::VERTEX::r.

◆ ChangeItemDepth()

void VERTEX_MANAGER::ChangeItemDepth	(	const VERTEX_ITEM &	aItem,
		GLfloat	aDepth ) const

Change the depth of all vertices owned by an item.

Parameters

aItem	is the item to change.
aDepth	is the new color to be applied.

Definition at line 238 of file vertex_manager.cpp.

References KIGFX::VERTEX_ITEM::GetOffset(), KIGFX::VERTEX_ITEM::GetSize(), m_container, and KIGFX::VERTEX::z.

◆ Clear()

void VERTEX_MANAGER::Clear ( ) const

Remove all the stored vertices from the container.

Definition at line 270 of file vertex_manager.cpp.

References m_container.

◆ Color() [1/2]

void KIGFX::VERTEX_MANAGER::Color ( const COLOR4D & aColor )

inline

Change currently used color that will be applied to newly added vertices.

Parameters

aColor is the new color.

Definition at line 150 of file vertex_manager.h.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::COLOR4D::g, m_color, and KIGFX::COLOR4D::r.

◆ Color() [2/2]

void KIGFX::VERTEX_MANAGER::Color	(	GLfloat	aRed,
		GLfloat	aGreen,
		GLfloat	aBlue,
		GLfloat	aAlpha )

inline

Change currently used color that will be applied to newly added vertices.

It is the equivalent of glColor4f() function.

Parameters

aRed	is the red component of the new color.
aGreen	is the green component of the new color.
aBlue	is the blue component of the new color.
aAlpha	is the alpha component of the new color.

Definition at line 168 of file vertex_manager.h.

References m_color.

◆ DrawItem()

void VERTEX_MANAGER::DrawItem ( const VERTEX_ITEM & aItem ) const

Draw an item to the buffer.

Parameters

aItem is the item to be drawn.

Definition at line 282 of file vertex_manager.cpp.

References m_gpu.

◆ EnableDepthTest()

void VERTEX_MANAGER::EnableDepthTest ( bool aEnabled )

Enable/disable Z buffer depth test.

Definition at line 329 of file vertex_manager.cpp.

References m_gpu.

◆ EndDrawing()

void VERTEX_MANAGER::EndDrawing ( ) const

Finish drawing operations.

Definition at line 288 of file vertex_manager.cpp.

References m_gpu.

◆ FinishItem()

void VERTEX_MANAGER::FinishItem ( ) const

Clean after adding an item.

Definition at line 203 of file vertex_manager.cpp.

References m_container, m_reserved, m_reservedSpace, and traceVertexManager.

◆ FreeItem()

void VERTEX_MANAGER::FreeItem ( VERTEX_ITEM & aItem ) const

Free the memory occupied by the item, so it is no longer stored in the container.

Parameters

aItem is the item to be freed

Definition at line 212 of file vertex_manager.cpp.

References m_container.

◆ GetTransformation()

const glm::mat4 & KIGFX::VERTEX_MANAGER::GetTransformation ( ) const

inline

Definition at line 321 of file vertex_manager.h.

References m_transform.

◆ GetVertices()

VERTEX * VERTEX_MANAGER::GetVertices ( const VERTEX_ITEM & aItem ) const

Return a pointer to the vertices owned by an item.

Parameters

aItem is the owner of vertices that are going to be returned.

Returns: Pointer to the vertices or NULL if the item is not stored at the container.

Definition at line 255 of file vertex_manager.cpp.

References KIGFX::VERTEX_ITEM::GetOffset(), KIGFX::VERTEX_ITEM::GetSize(), and m_container.

◆ Map()

void VERTEX_MANAGER::Map ( )

Map vertex buffer.

Definition at line 81 of file vertex_manager.cpp.

References m_container.

◆ PopMatrix()

void KIGFX::VERTEX_MANAGER::PopMatrix ( )

inline

Pop the current transformation matrix stack.

It is the equivalent of the glPopMatrix() function.

Definition at line 262 of file vertex_manager.h.

References m_noTransform, m_transform, and m_transformStack.

◆ PushMatrix()

void KIGFX::VERTEX_MANAGER::PushMatrix ( )

inline

Push the current transformation matrix stack.

It is the equivalent of the glPushMatrix() function.

Definition at line 249 of file vertex_manager.h.

References m_noTransform, m_transform, and m_transformStack.

◆ putVertex()

void VERTEX_MANAGER::putVertex	(	VERTEX &	aTarget,
		GLfloat	aX,
		GLfloat	aY,
		GLfloat	aZ ) const

protected

Apply all transformation to the given coordinates and store them at the specified target.

Parameters

aTarget	is the place where the new vertex is going to be stored (it has to be allocated first).
aX	is the X coordinate of the new vertex.
aY	is the Y coordinate of the new vertex.
aZ	is the Z coordinate of the new vertex.

Definition at line 294 of file vertex_manager.cpp.

References KIGFX::VERTEX::a, KIGFX::VERTEX::b, KIGFX::VERTEX::g, m_color, m_noTransform, m_shader, m_transform, KIGFX::VERTEX::r, KIGFX::VERTEX::shader, KIGFX::SHADER_STRIDE, KIGFX::VERTEX::x, KIGFX::VERTEX::y, and KIGFX::VERTEX::z.

Referenced by Vertex(), and Vertices().

◆ Reserve()

bool VERTEX_MANAGER::Reserve ( unsigned int aSize )

Allocate space for vertices, so it will be used with subsequent Vertex() calls.

Parameters

aSize is the number of vertices that should be available in the reserved space.

Returns: True if successful, false otherwise.

Definition at line 93 of file vertex_manager.cpp.

References DisplayError(), m_container, m_reserved, and m_reservedSpace.

◆ Rotate()

void KIGFX::VERTEX_MANAGER::Rotate	(	GLfloat	aAngle,
		GLfloat	aX,
		GLfloat	aY,
		GLfloat	aZ )

inline

Multiply the current matrix by a rotation matrix, so the newly vertices will be rotated by the given angles.

It is the equivalent of the glRotatef() function.

Parameters

aAngle	is the angle of rotation, in radians.
aX	is a multiplier for the X axis
aY	is a multiplier for the Y axis
aZ	is a multiplier for the Z axis.

Definition at line 224 of file vertex_manager.h.

References m_transform.

◆ Scale()

void KIGFX::VERTEX_MANAGER::Scale	(	GLfloat	aX,
		GLfloat	aY,
		GLfloat	aZ )

inline

Multiply the current matrix by a scaling matrix, so the newly vertices will be scaled by the given factors.

It is the equivalent of the glScalef() function.

Parameters

aX	is the X axis scaling factor.
aY	is the Y axis scaling factor.
aZ	is the Z axis scaling factor.

Definition at line 239 of file vertex_manager.h.

References m_transform.

◆ SetItem()

void VERTEX_MANAGER::SetItem ( VERTEX_ITEM & aItem ) const

Set an item to start its modifications.

After calling the function it is possible to add vertices using function Add().

Parameters

aItem is the item that is going to store vertices in the container.

Definition at line 197 of file vertex_manager.cpp.

References m_container.

◆ SetShader()

void VERTEX_MANAGER::SetShader ( SHADER & aShader ) const

Set a shader program that is going to be used during rendering.

Parameters

aShader is the object containing compiled and linked shader program.

Definition at line 264 of file vertex_manager.cpp.

References m_gpu.

◆ Shader()

void KIGFX::VERTEX_MANAGER::Shader	(	GLfloat	aShaderType,
		GLfloat	aParam1 = 0.0f,
		GLfloat	aParam2 = 0.0f,
		GLfloat	aParam3 = 0.0f )

inline

Change currently used shader and its parameters that will be applied to newly added vertices.

Parameters depend on shader, for more information have a look at shaders source code.

See also: SHADER_TYPE

Parameters

aShaderType	is the a shader type to be applied.
aParam1	is the optional parameter for a shader.
aParam2	is the optional parameter for a shader.
aParam3	is the optional parameter for a shader.

Definition at line 189 of file vertex_manager.h.

References m_shader.

◆ Translate()

void KIGFX::VERTEX_MANAGER::Translate	(	GLfloat	aX,
		GLfloat	aY,
		GLfloat	aZ )

inline

Multiply the current matrix by a translation matrix, so newly vertices will be translated by the given vector.

It is the equivalent of the glTranslatef() function.

Parameters

aX	is the X coordinate of a translation vector.
aY	is the X coordinate of a translation vector.
aZ	is the X coordinate of a translation vector.

Definition at line 208 of file vertex_manager.h.

References m_transform.

◆ Unmap()

void VERTEX_MANAGER::Unmap ( )

Unmap vertex buffer.

Definition at line 87 of file vertex_manager.cpp.

References m_container.

◆ Vertex() [1/3]

bool KIGFX::VERTEX_MANAGER::Vertex	(	const VECTOR2D &	aXY,
		GLfloat	aZ )

inline

Add a vertex with the given coordinates to the currently set item.

Vertex coordinates will have the current transformation matrix applied.

Parameters

aXY	are the XY coordinates of the new vertex.
aZ	is the Z coordinate of the new vertex.

Returns: True if successful, false otherwise.

Definition at line 126 of file vertex_manager.h.

References Vertex(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ Vertex() [2/3]

bool KIGFX::VERTEX_MANAGER::Vertex ( const VERTEX & aVertex )

inline

Add a vertex with the given coordinates to the currently set item.

Color & shader parameters stored in aVertex are ignored, instead color & shader set by Color() and Shader() functions are used. Vertex coordinates will have the current transformation matrix applied.

Parameters

aVertex contains vertex coordinates.

Returns: True if successful, false otherwise.

Definition at line 100 of file vertex_manager.h.

References Vertex(), KIGFX::VERTEX::x, KIGFX::VERTEX::y, and KIGFX::VERTEX::z.

Referenced by Vertex(), Vertex(), and VertexCallback().

◆ Vertex() [3/3]

bool VERTEX_MANAGER::Vertex	(	GLfloat	aX,
		GLfloat	aY,
		GLfloat	aZ )

Add a vertex with the given coordinates to the currently set item.

Vertex coordinates will have the current transformation matrix applied.

Parameters

aX	is the X coordinate of the new vertex.
aY	is the Y coordinate of the new vertex.
aZ	is the Z coordinate of the new vertex.

Returns: True if successful, false otherwise.

Definition at line 130 of file vertex_manager.cpp.

References DisplayError(), m_container, m_reserved, m_reservedSpace, and putVertex().

◆ Vertices()

bool VERTEX_MANAGER::Vertices	(	const VERTEX	aVertices[],
		unsigned int	aSize )

Add one or more vertices to the currently set item.

It takes advantage of allocating memory in advance, so should be faster than adding vertices one by one. Color & shader parameters stored in aVertices are ignored, instead color & shader set by Color() and Shader() functions are used. All the vertex coordinates will have the current transformation matrix applied.

Parameters

aVertices	contains vertices to be added.
aSize	is the number of vertices to be added.

Returns: True if successful, false otherwise.

Definition at line 168 of file vertex_manager.cpp.

References DisplayError(), m_container, and putVertex().

Member Data Documentation

◆ m_color

GLubyte KIGFX::VERTEX_MANAGER::m_color[COLOR_STRIDE]

protected

Currently used color.

Definition at line 389 of file vertex_manager.h.

Referenced by Color(), Color(), and putVertex().

◆ m_container

std::shared_ptr<VERTEX_CONTAINER> KIGFX::VERTEX_MANAGER::m_container

protected

Container for vertices, may be cached or noncached.

Definition at line 373 of file vertex_manager.h.

Referenced by Abandon(), ChangeItemColor(), ChangeItemDepth(), Clear(), FinishItem(), FreeItem(), GetVertices(), Map(), Reserve(), SetItem(), Unmap(), Vertex(), VERTEX_MANAGER(), VERTEX_MANAGER(), and Vertices().

◆ m_gpu

std::shared_ptr<GPU_MANAGER> KIGFX::VERTEX_MANAGER::m_gpu

protected

GPU manager for data transfers and drawing operations.

Definition at line 376 of file vertex_manager.h.

Referenced by BeginDrawing(), DrawItem(), EnableDepthTest(), EndDrawing(), SetShader(), and VERTEX_MANAGER().

◆ m_noTransform

bool KIGFX::VERTEX_MANAGER::m_noTransform

protected

State machine variables True in case there is no need to transform vertices.

Definition at line 380 of file vertex_manager.h.

Referenced by PopMatrix(), PushMatrix(), putVertex(), VERTEX_MANAGER(), and VERTEX_MANAGER().

◆ m_reserved

VERTEX* KIGFX::VERTEX_MANAGER::m_reserved

protected

Currently reserved chunk to store vertices.

Definition at line 395 of file vertex_manager.h.

Referenced by FinishItem(), Reserve(), Vertex(), VERTEX_MANAGER(), and VERTEX_MANAGER().

◆ m_reservedSpace

unsigned int KIGFX::VERTEX_MANAGER::m_reservedSpace

protected

Currently available reserved space.

Definition at line 398 of file vertex_manager.h.

Referenced by FinishItem(), Reserve(), Vertex(), VERTEX_MANAGER(), and VERTEX_MANAGER().

◆ m_shader

GLfloat KIGFX::VERTEX_MANAGER::m_shader[SHADER_STRIDE]

protected

Currently used shader and its parameters.

Definition at line 392 of file vertex_manager.h.

Referenced by putVertex(), Shader(), VERTEX_MANAGER(), and VERTEX_MANAGER().

◆ m_transform

glm::mat4 KIGFX::VERTEX_MANAGER::m_transform

protected

Currently used transform matrix.

Definition at line 383 of file vertex_manager.h.

Referenced by GetTransformation(), PopMatrix(), PushMatrix(), putVertex(), Rotate(), Scale(), Translate(), VERTEX_MANAGER(), and VERTEX_MANAGER().

◆ m_transformStack

std::stack<glm::mat4> KIGFX::VERTEX_MANAGER::m_transformStack

protected

Stack of transformation matrices, used for Push/PopMatrix.

Definition at line 386 of file vertex_manager.h.

Referenced by PopMatrix(), and PushMatrix().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VERTEX_MANAGER() [1/2]

◆ VERTEX_MANAGER() [2/2]

Member Function Documentation

◆ Abandon()

◆ BeginDrawing()

◆ ChangeItemColor()

◆ ChangeItemDepth()

◆ Clear()

◆ Color() [1/2]

◆ Color() [2/2]

◆ DrawItem()

◆ EnableDepthTest()

◆ EndDrawing()

◆ FinishItem()

◆ FreeItem()

◆ GetTransformation()

◆ GetVertices()

◆ Map()

◆ PopMatrix()

◆ PushMatrix()

◆ putVertex()

◆ Reserve()

◆ Rotate()

◆ Scale()

◆ SetItem()

◆ SetShader()

◆ Shader()

◆ Translate()

◆ Unmap()

◆ Vertex() [1/3]

◆ Vertex() [2/3]

◆ Vertex() [3/3]

◆ Vertices()

Member Data Documentation

◆ m_color

◆ m_container

◆ m_gpu

◆ m_noTransform

◆ m_reserved

◆ m_reservedSpace

◆ m_shader

◆ m_transform

◆ m_transformStack