Ra::Core::Utils::ContainerIntrospectionInterface Class Reference

This class defines the introspection interface a container need to implement. More...

#include <Core/Utils/ContainerIntrospectionInterface.hpp>

Inheritance diagram for Ra::Core::Utils::ContainerIntrospectionInterface:

Collaboration diagram for Ra::Core::Utils::ContainerIntrospectionInterface:

Public Member Functions
virtual	~ContainerIntrospectionInterface ()
	only needed for correct abstract dtor call.
virtual size_t	getSize () const =0
virtual size_t	getNumberOfComponents () const =0
virtual size_t	getBufferSize () const =0
virtual int	getStride () const =0
virtual const void *	dataPtr () const =0

Detailed Description

This class defines the introspection interface a container need to implement.

This API allows to parse and copy contained element, or send/map to GPU buffer, given a generic pointer to the container. Typical usage are shown in Ra::Core::Utils::Attrib or Ra::Core::Geometry::IndexedGeometry This "interface" do not contain any data.

Definition at line 13 of file ContainerIntrospectionInterface.hpp.

Constructor & Destructor Documentation

~ContainerIntrospectionInterface()

virtual Ra::Core::Utils::ContainerIntrospectionInterface::~ContainerIntrospectionInterface ( )

inlinevirtual

only needed for correct abstract dtor call.

Definition at line 17 of file ContainerIntrospectionInterface.hpp.

Member Function Documentation

dataPtr()

virtual const void * Ra::Core::Utils::ContainerIntrospectionInterface::dataPtr ( ) const

pure virtual

Returns

a const pointer to the raw data

Implemented in Ra::Core::Geometry::GeometryIndexLayer< T >, Ra::Core::Geometry::GeometryIndexLayer< Vector1ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector2ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector3ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector4ui >, Ra::Core::Geometry::GeometryIndexLayer< VectorNui >, Ra::Core::Utils::Attrib< T >, Ra::Core::VectorArray< V >, Ra::Core::VectorArray< IndexType >, Ra::Core::VectorArray< Ra::Core::Vector3ui >, Ra::Core::VectorArray< Scalar >, Ra::Core::VectorArray< T >, Ra::Core::VectorArray< Vector >, Ra::Core::VectorArray< Vector2 >, Ra::Core::VectorArray< Vector3 >, and Ra::Core::VectorArray< Vector4 >.

getBufferSize()

virtual size_t Ra::Core::Utils::ContainerIntrospectionInterface::getBufferSize ( ) const

pure virtual

Returns

the size in byte of container

Implemented in Ra::Core::Geometry::GeometryIndexLayer< T >, Ra::Core::Geometry::GeometryIndexLayer< Vector1ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector2ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector3ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector4ui >, Ra::Core::Geometry::GeometryIndexLayer< VectorNui >, Ra::Core::Utils::Attrib< T >, Ra::Core::VectorArray< V >, Ra::Core::VectorArray< IndexType >, Ra::Core::VectorArray< Ra::Core::Vector3ui >, Ra::Core::VectorArray< Scalar >, Ra::Core::VectorArray< T >, Ra::Core::VectorArray< Vector >, Ra::Core::VectorArray< Vector2 >, Ra::Core::VectorArray< Vector3 >, and Ra::Core::VectorArray< Vector4 >.

getNumberOfComponents()

virtual size_t Ra::Core::Utils::ContainerIntrospectionInterface::getNumberOfComponents ( ) const

pure virtual

Return the number of components of one element (i.e. for glVertexAttribPointer size argument )

See also

https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/glVertexAttribPointer.xhtml

Returns

the number of components of one element (i.e. faces, vector)

Implemented in Ra::Core::Geometry::GeometryIndexLayer< T >, Ra::Core::Geometry::GeometryIndexLayer< Vector1ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector2ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector3ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector4ui >, Ra::Core::Geometry::GeometryIndexLayer< VectorNui >, Ra::Core::Utils::Attrib< T >, Ra::Core::VectorArray< V >, Ra::Core::VectorArray< IndexType >, Ra::Core::VectorArray< Ra::Core::Vector3ui >, Ra::Core::VectorArray< Scalar >, Ra::Core::VectorArray< T >, Ra::Core::VectorArray< Vector >, Ra::Core::VectorArray< Vector2 >, Ra::Core::VectorArray< Vector3 >, and Ra::Core::VectorArray< Vector4 >.

getSize()

virtual size_t Ra::Core::Utils::ContainerIntrospectionInterface::getSize ( ) const

pure virtual

Returns

the number of element (i.e. faces, vector) contained in the array.

Implemented in Ra::Core::Geometry::GeometryIndexLayer< T >, Ra::Core::Geometry::GeometryIndexLayer< Vector1ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector2ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector3ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector4ui >, Ra::Core::Geometry::GeometryIndexLayer< VectorNui >, Ra::Core::Utils::Attrib< T >, Ra::Core::VectorArray< V >, Ra::Core::VectorArray< IndexType >, Ra::Core::VectorArray< Ra::Core::Vector3ui >, Ra::Core::VectorArray< Scalar >, Ra::Core::VectorArray< T >, Ra::Core::VectorArray< Vector >, Ra::Core::VectorArray< Vector2 >, Ra::Core::VectorArray< Vector3 >, and Ra::Core::VectorArray< Vector4 >.

getStride()

virtual int Ra::Core::Utils::ContainerIntrospectionInterface::getStride ( ) const

pure virtual

Returns

the stride, in bytes, from one attribute address to the next one.

Warning

it's meaningful only if the attrib do not contain heap allocated data. Such attrib could not be easily sent to the GPU, and getStride is meaningless.

Implemented in Ra::Core::Geometry::GeometryIndexLayer< T >, Ra::Core::Geometry::GeometryIndexLayer< Vector1ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector2ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector3ui >, Ra::Core::Geometry::GeometryIndexLayer< Vector4ui >, Ra::Core::Geometry::GeometryIndexLayer< VectorNui >, Ra::Core::Utils::Attrib< T >, Ra::Core::VectorArray< V >, Ra::Core::VectorArray< IndexType >, Ra::Core::VectorArray< Ra::Core::Vector3ui >, Ra::Core::VectorArray< Scalar >, Ra::Core::VectorArray< T >, Ra::Core::VectorArray< Vector >, Ra::Core::VectorArray< Vector2 >, Ra::Core::VectorArray< Vector3 >, and Ra::Core::VectorArray< Vector4 >.

---

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

• /home/runner/work/Radium-Engine/Radium-Engine/src/Radium-Engine/src/Core/Utils/ContainerIntrospectionInterface.hpp