mrpt::opengl::CText3D Class Reference

Detailed Description

A 3D text (rendered with OpenGL primitives), with selectable font face and drawing style.

Use setString and setFont to change the text displayed by this object (can be multi-lined).

Text is drawn along the (+X,+Y) axes.

Default size of characters is "1.0 units". Change it with the standard method CRenderizable::setScale() as with any other 3D object. The color can be also changed with standard methods in the base class CRenderizable.

See also

opengl::COpenGLScene, CText

mrpt::opengl::CText3D

Note

This class is based on code from libcvd (BSD, http://www.edwardrosten.com/cvd/ )

Definition at line 43 of file CText3D.h.

#include <mrpt/opengl/CText3D.h>

Inheritance diagram for mrpt::opengl::CText3D:

Public Member Functions
void *	operator new (size_t size)
void *	operator new[] (size_t size)
void	operator delete (void *ptr) noexcept
void	operator delete[] (void *ptr) noexcept
void	operator delete (void *memory, void *ptr) noexcept
void *	operator new (size_t size, const std::nothrow_t &) noexcept
void	operator delete (void *ptr, const std::nothrow_t &) noexcept
void	setString (const std::string &s)
	Sets the displayed string. More...
const std::string &	getString () const
	Returns the currently text associated to this object. More...
void	setFont (const std::string &font)
	Changes the font name, among accepted values: "sans", "mono", "serif". More...
const std::string &	getFont () const
	Returns the text font. More...
void	setTextStyle (const mrpt::opengl::TOpenGLFontStyle text_style)
	Change drawing style: FILL, OUTLINE, NICE. More...
mrpt::opengl::TOpenGLFontStyle	getTextStyle () const
	Gets the current drawing style. More...
void	setTextSpacing (const double text_spacing)
double	setTextSpacing () const
void	setTextKerning (const double text_kerning)
double	setTextKerning () const
void	render_dl () const override
	Render. More...
void	getBoundingBox (mrpt::math::TPoint3D &bb_min, mrpt::math::TPoint3D &bb_max) const override
	Evaluates the bounding box of this object (including possible children) in the coordinate frame of the object parent. More...
	CText3D (const std::string &str=std::string(""), const std::string &fontName=std::string("sans"), const double scale=1.0, const mrpt::opengl::TOpenGLFontStyle text_style=mrpt::opengl::NICE, const double text_spacing=1.5, const double text_kerning=0.1)
	Constructor. More...
virtual	~CText3D ()
	Private, virtual destructor: only can be deleted from smart pointers. 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 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...
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
	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...

Static Public Member Functions
static void *	operator new (size_t size, void *ptr)
static CText3D::Ptr	Create (const std::string &str, const std::string &fontName=std::string("sans"), const double scale=1.0, const mrpt::opengl::TOpenGLFontStyle text_style=mrpt::opengl::FILL, const double text_spacing=1.5, const double text_kerning=0.1)
	Class factory. More...
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
void	writeToStreamRender (mrpt::serialization::CArchive &out) const
CSerializable virtual methods
uint8_t	serializeGetVersion () const override
	Must return the current versioning number of the object. More...
void	serializeTo (mrpt::serialization::CArchive &out) const override
	Pure virtual method for writing (serializing) to an abstract archive. More...
void	serializeFrom (mrpt::serialization::CArchive &in, uint8_t serial_version) override
	Pure virtual method for reading (deserializing) from an abstract archive. More...
Methods accesible or implemented by derived classes
EIGEN_STRONG_INLINE 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)

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_str
std::string	m_fontName
TOpenGLFontStyle	m_text_style
double	m_text_spacing
double	m_text_kerning
std::string	m_name
bool	m_show_name
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
	Scale components to apply to the object (default=1) More...
float	m_scale_y
float	m_scale_z
bool	m_visible
	Is the object visible? (default=true) More...

RTTI stuff
using	Ptr = std::shared_ptr< CText3D >
using	ConstPtr = std::shared_ptr< const CText3D >
using	UniquePtr = std::unique_ptr< CText3D >
using	ConstUniquePtr = std::unique_ptr< const CText3D >
static mrpt::rtti::CLASSINIT	_init_CText3D
static const mrpt::rtti::TRuntimeClassId	runtimeClassId
static constexpr const char *	className = "CText3D"
static const mrpt::rtti::TRuntimeClassId *	_GetBaseClass ()
static constexpr auto	getClassName ()
static const mrpt::rtti::TRuntimeClassId &	GetRuntimeClassIdStatic ()
static mrpt::rtti::CObject *	CreateObject ()
template<typename... Args>
static Ptr	Create (Args &&... args)
template<typename... Args>
static UniquePtr	CreateUnique (Args &&... args)
virtual const mrpt::rtti::TRuntimeClassId *	GetRuntimeClass () const override
	Returns information about the class of an object in runtime. More...
