MRPT  1.9.9
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 56 of file CPlanarLaserScan.h.

#include <mrpt/opengl/CPlanarLaserScan.h>

Inheritance diagram for mrpt::opengl::CPlanarLaserScan:

Public Member Functions

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...
 
 ~CPlanarLaserScan () override=default
 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::img::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::img::TColorf getColor () const
 Returns the object color property as a TColorf. More...
 
CRenderizablesetColor (const mrpt::img::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::img::TColorgetColor_u8 () const
 Returns the object color property as a TColor. More...
 
RTTI classes and functions for polymorphic hierarchies
mrpt::rtti::CObject::Ptr duplicateGetSmartPtr () const
 Makes a deep copy of the object and returns a smart pointer to it. More...
 

Static Public Member Functions

static void renderTextBitmap (const char *str, void *fontStyle)
 This method is safe for calling from within ::render() methods. More...
 
static void renderTextBitmap (int screen_x, int screen_y, const std::string &str, float color_r=1, float color_g=1, float color_b=1, mrpt::opengl::TOpenGLFont font=mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24)
 Render a text message in the current rendering context, creating a glViewport in the way (do not call within ::render() methods) More...
 
static int textBitmapWidth (const std::string &str, mrpt::opengl::TOpenGLFont font=mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24)
 Return the exact width in pixels for a given string, as will be rendered by renderTextBitmap(). More...
 

Protected Member Functions

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
void notifyChange () const
 Must be called to notify that the object has changed (so, the display list must be updated) More...
 
virtual bool should_skip_display_list_cache () const
 Optional: If the object has some state in which creating a display list is NOT preferred over direct rendering, implement this method and return "true" in those cases. More...
 
void readFromStreamRender (mrpt::serialization::CArchive &in)
 
CSerializable virtual methods
virtual void serializeTo (CSchemeArchiveBase &out) const
 Virtual method for writing (serializing) to an abstract schema based archive. More...
 
virtual void serializeFrom (CSchemeArchiveBase &in)
 Virtual method for reading (deserializing) from an abstract schema based archive. More...
 

Static Protected Member Functions

static void checkOpenGLError ()
 Checks glGetError and throws an exception if an error situation is found. More...
 
static unsigned int getNewTextureNumber ()
 Returns the lowest next free texture name (avoid using OpenGL's own function since we may call them from different threads and seem it's not cool). More...
 
static void releaseTextureName (unsigned int i)
 

Protected Attributes

mrpt::obs::CObservation2DRangeScan m_scan
 
mrpt::maps::CSimplePointsMap m_cache_points
 
bool m_cache_valid {false}
 
float m_line_width {1}
 
float m_line_R {1.f}
 
float m_line_G {0.f}
 
float m_line_B {0.f}
 
float m_line_A {0.5f}
 
float m_points_width {3}
 
float m_points_R {1.0f}
 
float m_points_G {0.0f}
 
float m_points_B {0.0f}
 
float m_points_A {1.0f}
 
float m_plane_R {0.01f}
 
float m_plane_G {0.01f}
 
float m_plane_B {0.6f}
 
float m_plane_A {0.6f}
 
bool m_enable_points {true}
 
bool m_enable_line {true}
 
bool m_enable_surface {true}
 
std::string m_name
 
bool m_show_name {false}
 
mrpt::img::TColor m_color
 Color components in the range [0,255]. More...
 
mrpt::poses::CPose3D m_pose
 6D pose wrt the parent coordinate reference. More...
 
float m_scale_x {1}
 Scale components to apply to the object (default=1) More...
 
float m_scale_y {1}
 
float m_scale_z {1}
 
bool m_visible {true}
 Is the object visible? (default=true) More...
 

RTTI stuff

using Ptr = std::shared_ptr< CPlanarLaserScan >
 
using ConstPtr = std::shared_ptr< const CPlanarLaserScan >
 
using UniquePtr = std::unique_ptr< CPlanarLaserScan >
 
using ConstUniquePtr = std::unique_ptr< const CPlanarLaserScan >
 
static mrpt::rtti::CLASSINIT _init_CPlanarLaserScan
 
static const mrpt::rtti::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "CPlanarLaserScan"
 
static const mrpt::rtti::TRuntimeClassId_GetBaseClass ()
 
static constexpr auto getClassName ()
 
static const mrpt::rtti::TRuntimeClassIdGetRuntimeClassIdStatic ()
 
static std::shared_ptr< CObjectCreateObject ()
 
template<typename... Args>
static Ptr Create (Args &&... args)
 
template<typename Alloc , typename... Args>
static Ptr CreateAlloc (const Alloc &alloc, Args &&... args)
 
template<typename... Args>
static UniquePtr CreateUnique (Args &&... args)
 
virtual const mrpt::rtti::TRuntimeClassIdGetRuntimeClass () const override
 Returns information about the class of an object in runtime. More...
 
virtual mrpt::rtti::CObjectclone () const override
 Returns a deep copy (clone) of the object, indepently of its class. More...
 

Member Typedef Documentation

◆ ConstPtr

◆ ConstUniquePtr

Definition at line 58 of file CPlanarLaserScan.h.

◆ Ptr

A type for the associated smart pointer

Definition at line 58 of file CPlanarLaserScan.h.

◆ UniquePtr

Definition at line 58 of file CPlanarLaserScan.h.

Constructor & Destructor Documentation

◆ CPlanarLaserScan()

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

Constructor.

◆ ~CPlanarLaserScan()

mrpt::opengl::CPlanarLaserScan::~CPlanarLaserScan ( )
overridedefault

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

Member Function Documentation

◆ _GetBaseClass()

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

◆ checkOpenGLError()

void CRenderizable::checkOpenGLError ( )
staticprotectedinherited

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

Definition at line 295 of file CRenderizable.cpp.

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

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

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

◆ clear()

void CPlanarLaserScan::clear ( )

< Clear the scan

Definition at line 52 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::rtti::CObject* mrpt::opengl::CPlanarLaserScan::clone ( ) const
overridevirtual

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

Implements mrpt::rtti::CObject.

◆ Create()

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

Definition at line 58 of file CPlanarLaserScan.h.

Referenced by mrpt::graphslam::deciders::CICPCriteriaERD< GRAPH_T >::initializeVisuals(), and mrpt::graphslam::deciders::CLoopCloserERD< GRAPH_T >::initLaserScansVisualization().

Here is the caller graph for this function:

◆ CreateAlloc()

template<typename Alloc , typename... Args>
static Ptr mrpt::opengl::CPlanarLaserScan::CreateAlloc ( const Alloc &  alloc,
Args &&...  args 
)
inlinestatic

Definition at line 58 of file CPlanarLaserScan.h.

◆ CreateObject()

static std::shared_ptr<CObject> mrpt::opengl::CPlanarLaserScan::CreateObject ( )
static

◆ CreateUnique()

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

Definition at line 58 of file CPlanarLaserScan.h.

◆ duplicateGetSmartPtr()

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

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

Definition at line 200 of file CObject.h.

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

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

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

◆ 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 82 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

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 190 of file CPlanarLaserScan.cpp.

References bb_max, bb_min, mrpt::maps::CMetricMap::clear(), mrpt::poses::CPose3D::composePoint(), mrpt::maps::CPointsMap::getPointsBuffer(), mrpt::maps::CPointsMap::insertionOptions, mrpt::maps::CMetricMap::insertObservation(), mrpt::maps::CPointsMap::TInsertionOptions::isPlanarMap, mrpt::keep_max(), mrpt::keep_min(), m_cache_points, m_cache_valid, mrpt::opengl::CRenderizable::m_pose, m_scan, and mrpt::maps::CPointsMap::TInsertionOptions::minDistBetweenLaserPoints.

Here is the call graph for this function:

◆ getClassName()

static constexpr auto mrpt::opengl::CPlanarLaserScan::getClassName ( )
inlinestatic

Definition at line 58 of file CPlanarLaserScan.h.

◆ getColor()

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

Returns the object color property as a TColorf.

Definition at line 231 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getColor_u8()

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

Returns the object color property as a TColor.

Definition at line 250 of file CRenderizable.h.

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

◆ getColorA()

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

Color components in the range [0,1].

Definition at line 154 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getColorA_u8()

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

Color components in the range [0,255].

Definition at line 162 of file CRenderizable.h.

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

◆ getColorB()

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

Color components in the range [0,1].

Definition at line 152 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getColorB_u8()

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

Color components in the range [0,255].

Definition at line 160 of file CRenderizable.h.

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

◆ getColorG()

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

Color components in the range [0,1].

Definition at line 150 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getColorG_u8()

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

Color components in the range [0,255].

Definition at line 158 of file CRenderizable.h.

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

◆ getColorR()

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

Color components in the range [0,1].

Definition at line 148 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getColorR_u8()

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

Color components in the range [0,255].

Definition at line 156 of file CRenderizable.h.

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

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

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

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

Here is the caller graph for this function:

◆ getNewTextureNumber()

unsigned int CRenderizable::getNewTextureNumber ( )
staticprotectedinherited

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

Returns the lowest, free texture name.

Definition at line 65 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ getPose()

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

Returns the 3D pose of the object as TPose3D.

Definition at line 337 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ getPosePitch()

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

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 138 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPosePitchRad()

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

Rotation relative to parent coordinate origin, in radians.

Definition at line 144 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseRef()

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

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

Definition at line 108 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getPoseRoll()

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

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 140 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseRollRad()

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

Rotation relative to parent coordinate origin, in radians.

Definition at line 146 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseX()

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

Translation relative to parent coordinate origin.

Definition at line 130 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseY()

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

Translation relative to parent coordinate origin.

Definition at line 132 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseYaw()

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

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 136 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseYawRad()

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

Rotation relative to parent coordinate origin, in radians.

Definition at line 142 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseZ()

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

Translation relative to parent coordinate origin.

Definition at line 134 of file CRenderizable.h.

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

◆ GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::opengl::CPlanarLaserScan::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::CPlanarLaserScan::GetRuntimeClassIdStatic ( )
static

◆ getScaleX()

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

Get the current scaling factor in one axis.

Definition at line 225 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getScaleY()

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

Get the current scaling factor in one axis.

Definition at line 227 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getScaleZ()

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

Get the current scaling factor in one axis.

Definition at line 229 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ isShowNameEnabled()

bool mrpt::opengl::CRenderizable::isShowNameEnabled ( ) const
inlineinherited
See also
enableShowName

Definition at line 84 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ isVisible()

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

Is the object visible?

See also
setVisibility

Definition at line 68 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ notifyChange()

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

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

Definition at line 54 of file CRenderizableDisplayList.h.

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

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(), 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(), 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::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::CArrow::serializeFrom(), mrpt::opengl::CGridPlaneXY::serializeFrom(), mrpt::opengl::CGridPlaneXZ::serializeFrom(), mrpt::opengl::CAxis::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(), mrpt::opengl::CText3D::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(), 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::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(), 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::CAxis::setTickMarksLength(), 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().

◆ readFromStreamRender()

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

Definition at line 62 of file CRenderizableDisplayList.h.

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

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

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

◆ releaseTextureName()

void CRenderizable::releaseTextureName ( unsigned int  i)
staticprotectedinherited

Definition at line 93 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ render()

void CRenderizableDisplayList::render ( ) const
overridevirtualinherited

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

Implements mrpt::opengl::CRenderizable.

Definition at line 80 of file CRenderizableDisplayList.cpp.

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

Here is the call graph for this function:

◆ render_dl()

◆ renderTextBitmap() [1/2]

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

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

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

Definition at line 361 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ renderTextBitmap() [2/2]

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

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

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

Definition at line 332 of file gl_utils.cpp.

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

Here is the call graph for this function:

◆ serializeFrom() [1/2]

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

Implements mrpt::serialization::CSerializable.

Definition at line 159 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:

◆ serializeFrom() [2/2]

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

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

Definition at line 74 of file CSerializable.h.

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

Here is the call graph for this function:

◆ serializeGetVersion()

uint8_t CPlanarLaserScan::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 148 of file CPlanarLaserScan.cpp.

◆ serializeTo() [1/2]

void CPlanarLaserScan::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::exceptionOn any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 149 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:

◆ serializeTo() [2/2]

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

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

Definition at line 64 of file CSerializable.h.

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

Here is the call graph for this function:

◆ setColor() [1/2]

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

Changes the default object color.

Returns
a ref to this

Definition at line 236 of file CRenderizable.h.

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

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

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

◆ setColor() [2/2]

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

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

Returns
a ref to this

Definition at line 244 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ setColor_u8() [1/2]

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

Changes the default object color.

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 110 of file CRenderizableDisplayList.h.

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

Here is the call graph for this function:

◆ setColor_u8() [2/2]

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

Color components in the range [0,255].

Returns
a ref to this

Definition at line 117 of file CRenderizableDisplayList.h.

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

Here is the call graph for this function:

◆ setColorA()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 179 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ setColorA_u8()

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

Color components in the range [0,255].

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 103 of file CRenderizableDisplayList.h.

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

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

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

◆ setColorB()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 174 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ setColorB_u8()

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

Color components in the range [0,255].

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 96 of file CRenderizableDisplayList.h.

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

Here is the call graph for this function:

◆ setColorG()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 169 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ setColorG_u8()

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

Color components in the range [0,255].

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 89 of file CRenderizableDisplayList.h.

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

Here is the call graph for this function:

◆ setColorR()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 164 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ setColorR_u8()

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

Color components in the range [0,255].

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 82 of file CRenderizableDisplayList.h.

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

Here is the call graph for this function:

◆ 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 G, 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 111 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ setLocation() [2/2]

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

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

Returns
a ref to this

Definition at line 121 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ setName()

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

Changes the name of the object.

Definition at line 65 of file CRenderizable.h.

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

◆ 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 G, 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

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

Definition at line 303 of file CRenderizable.cpp.

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

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

Here is the caller graph for this function:

◆ setPose() [2/6]

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

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

Definition at line 308 of file CRenderizable.cpp.

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

◆ setPose() [3/6]

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

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

Definition at line 313 of file CRenderizable.cpp.

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

◆ setPose() [4/6]

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

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

Definition at line 318 of file CRenderizable.cpp.

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

◆ setPose() [5/6]

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

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

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

Definition at line 325 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ setPose() [6/6]

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

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

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

Definition at line 331 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ setScale() [1/2]

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

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

Returns
a ref to this

Definition at line 210 of file CRenderizable.h.

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

◆ setScale() [2/2]

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

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

Returns
a ref to this

Definition at line 217 of file CRenderizable.h.

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

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

Here is the call 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 G, m_plane_A, m_plane_B, m_plane_G, m_plane_R, and R.

◆ setVisibility()

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

Set object visibility (default=true)

See also
isVisible

Definition at line 73 of file CRenderizable.h.

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

◆ should_skip_display_list_cache()

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

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

Reimplemented in mrpt::opengl::CSphere.

Definition at line 61 of file CRenderizableDisplayList.h.

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

Here is the caller graph for this function:

◆ textBitmapWidth()

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

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

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

Definition at line 370 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ traceRay()

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

◆ writeToMatlab()

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

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

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

Definition at line 90 of file CSerializable.h.

◆ writeToStreamRender()

Member Data Documentation

◆ _init_CPlanarLaserScan

mrpt::rtti::CLASSINIT mrpt::opengl::CPlanarLaserScan::_init_CPlanarLaserScan
staticprotected

Definition at line 58 of file CPlanarLaserScan.h.

◆ className

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

Definition at line 58 of file CPlanarLaserScan.h.

◆ m_cache_points

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

Definition at line 61 of file CPlanarLaserScan.h.

Referenced by getBoundingBox(), and render_dl().

◆ m_cache_valid

bool mrpt::opengl::CPlanarLaserScan::m_cache_valid {false}
mutableprotected

Definition at line 62 of file CPlanarLaserScan.h.

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

◆ m_color

◆ m_enable_line

bool mrpt::opengl::CPlanarLaserScan::m_enable_line {true}
protected

Definition at line 74 of file CPlanarLaserScan.h.

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

◆ m_enable_points

bool mrpt::opengl::CPlanarLaserScan::m_enable_points {true}
protected

Definition at line 73 of file CPlanarLaserScan.h.

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

◆ m_enable_surface

bool mrpt::opengl::CPlanarLaserScan::m_enable_surface {true}
protected

Definition at line 75 of file CPlanarLaserScan.h.

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

◆ m_line_A

float mrpt::opengl::CPlanarLaserScan::m_line_A {0.5f}
protected

Definition at line 65 of file CPlanarLaserScan.h.

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

◆ m_line_B

float mrpt::opengl::CPlanarLaserScan::m_line_B {0.f}
protected

Definition at line 65 of file CPlanarLaserScan.h.

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

◆ m_line_G

float mrpt::opengl::CPlanarLaserScan::m_line_G {0.f}
protected

Definition at line 65 of file CPlanarLaserScan.h.

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

◆ m_line_R

float mrpt::opengl::CPlanarLaserScan::m_line_R {1.f}
protected

Definition at line 65 of file CPlanarLaserScan.h.

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

◆ m_line_width

float mrpt::opengl::CPlanarLaserScan::m_line_width {1}
protected

Definition at line 64 of file CPlanarLaserScan.h.

Referenced by getLineWidth(), render_dl(), serializeFrom(), serializeTo(), and setLineWidth().

◆ m_name

◆ m_plane_A

float mrpt::opengl::CPlanarLaserScan::m_plane_A {0.6f}
protected

Definition at line 71 of file CPlanarLaserScan.h.

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

◆ m_plane_B

float mrpt::opengl::CPlanarLaserScan::m_plane_B {0.6f}
protected

Definition at line 71 of file CPlanarLaserScan.h.

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

◆ m_plane_G

float mrpt::opengl::CPlanarLaserScan::m_plane_G {0.01f}
protected

Definition at line 71 of file CPlanarLaserScan.h.

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

◆ m_plane_R

float mrpt::opengl::CPlanarLaserScan::m_plane_R {0.01f}
protected

Definition at line 71 of file CPlanarLaserScan.h.

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

◆ m_points_A

float mrpt::opengl::CPlanarLaserScan::m_points_A {1.0f}
protected

Definition at line 69 of file CPlanarLaserScan.h.

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

◆ m_points_B

float mrpt::opengl::CPlanarLaserScan::m_points_B {0.0f}
protected

Definition at line 68 of file CPlanarLaserScan.h.

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

◆ m_points_G

float mrpt::opengl::CPlanarLaserScan::m_points_G {0.0f}
protected

Definition at line 68 of file CPlanarLaserScan.h.

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

◆ m_points_R

float mrpt::opengl::CPlanarLaserScan::m_points_R {1.0f}
protected

Definition at line 68 of file CPlanarLaserScan.h.

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

◆ m_points_width

float mrpt::opengl::CPlanarLaserScan::m_points_width {3}
protected

Definition at line 67 of file CPlanarLaserScan.h.

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

◆ m_pose

◆ m_scale_x

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

◆ m_scale_y

◆ m_scale_z

◆ m_scan

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

Definition at line 60 of file CPlanarLaserScan.h.

Referenced by clear(), getBoundingBox(), render_dl(), serializeFrom(), serializeTo(), and setScan().

◆ m_show_name

◆ m_visible

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

◆ runtimeClassId

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

Definition at line 58 of file CPlanarLaserScan.h.




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: 8fe78517f Sun Jul 14 19:43:28 2019 +0200 at lun oct 28 02:10:00 CET 2019