Detailed Description

The base class of 3D objects that can be directly rendered through OpenGL.

In this class there are a set of common properties to all 3D objects, mainly:

A name (m_name): A name that can be optionally asigned to objects for easing its reference.
6D coordinates (x,y,z,yaw,pitch,roll), relative to the "current" reference framework. By default, any object is referenced to global scene coordinates.
A RGB color: This field will be used in simple elements (points, lines, text,...) but is ignored in more complex objects that carry their own color information (triangle sets,...) See the main class opengl::COpenGLScene
See also
opengl::COpenGLScene, mrpt::opengl

Definition at line 44 of file CRenderizable.h.

#include <mrpt/opengl/CRenderizable.h>

Inheritance diagram for mrpt::opengl::CRenderizable:

Public Member Functions
	CRenderizable ()
	Default constructor: More...

virtual	~CRenderizable ()

CRenderizable *	clone () const
	Interface for the stlplus smart pointer class. More...

virtual void	render () const =0
	Implements the rendering of 3D objects in each class derived from CRenderizable. More...

virtual bool	traceRay (const mrpt::poses::CPose3D &o, double &dist) const
	Simulation of ray-trace, given a pose. More...

virtual void	getBoundingBox (mrpt::math::TPoint3D &bb_min, mrpt::math::TPoint3D &bb_max) const =0
	Evaluates the bounding box of this object (including possible children) in the coordinate frame of the object parent. More...

virtual mxArray *	writeToMatlab () const
	Introduces a pure virtual method responsible for writing to a `mxArray` Matlab object, typically a MATLAB `struct` whose contents are documented in each derived class. More...

virtual CObject *	duplicate () const =0
	Returns a copy of the object, indepently of its class. More...

mrpt::utils::CObjectPtr	duplicateGetSmartPtr () const
	Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More...

Changes the appearance of the object to render
void	setName (const std::string &n)
	Changes the name of the object. More...

const std::string &	getName () const
	Returns the name of the object. More...

bool	isVisible () const
	Is the object visible? More...

void	setVisibility (bool visible=true)
	Set object visibility (default=true) More...

void	enableShowName (bool showName=true)
	Enables or disables showing the name of the object as a label when rendering. More...

bool	isShowNameEnabled () const

CRenderizable &	setPose (const mrpt::poses::CPose3D &o)
	Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...

CRenderizable &	setPose (const mrpt::poses::CPose2D &o)
	Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...

CRenderizable &	setPose (const mrpt::math::TPose3D &o)
	Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this) More...

CRenderizable &	setPose (const mrpt::math::TPose2D &o)
	Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this) More...

CRenderizable &	setPose (const mrpt::poses::CPoint3D &o)
	Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...

CRenderizable &	setPose (const mrpt::poses::CPoint2D &o)
	Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...

mrpt::math::TPose3D	getPose () const
	Returns the 3D pose of the object as TPose3D. More...

const mrpt::poses::CPose3D &	getPoseRef () const
	Returns a const ref to the 3D pose of the object as mrpt::poses::CPose3D (which explicitly contains the 3x3 rotation matrix) More...

CRenderizable &	setLocation (double x, double y, double z)
	Changes the location of the object, keeping untouched the orientation. More...

CRenderizable &	setLocation (const mrpt::math::TPoint3D &p)
	Changes the location of the object, keeping untouched the orientation. More...

double	getPoseX () const
	Translation relative to parent coordinate origin. More...

double	getPoseY () const
	Translation relative to parent coordinate origin. More...

double	getPoseZ () const
	Translation relative to parent coordinate origin. More...

double	getPoseYaw () const
	Rotation relative to parent coordinate origin, in DEGREES. More...

double	getPosePitch () const
	Rotation relative to parent coordinate origin, in DEGREES. More...

double	getPoseRoll () const
	Rotation relative to parent coordinate origin, in DEGREES. More...

double	getPoseYawRad () const
	Rotation relative to parent coordinate origin, in radians. More...

double	getPosePitchRad () const
	Rotation relative to parent coordinate origin, in radians. More...

double	getPoseRollRad () const
	Rotation relative to parent coordinate origin, in radians. More...

double	getColorR () const
	Color components in the range [0,1]. More...

double	getColorG () const
	Color components in the range [0,1]. More...

double	getColorB () const
	Color components in the range [0,1]. More...

double	getColorA () const
	Color components in the range [0,1]. More...

uint8_t	getColorR_u8 () const
	Color components in the range [0,255]. More...

uint8_t	getColorG_u8 () const
	Color components in the range [0,255]. More...

uint8_t	getColorB_u8 () const
	Color components in the range [0,255]. More...

uint8_t	getColorA_u8 () const
	Color components in the range [0,255]. More...

CRenderizable &	setColorR (const double r)
	Color components in the range [0,1]. More...

CRenderizable &	setColorG (const double g)
	Color components in the range [0,1]. More...

CRenderizable &	setColorB (const double b)
	Color components in the range [0,1]. More...

CRenderizable &	setColorA (const double a)
	Color components in the range [0,1]. More...

virtual CRenderizable &	setColorR_u8 (const uint8_t r)
	Color components in the range [0,255]. More...

