Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
mrpt::opengl::CPlanarLaserScan Class Reference

Detailed Description

This object renders a 2D laser scan by means of three elements: the points, the line along end-points and the 2D scanned surface.

By default, all those three elements are drawn, but you can individually switch them on/off with:

To change the final result, more methods allow further customization of the 3D object (color of each element, etc.).

The scan is passed or updated through CPlanarLaserScan::setScan()

mrpt::opengl::CPlanarLaserScan
preview_CPlanarLaserScan.png
Note
The laser points are projected at the sensor pose as given in the "scan" object, so this CPlanarLaserScan object should be placed at the exact pose of the robot coordinates origin.
See also
mrpt::opengl::CPointCloud, opengl::COpenGLScene

Definition at line 57 of file CPlanarLaserScan.h.

#include <mrpt/opengl/CPlanarLaserScan.h>

Inheritance diagram for mrpt::opengl::CPlanarLaserScan:
Inheritance graph

Public Member Functions

voidoperator new (size_t size)
 
voidoperator new[] (size_t size)
 
void operator delete (void *ptr) noexcept
 
void operator delete[] (void *ptr) noexcept
 
void operator delete (void *memory, void *ptr) noexcept
 
voidoperator new (size_t size, const std::nothrow_t &) noexcept
 
void operator delete (void *ptr, const std::nothrow_t &) noexcept
 
void clear ()
 < Clear the scan More...
 
void enablePoints (bool enable=true)
 Show or hides the scanned points. More...
 
void enableLine (bool enable=true)
 Show or hides lines along all scanned points. More...
 
void enableSurface (bool enable=true)
 Show or hides the scanned area as a 2D surface. More...
 
void setLineWidth (float w)
 
float getLineWidth () const
 
void setPointsWidth (float w)
 
void setLineColor (float R, float G, float B, float A=1.0f)
 
void setPointsColor (float R, float G, float B, float A=1.0f)
 
void setSurfaceColor (float R, float G, float B, float A=1.0f)
 
void setScan (const mrpt::obs::CObservation2DRangeScan &scan)
 
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...
 
 CPlanarLaserScan ()
 Constructor. More...
 
virtual ~CPlanarLaserScan ()
 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 mxArraywriteToMatlab () 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)

CRenderizablesetColorR_u8 (const uint8_t r) override
 Color components in the range [0,255]. More...
 
CRenderizablesetColorG_u8 (const uint8_t g) override
 Color components in the range [0,255]. More...
 
CRenderizablesetColorB_u8 (const uint8_t b) override
 Color components in the range [0,255]. More...
 
CRenderizablesetColorA_u8 (const uint8_t a) override
 Color components in the range [0,255]. More...
 
CRenderizablesetColor_u8 (const mrpt::utils::TColor &c) override
 Changes the default object color. More...
 
CRenderizablesetColor_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::stringgetName () 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
 
CRenderizablesetPose (const mrpt::poses::CPose3D &o)
 Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...
 
CRenderizablesetPose (const mrpt::poses::CPose2D &o)
 Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...
 
CRenderizablesetPose (const mrpt::math::TPose3D &o)
 Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this) More...
 
CRenderizablesetPose (const mrpt::math::TPose2D &o)
 Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this) More...
 
CRenderizablesetPose (const mrpt::poses::CPoint3D &o)
 Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...
 
