Kanzi 4.0.0
Public Types | Public Member Functions | Protected Attributes | List of all members
kanzi::RenderEntryParameterContainer3D Class Reference

Container type for returning return render entries from nodes. More...

#include <kanzi/core.ui/graphics3d/render_entry_parameters_3d.hpp>

Public Types

using const_iterator
 Const iterator type.
 
using container_type
 Internal container type.
 
using iterator
 Iterator type.
 

Public Member Functions

RenderEntryParameters3D & back ()
 Gets the last element of the container.
 
const RenderEntryParameters3D & back () const
 Gets the last element of the container.
 
iterator begin ()
 Gets an iterator to the beginning of the internal container.
 
const_iterator begin () const
 Gets a const iterator to the beginning of the internal container.
 
const_iterator cbegin () const
 Gets a const iterator to the beginning of the internal container.
 
const_iterator cend () const
 Gets a const iterator to the end of the internal container.
 
void clear ()
 Clears the internal container.
 
template<typename... Args>
RenderEntryParameters3D & emplace_back (Args &&... args)
 Variadic emplace into the container.
 
bool empty () const
 Indicates whether or not the container is empty.
 
iterator end ()
 Gets an iterator to the end of the internal container.
 
const_iterator end () const
 Gets a const iterator to the end of the internal container.
 
iterator erase (const_iterator first, const_iterator last)
 Erase from internal container.
 
RenderEntryParameters3D & front ()
 Gets the first element of the container.
 
const RenderEntryParameters3D & front () const
 Gets the first element of the container.
 
iterator insert (const_iterator pos, const RenderEntryParameters3D &value)
 Insert into internal container.
 
iterator insert (const_iterator pos, RenderEntryParameters3D &&value)
 Insert into internal container.
 
RenderEntryParameterContainer3D & operator= (const RenderEntryParameterContainer3D &)=delete
 Deleted copy operator.
 
RenderEntryParameterContainer3D & operator= (RenderEntryParameterContainer3D &&)=default
 Default move operator.
 
RenderEntryParameters3D & operator[] (size_t index)
 Indexed access operator.
 
const RenderEntryParameters3D & operator[] (size_t index) const
 Indexed access operator.
 
void push_back (const RenderEntryParameters3D &value)
 Push into the container (copy).
 
void push_back (RenderEntryParameters3D &&value)
 Push into the container (move).
 
 RenderEntryParameterContainer3D ()=default
 Default constructor.
 
 RenderEntryParameterContainer3D (const RenderEntryParameterContainer3D &)=delete
 Deleted copy constructor.
 
 RenderEntryParameterContainer3D (RenderEntryParameterContainer3D &&)=default
 Default move constructor.
 
size_t size () const
 Gets the size of the internal container.
 

Protected Attributes

container_type m_parameters
 Internal container.
 

Detailed Description

Container type for returning return render entries from nodes.

If possible, this class should simply be a vector with copy constructor and copy operator deleted.

Since
Kanzi 4.0.0
  • Renamed from RenderEntryParameterContainer.
  • Transformed into a class.

Member Typedef Documentation

◆ container_type

using kanzi::RenderEntryParameterContainer3D::container_type

Internal container type.

◆ iterator

using kanzi::RenderEntryParameterContainer3D::iterator

Iterator type.

◆ const_iterator

using kanzi::RenderEntryParameterContainer3D::const_iterator

Const iterator type.

Constructor & Destructor Documentation

◆ RenderEntryParameterContainer3D() [1/3]

kanzi::RenderEntryParameterContainer3D::RenderEntryParameterContainer3D ( )
explicitdefault

Default constructor.

◆ RenderEntryParameterContainer3D() [2/3]

kanzi::RenderEntryParameterContainer3D::RenderEntryParameterContainer3D ( RenderEntryParameterContainer3D && )
default

Default move constructor.

◆ RenderEntryParameterContainer3D() [3/3]

kanzi::RenderEntryParameterContainer3D::RenderEntryParameterContainer3D ( const RenderEntryParameterContainer3D & )
delete

Deleted copy constructor.

Member Function Documentation

◆ operator=() [1/2]

RenderEntryParameterContainer3D & kanzi::RenderEntryParameterContainer3D::operator= ( RenderEntryParameterContainer3D && )
default

Default move operator.

◆ operator=() [2/2]

RenderEntryParameterContainer3D & kanzi::RenderEntryParameterContainer3D::operator= ( const RenderEntryParameterContainer3D & )
delete

Deleted copy operator.

◆ erase()

iterator kanzi::RenderEntryParameterContainer3D::erase ( const_iterator first,
const_iterator last )
inline