virtual CRenderizable &	setColorG_u8 (const uint8_t g)
	Color components in the range [0,255]. More...

virtual CRenderizable &	setColorB_u8 (const uint8_t b)
	Color components in the range [0,255]. More...

virtual CRenderizable &	setColorA_u8 (const uint8_t a)
	Color components in the range [0,255]. More...

CRenderizable &	setScale (float s)
	Scale to apply to the object, in all three axes (default=1) More...

CRenderizable &	setScale (float sx, float sy, float sz)
	Scale to apply to the object in each axis (default=1) More...

float	getScaleX () const
	Get the current scaling factor in one axis. More...

float	getScaleY () const
	Get the current scaling factor in one axis. More...

float	getScaleZ () const
	Get the current scaling factor in one axis. More...

mrpt::utils::TColorf	getColor () const
	Returns the object color property as a TColorf. More...

CRenderizable &	setColor (const mrpt::utils::TColorf &c)

CRenderizable &	setColor (double R, double G, double B, double A=1)
	Set the color components of this object (R,G,B,Alpha, in the range 0-1) More...

const mrpt::utils::TColor &	getColor_u8 () const
	Returns the object color property as a TColor. More...

virtual CRenderizable &	setColor_u8 (const mrpt::utils::TColor &c)

CRenderizable &	setColor_u8 (uint8_t R, uint8_t G, uint8_t B, uint8_t A=255)
	Set the color components of this object (R,G,B,Alpha, in the range 0-255) More...

Static Public Member Functions
static void	renderTextBitmap (const char str, void fontStyle)
	This method is safe for calling from within ::render() methods. More...

static int	textBitmapWidth (const std::string &str, mrpt::opengl::TOpenGLFont font=mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24)
	Return the exact width in pixels for a given string, as will be rendered by renderTextBitmap(). More...

static void	renderTextBitmap (int screen_x, int screen_y, const std::string &str, float color_r=1, float color_g=1, float color_b=1, mrpt::opengl::TOpenGLFont font=mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24)
	Render a text message in the current rendering context, creating a glViewport in the way (do not call within ::render() methods) More...

Static Public Attributes
static const mrpt::utils::TRuntimeClassId	classCObject

RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable

Protected Member Functions
void	writeToStreamRender (utils::CStream &out) const

void	readFromStreamRender (utils::CStream &in)

virtual void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const =0
	Introduces a pure virtual method responsible for writing to a CStream. More...

virtual void	readFromStream (mrpt::utils::CStream &in, int version)=0
	Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More...

Static Protected Member Functions
static void	checkOpenGLError ()
	Checks glGetError and throws an exception if an error situation is found. More...

static unsigned int	getNewTextureNumber ()
	Returns the lowest next free texture name (avoid using OpenGL's own function since we may call them from different threads and seem it's not cool). More...

static void	releaseTextureName (unsigned int i)

Protected Attributes
std::string	m_name

bool	m_show_name

mrpt::utils::TColor	m_color
	Color components in the range [0,255]. More...

mrpt::poses::CPose3D	m_pose
	6D pose wrt the parent coordinate reference. This class automatically holds the cached 3x3 rotation matrix for quick load into opengl stack. More...

float	m_scale_x

float	m_scale_y

float	m_scale_z
	Scale components to apply to the object (default=1) More...

bool	m_visible
	Is the object visible? (default=true) More...

Friends
class	mrpt::opengl::COpenGLViewport

class	mrpt::opengl::CSetOfObjects

RTTI stuff
typedef CRenderizablePtr	Ptr

typedef CRenderizablePtr	ConstPtr

static const mrpt::utils::TRuntimeClassId	classCRenderizable

class	mrpt::utils::CStream

static const mrpt::utils::TRuntimeClassId *	_GetBaseClass ()

virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const
	Returns information about the class of an object in runtime. More...

Member Typedef Documentation

◆ ConstPtr

typedef CRenderizablePtr mrpt::opengl::CRenderizable::ConstPtr

Definition at line 46 of file CRenderizable.h.

◆ Ptr

typedef CRenderizablePtr mrpt::opengl::CRenderizable::Ptr

Definition at line 46 of file CRenderizable.h.

Constructor & Destructor Documentation

◆ CRenderizable()

CRenderizable::CRenderizable ( )

Default constructor:

Definition at line 58 of file CRenderizable.cpp.

◆ ~CRenderizable()

CRenderizable::~CRenderizable ( )

virtual

Definition at line 69 of file CRenderizable.cpp.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::opengl::CRenderizable::_GetBaseClass ( )

staticprotected

◆ checkOpenGLError()

void CRenderizable::checkOpenGLError ( )

staticprotected

Checks glGetError and throws an exception if an error situation is found.

Definition at line 277 of file CRenderizable.cpp.

References mrpt::opengl::gl_utils::checkOpenGLError().

Referenced by mrpt::opengl::CTexturedObject::loadTextureInOpenGL(), mrpt::opengl::COpenGLViewport::render(), mrpt::opengl::CBox::render_dl(), mrpt::opengl::CSimpleLine::render_dl(), mrpt::opengl::CGridPlaneXY::render_dl(), mrpt::opengl::CGridPlaneXZ::render_dl(), mrpt::opengl::CSetOfLines::render_dl(), mrpt::opengl::CVectorField2D::render_dl(), mrpt::opengl::CVectorField3D::render_dl(), mrpt::opengl::CTexturedObject::render_post(), mrpt::opengl::CTexturedObject::render_pre(), and mrpt::opengl::CTexturedPlane::render_texturedobj().

