Ra::Engine::Data::Displayable Class Reference

#include <Engine/Data/DisplayableObject.hpp>

Inheritance diagram for Ra::Engine::Data::Displayable:

Collaboration diagram for Ra::Engine::Data::Displayable:

Public Types
enum	PickingRenderMode {   PKM_POINTS = 0 , PKM_LINES = 1 , PKM_LINE_ADJ = 2 , PKM_TRI = 3 ,   NO_PICKING }

Public Member Functions
	Displayable (const std::string &name)
	Displayable (const Displayable &rhs)=delete
void	operator= (const Displayable &rhs)=delete
PickingRenderMode	pickingRenderMode () const
	Returns the picking rendermode advised by the object (default PickingRenderMode::NO_PICKING)
const std::string &	getName () const
	Returns the name of the mesh.
virtual const Core::Geometry::AbstractGeometry &	getAbstractGeometry () const =0
virtual Core::Geometry::AbstractGeometry &	getAbstractGeometry ()=0
virtual void	updateGL ()=0
virtual void	render (const ShaderProgram *prog)=0
virtual size_t	getNumFaces () const
virtual size_t	getNumVertices () const

Protected Attributes
PickingRenderMode	m_pickingRenderMode { NO_PICKING }

Detailed Description

Base class of any displayable object.

Definition at line 21 of file DisplayableObject.hpp.

Member Enumeration Documentation

PickingRenderMode

enum Ra::Engine::Data::Displayable::PickingRenderMode

Definition at line 24 of file DisplayableObject.hpp.

Constructor & Destructor Documentation

Displayable()

Ra::Engine::Data::Displayable::Displayable ( const std::string & name )

inline

Definition at line 32 of file DisplayableObject.hpp.

Member Function Documentation

getAbstractGeometry()

virtual const Core::Geometry::AbstractGeometry & Ra::Engine::Data::Displayable::getAbstractGeometry ( ) const

pure virtual

Returns the underlying AbstractGeometry, which is in fact a TriangleMesh

See also

getTriangleMesh

Todo

not sure the displayable must have an abstract geometry ...

Implemented in Ra::Engine::Data::CoreGeometryDisplayable< T >, Ra::Engine::Data::CoreGeometryDisplayable< Core::Geometry::LineMesh >, Ra::Engine::Data::CoreGeometryDisplayable< Core::Geometry::PointCloud >, Ra::Engine::Data::CoreGeometryDisplayable< Core::Geometry::TriangleMesh >, and Ra::Engine::Data::VolumeObject.

getName()

const std::string & Ra::Engine::Data::Displayable::getName ( ) const

inline

Returns the name of the mesh.

Definition at line 42 of file DisplayableObject.hpp.

getNumFaces()

virtual size_t Ra::Engine::Data::Displayable::getNumFaces ( ) const

inlinevirtual

Reimplemented in Ra::Engine::Data::Mesh, and Ra::Engine::Data::VolumeObject.

Definition at line 61 of file DisplayableObject.hpp.

getNumVertices()

virtual size_t Ra::Engine::Data::Displayable::getNumVertices ( ) const

inlinevirtual

Reimplemented in Ra::Engine::Data::VolumeObject.

Definition at line 62 of file DisplayableObject.hpp.

pickingRenderMode()

PickingRenderMode Ra::Engine::Data::Displayable::pickingRenderMode ( ) const

inline

Returns the picking rendermode advised by the object (default PickingRenderMode::NO_PICKING)

Definition at line 39 of file DisplayableObject.hpp.

render()

virtual void Ra::Engine::Data::Displayable::render ( const ShaderProgram * prog )

pure virtual

Draw the mesh. Prog is used to set VertexAttribBinding, but it has to be already binded

Implemented in Ra::Engine::Data::IndexedGeometry< T >, Ra::Engine::Data::IndexedGeometry< Core::Geometry::LineMesh >, Ra::Engine::Data::IndexedGeometry< Core::Geometry::TriangleMesh >, Ra::Engine::Data::MultiIndexedGeometry< T >, Ra::Engine::Data::PointCloud, and Ra::Engine::Data::VolumeObject.

updateGL()

virtual void Ra::Engine::Data::Displayable::updateGL ( )

pure virtual

This function is called at the start of the rendering. It will update the necessary openGL buffers.

Implemented in Ra::Engine::Data::AttribArrayDisplayable, Ra::Engine::Data::CoreGeometryDisplayable< T >, Ra::Engine::Data::CoreGeometryDisplayable< Core::Geometry::LineMesh >, Ra::Engine::Data::CoreGeometryDisplayable< Core::Geometry::PointCloud >, Ra::Engine::Data::CoreGeometryDisplayable< Core::Geometry::TriangleMesh >, and Ra::Engine::Data::VolumeObject.

Member Data Documentation

m_pickingRenderMode

PickingRenderMode Ra::Engine::Data::Displayable::m_pickingRenderMode { NO_PICKING }

protected

Definition at line 65 of file DisplayableObject.hpp.

---

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

• /home/runner/work/Radium-Engine/Radium-Engine/src/Radium-Engine/src/Engine/Data/DisplayableObject.hpp