Erase from internal container.

Parameters
firstFirst element to erase.
lastErasing will stop before advancing to the last element.
Returns
Iterator to the first element after first that was not erased.

◆ insert() [1/2]

iterator kanzi::RenderEntryParameterContainer3D::insert ( const_iterator pos,
const RenderEntryParameters3D & value )
inline

Insert into internal container.

Parameters
posInsertion position.
valueValue to insert.
Returns
Iterator pointing to the inserted value.

◆ insert() [2/2]

iterator kanzi::RenderEntryParameterContainer3D::insert ( const_iterator pos,
RenderEntryParameters3D && value )
inline

Insert into internal container.

Parameters
posInsertion position.
valueValue to insert.
Returns
Iterator pointing to the inserted value.

◆ emplace_back()

template<typename... Args>
RenderEntryParameters3D & kanzi::RenderEntryParameterContainer3D::emplace_back ( Args &&... args)
inline

Variadic emplace into the container.

Parameters
argsArguments.

◆ push_back() [1/2]

void kanzi::RenderEntryParameterContainer3D::push_back ( const RenderEntryParameters3D & value)
inline

Push into the container (copy).

Parameters
valueElement to push.

◆ push_back() [2/2]

void kanzi::RenderEntryParameterContainer3D::push_back ( RenderEntryParameters3D && value)
inline

Push into the container (move).

Parameters
valueElement to push.

◆ front() [1/2]

RenderEntryParameters3D & kanzi::RenderEntryParameterContainer3D::front ( )
inline

Gets the first element of the container.

Returns
Reference to the first element.

◆ front() [2/2]

const RenderEntryParameters3D & kanzi::RenderEntryParameterContainer3D::front ( ) const
inline

Gets the first element of the container.

Returns
Const reference to the first element.

◆ back() [1/2]

RenderEntryParameters3D & kanzi::RenderEntryParameterContainer3D::back ( )
inline

Gets the last element of the container.

Returns
Reference to the last element.

◆ back() [2/2]

const RenderEntryParameters3D & kanzi::RenderEntryParameterContainer3D::back ( ) const
inline

Gets the last element of the container.

Returns
Const reference to the last element.

◆ empty()

bool kanzi::RenderEntryParameterContainer3D::empty ( ) const
inline

Indicates whether or not the container is empty.

Returns
If the container is empty true, false otherwise.

◆ clear()

void kanzi::RenderEntryParameterContainer3D::clear ( )
inline

Clears the internal container.

◆ size()

size_t kanzi::RenderEntryParameterContainer3D::size ( ) const
inline

Gets the size of the internal container.

Returns
Size of the container.

◆ begin() [1/2]

iterator kanzi::RenderEntryParameterContainer3D::begin ( )
inline

Gets an iterator to the beginning of the internal container.

Returns
Iterator to the beginning of the internal container.

◆ begin() [2/2]

const_iterator kanzi::RenderEntryParameterContainer3D::begin ( ) const
inline

Gets a const iterator to the beginning of the internal container.

Returns
Const iterator to the beginning of the internal container.

◆ cbegin()

const_iterator kanzi::RenderEntryParameterContainer3D::cbegin ( ) const
inline

Gets a const iterator to the beginning of the internal container.

Returns
Const iterator to the beginning of the internal container.

◆ end() [1/2]

iterator kanzi::RenderEntryParameterContainer3D::end ( )
inline

Gets an iterator to the end of the internal container.

Returns
Const iterator to the end of the internal container.

◆ end() [2/2]

const_iterator kanzi::RenderEntryParameterContainer3D::end ( ) const
inline

Gets a const iterator to the end of the internal container.

Returns
Const iterator to the end of the internal container.

◆ cend()

const_iterator kanzi::RenderEntryParameterContainer3D::cend ( ) const
inline

Gets a const iterator to the end of the internal container.

Returns
Const iterator to the end of the internal container.

◆ operator[]() [1/2]

RenderEntryParameters3D & kanzi::RenderEntryParameterContainer3D::operator[] ( size_t index)
inline

Indexed access operator.

Parameters
indexIndex to access.
Returns
Reference to element at index.

◆ operator[]() [2/2]

const RenderEntryParameters3D & kanzi::RenderEntryParameterContainer3D::operator[] ( size_t index) const
inline

Indexed access operator.

Parameters
indexIndex to access.
Returns
Reference to element at index.

Member Data Documentation

◆ m_parameters

container_type kanzi::RenderEntryParameterContainer3D::m_parameters
protected

Internal container.

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