◆ clone()

CRenderizable* mrpt::opengl::CRenderizable::clone ( ) const

inline

Interface for the stlplus smart pointer class.

Definition at line 150 of file CRenderizable.h.

◆ duplicate()

virtual CObject* mrpt::utils::CObject::duplicate ( ) const

pure virtualinherited

Returns a copy of the object, indepently of its class.

Referenced by mrpt::poses::CPoseRandomSampler::CPoseRandomSampler(), mrpt::maps::CSimpleMap::insert(), mrpt::obs::CActionCollection::insert(), mrpt::poses::CPoseRandomSampler::operator=(), and mrpt::poses::CPoseRandomSampler::setPosePDF().

◆ duplicateGetSmartPtr()

mrpt::utils::CObjectPtr mrpt::utils::CObject::duplicateGetSmartPtr ( ) const

inlineinherited

Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).

Definition at line 140 of file CObject.h.

Referenced by mrpt::obs::CRawlog::addActions(), mrpt::slam::CIncrementalMapPartitioner::addMapFrame(), and mrpt::obs::CRawlog::addObservations().

◆ enableShowName()

void mrpt::opengl::CRenderizable::enableShowName ( bool showName = true )

inline

Enables or disables showing the name of the object as a label when rendering.

Definition at line 69 of file CRenderizable.h.

◆ getBoundingBox()

virtual void mrpt::opengl::CRenderizable::getBoundingBox	(	mrpt::math::TPoint3D &	bb_min,
		mrpt::math::TPoint3D &	bb_max
	)		const

pure virtual

Evaluates the bounding box of this object (including possible children) in the coordinate frame of the object parent.

Implemented in mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CVectorField3D, mrpt::opengl::CSetOfLines, mrpt::opengl::CVectorField2D, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::COctoMapVoxels, mrpt::opengl::CGeneralizedEllipsoidTemplate< DIM >, mrpt::opengl::CGeneralizedEllipsoidTemplate< 2 >, mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >, mrpt::opengl::CSetOfTriangles, mrpt::opengl::CMesh, mrpt::opengl::CMeshFast, mrpt::opengl::CCylinder, mrpt::opengl::CPolyhedron, mrpt::opengl::CPlanarLaserScan, mrpt::opengl::CMesh3D, mrpt::opengl::CSetOfObjects, mrpt::opengl::CFrustum, mrpt::opengl::CEllipsoid, mrpt::opengl::CCamera, mrpt::opengl::CText3D, mrpt::opengl::CGridPlaneXZ, mrpt::opengl::CPointCloudColoured, mrpt::opengl::CPointCloud, mrpt::opengl::CGridPlaneXY, mrpt::opengl::CTexturedPlane, mrpt::opengl::CAxis, mrpt::opengl::CColorBar, mrpt::opengl::CSimpleLine, mrpt::opengl::CArrow, mrpt::opengl::CSphere, mrpt::opengl::CText, mrpt::opengl::CBox, mrpt::opengl::CDisk, mrpt::opengl::CSetOfTexturedTriangles, mrpt::opengl::COpenGLStandardObject, mrpt::opengl::CAssimpModel, and mrpt::opengl::C3DSScene.

◆ getColor()

mrpt::utils::TColorf mrpt::opengl::CRenderizable::getColor ( ) const

inline

Returns the object color property as a TColorf.

Definition at line 126 of file CRenderizable.h.

Referenced by mrpt::maps::COctoMap::getAsOctoMapVoxels(), and mrpt::maps::CColouredOctoMap::getAsOctoMapVoxels().

◆ getColor_u8()

const mrpt::utils::TColor& mrpt::opengl::CRenderizable::getColor_u8 ( ) const

inline

Returns the object color property as a TColor.

Definition at line 135 of file CRenderizable.h.

◆ getColorA()

double mrpt::opengl::CRenderizable::getColorA ( ) const

inline

Color components in the range [0,1].

Definition at line 102 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

◆ getColorA_u8()

uint8_t mrpt::opengl::CRenderizable::getColorA_u8 ( ) const

inline

Color components in the range [0,255].

Definition at line 107 of file CRenderizable.h.

◆ getColorB()

double mrpt::opengl::CRenderizable::getColorB ( ) const

inline

Color components in the range [0,1].

Definition at line 101 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

◆ getColorB_u8()

uint8_t mrpt::opengl::CRenderizable::getColorB_u8 ( ) const

inline

Color components in the range [0,255].

Definition at line 106 of file CRenderizable.h.

◆ getColorG()

double mrpt::opengl::CRenderizable::getColorG ( ) const

inline

Color components in the range [0,1].

Definition at line 100 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

◆ getColorG_u8()

uint8_t mrpt::opengl::CRenderizable::getColorG_u8 ( ) const

inline

Color components in the range [0,255].

Definition at line 105 of file CRenderizable.h.

◆ getColorR()

double mrpt::opengl::CRenderizable::getColorR ( ) const

