Detailed Description

A base class for all OpenGL objects with loadable textures.

See also: opengl::COpenGLScene, opengl::CTexturedPlane, opengl::CSetOfTexturedTriangles

Definition at line 22 of file CTexturedObject.h.

#include <mrpt/opengl/CTexturedObject.h>

Inheritance diagram for mrpt::opengl::CTexturedObject:

Public Types
using	UniquePtr = std::unique_ptr< CObject >

using	ConstUniquePtr = std::unique_ptr< const CObject >

Public Member Functions
void	assignImage (const mrpt::img::CImage &img, const mrpt::img::CImage &imgAlpha)
	Assigns a texture and a transparency image, and enables transparency (If the images are not 2^N x 2^M, they will be internally filled to its dimensions to be powers of two) More...

void	assignImage (const mrpt::img::CImage &img)
	Assigns a texture image, and disable transparency. More...

void	assignImage_fast (mrpt::img::CImage &img, mrpt::img::CImage &imgAlpha)
	Similar to assignImage, but the passed images will be returned as empty: it avoids making a copy of the whole image, just copies a pointer. More...

void	assignImage_fast (mrpt::img::CImage &img)
	Similar to assignImage, but the passed images will be returned as empty: it avoids making a copy of the whole image, just copies a pointer. More...

void	loadTextureInOpenGL () const
	VERY IMPORTANT: If you use a multi-thread application, you MUST call this from the same thread that will later destruct the object in order to the OpenGL texture memory to be correctly deleted. More...

void	render_dl () const override
	Derived classes must implement this method to the render the object. More...

void	render () const override
	Render the object, regenerating the display list if needed, otherwise just calling it. 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 *	clone () const =0
	Returns a deep copy (clone) of the object, indepently of its class. More...

Changes the appearance of the object to render (methods from
CRenderizable that need to be redefined)
CRenderizable &	setColorR_u8 (const uint8_t r) override
	Color components in the range [0,255]. More...

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

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

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

CRenderizable &	setColor_u8 (const mrpt::img::TColor &c) override
	Changes the default object color. More...

CRenderizable &	setColor_u8 (uint8_t R, uint8_t G, uint8_t B, uint8_t A=255)
	Color components in the range [0,255]. 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...

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::img::TColorf	getColor () const
	Returns the object color property as a TColorf. More...

CRenderizable &	setColor (const mrpt::img::TColorf &c)
	Changes the default object color. More...

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::img::TColor &	getColor_u8 () const
	Returns the object color property as a TColor. More...

RTTI classes and functions for polymorphic hierarchies
mrpt::rtti::CObject::Ptr	duplicateGetSmartPtr () const
	Makes a deep copy of the object and returns a smart pointer to it. 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 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 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...

Protected Member Functions
	~CTexturedObject () override

void	unloadTexture ()

virtual void	render_pre () const

virtual void	render_post () const

virtual void	render_texturedobj () const =0
	Must be implemented by derived classes. More...

void	writeToStreamTexturedObject (mrpt::serialization::CArchive &out) const

void	readFromStreamTexturedObject (mrpt::serialization::CArchive &in)

void	writeToStreamRender (mrpt::serialization::CArchive &out) const

Methods accesible or implemented by derived classes
void	notifyChange () const
	Must be called to notify that the object has changed (so, the display list must be updated) More...

virtual bool	should_skip_display_list_cache () const
	Optional: If the object has some state in which creating a display list is NOT preferred over direct rendering, implement this method and return "true" in those cases. More...

void	readFromStreamRender (mrpt::serialization::CArchive &in)

CSerializable virtual methods
virtual uint8_t	serializeGetVersion () const =0
	Must return the current versioning number of the object. More...

virtual void	serializeTo (CArchive &out) const =0
	Pure virtual method for writing (serializing) to an abstract archive. More...

virtual void	serializeTo (CSchemeArchiveBase &out) const
	Virtual method for writing (serializing) to an abstract schema based archive. More...

virtual void	serializeFrom (CArchive &in, uint8_t serial_version)=0
	Pure virtual method for reading (deserializing) from an abstract archive. More...

virtual void	serializeFrom (CSchemeArchiveBase &in)
	Virtual method for reading (deserializing) from an abstract schema based archive. 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
unsigned int	m_glTextureName {0}

bool	m_texture_is_loaded {false}

mrpt::img::CImage	m_textureImage

mrpt::img::CImage	m_textureImageAlpha

bool	m_enableTransparency {false}
	Of the texture using "m_textureImageAlpha". More...

