iridescence
Loading...
Searching...
No Matches
glk::DrawableContainer Class Reference

Container to store multiple drawables and draw them in order. It can also store a shader setting for each drawable. More...

#include <drawable_container.hpp>

Inheritance diagram for glk::DrawableContainer:
Collaboration diagram for glk::DrawableContainer:

Public Types

using Ptr = std::shared_ptr<Drawable>
using ConstPtr = std::shared_ptr<const Drawable>
Public Types inherited from glk::Drawable
using Ptr = std::shared_ptr<Drawable>
using ConstPtr = std::shared_ptr<const Drawable>

Public Member Functions

 DrawableContainer (bool skip_model_matrix_setting=true)
 Constructor.
 DrawableContainer (std::initializer_list< glk::Drawable::ConstPtr > init, bool skip_model_matrix_setting=true)
 Constructor.
virtual ~DrawableContainer ()
size_t size () const
 Number of drawables in the container.
void clear ()
 Clear all drawables in the container.
void push_back (const glk::Drawable::ConstPtr &drawable)
 Add a drawable to the container.
void push_back (const glk::Drawable::ConstPtr &drawable, const guik::ShaderSetting &shader_setting)
 Add a drawable to the container with a shader setting.
virtual void draw (glk::GLSLShader &shader) const override
Public Member Functions inherited from glk::Drawable
virtual ~Drawable ()

Public Attributes

bool skip_model_matrix
std::vector< std::pair< std::optional< guik::ShaderSetting >, glk::Drawable::ConstPtr > > drawables

Detailed Description

Container to store multiple drawables and draw them in order. It can also store a shader setting for each drawable.

Member Typedef Documentation

◆ ConstPtr

using glk::DrawableContainer::ConstPtr = std::shared_ptr<const Drawable>

◆ Ptr

using glk::DrawableContainer::Ptr = std::shared_ptr<Drawable>

Constructor & Destructor Documentation

◆ DrawableContainer() [1/2]

glk::DrawableContainer::DrawableContainer ( bool skip_model_matrix_setting = true)

Constructor.

Parameters
skip_model_matrix_settingIf true, the model matrix setting will be skipped when drawing the drawables.

◆ DrawableContainer() [2/2]

glk::DrawableContainer::DrawableContainer ( std::initializer_list< glk::Drawable::ConstPtr > init,
bool skip_model_matrix_setting = true )

Constructor.

Parameters
initInitializer list of drawables to be added to the container.
skip_model_matrix_settingIf true, the model matrix setting will be skipped when drawing the drawables.

◆ ~DrawableContainer()

virtual glk::DrawableContainer::~DrawableContainer ( )
virtual

Member Function Documentation

◆ clear()

void glk::DrawableContainer::clear ( )

Clear all drawables in the container.

◆ draw()

virtual void glk::DrawableContainer::draw ( glk::GLSLShader & shader) const
overridevirtual

Reimplemented from glk::Drawable.

◆ push_back() [1/2]

void glk::DrawableContainer::push_back ( const glk::Drawable::ConstPtr & drawable)

Add a drawable to the container.

Parameters
drawableDrawable to be added.

◆ push_back() [2/2]

void glk::DrawableContainer::push_back ( const glk::Drawable::ConstPtr & drawable,
const guik::ShaderSetting & shader_setting )

Add a drawable to the container with a shader setting.

Parameters
drawableDrawable to be added.
shader_settingShader setting to be used when drawing the drawable.

◆ size()

size_t glk::DrawableContainer::size ( ) const

Number of drawables in the container.

Member Data Documentation

◆ drawables

std::vector<std::pair<std::optional<guik::ShaderSetting>, glk::Drawable::ConstPtr> > glk::DrawableContainer::drawables

◆ skip_model_matrix

bool glk::DrawableContainer::skip_model_matrix

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