inline

Color components in the range [0,1].

Definition at line 99 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

◆ getColorR_u8()

uint8_t mrpt::opengl::CRenderizable::getColorR_u8 ( ) const

inline

Color components in the range [0,255].

Definition at line 104 of file CRenderizable.h.

◆ getName()

const std::string& mrpt::opengl::CRenderizable::getName ( ) const

inline

Returns the name of the object.

Definition at line 64 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

◆ getNewTextureNumber()

unsigned int CRenderizable::getNewTextureNumber ( )

staticprotected

Returns the lowest next free texture name (avoid using OpenGL's own function since we may call them from different threads and seem it's not cool).

Returns the lowest, free texture name.

Definition at line 77 of file CRenderizable.cpp.

References TOpenGLNameBooker::instance(), MAX_GL_TEXTURE_IDS, MAX_GL_TEXTURE_IDS_MASK, MRPT_END, MRPT_START, and THROW_EXCEPTION_FMT.

Referenced by mrpt::opengl::CTexturedObject::loadTextureInOpenGL().

◆ getPose()

mrpt::math::TPose3D CRenderizable::getPose ( ) const

Returns the 3D pose of the object as TPose3D.

Definition at line 321 of file CRenderizable.cpp.

References m_pose.

◆ getPosePitch()

double mrpt::opengl::CRenderizable::getPosePitch ( ) const

inline

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 93 of file CRenderizable.h.

References mrpt::mrpt::utils::RAD2DEG().

◆ getPosePitchRad()

double mrpt::opengl::CRenderizable::getPosePitchRad ( ) const

inline

Rotation relative to parent coordinate origin, in radians.

Definition at line 96 of file CRenderizable.h.

◆ getPoseRef()

const mrpt::poses::CPose3D& mrpt::opengl::CRenderizable::getPoseRef ( ) const

inline

Returns a const ref to the 3D pose of the object as mrpt::poses::CPose3D (which explicitly contains the 3x3 rotation matrix)

Definition at line 81 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

◆ getPoseRoll()

double mrpt::opengl::CRenderizable::getPoseRoll ( ) const

inline

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 94 of file CRenderizable.h.

References mrpt::mrpt::utils::RAD2DEG().

◆ getPoseRollRad()

double mrpt::opengl::CRenderizable::getPoseRollRad ( ) const

inline

Rotation relative to parent coordinate origin, in radians.

Definition at line 97 of file CRenderizable.h.

◆ getPoseX()

double mrpt::opengl::CRenderizable::getPoseX ( ) const

inline

Translation relative to parent coordinate origin.

Definition at line 89 of file CRenderizable.h.

◆ getPoseY()

double mrpt::opengl::CRenderizable::getPoseY ( ) const

inline

Translation relative to parent coordinate origin.

Definition at line 90 of file CRenderizable.h.

◆ getPoseYaw()

double mrpt::opengl::CRenderizable::getPoseYaw ( ) const

inline

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 92 of file CRenderizable.h.

References mrpt::mrpt::utils::RAD2DEG().

◆ getPoseYawRad()

double mrpt::opengl::CRenderizable::getPoseYawRad ( ) const

inline

Rotation relative to parent coordinate origin, in radians.

Definition at line 95 of file CRenderizable.h.

◆ getPoseZ()

double mrpt::opengl::CRenderizable::getPoseZ ( ) const

inline

Translation relative to parent coordinate origin.

Definition at line 91 of file CRenderizable.h.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::opengl::CRenderizable::GetRuntimeClass ( ) const

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

Reimplemented in mrpt::opengl::COctoMapVoxels, mrpt::opengl::CPlanarLaserScan, mrpt::opengl::CPointCloud, mrpt::opengl::CFrustum, mrpt::opengl::CPointCloudColoured, mrpt::opengl::CEllipsoidInverseDepth3D, mrpt::opengl::CEllipsoid, mrpt::opengl::CEllipsoidInverseDepth2D, mrpt::opengl::CText3D, mrpt::opengl::CVectorField3D, mrpt::opengl::CAssimpModel, mrpt::opengl::CMeshFast, mrpt::opengl::CEllipsoidRangeBearing2D, mrpt::opengl::CMesh, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CMesh3D, mrpt::opengl::CText, mrpt::opengl::CBox, mrpt::opengl::CRenderizableDisplayList, mrpt::opengl::CVectorField2D, mrpt::opengl::CGridPlaneXY, mrpt::opengl::CGridPlaneXZ, mrpt::opengl::CSetOfLines, mrpt::opengl::CArrow, mrpt::opengl::CAxis, mrpt::opengl::CDisk, mrpt::opengl::CSphere, mrpt::opengl::CCamera, mrpt::opengl::CColorBar, mrpt::opengl::CPolyhedron, mrpt::opengl::CSetOfObjects, mrpt::opengl::CCylinder, mrpt::opengl::CSetOfTriangles, mrpt::opengl::CTexturedObject, mrpt::opengl::C3DSScene, mrpt::opengl::CSetOfTexturedTriangles, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CSimpleLine, mrpt::opengl::CTexturedPlane, and mrpt::opengl::COpenGLStandardObject.