int	r_width {0}
	Size of the texture image, rounded up to next power of 2. More...

int	r_height {0}

int	m_pad_x_right {0}
	The size of the fill in pixels in the textured image, w.r.t the image passed by the user. More...

int	m_pad_y_bottom {0}

std::string	m_name

bool	m_show_name {false}

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

mrpt::poses::CPose3D	m_pose
	6D pose wrt the parent coordinate reference. More...

float	m_scale_x {1}
	Scale components to apply to the object (default=1) More...

float	m_scale_y {1}

float	m_scale_z {1}

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

RTTI stuff
using	Ptr = std::shared_ptr< CTexturedObject >

using	ConstPtr = std::shared_ptr< const CTexturedObject >

static const mrpt::rtti::TRuntimeClassId	runtimeClassId

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

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

static const mrpt::rtti::TRuntimeClassId &	GetRuntimeClassIdStatic ()

Member Typedef Documentation

◆ ConstPtr

using mrpt::opengl::CTexturedObject::ConstPtr = std::shared_ptr<const CTexturedObject >

Definition at line 24 of file CTexturedObject.h.

◆ ConstUniquePtr

using mrpt::rtti::CObject::ConstUniquePtr = std::unique_ptr<const CObject>

inherited

Definition at line 183 of file CObject.h.

◆ Ptr

using mrpt::opengl::CTexturedObject::Ptr = std::shared_ptr< CTexturedObject >

Definition at line 24 of file CTexturedObject.h.

◆ UniquePtr

using mrpt::rtti::CObject::UniquePtr = std::unique_ptr<CObject>

inherited

Definition at line 182 of file CObject.h.

Constructor & Destructor Documentation

◆ ~CTexturedObject()

CTexturedObject::~CTexturedObject ( )

overrideprotected

Definition at line 462 of file CTexturedObject.cpp.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::rtti::TRuntimeClassId* mrpt::opengl::CTexturedObject::_GetBaseClass ( )

staticprotected

◆ assignImage() [1/2]

void CTexturedObject::assignImage	(	const mrpt::img::CImage &	img,
		const mrpt::img::CImage &	imgAlpha
	)

Assigns a texture and a transparency image, and enables transparency (If the images are not 2^N x 2^M, they will be internally filled to its dimensions to be powers of two)

Note: Images are copied, the original ones can be deleted.

Definition at line 58 of file CTexturedObject.cpp.

References MRPT_END, MRPT_START, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

Here is the call graph for this function:

◆ assignImage() [2/2]

void CTexturedObject::assignImage ( const mrpt::img::CImage & img )

Assigns a texture image, and disable transparency.

Note: Images are copied, the original ones can be deleted.

Definition at line 78 of file CTexturedObject.cpp.

References MRPT_END, MRPT_START, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

Here is the call graph for this function:

◆ assignImage_fast() [1/2]

void CTexturedObject::assignImage_fast	(	mrpt::img::CImage &	img,
		mrpt::img::CImage &	imgAlpha
	)

Similar to assignImage, but the passed images will be returned as empty: it avoids making a copy of the whole image, just copies a pointer.

Definition at line 97 of file CTexturedObject.cpp.

References MRPT_END, MRPT_START, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

Here is the call graph for this function:

◆ assignImage_fast() [2/2]

void CTexturedObject::assignImage_fast ( mrpt::img::CImage & img )

Similar to assignImage, but the passed images will be returned as empty: it avoids making a copy of the whole image, just copies a pointer.

Definition at line 117 of file CTexturedObject.cpp.

References MRPT_END, MRPT_START, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

Here is the call graph for this function:

◆ checkOpenGLError()

void CRenderizable::checkOpenGLError ( )

staticprotectedinherited

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

Definition at line 295 of file CRenderizable.cpp.

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

Referenced by mrpt::opengl::COpenGLViewport::render(), mrpt::opengl::CBox::render_dl(), mrpt::opengl::CPlanarLaserScan::render_dl(), mrpt::opengl::CSetOfLines::render_dl(), mrpt::opengl::CVectorField2D::render_dl(), mrpt::opengl::CVectorField3D::render_dl(), and mrpt::opengl::CPolyhedron::render_dl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone()

virtual CObject* mrpt::rtti::CObject::clone ( ) const

pure virtualinherited

Returns a deep copy (clone) of the object, indepently of its class.

Referenced by mrpt::rtti::CObject::duplicateGetSmartPtr(), mrpt::maps::CSimpleMap::insert(), mrpt::obs::CActionCollection::insert(), and mrpt::poses::CPoseRandomSampler::setPosePDF().