virtual mrpt::rtti::CObject *	clone () const override
	Returns a deep copy (clone) of the object, indepently of its class. More...

Member Typedef Documentation

ConstPtr

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

Definition at line 45 of file CText3D.h.

ConstUniquePtr

using mrpt::opengl::CText3D::ConstUniquePtr = std::unique_ptr<const CText3D >

Definition at line 45 of file CText3D.h.

Ptr

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

A type for the associated smart pointer

Definition at line 45 of file CText3D.h.

UniquePtr

using mrpt::opengl::CText3D::UniquePtr = std::unique_ptr< CText3D >

Definition at line 45 of file CText3D.h.

Constructor & Destructor Documentation

CText3D()

CText3D::CText3D	(	const std::string &	str = std::string(""),
		const std::string &	fontName = std::string("sans"),
		const double	scale = 1.0,
		const mrpt::opengl::TOpenGLFontStyle	text_style = mrpt::opengl::NICE,
		const double	text_spacing = 1.5,
		const double	text_kerning = 0.1
	)

Constructor.

Definition at line 36 of file CText3D.cpp.

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

~CText3D()

CText3D::~CText3D ( )

virtual

Private, virtual destructor: only can be deleted from smart pointers.

Definition at line 52 of file CText3D.cpp.

Member Function Documentation

_GetBaseClass()

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

staticprotected

checkOpenGLError()

void CRenderizable::checkOpenGLError ( )

staticprotectedinherited

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

Definition at line 301 of file CRenderizable.cpp.

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

Referenced by 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::CPlanarLaserScan::render_dl(), mrpt::opengl::CSetOfLines::render_dl(), mrpt::opengl::CVectorField2D::render_dl(), mrpt::opengl::CVectorField3D::render_dl(), mrpt::opengl::CPolyhedron::render_dl(), and mrpt::opengl::CTexturedPlane::render_texturedobj().

clone()

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

overridevirtual

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

Implements mrpt::rtti::CObject.

Create() [1/2]

template<typename... Args>

static Ptr mrpt::opengl::CText3D::Create ( Args &&...  args )

inlinestatic

Definition at line 45 of file CText3D.h.

Create() [2/2]

CText3D::Ptr CText3D::Create ( const std::string &  str, const std::string &  fontName = std::string("sans"), const double  scale = 1.0, const mrpt::opengl::TOpenGLFontStyle  text_style = mrpt::opengl::FILL, const double  text_spacing = 1.5, const double  text_kerning = 0.1  )

static

Class factory.

Definition at line 24 of file CText3D.cpp.

CreateObject()

static mrpt::rtti::CObject* mrpt::opengl::CText3D::CreateObject ( )

static

CreateUnique()

template<typename... Args>

static UniquePtr mrpt::opengl::CText3D::CreateUnique ( Args &&...  args )

inlinestatic

Definition at line 45 of file CText3D.h.

duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr 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 168 of file CObject.h.

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

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

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

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

getBoundingBox()

void CText3D::getBoundingBox ( mrpt::math::TPoint3D &  bb_min, mrpt::math::TPoint3D &  bb_max  ) const

overridevirtual

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

Implements mrpt::opengl::CRenderizable.

Definition at line 98 of file CText3D.cpp.

References mrpt::poses::CPose3D::composePoint(), mrpt::opengl::CRenderizable::m_pose, mrpt::opengl::CRenderizable::m_scale_x, m_str, mrpt::math::TPoint3D::x, mrpt::math::TPoint3D::y, and mrpt::math::TPoint3D::z.

getClassName()

static constexpr auto mrpt::opengl::CText3D::getClassName ( )

inlinestatic

Definition at line 45 of file CText3D.h.

getColor()

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

inlineinherited

Returns the object color property as a TColorf.

Definition at line 232 of file CRenderizable.h.

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

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

getColor_u8()

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

inlineinherited

Returns the object color property as a TColor.

Definition at line 252 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 155 of file CRenderizable.h.

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

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

getColorA_u8()

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

inlineinherited

Color components in the range [0,255].

Definition at line 163 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 153 of file CRenderizable.h.

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

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

getColorB_u8()

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

inlineinherited

Color components in the range [0,255].

Definition at line 161 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 151 of file CRenderizable.h.

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

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

getColorG_u8()

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

inlineinherited

Color components in the range [0,255].

Definition at line 159 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 149 of file CRenderizable.h.

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

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

getColorR_u8()

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

inlineinherited

Color components in the range [0,255].

Definition at line 157 of file CRenderizable.h.

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

getFont()

const std::string& mrpt::opengl::CText3D::getFont ( ) const

inline

Returns the text font.

Definition at line 69 of file CText3D.h.

References m_fontName.

getName()

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

inlineinherited

Returns the name of the object.

Definition at line 68 of file CRenderizable.h.

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

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

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

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

getPose()

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

inherited

Returns the 3D pose of the object as TPose3D.

