KiCad PCB EDA Suite
Loading...
Searching...
No Matches
KIGFX::VERTEX_MANAGER Class Reference

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)
 
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)
 Changes 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.
 
VERTEXGetVertices (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_CONTAINERm_container
 Container for vertices, may be cached or noncached.
 
std::shared_ptr< GPU_MANAGERm_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.
 
VERTEXm_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 53 of file vertex_manager.h.

Constructor & Destructor Documentation

◆ VERTEX_MANAGER()

VERTEX_MANAGER::VERTEX_MANAGER ( bool  aCached)
Parameters
aCachedsays 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 52 of file vertex_manager.cpp.

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

Member Function Documentation

◆ BeginDrawing()

void VERTEX_MANAGER::BeginDrawing ( ) const

Prepare buffers and items to start drawing.

Definition at line 255 of file vertex_manager.cpp.

References m_gpu.

Referenced by KIGFX::OPENGL_GAL::BeginDrawing().

◆ ChangeItemColor()

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

Change the color of all vertices owned by an item.

Parameters
aItemis the item to change.
aColoris the new color to be applied.

Definition at line 197 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.

Referenced by KIGFX::OPENGL_GAL::ChangeGroupColor().

◆ ChangeItemDepth()

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

Change the depth of all vertices owned by an item.

Parameters
aItemis the item to change.
aDepthis the new color to be applied.

Definition at line 217 of file vertex_manager.cpp.

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

Referenced by KIGFX::OPENGL_GAL::ChangeGroupDepth().

◆ Clear()

void VERTEX_MANAGER::Clear ( ) const

Remove all the stored vertices from the container.

Definition at line 249 of file vertex_manager.cpp.

References m_container.

Referenced by KIGFX::OPENGL_GAL::BeginDrawing(), and KIGFX::OPENGL_GAL::ClearCache().

◆ Color() [1/2]

◆ 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
aRedis the red component of the new color.
aGreenis the green component of the new color.
aBlueis the blue component of the new color.
aAlphais the alpha component of the new color.

Definition at line 158 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
aItemis the item to be drawn.

Definition at line 261 of file vertex_manager.cpp.

References m_gpu.

Referenced by KIGFX::OPENGL_GAL::DrawGroup().

◆ EnableDepthTest()

void VERTEX_MANAGER::EnableDepthTest ( bool  aEnabled)

Enable/disable Z buffer depth test.

Definition at line 308 of file vertex_manager.cpp.

References m_gpu.

Referenced by KIGFX::OPENGL_GAL::DrawGrid(), and KIGFX::OPENGL_GAL::EnableDepthTest().

◆ EndDrawing()

void VERTEX_MANAGER::EndDrawing ( ) const

◆ FinishItem()

void VERTEX_MANAGER::FinishItem ( ) const

Clean after adding an item.

Definition at line 182 of file vertex_manager.cpp.

References m_container, m_reserved, m_reservedSpace, and traceVertexManager.

Referenced by KIGFX::OPENGL_GAL::EndGroup().

◆ 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
aItemis the item to be freed

Definition at line 191 of file vertex_manager.cpp.

References m_container.

Referenced by KIGFX::VERTEX_ITEM::~VERTEX_ITEM().

◆ GetTransformation()

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

Definition at line 311 of file vertex_manager.h.

References m_transform.

Referenced by KIGFX::OPENGL_GAL::DrawBitmap(), and KIGFX::OPENGL_GAL::drawLineQuad().

◆ GetVertices()

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

Return a pointer to the vertices owned by an item.

Parameters
aItemis 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 234 of file vertex_manager.cpp.

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

Referenced by KIGFX::VERTEX_ITEM::GetVertices().

◆ Map()

void VERTEX_MANAGER::Map ( )

Map vertex buffer.

Definition at line 67 of file vertex_manager.cpp.

References m_container.

Referenced by KIGFX::OPENGL_GAL::beginUpdate().

◆ PopMatrix()

void KIGFX::VERTEX_MANAGER::PopMatrix ( )
inline

Pop the current transformation matrix stack.

It is the equivalent of the glPopMatrix() function.

Definition at line 252 of file vertex_manager.h.

References m_noTransform, m_transform, and m_transformStack.

Referenced by KIGFX::OPENGL_GAL::Restore().

◆ PushMatrix()

void KIGFX::VERTEX_MANAGER::PushMatrix ( )
inline

Push the current transformation matrix stack.

It is the equivalent of the glPushMatrix() function.

Definition at line 239 of file vertex_manager.h.

References m_noTransform, m_transform, and m_transformStack.

Referenced by KIGFX::OPENGL_GAL::Save().

◆ 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
aTargetis the place where the new vertex is going to be stored (it has to be allocated first).
aXis the X coordinate of the new vertex.
aYis the Y coordinate of the new vertex.
aZis the Z coordinate of the new vertex.

Definition at line 273 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()

◆ 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
aAngleis the angle of rotation, in radians.
aXis a multiplier for the X axis
aYis a multiplier for the Y axis
aZis a multiplier for the Z axis.

Definition at line 214 of file vertex_manager.h.

References m_transform.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), KIGFX::OPENGL_GAL::drawFilledSemiCircle(), KIGFX::OPENGL_GAL::drawSegment(), KIGFX::OPENGL_GAL::drawStrokedSemiCircle(), and KIGFX::OPENGL_GAL::Rotate().