Here is the caller graph for this function:

◆ duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr CObject::duplicateGetSmartPtr ( ) const

inlineinherited

Makes a deep copy of the object and returns a smart pointer to it.

Definition at line 200 of file CObject.h.

References mrpt::rtti::CObject::clone().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableShowName()

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

inlineinherited

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

Definition at line 82 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_show_name.

◆ getBoundingBox()

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

pure virtualinherited

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

◆ getColor()

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

inlineinherited

Returns the object color property as a TColorf.

Definition at line 231 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_color.

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

Here is the caller graph for this function:

◆ getColor_u8()

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

inlineinherited

Returns the object color property as a TColor.

Definition at line 250 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_color.

◆ getColorA()

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

inlineinherited

Color components in the range [0,1].

Definition at line 154 of file CRenderizable.h.

References mrpt::img::TColor::A, and mrpt::opengl::CRenderizable::m_color.

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

Here is the caller graph for this function:

◆ getColorA_u8()

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

inlineinherited

Color components in the range [0,255].

Definition at line 162 of file CRenderizable.h.

References mrpt::img::TColor::A, and mrpt::opengl::CRenderizable::m_color.

◆ getColorB()

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

inlineinherited

Color components in the range [0,1].

Definition at line 152 of file CRenderizable.h.

References mrpt::img::TColor::B, and mrpt::opengl::CRenderizable::m_color.

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

Here is the caller graph for this function:

◆ getColorB_u8()

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

inlineinherited

Color components in the range [0,255].

Definition at line 160 of file CRenderizable.h.

References mrpt::img::TColor::B, and mrpt::opengl::CRenderizable::m_color.

◆ getColorG()

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

inlineinherited

Color components in the range [0,1].

Definition at line 150 of file CRenderizable.h.

References mrpt::img::TColor::G, and mrpt::opengl::CRenderizable::m_color.

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

Here is the caller graph for this function:

◆ getColorG_u8()

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

inlineinherited

Color components in the range [0,255].

Definition at line 158 of file CRenderizable.h.

References mrpt::img::TColor::G, and mrpt::opengl::CRenderizable::m_color.

◆ getColorR()

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

inlineinherited

Color components in the range [0,1].

Definition at line 148 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_color, and mrpt::img::TColor::R.

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

Here is the caller graph for this function:

◆ getColorR_u8()

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

inlineinherited

Color components in the range [0,255].

Definition at line 156 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_color, and mrpt::img::TColor::R.

◆ getName()

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

inlineinherited

Returns the name of the object.

Definition at line 67 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_name.

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

Here is the caller graph for this function:

◆ getNewTextureNumber()

unsigned int CRenderizable::getNewTextureNumber ( )

staticprotectedinherited

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 65 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ getPose()

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

inherited

Returns the 3D pose of the object as TPose3D.

Definition at line 337 of file CRenderizable.cpp.

References mrpt::poses::CPose3D::asTPose(), and mrpt::opengl::CRenderizable::m_pose.

Here is the call graph for this function:

◆ getPosePitch()

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

inlineinherited

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 138 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, mrpt::poses::CPose3D::pitch(), and mrpt::RAD2DEG().

Here is the call graph for this function:

◆ getPosePitchRad()

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

inlineinherited

Rotation relative to parent coordinate origin, in radians.

Definition at line 144 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, and mrpt::poses::CPose3D::pitch().

Here is the call graph for this function:

◆ getPoseRef()

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

inlineinherited

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 108 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose.

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

Here is the caller graph for this function:

◆ getPoseRoll()

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

inlineinherited

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 140 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, mrpt::RAD2DEG(), and mrpt::poses::CPose3D::roll().

Here is the call graph for this function:

◆ getPoseRollRad()

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

inlineinherited

Rotation relative to parent coordinate origin, in radians.

Definition at line 146 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, and mrpt::poses::CPose3D::roll().

Here is the call graph for this function:

◆ getPoseX()

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

inlineinherited

Translation relative to parent coordinate origin.

Definition at line 130 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, and mrpt::poses::CPoseOrPoint< DERIVEDCLASS, DIM >::x().

Here is the call graph for this function:

◆ getPoseY()

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

inlineinherited

Translation relative to parent coordinate origin.

Definition at line 132 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, and mrpt::poses::CPoseOrPoint< DERIVEDCLASS, DIM >::y().

Here is the call graph for this function:

◆ getPoseYaw()

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