Definition at line 343 of file CRenderizable.cpp.

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

getPosePitch()

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

inlineinherited

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 139 of file CRenderizable.h.

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

getPosePitchRad()

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

inlineinherited

Rotation relative to parent coordinate origin, in radians.

Definition at line 145 of file CRenderizable.h.

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

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

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

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

getPoseRoll()

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

inlineinherited

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 141 of file CRenderizable.h.

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

getPoseRollRad()

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

inlineinherited

Rotation relative to parent coordinate origin, in radians.

Definition at line 147 of file CRenderizable.h.

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

getPoseX()

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

inlineinherited

Translation relative to parent coordinate origin.

Definition at line 131 of file CRenderizable.h.

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

getPoseY()

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

inlineinherited

Translation relative to parent coordinate origin.

Definition at line 133 of file CRenderizable.h.

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

getPoseYaw()

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

inlineinherited

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 137 of file CRenderizable.h.

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

getPoseYawRad()

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

inlineinherited

Rotation relative to parent coordinate origin, in radians.

Definition at line 143 of file CRenderizable.h.

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

getPoseZ()

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

inlineinherited

Translation relative to parent coordinate origin.

Definition at line 135 of file CRenderizable.h.

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

GetRuntimeClass()

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

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::opengl::CRenderizableDisplayList.

GetRuntimeClassIdStatic()

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

static

getScaleX()

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

inlineinherited

Get the current scaling factor in one axis.

Definition at line 226 of file CRenderizable.h.

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

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

getScaleY()

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

inlineinherited

Get the current scaling factor in one axis.

Definition at line 228 of file CRenderizable.h.

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

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

getScaleZ()

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

inlineinherited

Get the current scaling factor in one axis.

Definition at line 230 of file CRenderizable.h.

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

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

getString()

const std::string& mrpt::opengl::CText3D::getString ( ) const

inline

Returns the currently text associated to this object.

Definition at line 61 of file CText3D.h.

References m_str.

getTextStyle()

mrpt::opengl::TOpenGLFontStyle mrpt::opengl::CText3D::getTextStyle ( ) const

inline

Gets the current drawing style.

Definition at line 77 of file CText3D.h.

References m_text_style.

isShowNameEnabled()

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

inlineinherited

See also

enableShowName

Definition at line 85 of file CRenderizable.h.

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

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

isVisible()

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

inlineinherited

Is the object visible?

See also

setVisibility

Definition at line 69 of file CRenderizable.h.

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

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

notifyChange()

EIGEN_STRONG_INLINE 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 55 of file CRenderizableDisplayList.h.

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