◆ 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
aXis the X axis scaling factor.
aYis the Y axis scaling factor.
aZis the Z axis scaling factor.

Definition at line 229 of file vertex_manager.h.

References m_transform.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), and KIGFX::OPENGL_GAL::Scale().

◆ 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
aItemis the item that is going to store vertices in the container.

Definition at line 176 of file vertex_manager.cpp.

References m_container.

Referenced by KIGFX::VERTEX_ITEM::VERTEX_ITEM().

◆ SetShader()

void VERTEX_MANAGER::SetShader ( SHADER aShader) const

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

Parameters
aShaderis the object containing compiled and linked shader program.

Definition at line 243 of file vertex_manager.cpp.

References m_gpu.

Referenced by KIGFX::OPENGL_GAL::init().

◆ 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
aShaderTypeis the a shader type to be applied.
aParam1is the optional parameter for a shader.
aParam2is the optional parameter for a shader.
aParam3is the optional parameter for a shader.

Definition at line 179 of file vertex_manager.h.

References m_shader.

Referenced by KIGFX::OPENGL_GAL::DrawArc(), KIGFX::OPENGL_GAL::drawBitmapChar(), KIGFX::OPENGL_GAL::drawBitmapOverbar(), KIGFX::OPENGL_GAL::drawCircle(), KIGFX::OPENGL_GAL::drawFilledSemiCircle(), KIGFX::OPENGL_GAL::DrawGlyph(), KIGFX::OPENGL_GAL::DrawGlyphs(), KIGFX::OPENGL_GAL::drawLineQuad(), KIGFX::OPENGL_GAL::drawPolygon(), KIGFX::OPENGL_GAL::DrawRectangle(), KIGFX::OPENGL_GAL::drawStrokedSemiCircle(), and KIGFX::OPENGL_GAL::drawTriangulatedPolyset().

◆ 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
aXis the X coordinate of a translation vector.
aYis the X coordinate of a translation vector.
aZis the X coordinate of a translation vector.

Definition at line 198 of file vertex_manager.h.

References m_transform.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), KIGFX::OPENGL_GAL::DrawArc(), KIGFX::OPENGL_GAL::DrawArcSegment(), KIGFX::OPENGL_GAL::drawFilledSemiCircle(), KIGFX::OPENGL_GAL::drawSegment(), KIGFX::OPENGL_GAL::drawStrokedSemiCircle(), and KIGFX::OPENGL_GAL::Translate().

◆ Unmap()

void VERTEX_MANAGER::Unmap ( )

Unmap vertex buffer.

Definition at line 73 of file vertex_manager.cpp.

References m_container.

Referenced by KIGFX::OPENGL_GAL::endUpdate().

◆ 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
aXYare the XY coordinates of the new vertex.
aZis the Z coordinate of the new vertex.
Returns
True if successful, false otherwise.

Definition at line 116 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
aVertexcontains vertex coordinates.
Returns
True if successful, false otherwise.

Definition at line 90 of file vertex_manager.h.

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

Referenced by KIGFX::OPENGL_GAL::DrawArc(), KIGFX::OPENGL_GAL::drawBitmapChar(), KIGFX::OPENGL_GAL::drawBitmapOverbar(), KIGFX::OPENGL_GAL::drawCircle(), KIGFX::OPENGL_GAL::drawFilledSemiCircle(), KIGFX::OPENGL_GAL::DrawGlyph(), KIGFX::OPENGL_GAL::DrawGlyphs(), KIGFX::OPENGL_GAL::drawLineQuad(), KIGFX::OPENGL_GAL::DrawRectangle(), KIGFX::OPENGL_GAL::drawStrokedSemiCircle(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), 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
aXis the X coordinate of the new vertex.
aYis the Y coordinate of the new vertex.
aZis the Z coordinate of the new vertex.
Returns
True if successful, false otherwise.

Definition at line 109 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
aVerticescontains vertices to be added.
aSizeis the number of vertices to be added.
Returns
True if successful, false otherwise.

Definition at line 147 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 375 of file vertex_manager.h.

Referenced by 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 363 of file vertex_manager.h.

Referenced by ChangeItemColor(), ChangeItemDepth(), Clear(), FinishItem(), FreeItem(), GetVertices(), Map(), Reserve(), SetItem(), Unmap(), Vertex(), 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 365 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 369 of file vertex_manager.h.

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

◆ m_reserved

VERTEX* KIGFX::VERTEX_MANAGER::m_reserved
protected

Currently reserved chunk to store vertices.

Definition at line 380 of file vertex_manager.h.

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

◆ m_reservedSpace

unsigned int KIGFX::VERTEX_MANAGER::m_reservedSpace
protected

Currently available reserved space.

Definition at line 383 of file vertex_manager.h.

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

◆ m_shader

GLfloat KIGFX::VERTEX_MANAGER::m_shader[SHADER_STRIDE]
protected

Currently used shader and its parameters.

Definition at line 377 of file vertex_manager.h.

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

◆ m_transform

glm::mat4 KIGFX::VERTEX_MANAGER::m_transform
protected

Currently used transform matrix.

Definition at line 371 of file vertex_manager.h.

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

◆ m_transformStack

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

Stack of transformation matrices, used for Push/PopMatrix.

Definition at line 373 of file vertex_manager.h.

Referenced by PopMatrix(), and PushMatrix().


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