inlineinherited

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 136 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, mrpt::RAD2DEG(), and mrpt::poses::CPose3D::yaw().

Here is the call graph for this function:

◆ getPoseYawRad()

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

inlineinherited

Rotation relative to parent coordinate origin, in radians.

Definition at line 142 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, and mrpt::poses::CPose3D::yaw().

Here is the call graph for this function:

◆ getPoseZ()

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

inlineinherited

Translation relative to parent coordinate origin.

Definition at line 134 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose.

◆ GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::opengl::CTexturedObject::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::opengl::CRenderizableDisplayList.

Reimplemented in mrpt::opengl::CSetOfTexturedTriangles, and mrpt::opengl::CTexturedPlane.

◆ GetRuntimeClassIdStatic()

static const mrpt::rtti::TRuntimeClassId& mrpt::opengl::CTexturedObject::GetRuntimeClassIdStatic ( )

static

◆ getScaleX()

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

inlineinherited

Get the current scaling factor in one axis.

Definition at line 225 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_scale_x.

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

Here is the caller graph for this function:

◆ getScaleY()

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

inlineinherited

Get the current scaling factor in one axis.

Definition at line 227 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_scale_y.

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

Here is the caller graph for this function:

◆ getScaleZ()

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

inlineinherited

Get the current scaling factor in one axis.

Definition at line 229 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_scale_z.

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

Here is the caller graph for this function:

◆ isShowNameEnabled()

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

inlineinherited

See also: enableShowName

Definition at line 84 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_show_name.

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

Here is the caller graph for this function:

◆ isVisible()

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

inlineinherited

Is the object visible?

See also: setVisibility

Definition at line 68 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_visible.

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

Here is the caller graph for this function:

◆ loadTextureInOpenGL()

void CTexturedObject::loadTextureInOpenGL ( ) const

VERY IMPORTANT: If you use a multi-thread application, you MUST call this from the same thread that will later destruct the object in order to the OpenGL texture memory to be correctly deleted.

Calling this method more than once has no effects. If you use one thread, this method will be automatically called when rendering, so there is no need to explicitly call it.

Definition at line 164 of file CTexturedObject.cpp.

References ASSERT_, mrpt::opengl::gl_utils::checkOpenGLError(), mrpt::img::D8U, mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::dump_to_pool(), mrpt::system::CTimeLogger::enter(), mrpt::format(), mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::getInstance(), GL_BGR, GL_BGRA, GL_LINEAR, GL_LUMINANCE, GL_LUMINANCE_ALPHA, GL_MAX_TEXTURE_SIZE, GL_NEAREST, GL_REPEAT, GL_RGB, GL_RGBA, GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_TEXTURE_MIN_FILTER, GL_TEXTURE_WRAP_S, GL_TEXTURE_WRAP_T, GL_UNPACK_ALIGNMENT, GL_UNPACK_ROW_LENGTH, GL_UNSIGNED_BYTE, glBindTexture(), glGetIntegerv(), glPixelStorei(), glTexImage2D(), glTexParameterf(), mrpt::img::IMG_INTERP_LINEAR, mrpt::system::CTimeLogger::leave(), reserveDataBuffer(), and THROW_EXCEPTION.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ notifyChange()

void mrpt::opengl::CRenderizableDisplayList::notifyChange ( ) const

inlineprotectedinherited

Must be called to notify that the object has changed (so, the display list must be updated)

Definition at line 54 of file CRenderizableDisplayList.h.

References mrpt::opengl::CRenderizableDisplayList::m_dl_recreate.

◆ readFromStreamRender()

void mrpt::opengl::CRenderizableDisplayList::readFromStreamRender ( mrpt::serialization::CArchive & in )

inlineprotectedinherited

Definition at line 62 of file CRenderizableDisplayList.h.

References mrpt::opengl::CRenderizableDisplayList::notifyChange(), and mrpt::opengl::CRenderizable::readFromStreamRender().

Referenced by mrpt::opengl::CSetOfLines::serializeFrom(), mrpt::opengl::CVectorField2D::serializeFrom(), mrpt::opengl::CVectorField3D::serializeFrom(), mrpt::opengl::CBox::serializeFrom(), mrpt::opengl::CPolyhedron::serializeFrom(), mrpt::opengl::CFrustum::serializeFrom(), and mrpt::opengl::CPlanarLaserScan::serializeFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFromStreamTexturedObject()

void CTexturedObject::readFromStreamTexturedObject ( mrpt::serialization::CArchive & in )

protected

Definition at line 551 of file CTexturedObject.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

Here is the call graph for this function:

◆ releaseTextureName()

void CRenderizable::releaseTextureName ( unsigned int i )

staticprotectedinherited

Definition at line 93 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ render()

void CRenderizableDisplayList::render ( ) const

overridevirtualinherited

Render the object, regenerating the display list if needed, otherwise just calling it.

Implements mrpt::opengl::CRenderizable.

Definition at line 80 of file CRenderizableDisplayList.cpp.

References TAuxDLData::getSingleton(), GL_COMPILE, GL_NO_ERROR, glCallList(), glDeleteLists(), glEndList(), glGenLists(), glGetError(), glNewList(), INVALID_DISPLAY_LIST_ID, mrpt::opengl::CRenderizableDisplayList::m_dl, mrpt::opengl::CRenderizableDisplayList::m_dl_recreate, mrpt::opengl::CRenderizableDisplayList::render_dl(), and mrpt::opengl::CRenderizableDisplayList::should_skip_display_list_cache().

Here is the call graph for this function:

◆ render_dl()

void CTexturedObject::render_dl ( ) const

overridevirtual

Derived classes must implement this method to the render the object.

Implements mrpt::opengl::CRenderizableDisplayList.

Definition at line 487 of file CTexturedObject.cpp.

References GL_NO_ERROR, and glGetError().

Here is the call graph for this function:

◆ render_post()

void CTexturedObject::render_post ( ) const

protectedvirtual

Definition at line 528 of file CTexturedObject.cpp.

References mrpt::opengl::gl_utils::checkOpenGLError(), GL_BLEND, GL_DEPTH_TEST, GL_ONE, GL_TEXTURE_2D, GL_ZERO, glBlendFunc(), glDisable(), glEnable(), MRPT_END, and MRPT_START.

Here is the call graph for this function:

◆ render_pre()

void CTexturedObject::render_pre ( ) const

protectedvirtual

Definition at line 502 of file CTexturedObject.cpp.

References mrpt::opengl::gl_utils::checkOpenGLError(), GL_BLEND, GL_DEPTH_TEST, GL_ONE_MINUS_SRC_ALPHA, GL_SRC_ALPHA, GL_TEXTURE_2D, glBlendFunc(), glDisable(), glEnable(), MRPT_END, and MRPT_START.

Here is the call graph for this function:

◆ render_texturedobj()

virtual void mrpt::opengl::CTexturedObject::render_texturedobj ( ) const

protectedpure virtual

Must be implemented by derived classes.

Implemented in mrpt::opengl::CSetOfTexturedTriangles, and mrpt::opengl::CTexturedPlane.

◆ renderTextBitmap() [1/2]

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

staticinherited

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

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