Referenced by mrpt::opengl::CGeneralizedCylinder::addVisibleSectionAtEnd(), mrpt::opengl::CGeneralizedCylinder::addVisibleSectionAtStart(), mrpt::opengl::CMeshFast::adjustGridToImageAR(), mrpt::opengl::CMesh::adjustGridToImageAR(), mrpt::opengl::CVectorField2D::adjustVectorFieldToGrid(), mrpt::opengl::CSetOfLines::appendLine(), mrpt::opengl::CSetOfLines::appendLines(), mrpt::opengl::CTexturedObject::assignImage(), mrpt::opengl::CMeshFast::assignImage(), mrpt::opengl::CMesh::assignImage(), mrpt::opengl::CTexturedObject::assignImage_fast(), mrpt::opengl::CMeshFast::assignImageAndZ(), mrpt::opengl::CMesh::assignImageAndZ(), mrpt::opengl::CSetOfLines::begin(), mrpt::opengl::CSetOfLines::clear(), mrpt::opengl::CVectorField2D::clear(), mrpt::opengl::CAssimpModel::clear(), mrpt::opengl::CPlanarLaserScan::clear(), mrpt::opengl::CVectorField3D::clear(), mrpt::opengl::COctoMapVoxels::clear(), mrpt::opengl::CSetOfTexturedTriangles::clearTriangles(), mrpt::opengl::CSetOfTriangles::clearTriangles(), mrpt::opengl::COpenGLStandardObject::disable(), mrpt::opengl::COpenGLStandardObject::enable(), mrpt::opengl::CSimpleLine::enableAntiAliasing(), mrpt::opengl::CGridPlaneXZ::enableAntiAliasing(), mrpt::opengl::CGridPlaneXY::enableAntiAliasing(), mrpt::opengl::CMesh3D::enableAntiAliasing(), mrpt::opengl::CSetOfLines::enableAntiAliasing(), mrpt::opengl::CVectorField2D::enableAntiAliasing(), mrpt::opengl::CVectorField3D::enableAntiAliasing(), mrpt::opengl::CBox::enableBoxBorder(), mrpt::opengl::CVectorField3D::enableColorFromModule(), mrpt::opengl::CMeshFast::enableColorFromZ(), mrpt::opengl::CMesh::enableColorFromZ(), mrpt::opengl::COctoMapVoxels::enableCubeTransparency(), mrpt::opengl::CColorBar::enableDepthTest(), mrpt::opengl::CEllipsoid::enableDrawSolid3D(), mrpt::opengl::CMesh3D::enableFaceNormals(), mrpt::opengl::COctoMapVoxels::enableLights(), mrpt::opengl::CPlanarLaserScan::enableLine(), mrpt::opengl::CPlanarLaserScan::enablePoints(), mrpt::opengl::CSphere::enableRadiusIndependentOfEyeDistance(), mrpt::opengl::CMesh3D::enableShowEdges(), mrpt::opengl::CMesh3D::enableShowFaces(), mrpt::opengl::CVectorField3D::enableShowPoints(), mrpt::opengl::CMesh3D::enableShowVertices(), mrpt::opengl::CPlanarLaserScan::enableSurface(), mrpt::opengl::CAxis::enableTickMarks(), mrpt::opengl::CMesh3D::enableTransparency(), mrpt::opengl::CMeshFast::enableTransparency(), mrpt::opengl::CMesh::enableTransparency(), mrpt::opengl::CSetOfTriangles::enableTransparency(), mrpt::opengl::CAngularObservationMesh::enableTransparency(), mrpt::opengl::CMesh::enableWireFrame(), mrpt::opengl::CSetOfLines::end(), mrpt::opengl::COctoMapVoxels::getGridCubeRef(), mrpt::opengl::CSetOfTexturedTriangles::getTriangle(), mrpt::opengl::COctoMapVoxels::getVoxel(), mrpt::opengl::COctoMapVoxels::getVoxelRef(), mrpt::opengl::CSetOfTexturedTriangles::insertTriangle(), mrpt::opengl::CSetOfTriangles::insertTriangle(), mrpt::opengl::CSetOfTriangles::insertTriangles(), mrpt::opengl::CMesh3D::loadMesh(), mrpt::opengl::CAssimpModel::loadScene(), mrpt::opengl::COctoMapVoxels::push_back_GridCube(), mrpt::opengl::COctoMapVoxels::push_back_Voxel(), mrpt::opengl::CRenderizableDisplayList::readFromStreamRender(), mrpt::opengl::CTexturedObject::readFromStreamTexturedObject(), mrpt::opengl::CSetOfTriangles::reserve(), mrpt::opengl::CSetOfLines::reserve(), mrpt::opengl::COctoMapVoxels::reserveVoxels(), mrpt::opengl::CSetOfLines::resize(), mrpt::opengl::CVectorField2D::resize(), mrpt::opengl::CVectorField3D::resize(), mrpt::opengl::COctoMapVoxels::resizeGridCubes(), mrpt::opengl::COctoMapVoxels::resizeVoxels(), mrpt::opengl::COctoMapVoxels::resizeVoxelSets(), mrpt::opengl::CSimpleLine::serializeFrom(), mrpt::opengl::CTexturedPlane::serializeFrom(), mrpt::opengl::CSetOfTriangles::serializeFrom(), mrpt::opengl::COpenGLStandardObject::serializeFrom(), mrpt::opengl::CSphere::serializeFrom(), mrpt::opengl::CAxis::serializeFrom(), mrpt::opengl::CArrow::serializeFrom(), mrpt::opengl::CGridPlaneXY::serializeFrom(), mrpt::opengl::CGridPlaneXZ::serializeFrom(), mrpt::opengl::CCylinder::serializeFrom(), mrpt::opengl::CDisk::serializeFrom(), mrpt::opengl::CSetOfLines::serializeFrom(), mrpt::opengl::CVectorField2D::serializeFrom(), mrpt::opengl::CColorBar::serializeFrom(), mrpt::opengl::CMesh::serializeFrom(), mrpt::opengl::CVectorField3D::serializeFrom(), mrpt::opengl::CMeshFast::serializeFrom(), mrpt::opengl::CBox::serializeFrom(), mrpt::opengl::CAssimpModel::serializeFrom(), serializeFrom(), mrpt::opengl::CPolyhedron::serializeFrom(), mrpt::opengl::CEllipsoid::serializeFrom(), mrpt::opengl::CFrustum::serializeFrom(), mrpt::opengl::COctoMapVoxels::serializeFrom(), mrpt::opengl::CEllipsoid::set2DsegmentsCount(), mrpt::opengl::CEllipsoid::set3DsegmentsCount(), mrpt::opengl::CGeneralizedCylinder::setAllSectionsInvisible(), mrpt::opengl::CGeneralizedCylinder::setAllSectionsVisible(), mrpt::opengl::CArrow::setArrowEnds(), mrpt::opengl::CArrow::setArrowYawPitchRoll(), mrpt::opengl::CGeneralizedCylinder::setAxis(), mrpt::opengl::CAxis::setAxisLimits(), mrpt::opengl::CBox::setBoxBorderColor(), mrpt::opengl::CBox::setBoxCorners(), mrpt::opengl::CGeneralizedCylinder::setClosed(), mrpt::opengl::CRenderizableDisplayList::setColor_u8(), mrpt::opengl::CSetOfTriangles::setColor_u8(), mrpt::opengl::CRenderizableDisplayList::setColorA_u8(), mrpt::opengl::CSetOfTriangles::setColorA_u8(), mrpt::opengl::CColorBar::setColorAndValueLimits(), mrpt::opengl::CRenderizableDisplayList::setColorB_u8(), mrpt::opengl::CSetOfTriangles::setColorB_u8(), mrpt::opengl::CRenderizableDisplayList::setColorG_u8(), mrpt::opengl::CSetOfTriangles::setColorG_u8(), mrpt::opengl::CColorBar::setColormap(), mrpt::opengl::CRenderizableDisplayList::setColorR_u8(), mrpt::opengl::CSetOfTriangles::setColorR_u8(), mrpt::opengl::CEllipsoid::setCovMatrix(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::setCovMatrixAndMean(), mrpt::opengl::CDisk::setDiskRadius(), mrpt::opengl::COpenGLStandardObject::setFlags(), setFont(), mrpt::opengl::CAxis::setFrequency(), mrpt::opengl::CGeneralizedCylinder::setGeneratrix(), mrpt::opengl::CVectorField2D::setGridCenterAndCellSize(), mrpt::opengl::CGridPlaneXZ::setGridFrequency(), mrpt::opengl::CGridPlaneXY::setGridFrequency(), mrpt::opengl::CMeshFast::setGridLimits(), mrpt::opengl::CMesh::setGridLimits(), mrpt::opengl::CVectorField2D::setGridLimits(), mrpt::opengl::COctoMapVoxels::setGridLinesColor(), mrpt::opengl::COctoMapVoxels::setGridLinesWidth(), mrpt::opengl::CCylinder::setHasBases(), mrpt::opengl::CArrow::setHeadRatio(), mrpt::opengl::CCylinder::setHeight(), mrpt::opengl::CFrustum::setHorzFOV(), mrpt::opengl::CFrustum::setHorzFOVAsymmetric(), mrpt::opengl::CArrow::setLargeRadius(), mrpt::opengl::CSetOfLines::setLineByIndex(), mrpt::opengl::CSimpleLine::setLineCoords(), mrpt::opengl::CSimpleLine::setLineWidth(), mrpt::opengl::CGridPlaneXY::setLineWidth(), mrpt::opengl::CGridPlaneXZ::setLineWidth(), mrpt::opengl::CAxis::setLineWidth(), mrpt::opengl::CSetOfLines::setLineWidth(), mrpt::opengl::CFrustum::setLineWidth(), mrpt::opengl::CBox::setLineWidth(), mrpt::opengl::CVectorField2D::setLineWidth(), mrpt::opengl::CEllipsoid::setLineWidth(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::setLineWidth(), mrpt::opengl::CVectorField3D::setLineWidth(), mrpt::opengl::CDisk::setLoopsCount(), mrpt::opengl::CMesh::setMask(), mrpt::opengl::CVectorField3D::setMaxSpeedForColor(), mrpt::opengl::CVectorField3D::setMotionFieldColormap(), mrpt::opengl::CFrustum::setNearFarPlanes(), mrpt::opengl::COpenGLStandardObject::setNormal(), mrpt::opengl::CSphere::setNumberDivsLatitude(), mrpt::opengl::CSphere::setNumberDivsLongitude(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::setNumberOfSegments(), mrpt::opengl::CFrustum::setPlaneColor(), mrpt::opengl::CTexturedPlane::setPlaneCorners(), mrpt::opengl::CGridPlaneXY::setPlaneLimits(), mrpt::opengl::CGridPlaneXZ::setPlaneLimits(), mrpt::opengl::CGridPlaneXZ::setPlaneYcoord(), mrpt::opengl::CGridPlaneXY::setPlaneZcoord(), mrpt::opengl::CVectorField2D::setPointColor(), mrpt::opengl::CVectorField3D::setPointColor(), mrpt::opengl::CVectorField3D::setPointCoordinates(), mrpt::opengl::CVectorField2D::setPointSize(), mrpt::opengl::CVectorField3D::setPointSize(), mrpt::opengl::CEllipsoid::setQuantiles(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::setQuantiles(), mrpt::opengl::CCylinder::setRadii(), mrpt::opengl::CSphere::setRadius(), mrpt::opengl::CCylinder::setRadius(), mrpt::opengl::CPlanarLaserScan::setScan(), mrpt::opengl::CDisk::setSlicesCount(), mrpt::opengl::CCylinder::setSlicesCount(), mrpt::opengl::CArrow::setSmallRadius(), mrpt::opengl::CCylinder::setStacksCount(), setString(), setTextKerning(), mrpt::opengl::CAxis::setTextScale(), setTextSpacing(), setTextStyle(), mrpt::opengl::CTexturedPlane::setTextureCornerCoords(), mrpt::opengl::CMesh::setUV(), mrpt::opengl::CVectorField2D::setVectorField(), mrpt::opengl::CVectorField3D::setVectorField(), mrpt::opengl::CVectorField2D::setVectorFieldColor(), mrpt::opengl::CVectorField3D::setVectorFieldColor(), mrpt::opengl::CFrustum::setVertFOV(), mrpt::opengl::CFrustum::setVertFOVAsymmetric(), mrpt::opengl::CSetOfLines::setVerticesPointSize(), mrpt::opengl::CGeneralizedCylinder::setVisibleSections(), mrpt::opengl::COctoMapVoxels::setVisualizationMode(), mrpt::opengl::COctoMapVoxels::setVoxelAsPointsSize(), mrpt::opengl::CBox::setWireframe(), mrpt::opengl::CAngularObservationMesh::setWireframe(), mrpt::opengl::CMeshFast::setXBounds(), mrpt::opengl::CMesh::setXBounds(), mrpt::opengl::CMeshFast::setXMax(), mrpt::opengl::CMesh::setXMax(), mrpt::opengl::CMeshFast::setXMin(), mrpt::opengl::CMesh::setXMin(), mrpt::opengl::CMeshFast::setYBounds(), mrpt::opengl::CMesh::setYBounds(), mrpt::opengl::CMeshFast::setYMax(), mrpt::opengl::CMesh::setYMax(), mrpt::opengl::CMeshFast::setYMin(), mrpt::opengl::CMesh::setYMin(), mrpt::opengl::CMeshFast::setZ(), mrpt::opengl::CMesh::setZ(), mrpt::opengl::COctoMapVoxels::showGridLines(), mrpt::opengl::COctoMapVoxels::showVoxels(), mrpt::opengl::COctoMapVoxels::showVoxelsAsPoints(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::thisclass_readFromStream(), mrpt::opengl::CMesh::updateColorsMatrix(), mrpt::opengl::CMeshFast::updateColorsMatrix(), mrpt::opengl::CMeshFast::updatePoints(), mrpt::opengl::CSetOfTriangles::updatePolygons(), mrpt::opengl::CMesh::updatePolygons(), and mrpt::opengl::CMesh::updateTriangles().

operator delete() [1/3]

void mrpt::opengl::CText3D::operator delete ( void *  ptr, const std::nothrow_t &    )

inlinenoexcept

Definition at line 45 of file CText3D.h.

operator delete() [2/3]

void mrpt::opengl::CText3D::operator delete ( void *  ptr )

inlinenoexcept

Definition at line 45 of file CText3D.h.

operator delete() [3/3]

void mrpt::opengl::CText3D::operator delete ( void *  memory, void *  ptr  )

inlinenoexcept

Definition at line 45 of file CText3D.h.

operator delete[]()

void mrpt::opengl::CText3D::operator delete[] ( void *  ptr )

inlinenoexcept

Definition at line 45 of file CText3D.h.

operator new() [1/3]

void* mrpt::opengl::CText3D::operator new ( size_t  size )

inline

Definition at line 45 of file CText3D.h.

operator new() [2/3]

static void* mrpt::opengl::CText3D::operator new ( size_t  size, void *  ptr  )

inlinestatic

Definition at line 45 of file CText3D.h.

operator new() [3/3]

void* mrpt::opengl::CText3D::operator new ( size_t  size, const std::nothrow_t &    )

inlinenoexcept

Definition at line 45 of file CText3D.h.

operator new[]()

void* mrpt::opengl::CText3D::operator new[] ( size_t  size )

inline

Definition at line 45 of file CText3D.h.

readFromStreamRender()

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

inlineprotectedinherited

Definition at line 63 of file CRenderizableDisplayList.h.

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

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

releaseTextureName()

void CRenderizable::releaseTextureName ( unsigned int  i )

staticprotectedinherited

Definition at line 99 of file CRenderizable.cpp.

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

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

render_dl()

void CText3D::render_dl ( ) const

overridevirtual

Render.

Implements mrpt::opengl::CRenderizableDisplayList.

Definition at line 56 of file CText3D.cpp.

References mrpt::img::TColor::A, mrpt::img::TColor::B, mrpt::img::TColor::G, glColor4ub(), mrpt::opengl::gl_utils::glDrawText(), mrpt::opengl::gl_utils::glSetFont(), mrpt::opengl::CRenderizable::m_color, m_fontName, m_str, m_text_kerning, m_text_spacing, m_text_style, and mrpt::img::TColor::R.

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 367 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  )

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

serializeFrom()

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

overrideprotectedvirtual

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

Implements mrpt::serialization::CSerializable.

Definition at line 78 of file CText3D.cpp.

References m_fontName, m_str, m_text_kerning, m_text_spacing, m_text_style, MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, mrpt::opengl::CRenderizableDisplayList::notifyChange(), and mrpt::opengl::CRenderizableDisplayList::readFromStreamRender().

serializeGetVersion()

uint8_t CText3D::serializeGetVersion ( ) const

overrideprotectedvirtual

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.

Implements mrpt::serialization::CSerializable.

Definition at line 70 of file CText3D.cpp.

serializeTo()

void CText3D::serializeTo ( mrpt::serialization::CArchive &  out ) const

overrideprotectedvirtual

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

Implements mrpt::serialization::CSerializable.

Definition at line 71 of file CText3D.cpp.

References m_fontName, m_str, m_text_kerning, m_text_spacing, m_text_style, and mrpt::opengl::CRenderizable::writeToStreamRender().

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

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

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

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

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

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 111 of file CRenderizableDisplayList.h.

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

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 118 of file CRenderizableDisplayList.h.

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

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

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

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 104 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().

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

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

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 97 of file CRenderizableDisplayList.h.

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

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

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

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 90 of file CRenderizableDisplayList.h.

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

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

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

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 83 of file CRenderizableDisplayList.h.

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

setFont()

void mrpt::opengl::CText3D::setFont ( const std::string &  font )

inline

Changes the font name, among accepted values: "sans", "mono", "serif".

Definition at line 63 of file CText3D.h.

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

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

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

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

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

setName()

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

inlineinherited

Changes the name of the object.

Definition at line 66 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 309 of file CRenderizable.cpp.

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

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

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 314 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 319 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 324 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 331 of file CRenderizable.cpp.

References mrpt::opengl::CRenderizable::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 )

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

References mrpt::opengl::CRenderizable::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 )

inlineinherited

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

Returns

a ref to this

Definition at line 211 of file CRenderizable.h.

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

Referenced by CText3D().

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

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

setString()

void mrpt::opengl::CText3D::setString ( const std::string &  s )

inline

Sets the displayed string.

Definition at line 55 of file CText3D.h.

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

setTextKerning() [1/2]

void mrpt::opengl::CText3D::setTextKerning ( const double  text_kerning )

inline

Definition at line 84 of file CText3D.h.

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

setTextKerning() [2/2]

double mrpt::opengl::CText3D::setTextKerning ( ) const

inline

Definition at line 89 of file CText3D.h.

References m_text_kerning.

setTextSpacing() [1/2]

void mrpt::opengl::CText3D::setTextSpacing ( const double  text_spacing )

inline

Definition at line 78 of file CText3D.h.

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

setTextSpacing() [2/2]

double mrpt::opengl::CText3D::setTextSpacing ( ) const

inline

Definition at line 83 of file CText3D.h.

References m_text_spacing.

setTextStyle()

void mrpt::opengl::CText3D::setTextStyle ( const mrpt::opengl::TOpenGLFontStyle  text_style )

inline

Change drawing style: FILL, OUTLINE, NICE.

Definition at line 71 of file CText3D.h.

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

setVisibility()

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

inlineinherited

Set object visibility (default=true)

See also

isVisible

Definition at line 74 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 62 of file CRenderizableDisplayList.h.

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

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

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

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::CBox, mrpt::opengl::CTexturedPlane, mrpt::opengl::CDisk, mrpt::opengl::CAssimpModel, mrpt::opengl::CCylinder, and mrpt::opengl::COpenGLStandardObject.

Definition at line 344 of file CRenderizable.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 68 of file CSerializable.h.

writeToStreamRender()

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

protectedinherited

Definition at line 110 of file CRenderizable.cpp.

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

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

Member Data Documentation

_init_CText3D

mrpt::rtti::CLASSINIT mrpt::opengl::CText3D::_init_CText3D

staticprotected

Definition at line 45 of file CText3D.h.

className

constexpr const char* mrpt::opengl::CText3D::className = "CText3D"

static

Definition at line 45 of file CText3D.h.

m_color

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

protectedinherited

Color components in the range [0,255].

Definition at line 52 of file CRenderizable.h.

Referenced by mrpt::opengl::CMeshFast::CMeshFast(), mrpt::opengl::CVectorField2D::CVectorField2D(), mrpt::opengl::CVectorField3D::CVectorField3D(), mrpt::opengl::CRenderizable::getColor(), mrpt::opengl::CRenderizable::getColor_u8(), mrpt::opengl::CRenderizable::getColorA(), mrpt::opengl::CRenderizable::getColorA_u8(), mrpt::opengl::CRenderizable::getColorB(), mrpt::opengl::CRenderizable::getColorB_u8(), mrpt::opengl::CRenderizable::getColorG(), mrpt::opengl::CRenderizable::getColorG_u8(), mrpt::opengl::CRenderizable::getColorR(), mrpt::opengl::CRenderizable::getColorR_u8(), mrpt::opengl::CRenderizable::readFromStreamRender(), mrpt::opengl::CBox::render_dl(), mrpt::opengl::CSimpleLine::render_dl(), render_dl(), mrpt::opengl::CSetOfLines::render_dl(), mrpt::opengl::CVectorField2D::render_dl(), mrpt::opengl::CVectorField3D::render_dl(), mrpt::opengl::CPolyhedron::render_dl(), mrpt::opengl::CRenderizable::setColor_u8(), mrpt::opengl::CRenderizableDisplayList::setColorA_u8(), mrpt::opengl::CRenderizable::setColorA_u8(), mrpt::opengl::CRenderizableDisplayList::setColorB_u8(), mrpt::opengl::CRenderizable::setColorB_u8(), mrpt::opengl::CRenderizableDisplayList::setColorG_u8(), mrpt::opengl::CRenderizable::setColorG_u8(), mrpt::opengl::CRenderizableDisplayList::setColorR_u8(), mrpt::opengl::CRenderizable::setColorR_u8(), and mrpt::opengl::CRenderizable::writeToStreamRender().

m_fontName

std::string mrpt::opengl::CText3D::m_fontName

protected

Definition at line 48 of file CText3D.h.

Referenced by getFont(), render_dl(), serializeFrom(), serializeTo(), and setFont().

m_name

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

protectedinherited

Definition at line 49 of file CRenderizable.h.

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

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

Referenced by mrpt::opengl::CAssimpModel::getBoundingBox(), mrpt::opengl::CBox::getBoundingBox(), mrpt::opengl::CSimpleLine::getBoundingBox(), mrpt::opengl::CTexturedPlane::getBoundingBox(), mrpt::opengl::CGridPlaneXY::getBoundingBox(), getBoundingBox(), mrpt::opengl::CGridPlaneXZ::getBoundingBox(), mrpt::opengl::CFrustum::getBoundingBox(), mrpt::opengl::CPlanarLaserScan::getBoundingBox(), mrpt::opengl::CPolyhedron::getBoundingBox(), mrpt::opengl::CSetOfLines::getBoundingBox(), mrpt::opengl::CVectorField2D::getBoundingBox(), mrpt::opengl::CVectorField3D::getBoundingBox(), mrpt::opengl::CRenderizable::getPose(), mrpt::opengl::CRenderizable::getPosePitch(), mrpt::opengl::CRenderizable::getPosePitchRad(), mrpt::opengl::CRenderizable::getPoseRef(), mrpt::opengl::CRenderizable::getPoseRoll(), mrpt::opengl::CRenderizable::getPoseRollRad(), mrpt::opengl::CRenderizable::getPoseX(), mrpt::opengl::CRenderizable::getPoseY(), mrpt::opengl::CRenderizable::getPoseYaw(), mrpt::opengl::CRenderizable::getPoseYawRad(), mrpt::opengl::CRenderizable::getPoseZ(), mrpt::opengl::CPolyhedron::getSetOfPolygonsAbsolute(), mrpt::opengl::CRenderizable::readFromStreamRender(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::render_dl(), mrpt::opengl::CRenderizable::setLocation(), mrpt::opengl::CRenderizable::setPose(), mrpt::opengl::CTexturedPlane::traceRay(), mrpt::opengl::CPolyhedron::traceRay(), and mrpt::opengl::CRenderizable::writeToStreamRender().

m_scale_x

float mrpt::opengl::CRenderizable::m_scale_x

protectedinherited

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

Definition at line 57 of file CRenderizable.h.

Referenced by getBoundingBox(), 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

protectedinherited

Definition at line 57 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

protectedinherited

Definition at line 57 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

protectedinherited

Definition at line 50 of file CRenderizable.h.

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

m_str

std::string mrpt::opengl::CText3D::m_str

protected

Definition at line 47 of file CText3D.h.

Referenced by getBoundingBox(), getString(), render_dl(), serializeFrom(), serializeTo(), and setString().

m_text_kerning

double mrpt::opengl::CText3D::m_text_kerning

protected

Definition at line 51 of file CText3D.h.

Referenced by render_dl(), serializeFrom(), serializeTo(), and setTextKerning().

m_text_spacing

double mrpt::opengl::CText3D::m_text_spacing

protected

Definition at line 50 of file CText3D.h.

Referenced by render_dl(), serializeFrom(), serializeTo(), and setTextSpacing().

m_text_style

TOpenGLFontStyle mrpt::opengl::CText3D::m_text_style

protected

Definition at line 49 of file CText3D.h.

Referenced by getTextStyle(), render_dl(), serializeFrom(), serializeTo(), and setTextStyle().

m_visible

bool mrpt::opengl::CRenderizable::m_visible

protectedinherited

Is the object visible? (default=true)

Definition at line 59 of file CRenderizable.h.

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

runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::opengl::CText3D::runtimeClassId

staticprotected

Definition at line 45 of file CText3D.h.