Referenced by mrpt::opengl::COpenGLViewport::render().

◆ getScaleX()

float mrpt::opengl::CRenderizable::getScaleX ( ) const

inline

Get the current scaling factor in one axis.

Definition at line 121 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

◆ getScaleY()

float mrpt::opengl::CRenderizable::getScaleY ( ) const

inline

Get the current scaling factor in one axis.

Definition at line 122 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

◆ getScaleZ()

float mrpt::opengl::CRenderizable::getScaleZ ( ) const

inline

Get the current scaling factor in one axis.

Definition at line 123 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

◆ isShowNameEnabled()

bool mrpt::opengl::CRenderizable::isShowNameEnabled ( ) const

inline

See also: enableShowName

Definition at line 70 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

◆ isVisible()

bool mrpt::opengl::CRenderizable::isVisible ( ) const

inline

Is the object visible?

See also: setVisibility

Definition at line 66 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

◆ readFromStream()

virtual void mrpt::utils::CSerializable::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

protectedpure virtualinherited

Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

Parameters

in	The input binary stream where the object data must read from.
version	The version of the object stored in the stream: use this version number in your code to know how to read the incoming data.

Exceptions

std::exception On any error, see CStream::ReadBuffer

See also: CStream

◆ readFromStreamRender()

void CRenderizable::readFromStreamRender ( utils::CStream & in )

protected

◆ releaseTextureName()

void CRenderizable::releaseTextureName ( unsigned int i )

staticprotected

Definition at line 102 of file CRenderizable.cpp.

References TOpenGLNameBooker::cs, TOpenGLNameBooker::freeTextureNames, TOpenGLNameBooker::instance(), and TOpenGLNameBooker::next_free_texture.

Referenced by mrpt::opengl::CTexturedObject::unloadTexture().

◆ render()

virtual void mrpt::opengl::CRenderizable::render ( ) const

pure virtual

Implements the rendering of 3D objects in each class derived from CRenderizable.

Implemented in mrpt::opengl::CPointCloud, mrpt::opengl::CPointCloudColoured, mrpt::opengl::CCamera, mrpt::opengl::CRenderizableDisplayList, mrpt::opengl::CSetOfObjects, and mrpt::opengl::CText.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

◆ renderTextBitmap() [1/2]

void CRenderizable::renderTextBitmap	(	const char *	str,
		void *	fontStyle
	)

static

This method is safe for calling from within ::render() methods.

See also: renderTextBitmap, mrpt::opengl::gl_utils; renderTextBitmap

Definition at line 351 of file CRenderizable.cpp.

References mrpt::opengl::gl_utils::renderTextBitmap().

◆ renderTextBitmap() [2/2]

void CRenderizable::renderTextBitmap	(	int	screen_x,
		int	screen_y,
		const std::string &	str,
		float	color_r = `1`,
		float	color_g = `1`,
		float	color_b = `1`,
		mrpt::opengl::TOpenGLFont	font = `mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24`
	)

static

Render a text message in the current rendering context, creating a glViewport in the way (do not call within ::render() methods)

Coordinates (x,y) are 2D pixels, starting at bottom-left of the viewport. Negative numbers will wrap to the opposite side of the viewport (e.g. x=-10 means 10px fromt the right).
The text color is defined by (color_r,color_g,color_b), each float numbers in the range [0,1].
See also
renderTextBitmap, textBitmapWidth, mrpt::opengl::gl_utils

Definition at line 286 of file gl_utils.cpp.

References aux_mrptfont2glutfont(), GL_DEPTH_TEST, GL_MODELVIEW, GL_PROJECTION, GL_TRANSFORM_BIT, GL_VIEWPORT, GL_VIEWPORT_BIT, glColor3f(), glDisable(), glEnable(), glGetIntegerv(), glLoadIdentity(), glMatrixMode(), glPopAttrib(), glPopMatrix(), glPushAttrib(), glPushMatrix(), glRasterPos3f(), glViewport(), and MRPT_UNUSED_PARAM.

◆ setColor() [1/2]

CRenderizable& mrpt::opengl::CRenderizable::setColor ( const mrpt::utils::TColorf & c )

inline

Parameters

c	Changes the default object color

Returns: a ref to this

Definition at line 127 of file CRenderizable.h.

◆ setColor() [2/2]

CRenderizable& mrpt::opengl::CRenderizable::setColor	(	double	R,
		double	G,
		double	B,
		double	A = `1`
	)

inline

Set the color components of this object (R,G,B,Alpha, in the range 0-1)

Returns: a ref to this

Definition at line 133 of file CRenderizable.h.

References R.

◆ setColor_u8() [1/2]

CRenderizable & CRenderizable::setColor_u8 ( const mrpt::utils::TColor & c )

virtual

Reimplemented in mrpt::opengl::CSetOfTriangles, mrpt::opengl::CSetOfObjects, and mrpt::opengl::CRenderizableDisplayList.

Definition at line 339 of file CRenderizable.cpp.

References mrpt::utils::TColor::A, mrpt::utils::TColor::B, mrpt::utils::TColor::G, m_color, and mrpt::utils::TColor::R.

Referenced by mrpt::opengl::CRenderizableDisplayList::setColor_u8().

◆ setColor_u8() [2/2]