CRenderizablesetPose (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::CPose3DgetPoseRef () const
 Returns a const ref to the 3D pose of the object as mrpt::poses::CPose3D (which explicitly contains the 3x3 rotation matrix) More...
 
CRenderizablesetLocation (double x, double y, double z)
 Changes the location of the object, keeping untouched the orientation. More...
 
CRenderizablesetLocation (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...
 
CRenderizablesetColorR (const double r)
 Color components in the range [0,1]. More...
 
CRenderizablesetColorG (const double g)
 Color components in the range [0,1]. More...
 
CRenderizablesetColorB (const double b)
 Color components in the range [0,1]. More...
 
CRenderizablesetColorA (const double a)
 Color components in the range [0,1]. More...
 
CRenderizablesetScale (float s)
 Scale to apply to the object, in all three axes (default=1) More...
 
CRenderizablesetScale (float sx, float sy, float sz)
 Scale to apply to the object in each axis (default=1) More...
 
float getScaleX () const
 Get the current scaling factor in one axis. More...
 
float getScaleY () const
 Get the current scaling factor in one axis. More...
 
float getScaleZ () const
 Get the current scaling factor in one axis. More...
 
mrpt::utils::TColorf getColor () const
 Returns the object color property as a TColorf. More...
 
CRenderizablesetColor (const mrpt::utils::TColorf &c)
 Changes the default object color. More...
 
CRenderizablesetColor (double R, double G, double B, double A=1)
 Set the color components of this object (R,G,B,Alpha, in the range 0-1) More...
 
const mrpt::utils::TColorgetColor_u8 () const
 Returns the object color property as a TColor. More...
 
RTTI classes and functions
mrpt::utils::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 voidoperator new (size_t size, void *ptr)
 
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 (utils::CStream &out) const
 
CSerializable virtual methods
void writeToStream (mrpt::utils::CStream &out, int *getVersion) const override
 Introduces a pure virtual method responsible for writing to a CStream. More...
 
void readFromStream (mrpt::utils::CStream &in, int version) override
 Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More...
 
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::utils::CStream &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

mrpt::obs::CObservation2DRangeScan m_scan
 
mrpt::maps::CSimplePointsMap m_cache_points
 
bool m_cache_valid
 
float m_line_width
 
float m_line_R
 
float m_line_G
 
float m_line_B
 
float m_line_A
 
float m_points_width
 
float m_points_R
 
float m_points_G
 
float m_points_B
 
float m_points_A
 
float m_plane_R
 
float m_plane_G
 
float m_plane_B
 
float m_plane_A
 
bool m_enable_points
 
bool m_enable_line
 
bool m_enable_surface
 
std::string m_name
 
bool m_show_name
 
mrpt::utils::TColor m_color
 Color components in the range [0,255]. More...
 
mrpt::poses::CPose3D m_pose
 6D pose wrt the parent coordinate reference. 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< CPlanarLaserScan >
 
using ConstPtr = std::shared_ptr< const CPlanarLaserScan >
 
static mrpt::utils::CLASSINIT _init_CPlanarLaserScan
 
static const mrpt::utils::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "CPlanarLaserScan"
 
static const mrpt::utils::TRuntimeClassId_GetBaseClass ()
 
static const mrpt::utils::TRuntimeClassIdGetRuntimeClassIdStatic ()
 
static mrpt::utils::CObjectCreateObject ()
 
template<typename... Args>
static Ptr Create (Args &&... args)
 
virtual const mrpt::utils::TRuntimeClassIdGetRuntimeClass () const override
 Returns information about the class of an object in runtime. More...
 
virtual mrpt::utils::CObjectclone () const override
 Returns a deep copy (clone) of the object, indepently of its class. More...
 

Member Typedef Documentation

◆ ConstPtr

Definition at line 59 of file CPlanarLaserScan.h.

◆ Ptr

A typedef for the associated smart pointer

Definition at line 59 of file CPlanarLaserScan.h.

Constructor & Destructor Documentation

◆ CPlanarLaserScan()

mrpt::opengl::CPlanarLaserScan::CPlanarLaserScan ( )

Constructor.

◆ ~CPlanarLaserScan()

virtual mrpt::opengl::CPlanarLaserScan::~CPlanarLaserScan ( )
inlinevirtual

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

Definition at line 148 of file CPlanarLaserScan.h.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::opengl::CPlanarLaserScan::_GetBaseClass ( )
staticprotected

◆ checkOpenGLError()

void CRenderizable::checkOpenGLError ( )
staticprotectedinherited

◆ clear()

void CPlanarLaserScan::clear ( )

< Clear the scan

Definition at line 76 of file CPlanarLaserScan.cpp.

References m_scan, mrpt::opengl::CRenderizableDisplayList::notifyChange(), and mrpt::obs::CObservation2DRangeScan::resizeScan().

Here is the call graph for this function:

◆ clone()

virtual mrpt::utils::CObject* mrpt::opengl::CPlanarLaserScan::clone ( ) const
overridevirtual

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

Implements mrpt::utils::CObject.

◆ Create()

template<typename... Args>
static Ptr mrpt::opengl::CPlanarLaserScan::Create ( Args &&...  args)
inlinestatic

Definition at line 59 of file CPlanarLaserScan.h.

◆ CreateObject()

static mrpt::utils::CObject* mrpt::opengl::CPlanarLaserScan::CreateObject ( )
static

◆ enableLine()

void mrpt::opengl::CPlanarLaserScan::enableLine ( bool  enable = true)
inline

Show or hides lines along all scanned points.

See also
setLineWidth, setLineColor

Definition at line 90 of file CPlanarLaserScan.h.

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

Here is the call graph for this function:

◆ enablePoints()

void mrpt::opengl::CPlanarLaserScan::enablePoints ( bool  enable = true)
inline

Show or hides the scanned points.

See also
sePointsWidth, setPointsColor

Definition at line 82 of file CPlanarLaserScan.h.

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

Here is the call 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 85 of file CRenderizable.h.

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

◆ enableSurface()

void mrpt::opengl::CPlanarLaserScan::enableSurface ( bool  enable = true)
inline

Show or hides the scanned area as a 2D surface.

See also
setSurfaceColor

Definition at line 97 of file CPlanarLaserScan.h.

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

Here is the call graph for this function:

◆ getBoundingBox()

void CPlanarLaserScan::getBoundingBox ( mrpt::math::TPoint3D bb_min,
mrpt::math::TPoint3D bb_max 
) const
overridevirtual

◆ getColor()

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

Returns the object color property as a TColorf.

Definition at line 243 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getColor_u8()

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

Returns the object color property as a TColor.

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

References mrpt::utils::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 174 of file CRenderizable.h.

References mrpt::utils::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 164 of file CRenderizable.h.

References mrpt::utils::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 172 of file CRenderizable.h.

References mrpt::utils::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 162 of file CRenderizable.h.

References mrpt::utils::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 170 of file CRenderizable.h.

References mrpt::utils::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 160 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_color, and mrpt::utils::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 168 of file CRenderizable.h.

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

◆ getLineWidth()

float mrpt::opengl::CPlanarLaserScan::getLineWidth ( ) const
inline

Definition at line 104 of file CPlanarLaserScan.h.

References m_line_width.

◆ getName()

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

Returns the name of the object.

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

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

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getPose()

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

Returns the 3D pose of the object as TPose3D.

Definition at line 347 of file CRenderizable.cpp.

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

◆ getPosePitch()

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

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 144 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, mrpt::poses::CPose3D::pitch(), and mrpt::mrpt::utils::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 156 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 111 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 149 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, mrpt::mrpt::utils::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 158 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 133 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, and mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::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 135 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, and mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::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 139 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, mrpt::mrpt::utils::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 154 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 137 of file CRenderizable.h.

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

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::opengl::CPlanarLaserScan::GetRuntimeClass ( ) const
overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::opengl::CRenderizableDisplayList.

◆ GetRuntimeClassIdStatic()

static const mrpt::utils::TRuntimeClassId& mrpt::opengl::CPlanarLaserScan::GetRuntimeClassIdStatic ( )
static

◆ getScaleX()

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

Get the current scaling factor in one axis.

Definition at line 237 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 239 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 241 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 87 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 71 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:

◆ 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 57 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::C3DSScene::clear(), mrpt::opengl::CVectorField2D::clear(), mrpt::opengl::CAssimpModel::clear(), 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::CGridPlaneXY::enableAntiAliasing(), mrpt::opengl::CGridPlaneXZ::enableAntiAliasing(), mrpt::opengl::CMesh3D::enableAntiAliasing(), mrpt::opengl::CVectorField2D::enableAntiAliasing(), mrpt::opengl::CSetOfLines::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::C3DSScene::enableExtraAmbientLight(), mrpt::opengl::CMesh3D::enableFaceNormals(), mrpt::opengl::COctoMapVoxels::enableLights(), enableLine(), enablePoints(), mrpt::opengl::CSphere::enableRadiusIndependentOfEyeDistance(), mrpt::opengl::CMesh3D::enableShowEdges(), mrpt::opengl::CMesh3D::enableShowFaces(), mrpt::opengl::CVectorField3D::enableShowPoints(), mrpt::opengl::CMesh3D::enableShowVertices(), 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::C3DSScene::evaluateAnimation(), 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::C3DSScene::loadFrom3DSFile(), mrpt::opengl::CMesh3D::loadMesh(), mrpt::opengl::CAssimpModel::loadScene(), mrpt::opengl::COctoMapVoxels::push_back_GridCube(), mrpt::opengl::COctoMapVoxels::push_back_Voxel(), mrpt::opengl::CSimpleLine::readFromStream(), mrpt::opengl::CTexturedPlane::readFromStream(), mrpt::opengl::CSetOfTriangles::readFromStream(), mrpt::opengl::C3DSScene::readFromStream(), mrpt::opengl::COpenGLStandardObject::readFromStream(), mrpt::opengl::CArrow::readFromStream(), mrpt::opengl::CAxis::readFromStream(), mrpt::opengl::CSphere::readFromStream(), mrpt::opengl::CCylinder::readFromStream(), mrpt::opengl::CGridPlaneXY::readFromStream(), mrpt::opengl::CGridPlaneXZ::readFromStream(), mrpt::opengl::CDisk::readFromStream(), mrpt::opengl::CSetOfLines::readFromStream(), mrpt::opengl::CColorBar::readFromStream(), mrpt::opengl::CVectorField2D::readFromStream(), mrpt::opengl::CMesh::readFromStream(), mrpt::opengl::CMeshFast::readFromStream(), mrpt::opengl::CBox::readFromStream(), mrpt::opengl::CAssimpModel::readFromStream(), mrpt::opengl::CPolyhedron::readFromStream(), mrpt::opengl::CText3D::readFromStream(), mrpt::opengl::CVectorField3D::readFromStream(), mrpt::opengl::CEllipsoid::readFromStream(), mrpt::opengl::CFrustum::readFromStream(), mrpt::opengl::COctoMapVoxels::readFromStream(), 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::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(), mrpt::opengl::CText3D::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::CGridPlaneXZ::setPlaneLimits(), mrpt::opengl::CGridPlaneXY::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(), setScan(), mrpt::opengl::CDisk::setSlicesCount(), mrpt::opengl::CCylinder::setSlicesCount(), mrpt::opengl::CArrow::setSmallRadius(), mrpt::opengl::CCylinder::setStacksCount(), mrpt::opengl::CText3D::setString(), mrpt::opengl::CText3D::setTextKerning(), mrpt::opengl::CAxis::setTextScale(), mrpt::opengl::CText3D::setTextSpacing(), mrpt::opengl::CText3D::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::CMesh::updatePolygons(), mrpt::opengl::CSetOfTriangles::updatePolygons(), and mrpt::opengl::CMesh::updateTriangles().

◆ operator delete() [1/3]

void mrpt::opengl::CPlanarLaserScan::operator delete ( void ptr)
inlinenoexcept

Definition at line 59 of file CPlanarLaserScan.h.

◆ operator delete() [2/3]

void mrpt::opengl::CPlanarLaserScan::operator delete ( void memory,
void ptr 
)
inlinenoexcept

Definition at line 59 of file CPlanarLaserScan.h.

◆ operator delete() [3/3]

void mrpt::opengl::CPlanarLaserScan::operator delete ( void ptr,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 59 of file CPlanarLaserScan.h.

◆ operator delete[]()

void mrpt::opengl::CPlanarLaserScan::operator delete[] ( void ptr)
inlinenoexcept

Definition at line 59 of file CPlanarLaserScan.h.

◆ operator new() [1/3]

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

Definition at line 59 of file CPlanarLaserScan.h.

◆ operator new() [2/3]

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

Definition at line 59 of file CPlanarLaserScan.h.

◆ operator new() [3/3]

void* mrpt::opengl::CPlanarLaserScan::operator new ( size_t  size)
inline

Definition at line 59 of file CPlanarLaserScan.h.

◆ operator new[]()

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

Definition at line 59 of file CPlanarLaserScan.h.

◆ readFromStream()

void CPlanarLaserScan::readFromStream ( mrpt::utils::CStream in,
int  version 
)
overrideprotectedvirtual

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

Parameters
inThe input binary stream where the object data must read from.
versionThe 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::exceptionOn any error, see CStream::ReadBuffer
See also
CStream

Implements mrpt::utils::CSerializable.

Definition at line 197 of file CPlanarLaserScan.cpp.

References m_enable_line, m_enable_points, m_enable_surface, m_line_A, m_line_B, m_line_G, m_line_R, m_line_width, m_plane_A, m_plane_B, m_plane_G, m_plane_R, m_points_A, m_points_B, m_points_G, m_points_R, m_points_width, m_scan, MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, and mrpt::opengl::CRenderizableDisplayList::readFromStreamRender().

Here is the call graph for this function:

◆ readFromStreamRender()

void mrpt::opengl::CRenderizableDisplayList::readFromStreamRender ( mrpt::utils::CStream in)
inlineprotectedinherited

◆ releaseTextureName()

void CRenderizable::releaseTextureName ( unsigned int  i)
staticprotectedinherited

Definition at line 101 of file CRenderizable.cpp.

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

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ render()

void CRenderizableDisplayList::render ( ) const
overridevirtualinherited

◆ render_dl()

void CPlanarLaserScan::render_dl ( ) const
overridevirtual

◆ 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 380 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 315 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:

◆ setColor() [1/2]

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

Changes the default object color.

Returns
a ref to this

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

References 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::utils::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 113 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 120 of file CRenderizableDisplayList.h.

References 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 191 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 106 of file CRenderizableDisplayList.h.

References mrpt::utils::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 186 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 99 of file CRenderizableDisplayList.h.

References mrpt::utils::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 181 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 92 of file CRenderizableDisplayList.h.

References mrpt::utils::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 176 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 85 of file CRenderizableDisplayList.h.

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

Here is the call graph for this function:

◆ setLineColor()

void mrpt::opengl::CPlanarLaserScan::setLineColor ( float  R,
float  G,
float  B,
float  A = 1.0f 
)
inline

Definition at line 106 of file CPlanarLaserScan.h.

References m_line_A, m_line_B, m_line_G, m_line_R, and R.

◆ setLineWidth()

void mrpt::opengl::CPlanarLaserScan::setLineWidth ( float  w)
inline

Definition at line 103 of file CPlanarLaserScan.h.

References m_line_width.

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

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

Referenced by mrpt::graphslam::deciders::CLoopCloserERD< GRAPH_T >::updateCurrCovarianceVisualization(), and mrpt::graphslam::deciders::CLoopCloserERD< GRAPH_T >::updateMapPartitionsVisualization().

Here is the call graph for this function:
Here is the caller 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 124 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::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 68 of file CRenderizable.h.

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

◆ setPointsColor()

void mrpt::opengl::CPlanarLaserScan::setPointsColor ( float  R,
float  G,
float  B,
float  A = 1.0f 
)
inline

Definition at line 113 of file CPlanarLaserScan.h.

References m_points_A, m_points_B, m_points_G, m_points_R, and R.

◆ setPointsWidth()

void mrpt::opengl::CPlanarLaserScan::setPointsWidth ( float  w)
inline

Definition at line 105 of file CPlanarLaserScan.h.

References m_points_width.

◆ setPose() [1/6]

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

◆ 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 315 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 320 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 325 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 332 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().

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

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 222 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 mrpt::opengl::CText3D::CText3D().

Here is the caller graph for this function:

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

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

◆ setScan()

void mrpt::opengl::CPlanarLaserScan::setScan ( const mrpt::obs::CObservation2DRangeScan scan)
inline

Definition at line 128 of file CPlanarLaserScan.h.

References m_cache_valid, m_scan, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

Referenced by mrpt::hwdrivers::C2DRangeFinderAbstract::processPreview(), and mrpt::graphslam::deciders::CICPCriteriaERD< GRAPH_T >::updateVisuals().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setSurfaceColor()

void mrpt::opengl::CPlanarLaserScan::setSurfaceColor ( float  R,
float  G,
float  B,
float  A = 1.0f 
)
inline

Definition at line 120 of file CPlanarLaserScan.h.

References m_plane_A, m_plane_B, m_plane_G, m_plane_R, and R.

◆ setVisibility()

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

◆ 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 64 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 389 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

◆ writeToMatlab()

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

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

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

Definition at line 89 of file CSerializable.h.

◆ writeToStream()

void CPlanarLaserScan::writeToStream ( mrpt::utils::CStream out,
int *  getVersion 
) const
overrideprotectedvirtual

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

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

Parameters
outThe output binary stream where object must be dumped.
getVersionIf nullptr, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data.
Exceptions
std::exceptionOn any error, see CStream::WriteBuffer
See also
CStream

Implements mrpt::utils::CSerializable.

Definition at line 176 of file CPlanarLaserScan.cpp.

References m_enable_line, m_enable_points, m_enable_surface, m_line_A, m_line_B, m_line_G, m_line_R, m_line_width, m_plane_A, m_plane_B, m_plane_G, m_plane_R, m_points_A, m_points_B, m_points_G, m_points_R, m_points_width, m_scan, and mrpt::opengl::CRenderizable::writeToStreamRender().

Here is the call graph for this function:

◆ writeToStreamRender()

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

Member Data Documentation

◆ _init_CPlanarLaserScan

mrpt::utils::CLASSINIT mrpt::opengl::CPlanarLaserScan::_init_CPlanarLaserScan
staticprotected

Definition at line 59 of file CPlanarLaserScan.h.

◆ className

constexpr const char* mrpt::opengl::CPlanarLaserScan::className = "CPlanarLaserScan"
static

Definition at line 59 of file CPlanarLaserScan.h.

◆ m_cache_points

mrpt::maps::CSimplePointsMap mrpt::opengl::CPlanarLaserScan::m_cache_points
mutableprotected

Definition at line 62 of file CPlanarLaserScan.h.

Referenced by getBoundingBox(), and render_dl().

◆ m_cache_valid

bool mrpt::opengl::CPlanarLaserScan::m_cache_valid
mutableprotected

Definition at line 63 of file CPlanarLaserScan.h.

Referenced by getBoundingBox(), render_dl(), and setScan().

◆ m_color

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

Color components in the range [0,255].

Definition at line 54 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(), mrpt::opengl::CText3D::render_dl(), mrpt::opengl::CSetOfLines::render_dl(), mrpt::opengl::CVectorField2D::render_dl(), mrpt::opengl::CVectorField3D::render_dl(), mrpt::opengl::CPolyhedron::render_dl(), mrpt::opengl::CTexturedObject::render_post(), mrpt::opengl::CTexturedObject::render_pre(), 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_enable_line

bool mrpt::opengl::CPlanarLaserScan::m_enable_line
protected

Definition at line 74 of file CPlanarLaserScan.h.

Referenced by enableLine(), readFromStream(), render_dl(), and writeToStream().

◆ m_enable_points

bool mrpt::opengl::CPlanarLaserScan::m_enable_points
protected

Definition at line 73 of file CPlanarLaserScan.h.

Referenced by enablePoints(), readFromStream(), render_dl(), and writeToStream().

◆ m_enable_surface

bool mrpt::opengl::CPlanarLaserScan::m_enable_surface
protected

Definition at line 75 of file CPlanarLaserScan.h.

Referenced by enableSurface(), readFromStream(), render_dl(), and writeToStream().

◆ m_line_A

float mrpt::opengl::CPlanarLaserScan::m_line_A
protected

Definition at line 66 of file CPlanarLaserScan.h.

Referenced by readFromStream(), render_dl(), setLineColor(), and writeToStream().

◆ m_line_B

float mrpt::opengl::CPlanarLaserScan::m_line_B
protected

Definition at line 66 of file CPlanarLaserScan.h.

Referenced by readFromStream(), render_dl(), setLineColor(), and writeToStream().

◆ m_line_G

float mrpt::opengl::CPlanarLaserScan::m_line_G
protected

Definition at line 66 of file CPlanarLaserScan.h.

Referenced by readFromStream(), render_dl(), setLineColor(), and writeToStream().

◆ m_line_R

float mrpt::opengl::CPlanarLaserScan::m_line_R
protected

Definition at line 66 of file CPlanarLaserScan.h.

Referenced by readFromStream(), render_dl(), setLineColor(), and writeToStream().

◆ m_line_width

float mrpt::opengl::CPlanarLaserScan::m_line_width
protected

◆ m_name

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

◆ m_plane_A

float mrpt::opengl::CPlanarLaserScan::m_plane_A
protected

Definition at line 71 of file CPlanarLaserScan.h.

Referenced by readFromStream(), render_dl(), setSurfaceColor(), and writeToStream().

◆ m_plane_B

float mrpt::opengl::CPlanarLaserScan::m_plane_B
protected

Definition at line 71 of file CPlanarLaserScan.h.

Referenced by readFromStream(), render_dl(), setSurfaceColor(), and writeToStream().

◆ m_plane_G

float mrpt::opengl::CPlanarLaserScan::m_plane_G
protected

Definition at line 71 of file CPlanarLaserScan.h.

Referenced by readFromStream(), render_dl(), setSurfaceColor(), and writeToStream().

◆ m_plane_R

float mrpt::opengl::CPlanarLaserScan::m_plane_R
protected

Definition at line 71 of file CPlanarLaserScan.h.

Referenced by readFromStream(), render_dl(), setSurfaceColor(), and writeToStream().

◆ m_points_A

float mrpt::opengl::CPlanarLaserScan::m_points_A
protected

Definition at line 69 of file CPlanarLaserScan.h.

Referenced by readFromStream(), render_dl(), setPointsColor(), and writeToStream().

◆ m_points_B

float mrpt::opengl::CPlanarLaserScan::m_points_B
protected

Definition at line 69 of file CPlanarLaserScan.h.

Referenced by readFromStream(), render_dl(), setPointsColor(), and writeToStream().

◆ m_points_G

float mrpt::opengl::CPlanarLaserScan::m_points_G
protected

Definition at line 69 of file CPlanarLaserScan.h.

Referenced by readFromStream(), render_dl(), setPointsColor(), and writeToStream().

◆ m_points_R

float mrpt::opengl::CPlanarLaserScan::m_points_R
protected

Definition at line 69 of file CPlanarLaserScan.h.

Referenced by readFromStream(), render_dl(), setPointsColor(), and writeToStream().

◆ m_points_width

float mrpt::opengl::CPlanarLaserScan::m_points_width
protected

Definition at line 68 of file CPlanarLaserScan.h.

Referenced by readFromStream(), render_dl(), setPointsWidth(), and writeToStream().

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

Referenced by mrpt::opengl::C3DSScene::getBoundingBox(), mrpt::opengl::CAssimpModel::getBoundingBox(), mrpt::opengl::CBox::getBoundingBox(), mrpt::opengl::CSimpleLine::getBoundingBox(), mrpt::opengl::CTexturedPlane::getBoundingBox(), mrpt::opengl::CGridPlaneXY::getBoundingBox(), mrpt::opengl::CText3D::getBoundingBox(), mrpt::opengl::CGridPlaneXZ::getBoundingBox(), mrpt::opengl::CFrustum::getBoundingBox(), getBoundingBox(), mrpt::opengl::CPolyhedron::getBoundingBox(), mrpt::opengl::CVectorField2D::getBoundingBox(), mrpt::opengl::CSetOfLines::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

◆ m_scale_y

float mrpt::opengl::CRenderizable::m_scale_y
protectedinherited

◆ m_scale_z

float mrpt::opengl::CRenderizable::m_scale_z
protectedinherited

◆ m_scan

mrpt::obs::CObservation2DRangeScan mrpt::opengl::CPlanarLaserScan::m_scan
protected

◆ m_show_name

bool mrpt::opengl::CRenderizable::m_show_name
protectedinherited

◆ m_visible

bool mrpt::opengl::CRenderizable::m_visible
protectedinherited

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::opengl::CPlanarLaserScan::runtimeClassId
staticprotected

Definition at line 59 of file CPlanarLaserScan.h.




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ae4571287 Thu Nov 23 00:06:53 2017 +0100 at dom oct 27 23:51:55 CET 2019