Definition at line 361 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ 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`
	)

staticinherited

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 332 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.

Here is the call graph for this function:

◆ serializeFrom() [1/2]

virtual void mrpt::serialization::CSerializable::serializeFrom	(	CArchive &	in,
		uint8_t	serial_version
	)

protectedpure virtualinherited

Pure virtual method for reading (deserializing) from an abstract archive.

Users don't call this method directly. Instead, use stream >> object;.

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 I/O error

◆ serializeFrom() [2/2]

virtual void mrpt::serialization::CSerializable::serializeFrom ( CSchemeArchiveBase & in )

inlineprotectedvirtualinherited

Virtual method for reading (deserializing) from an abstract schema based archive.

Definition at line 74 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ serializeGetVersion()

virtual uint8_t mrpt::serialization::CSerializable::serializeGetVersion ( ) const

protectedpure virtualinherited

Must return the current versioning number of the object.

Start in zero for new classes, and increments each time there is a change in the stored format.

Referenced by mrpt::serialization::CArchive::WriteObject().

Here is the caller graph for this function:

◆ serializeTo() [1/2]

virtual void mrpt::serialization::CSerializable::serializeTo ( CArchive & out ) const

protectedpure virtualinherited

Pure virtual method for writing (serializing) to an abstract archive.

Users don't call this method directly. Instead, use stream << object;.

Exceptions

std::exception On any I/O error

Referenced by mrpt::serialization::CArchive::WriteObject().

Here is the caller graph for this function:

◆ serializeTo() [2/2]

virtual void mrpt::serialization::CSerializable::serializeTo ( CSchemeArchiveBase & out ) const

inlineprotectedvirtualinherited

Virtual method for writing (serializing) to an abstract schema based archive.

Definition at line 64 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ setColor() [1/2]

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

inlineinherited

Changes the default object color.

Returns: a ref to this

Definition at line 236 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::setColor_u8().

Referenced by mrpt::hwdrivers::CSkeletonTracker::processPreview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setColor() [2/2]

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

inlineinherited

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

Returns: a ref to this

Definition at line 244 of file CRenderizable.h.

References G, R, and mrpt::opengl::CRenderizable::setColor_u8().

Here is the call graph for this function:

◆ setColor_u8() [1/2]

CRenderizable& mrpt::opengl::CRenderizableDisplayList::setColor_u8 ( const mrpt::img::TColor & c )

inlineoverridevirtualinherited

Changes the default object color.

Returns: a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 110 of file CRenderizableDisplayList.h.

References mrpt::opengl::CRenderizableDisplayList::notifyChange(), and mrpt::opengl::CRenderizable::setColor_u8().

Here is the call graph for this function:

◆ setColor_u8() [2/2]

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

inlineinherited

Color components in the range [0,255].

Returns: a ref to this

Definition at line 117 of file CRenderizableDisplayList.h.

References G, mrpt::opengl::CRenderizableDisplayList::notifyChange(), R, and mrpt::opengl::CRenderizable::setColor_u8().

Here is the call graph for this function:

◆ setColorA()

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

inlineinherited

Color components in the range [0,1].

Returns: a ref to this

Definition at line 179 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::setColorA_u8().

Here is the call graph for this function:

◆ setColorA_u8()

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

inlineoverridevirtualinherited

Color components in the range [0,255].

Returns: a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 103 of file CRenderizableDisplayList.h.

References mrpt::img::TColor::A, mrpt::opengl::CRenderizable::m_color, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

Referenced by mrpt::nav::ClearanceDiagram::renderAs3DObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setColorB()

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

inlineinherited

Color components in the range [0,1].

Returns: a ref to this

Definition at line 174 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::setColorB_u8().

Here is the call graph for this function:

◆ setColorB_u8()

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

inlineoverridevirtualinherited

Color components in the range [0,255].

Returns: a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 96 of file CRenderizableDisplayList.h.

References mrpt::img::TColor::B, mrpt::opengl::CRenderizable::m_color, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

Here is the call graph for this function:

◆ setColorG()

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

inlineinherited

Color components in the range [0,1].

Returns: a ref to this

Definition at line 169 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::setColorG_u8().

Here is the call graph for this function:

◆ setColorG_u8()

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

inlineoverridevirtualinherited

Color components in the range [0,255].

Returns: a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 89 of file CRenderizableDisplayList.h.

References mrpt::img::TColor::G, mrpt::opengl::CRenderizable::m_color, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

Here is the call graph for this function:

◆ setColorR()

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

inlineinherited

Color components in the range [0,1].

Returns: a ref to this

Definition at line 164 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::setColorR_u8().

Here is the call graph for this function:

◆ setColorR_u8()

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

inlineoverridevirtualinherited

Color components in the range [0,255].

Returns: a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 82 of file CRenderizableDisplayList.h.

References mrpt::opengl::CRenderizable::m_color, mrpt::opengl::CRenderizableDisplayList::notifyChange(), and mrpt::img::TColor::R.

Here is the call graph for this function:

◆ setLocation() [1/2]

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

inlineinherited

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

Returns: a ref to this

Definition at line 111 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, mrpt::poses::CPoseOrPoint< DERIVEDCLASS, DIM >::x(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS, DIM >::y().

Here is the call graph for this function:

◆ setLocation() [2/2]

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

inlineinherited

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

Returns: a ref to this

Definition at line 121 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, mrpt::poses::CPoseOrPoint< DERIVEDCLASS, DIM >::x(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS, DIM >::y().

Here is the call graph for this function:

◆ setName()

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

inlineinherited

Changes the name of the object.

Definition at line 65 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_name.

◆ setPose() [1/6]

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

inherited

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

Definition at line 303 of file CRenderizable.cpp.

References mrpt::opengl::CRenderizable::m_pose.

Referenced by mrpt::hwdrivers::CSkeletonTracker::processPreview().

Here is the caller graph for this function:

◆ setPose() [2/6]

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

inherited

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

Definition at line 308 of file CRenderizable.cpp.

References mrpt::opengl::CRenderizable::m_pose.

◆ setPose() [3/6]

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

inherited

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

Definition at line 313 of file CRenderizable.cpp.

References mrpt::opengl::CRenderizable::m_pose.

◆ setPose() [4/6]

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

inherited

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

Definition at line 318 of file CRenderizable.cpp.

References mrpt::opengl::CRenderizable::m_pose.

◆ setPose() [5/6]

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

inherited

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

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

Definition at line 325 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ setPose() [6/6]

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

inherited

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

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

Definition at line 331 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ setScale() [1/2]

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

inlineinherited

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

Returns: a ref to this

Definition at line 210 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_scale_x, mrpt::opengl::CRenderizable::m_scale_y, and mrpt::opengl::CRenderizable::m_scale_z.

◆ setScale() [2/2]

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

inlineinherited

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

Returns: a ref to this

Definition at line 217 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_scale_x, mrpt::opengl::CRenderizable::m_scale_y, and mrpt::opengl::CRenderizable::m_scale_z.

◆ setVisibility()

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

inlineinherited

Set object visibility (default=true)

See also: isVisible

Definition at line 73 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_visible.

◆ should_skip_display_list_cache()

virtual bool mrpt::opengl::CRenderizableDisplayList::should_skip_display_list_cache ( ) const

inlineprotectedvirtualinherited

Optional: If the object has some state in which creating a display list is NOT preferred over direct rendering, implement this method and return "true" in those cases.

Reimplemented in mrpt::opengl::CSphere.

Definition at line 61 of file CRenderizableDisplayList.h.

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

Here is the caller graph for this function:

◆ textBitmapWidth()

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

staticinherited

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 370 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ traceRay()

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

virtualinherited

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::CMesh, mrpt::opengl::CGeneralizedEllipsoidTemplate< DIM >, mrpt::opengl::CGeneralizedEllipsoidTemplate< 2 >, mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >, mrpt::opengl::CEllipsoid, mrpt::opengl::CSetOfTriangles, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CFrustum, mrpt::opengl::CSetOfObjects, mrpt::opengl::CSetOfTexturedTriangles, mrpt::opengl::CSphere, mrpt::opengl::CDisk, mrpt::opengl::CBox, mrpt::opengl::CTexturedPlane, mrpt::opengl::CAssimpModel, mrpt::opengl::CCylinder, and mrpt::opengl::COpenGLStandardObject.

Definition at line 338 of file CRenderizable.cpp.

◆ unloadTexture()

void CTexturedObject::unloadTexture ( )

protected

Definition at line 466 of file CTexturedObject.cpp.

◆ writeToMatlab()

virtual mxArray* mrpt::serialization::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 nullptr is class does not support conversion to MATLAB.

Definition at line 90 of file CSerializable.h.

◆ writeToStreamRender()

void CRenderizable::writeToStreamRender ( mrpt::serialization::CArchive & out ) const

protectedinherited

Definition at line 104 of file CRenderizable.cpp.

Referenced by mrpt::opengl::CSetOfLines::serializeTo(), mrpt::opengl::CVectorField2D::serializeTo(), mrpt::opengl::CVectorField3D::serializeTo(), mrpt::opengl::CBox::serializeTo(), mrpt::opengl::CPolyhedron::serializeTo(), mrpt::opengl::CFrustum::serializeTo(), and mrpt::opengl::CPlanarLaserScan::serializeTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeToStreamTexturedObject()

void CTexturedObject::writeToStreamTexturedObject ( mrpt::serialization::CArchive & out ) const

protected

Definition at line 476 of file CTexturedObject.cpp.

Member Data Documentation

◆ m_color

mrpt::img::TColor mrpt::opengl::CRenderizable::m_color

protectedinherited

Color components in the range [0,255].

Definition at line 51 of file CRenderizable.h.

◆ m_enableTransparency

bool mrpt::opengl::CTexturedObject::m_enableTransparency {false}

mutableprotected

Of the texture using "m_textureImageAlpha".

Definition at line 32 of file CTexturedObject.h.

Referenced by mrpt::opengl::CTexturedPlane::serializeFrom().

◆ m_glTextureName

unsigned int mrpt::opengl::CTexturedObject::m_glTextureName {0}

mutableprotected

Definition at line 27 of file CTexturedObject.h.

◆ m_name

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

protectedinherited

Definition at line 48 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::getName(), mrpt::opengl::CRenderizable::readFromStreamRender(), mrpt::opengl::CRenderizable::setName(), and mrpt::opengl::CRenderizable::writeToStreamRender().

◆ m_pad_x_right

int mrpt::opengl::CTexturedObject::m_pad_x_right {0}

mutableprotected

The size of the fill in pixels in the textured image, w.r.t the image passed by the user.

Definition at line 37 of file CTexturedObject.h.

◆ m_pad_y_bottom

int mrpt::opengl::CTexturedObject::m_pad_y_bottom {0}

mutableprotected

Definition at line 37 of file CTexturedObject.h.

◆ m_pose

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

protectedinherited

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 54 of file CRenderizable.h.

◆ m_scale_x

float mrpt::opengl::CRenderizable::m_scale_x {1}

protectedinherited

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

Definition at line 56 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::getScaleX(), mrpt::opengl::CRenderizable::readFromStreamRender(), mrpt::opengl::CRenderizable::setScale(), and mrpt::opengl::CRenderizable::writeToStreamRender().

◆ m_scale_y

float mrpt::opengl::CRenderizable::m_scale_y {1}

protectedinherited

Definition at line 56 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::getScaleY(), mrpt::opengl::CRenderizable::readFromStreamRender(), mrpt::opengl::CRenderizable::setScale(), and mrpt::opengl::CRenderizable::writeToStreamRender().

◆ m_scale_z

float mrpt::opengl::CRenderizable::m_scale_z {1}

protectedinherited

Definition at line 56 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::getScaleZ(), mrpt::opengl::CRenderizable::readFromStreamRender(), mrpt::opengl::CRenderizable::setScale(), and mrpt::opengl::CRenderizable::writeToStreamRender().

◆ m_show_name

bool mrpt::opengl::CRenderizable::m_show_name {false}

protectedinherited

Definition at line 49 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::enableShowName(), mrpt::opengl::CRenderizable::isShowNameEnabled(), mrpt::opengl::CRenderizable::readFromStreamRender(), and mrpt::opengl::CRenderizable::writeToStreamRender().

◆ m_texture_is_loaded

bool mrpt::opengl::CTexturedObject::m_texture_is_loaded {false}

mutableprotected

Definition at line 28 of file CTexturedObject.h.

◆ m_textureImage

mrpt::img::CImage mrpt::opengl::CTexturedObject::m_textureImage

mutableprotected

Definition at line 29 of file CTexturedObject.h.

Referenced by mrpt::opengl::CTexturedPlane::serializeFrom().

◆ m_textureImageAlpha

mrpt::img::CImage mrpt::opengl::CTexturedObject::m_textureImageAlpha

mutableprotected

Definition at line 30 of file CTexturedObject.h.

Referenced by mrpt::opengl::CTexturedPlane::serializeFrom().

◆ m_visible

bool mrpt::opengl::CRenderizable::m_visible {true}

protectedinherited

Is the object visible? (default=true)

Definition at line 58 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::isVisible(), mrpt::opengl::CRenderizable::readFromStreamRender(), mrpt::opengl::CRenderizable::setVisibility(), and mrpt::opengl::CRenderizable::writeToStreamRender().

◆ r_height

int mrpt::opengl::CTexturedObject::r_height {0}

mutableprotected

Definition at line 34 of file CTexturedObject.h.

◆ r_width

int mrpt::opengl::CTexturedObject::r_width {0}

mutableprotected

Size of the texture image, rounded up to next power of 2.

Definition at line 34 of file CTexturedObject.h.

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::opengl::CTexturedObject::runtimeClassId

staticprotected

Definition at line 24 of file CTexturedObject.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ ConstUniquePtr

◆ Ptr

◆ UniquePtr

Constructor & Destructor Documentation

◆ ~CTexturedObject()

Member Function Documentation

◆ _GetBaseClass()

◆ assignImage() [1/2]

◆ assignImage() [2/2]

◆ assignImage_fast() [1/2]

◆ assignImage_fast() [2/2]

◆ checkOpenGLError()

◆ clone()

◆ 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()

◆ GetRuntimeClassIdStatic()

◆ getScaleX()

◆ getScaleY()

◆ getScaleZ()

◆ isShowNameEnabled()

◆ isVisible()

◆ loadTextureInOpenGL()

◆ notifyChange()

◆ readFromStreamRender()

◆ readFromStreamTexturedObject()

◆ releaseTextureName()

◆ render()

◆ render_dl()

◆ render_post()

◆ render_pre()

◆ render_texturedobj()

◆ renderTextBitmap() [1/2]

◆ renderTextBitmap() [2/2]

◆ serializeFrom() [1/2]

◆ serializeFrom() [2/2]

◆ serializeGetVersion()

◆ serializeTo() [1/2]

◆ serializeTo() [2/2]

◆ setColor() [1/2]

◆ setColor() [2/2]

◆ setColor_u8() [1/2]

◆ setColor_u8() [2/2]

◆ setColorA()

◆ setColorA_u8()

◆ setColorB()