CRenderizable& mrpt::opengl::CRenderizable::setColor_u8	(	uint8_t	R,
		uint8_t	G,
		uint8_t	B,
		uint8_t	A = `255`
	)

inline

Set the color components of this object (R,G,B,Alpha, in the range 0-255)

Returns: a ref to this

Definition at line 140 of file CRenderizable.h.

References R, and setColor_u8().

Referenced by setColor_u8().

◆ setColorA()

CRenderizable& mrpt::opengl::CRenderizable::setColorA ( const double a )

inline

Color components in the range [0,1].

Returns: a ref to this

Definition at line 112 of file CRenderizable.h.

◆ setColorA_u8()

virtual CRenderizable& mrpt::opengl::CRenderizable::setColorA_u8 ( const uint8_t a )

inlinevirtual

Color components in the range [0,255].

Returns: a ref to this

Reimplemented in mrpt::opengl::CSetOfTriangles, mrpt::opengl::CSetOfObjects, and mrpt::opengl::CRenderizableDisplayList.

Definition at line 117 of file CRenderizable.h.

Referenced by mrpt::opengl::CSetOfObjects::setColorA_u8().

◆ setColorB()

CRenderizable& mrpt::opengl::CRenderizable::setColorB ( const double b )

inline

Color components in the range [0,1].

Returns: a ref to this

Definition at line 111 of file CRenderizable.h.

◆ setColorB_u8()

virtual CRenderizable& mrpt::opengl::CRenderizable::setColorB_u8 ( const uint8_t b )

inlinevirtual

Color components in the range [0,255].

Returns: a ref to this

Reimplemented in mrpt::opengl::CSetOfTriangles, mrpt::opengl::CSetOfObjects, and mrpt::opengl::CRenderizableDisplayList.

Definition at line 116 of file CRenderizable.h.

Referenced by mrpt::opengl::CSetOfObjects::setColorB_u8().

◆ setColorG()

CRenderizable& mrpt::opengl::CRenderizable::setColorG ( const double g )

inline

Color components in the range [0,1].

Returns: a ref to this

Definition at line 110 of file CRenderizable.h.

◆ setColorG_u8()

virtual CRenderizable& mrpt::opengl::CRenderizable::setColorG_u8 ( const uint8_t g )

inlinevirtual

Color components in the range [0,255].

Returns: a ref to this

Reimplemented in mrpt::opengl::CSetOfTriangles, mrpt::opengl::CSetOfObjects, and mrpt::opengl::CRenderizableDisplayList.

Definition at line 115 of file CRenderizable.h.

Referenced by mrpt::opengl::CSetOfObjects::setColorG_u8().

◆ setColorR()

CRenderizable& mrpt::opengl::CRenderizable::setColorR ( const double r )

inline

Color components in the range [0,1].

Returns: a ref to this

Definition at line 109 of file CRenderizable.h.

◆ setColorR_u8()

virtual CRenderizable& mrpt::opengl::CRenderizable::setColorR_u8 ( const uint8_t r )

inlinevirtual

Color components in the range [0,255].

Returns: a ref to this

Reimplemented in mrpt::opengl::CSetOfTriangles, mrpt::opengl::CSetOfObjects, and mrpt::opengl::CRenderizableDisplayList.

Definition at line 114 of file CRenderizable.h.

Referenced by mrpt::opengl::CSetOfObjects::setColorR_u8().

◆ setLocation() [1/2]

CRenderizable& mrpt::opengl::CRenderizable::setLocation	(	double	x,
		double	y,
		double	z
	)

inline

Changes the location of the object, keeping untouched the orientation.

Returns: a ref to this

Definition at line 84 of file CRenderizable.h.

◆ setLocation() [2/2]

CRenderizable& mrpt::opengl::CRenderizable::setLocation ( const mrpt::math::TPoint3D & p )

inline

Changes the location of the object, keeping untouched the orientation.

Returns: a ref to this

Definition at line 87 of file CRenderizable.h.

◆ setName()

void mrpt::opengl::CRenderizable::setName ( const std::string & n )

inline

Changes the name of the object.

Definition at line 63 of file CRenderizable.h.

◆ setPose() [1/6]

CRenderizable & CRenderizable::setPose ( const mrpt::poses::CPose3D & o )

Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)

Definition at line 285 of file CRenderizable.cpp.

References m_pose.

◆ setPose() [2/6]

CRenderizable & CRenderizable::setPose ( const mrpt::poses::CPose2D & o )

Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)

Definition at line 290 of file CRenderizable.cpp.

References m_pose.

◆ setPose() [3/6]

CRenderizable & CRenderizable::setPose ( const mrpt::math::TPose3D & o )

Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this)

Definition at line 295 of file CRenderizable.cpp.

References m_pose.

◆ setPose() [4/6]

CRenderizable & CRenderizable::setPose ( const mrpt::math::TPose2D & o )

Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this)

Definition at line 300 of file CRenderizable.cpp.

References m_pose.

◆ setPose() [5/6]

CRenderizable & CRenderizable::setPose ( const mrpt::poses::CPoint3D & o )

Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)

Parameters

o	Set the 3D pose from a mrpt::poses::CPose3D object

Definition at line 306 of file CRenderizable.cpp.

References m_pose, mrpt::poses::CPose3D::setFromValues(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::y().

◆ setPose() [6/6]

CRenderizable & CRenderizable::setPose ( const mrpt::poses::CPoint2D & o )

Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)

Parameters

o	Set the 3D pose from a mrpt::poses::CPose3D object

Definition at line 311 of file CRenderizable.cpp.

References m_pose, mrpt::poses::CPose3D::setFromValues(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::y().

◆ setScale() [1/2]

CRenderizable& mrpt::opengl::CRenderizable::setScale ( float s )

inline

Scale to apply to the object, in all three axes (default=1)

Returns: a ref to this

Definition at line 119 of file CRenderizable.h.

Referenced by mrpt::opengl::CText3D::CText3D().

◆ setScale() [2/2]

CRenderizable& mrpt::opengl::CRenderizable::setScale	(	float	sx,
		float	sy,
		float	sz
	)

inline

Scale to apply to the object in each axis (default=1)

Returns: a ref to this

Definition at line 120 of file CRenderizable.h.

◆ setVisibility()

void mrpt::opengl::CRenderizable::setVisibility ( bool visible = true )

inline

Set object visibility (default=true)

See also: isVisible

Definition at line 67 of file CRenderizable.h.

◆ textBitmapWidth()

int CRenderizable::textBitmapWidth	(	const std::string &	str,
		mrpt::opengl::TOpenGLFont	font = `mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24`
	)

static

Return the exact width in pixels for a given string, as will be rendered by renderTextBitmap().

See also: renderTextBitmap, mrpt::opengl::gl_utils; renderTextBitmap

Definition at line 359 of file CRenderizable.cpp.

References mrpt::opengl::gl_utils::textBitmapWidth().

◆ traceRay()

bool CRenderizable::traceRay	(	const mrpt::poses::CPose3D &	o,
		double &	dist
	)		const

virtual

Simulation of ray-trace, given a pose.

Returns true if the ray effectively collisions with the object (returning the distance to the origin of the ray in "dist"), or false in other case. "dist" variable yields undefined behaviour when false is returned

Reimplemented in mrpt::opengl::CPolyhedron, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CGeneralizedEllipsoidTemplate< DIM >, mrpt::opengl::CGeneralizedEllipsoidTemplate< 2 >, mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >, mrpt::opengl::CMesh, mrpt::opengl::CSetOfTriangles, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CSetOfObjects, mrpt::opengl::CEllipsoid, mrpt::opengl::CFrustum, mrpt::opengl::CTexturedPlane, mrpt::opengl::CSetOfTexturedTriangles, mrpt::opengl::CSphere, mrpt::opengl::CAssimpModel, mrpt::opengl::C3DSScene, mrpt::opengl::CBox, mrpt::opengl::CDisk, mrpt::opengl::CCylinder, and mrpt::opengl::COpenGLStandardObject.

Definition at line 329 of file CRenderizable.cpp.

References MRPT_UNUSED_PARAM.

◆ writeToMatlab()

virtual mxArray* mrpt::utils::CSerializable::writeToMatlab ( ) const

inlinevirtualinherited

Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class.

Returns: A new mxArray (caller is responsible of memory freeing) or NULL is class does not support conversion to MATLAB.

Definition at line 79 of file CSerializable.h.

◆ writeToStream()

virtual void mrpt::utils::CSerializable::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

protectedpure virtualinherited

Introduces a pure virtual method responsible for writing to a CStream.

This can not be used directly be users, instead use "stream << object;" for writing it to a stream.

Parameters

out	The output binary stream where object must be dumped.
getVersion	If NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data.

Exceptions

std::exception On any error, see CStream::WriteBuffer

See also: CStream

Referenced by mrpt::utils::CStream::WriteObject().

◆ writeToStreamRender()

void CRenderizable::writeToStreamRender ( utils::CStream & out ) const

protected

Definition at line 112 of file CRenderizable.cpp.

References mrpt::utils::TColor::A, mrpt::utils::TColor::B, mrpt::utils::TColor::G, m_color, m_name, m_pose, m_scale_x, m_scale_y, m_scale_z, m_show_name, m_visible, mrpt::poses::CPose3D::pitch(), mrpt::utils::TColor::R, mrpt::poses::CPose3D::roll(), mrpt::utils::CStream::WriteBuffer(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::y(), and mrpt::poses::CPose3D::yaw().

Referenced by mrpt::opengl::CSimpleLine::writeToStream(), mrpt::opengl::CTexturedPlane::writeToStream(), mrpt::opengl::CSetOfLines::writeToStream(), mrpt::opengl::CGridPlaneXY::writeToStream(), mrpt::opengl::CGridPlaneXZ::writeToStream(), mrpt::opengl::CVectorField2D::writeToStream(), mrpt::opengl::CBox::writeToStream(), mrpt::opengl::CText3D::writeToStream(), mrpt::opengl::CVectorField3D::writeToStream(), and mrpt::opengl::CFrustum::writeToStream().

Friends And Related Function Documentation

◆ mrpt::opengl::COpenGLViewport

friend class mrpt::opengl::COpenGLViewport

friend

Definition at line 48 of file CRenderizable.h.

◆ mrpt::opengl::CSetOfObjects

friend class mrpt::opengl::CSetOfObjects

friend

Definition at line 49 of file CRenderizable.h.

◆ mrpt::utils::CStream

friend class mrpt::utils::CStream

friend

Definition at line 46 of file CRenderizable.h.

Member Data Documentation

◆ classCObject

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject

staticinherited

Definition at line 128 of file CObject.h.

◆ classCRenderizable

const mrpt::utils::TRuntimeClassId mrpt::opengl::CRenderizable::classCRenderizable

static

Definition at line 46 of file CRenderizable.h.

◆ classCSerializable

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable

staticinherited

Definition at line 42 of file CSerializable.h.

◆ m_color

mrpt::utils::TColor mrpt::opengl::CRenderizable::m_color

protected

Color components in the range [0,255].

Definition at line 54 of file CRenderizable.h.

Referenced by mrpt::opengl::CMesh3D::CMesh3D(), mrpt::opengl::CVectorField2D::CVectorField2D(), mrpt::opengl::CVectorField3D::CVectorField3D(), readFromStreamRender(), mrpt::opengl::CBox::render_dl(), mrpt::opengl::CSimpleLine::render_dl(), mrpt::opengl::CText3D::render_dl(), mrpt::opengl::CSetOfLines::render_dl(), mrpt::opengl::CVectorField2D::render_dl(), mrpt::opengl::CVectorField3D::render_dl(), mrpt::opengl::CTexturedObject::render_post(), mrpt::opengl::CTexturedObject::render_pre(), setColor_u8(), and writeToStreamRender().

◆ m_name

std::string mrpt::opengl::CRenderizable::m_name

protected

Definition at line 52 of file CRenderizable.h.

Referenced by readFromStreamRender(), and writeToStreamRender().

◆ m_pose

mrpt::poses::CPose3D mrpt::opengl::CRenderizable::m_pose

protected

6D pose wrt the parent coordinate reference. This class automatically holds the cached 3x3 rotation matrix for quick load into opengl stack.

Definition at line 55 of file CRenderizable.h.

◆ m_scale_x

float mrpt::opengl::CRenderizable::m_scale_x

protected

Definition at line 56 of file CRenderizable.h.

Referenced by mrpt::opengl::CText3D::getBoundingBox(), readFromStreamRender(), and writeToStreamRender().

◆ m_scale_y

float mrpt::opengl::CRenderizable::m_scale_y

protected

Definition at line 56 of file CRenderizable.h.

Referenced by readFromStreamRender(), and writeToStreamRender().

◆ m_scale_z

float mrpt::opengl::CRenderizable::m_scale_z

protected

Scale components to apply to the object (default=1)

Definition at line 56 of file CRenderizable.h.

Referenced by readFromStreamRender(), and writeToStreamRender().

◆ m_show_name

bool mrpt::opengl::CRenderizable::m_show_name

protected

Definition at line 53 of file CRenderizable.h.

Referenced by readFromStreamRender(), and writeToStreamRender().

◆ m_visible

bool mrpt::opengl::CRenderizable::m_visible

protected

Is the object visible? (default=true)

Definition at line 57 of file CRenderizable.h.

Referenced by readFromStreamRender(), and writeToStreamRender().

Detailed Description

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ CRenderizable()

◆ ~CRenderizable()

Member Function Documentation

◆ _GetBaseClass()

◆ checkOpenGLError()

◆ clone()

◆ duplicate()

◆ duplicateGetSmartPtr()

◆ enableShowName()

◆ getBoundingBox()

◆ getColor()

◆ getColor_u8()

◆ getColorA()

◆ getColorA_u8()

◆ getColorB()

◆ getColorB_u8()

◆ getColorG()

◆ getColorG_u8()

◆ getColorR()

◆ getColorR_u8()

◆ getName()

◆ getNewTextureNumber()

◆ getPose()

◆ getPosePitch()

◆ getPosePitchRad()

◆ getPoseRef()

◆ getPoseRoll()

◆ getPoseRollRad()

◆ getPoseX()

◆ getPoseY()

◆ getPoseYaw()

◆ getPoseYawRad()

◆ getPoseZ()

◆ GetRuntimeClass()

◆ getScaleX()

◆ getScaleY()

◆ getScaleZ()

◆ isShowNameEnabled()

◆ isVisible()

◆ readFromStream()

◆ readFromStreamRender()

◆ releaseTextureName()

◆ render()

◆ renderTextBitmap() [1/2]

◆ renderTextBitmap() [2/2]

◆ setColor() [1/2]

◆ setColor() [2/2]

◆ setColor_u8() [1/2]

◆ setColor_u8() [2/2]

◆ setColorA()

◆ setColorA_u8()

◆ setColorB()

◆ setColorB_u8()

◆ setColorG()

◆ setColorG_u8()

◆ setColorR()

◆ setColorR_u8()

◆ setLocation() [1/2]

◆ setLocation() [2/2]

◆ setName()

◆ setPose() [1/6]

◆ setPose() [2/6]

◆ setPose() [3/6]

◆ setPose() [4/6]

◆ setPose() [5/6]

◆ setPose() [6/6]

◆ setScale() [1/2]