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 | Friends
mrpt::opengl::CRenderizable Class Referenceabstract

Detailed Description

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

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

Definition at line 43 of file CRenderizable.h.

#include <mrpt/opengl/CRenderizable.h>

Inheritance diagram for mrpt::opengl::CRenderizable:
Inheritance graph

Public Member Functions

 CRenderizable ()
 Default constructor: More...
 
virtual ~CRenderizable ()
 
virtual void render () const =0
 Implements the rendering of 3D objects in each class derived from CRenderizable. More...
 
virtual bool traceRay (const mrpt::poses::CPose3D &o, double &dist) const
 Simulation of ray-trace, given a pose. More...
 
virtual void getBoundingBox (mrpt::math::TPoint3D &bb_min, mrpt::math::TPoint3D &bb_max) const =0
 Evaluates the bounding box of this object (including possible children) in the coordinate frame of the object parent. More...
 
virtual 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...
 
virtual CObjectclone () const =0
 Returns a deep copy (clone) of the object, indepently of its class. 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...
 
virtual CRenderizablesetColorR_u8 (const uint8_t r)
 Color components in the range [0,255]. More...
 
virtual CRenderizablesetColorG_u8 (const uint8_t g)
 Color components in the range [0,255]. More...
 
virtual CRenderizablesetColorB_u8 (const uint8_t b)
 Color components in the range [0,255]. More...
 
virtual CRenderizablesetColorA_u8 (const uint8_t a)
 Color components in the range [0,255]. 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...
 
virtual CRenderizablesetColor_u8 (const mrpt::utils::TColor &c)
 
CRenderizablesetColor_u8 (uint8_t R, uint8_t G, uint8_t B, uint8_t A=255)
 Set the color components of this object (R,G,B,Alpha, in the range 0-255) More...
 
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 void renderTextBitmap (const char *str, void *fontStyle)
 This method is safe for calling from within ::render() methods. More...
 
static int textBitmapWidth (const std::string &str, mrpt::opengl::TOpenGLFont font=mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24)
 Return the exact width in pixels for a given string, as will be rendered by renderTextBitmap(). More...
 
static void renderTextBitmap (int screen_x, int screen_y, const std::string &str, float color_r=1, float color_g=1, float color_b=1, mrpt::opengl::TOpenGLFont font=mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24)
 Render a text message in the current rendering context, creating a glViewport in the way (do not call within ::render() methods) More...
 

Protected Member Functions

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

Static Protected Member Functions

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

Protected Attributes

std::string m_name
 
bool m_show_name
 
mrpt::utils::TColor m_color
 Color components in the range [0,255]. More...
 
mrpt::poses::CPose3D m_pose
 6D pose wrt the parent coordinate reference. 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...
 

Friends

class mrpt::opengl::COpenGLViewport
 
class mrpt::opengl::CSetOfObjects
 

RTTI stuff

using Ptr = std::shared_ptr< CRenderizable >
 
using ConstPtr = std::shared_ptr< const CRenderizable >
 
static const mrpt::utils::TRuntimeClassId runtimeClassId
 
class mrpt::utils::CStream
 
static const mrpt::utils::TRuntimeClassId_GetBaseClass ()
 
virtual const mrpt::utils::TRuntimeClassIdGetRuntimeClass () const override
 Returns information about the class of an object in runtime. More...
 
static const mrpt::utils::TRuntimeClassIdGetRuntimeClassIdStatic ()
 

Member Typedef Documentation

◆ ConstPtr

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

Definition at line 45 of file CRenderizable.h.

◆ Ptr

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

Definition at line 45 of file CRenderizable.h.

Constructor & Destructor Documentation

◆ CRenderizable()

CRenderizable::CRenderizable ( )

Default constructor:

Definition at line 57 of file CRenderizable.cpp.

◆ ~CRenderizable()

CRenderizable::~CRenderizable ( )
virtual

Definition at line 70 of file CRenderizable.cpp.

Member Function Documentation

◆ _GetBaseClass()

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

◆ checkOpenGLError()

void CRenderizable::checkOpenGLError ( )
staticprotected

◆ clone()

virtual CObject* mrpt::utils::CObject::clone ( ) const
pure virtualinherited

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

Implemented in mrpt::obs::CObservation3DRangeScan, mrpt::nav::CLogFileRecord_ND, mrpt::nav::CLogFileRecord_FullEval, mrpt::maps::CMultiMetricMap, mrpt::utils::CSimpleDatabase, mrpt::utils::CImage, mrpt::obs::CObservationIMU, mrpt::maps::TMapGenericParams, mrpt::poses::CPose3D, mrpt::obs::CObservationRGBD360, mrpt::maps::CRandomFieldGridMap3D, mrpt::detectors::CDetectable3D, mrpt::hmtslam::THypothesisIDSet, mrpt::maps::CMultiMetricMapPDF, mrpt::hmtslam::CLocalMetricHypothesis, mrpt::obs::CObservationVelodyneScan, mrpt::maps::CLandmarksMap, mrpt::hmtslam::CHMTSLAM, mrpt::opengl::COctoMapVoxels, mrpt::kinematics::CKinematicChain, mrpt::maps::COccupancyGridMap2D, mrpt::obs::CObservationGPS, mrpt::obs::CRawlog, mrpt::opengl::COpenGLViewport, mrpt::maps::CHeightGridMap2D, mrpt::opengl::COpenGLScene, mrpt::opengl::CPlanarLaserScan, mrpt::nav::CHolonomicFullEval, mrpt::vision::CFeature, mrpt::nav::CHolonomicND, mrpt::obs::CObservation2DRangeScan, mrpt::obs::CSensoryFrame, mrpt::opengl::CFrustum, mrpt::poses::CPose2DInterpolator, mrpt::poses::CPose3DInterpolator, mrpt::nav::CHolonomicVFF, mrpt::opengl::CEllipsoidInverseDepth3D, mrpt::opengl::CPointCloud, mrpt::opengl::CPointCloudColoured, mrpt::pbmap::PbMap, mrpt::poses::CPose3DQuat, mrpt::pbmap::Plane, mrpt::opengl::CEllipsoid, mrpt::opengl::CEllipsoidInverseDepth2D, mrpt::poses::CPose3DQuatPDFGaussianInf, mrpt::detectors::CDetectable2D, mrpt::hmtslam::CLSLAMParticleData, mrpt::maps::CBeaconMap, mrpt::poses::CPose3DRotVec, mrpt::opengl::CText3D, mrpt::opengl::CVectorField3D, mrpt::poses::CPointPDFParticles, mrpt::poses::CPose3DQuatPDFGaussian, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CEllipsoidRangeBearing2D, mrpt::opengl::CPolyhedron, mrpt::poses::CPose3DPDFGaussianInf, mrpt::maps::CReflectivityGridMap2D, mrpt::obs::CObservationStereoImages, mrpt::opengl::CAssimpModel, mrpt::maps::CBeacon, mrpt::nav::CPTG_DiffDrive_C, mrpt::opengl::CBox, mrpt::poses::CPose2D, mrpt::opengl::CMeshFast, mrpt::poses::CPose3DPDFGaussian, mrpt::hmtslam::CHMHMapNode, mrpt::hmtslam::CRobotPosesGraph, mrpt::obs::CObservationStereoImagesFeatures, mrpt::opengl::CMesh, mrpt::utils::CMHPropertiesValuesList, mrpt::opengl::CMesh3D, mrpt::opengl::CText, mrpt::poses::CPosePDFGaussianInf, mrpt::maps::CHeightGridMap2D_MRF, mrpt::nav::CPTG_DiffDrive_alpha, mrpt::maps::CRBPFParticleData, mrpt::poses::CPoint2D, mrpt::poses::CPointPDFSOG, mrpt::poses::CPose3DPDFParticles, mrpt::poses::CPosePDFParticles, mrpt::poses::CPosePDFSOG, mrpt::hmtslam::CHMHMapArc, mrpt::opengl::CColorBar, mrpt::opengl::CVectorField2D, mrpt::poses::CPose3DPDFSOG, mrpt::maps::CGasConcentrationGridMap2D, mrpt::maps::CWirelessPowerGridMap2D, mrpt::maps::CSimpleMap, mrpt::obs::CObservationImage, mrpt::opengl::CSetOfLines, mrpt::maps::CLandmark, mrpt::hmtslam::CHierarchicalMHMap, mrpt::maps::COctoMap, mrpt::obs::CActionRobotMovement2D, mrpt::obs::CObservationBatteryState, mrpt::opengl::CDisk, mrpt::poses::CPoint3D, mrpt::utils::CStringList, mrpt::utils::TCamera, mrpt::obs::CObservationOdometry, mrpt::obs::CObservationRawDAQ, mrpt::opengl::CCamera, mrpt::opengl::CCylinder, mrpt::opengl::CGridPlaneXY, mrpt::opengl::CGridPlaneXZ, mrpt::poses::CPosePDFGaussian, mrpt::maps::CColouredOctoMap, mrpt::maps::CSimplePointsMap, mrpt::nav::CLogFileRecord, mrpt::obs::CObservationBearingRange, mrpt::obs::CObservationWindSensor, mrpt::opengl::CArrow, mrpt::opengl::CAxis, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CSphere, mrpt::slam::CIncrementalMapPartitioner, mrpt::maps::CColouredPointsMap, mrpt::maps::CWeightedPointsMap, mrpt::obs::CObservationRange, mrpt::opengl::CSetOfObjects, mrpt::obs::CActionCollection, mrpt::obs::CActionRobotMovement3D, mrpt::obs::CObservationWirelessPower, mrpt::opengl::CSetOfTexturedTriangles, mrpt::math::CSplineInterpolator1D, mrpt::nav::CLogFileRecord_VFF, mrpt::nav::CMultiObjMotionOpt_Scalarization, mrpt::nav::CPTG_Holo_Blend, mrpt::obs::CObservation6DFeatures, mrpt::obs::CObservationSkeleton, mrpt::obs::CObservationVisualLandmarks, mrpt::poses::CPosePDFGrid, mrpt::nav::CPTG_DiffDrive_CC, mrpt::nav::CPTG_DiffDrive_CCS, mrpt::nav::CPTG_DiffDrive_CS, mrpt::obs::CObservationBeaconRanges, mrpt::obs::CObservationComment, mrpt::obs::CObservationGasSensors, mrpt::obs::CObservationReflectivity, mrpt::obs::CObservationRFID, mrpt::math::CMatrixD, mrpt::poses::CPoses2DSequence, mrpt::poses::CPoses3DSequence, mrpt::opengl::C3DSScene, mrpt::opengl::COpenGLStandardObject, mrpt::math::CMatrix, mrpt::poses::CPointPDFGaussian, mrpt::utils::TStereoCamera, mrpt::opengl::CSetOfTriangles, mrpt::math::CMatrixB, mrpt::poses::TSimple3DPoint, mrpt::utils::CMemoryChunk, mrpt::utils::CPropertiesValuesList, mrpt::obs::CObservationCANBusJ1939, mrpt::obs::CObservationRobotPose, mrpt::math::CPolygon, mrpt::poses::CPoint2DPDFGaussian, mrpt::utils::CSimpleDatabaseTable, mrpt::utils::CTypeSelector, mrpt::opengl::CSimpleLine, mrpt::opengl::CTexturedPlane, mrpt::kinematics::CVehicleVelCmd_DiffDriven, and mrpt::kinematics::CVehicleVelCmd_Holo.

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

Here is the caller graph for this function:

◆ enableShowName()

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

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

Definition at line 85 of file CRenderizable.h.

References m_show_name.

◆ getBoundingBox()

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

◆ getColor()

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

Returns the object color property as a TColorf.

Definition at line 243 of file CRenderizable.h.

References 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
inline

Returns the object color property as a TColor.

Definition at line 263 of file CRenderizable.h.

References m_color.

◆ getColorA()

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

Color components in the range [0,1].

Definition at line 166 of file CRenderizable.h.

References mrpt::utils::TColor::A, and 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
inline

Color components in the range [0,255].

Definition at line 174 of file CRenderizable.h.

References mrpt::utils::TColor::A, and m_color.

◆ getColorB()

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

Color components in the range [0,1].

Definition at line 164 of file CRenderizable.h.

References mrpt::utils::TColor::B, and 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
inline

Color components in the range [0,255].

Definition at line 172 of file CRenderizable.h.

References mrpt::utils::TColor::B, and m_color.

◆ getColorG()

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

Color components in the range [0,1].

Definition at line 162 of file CRenderizable.h.

References mrpt::utils::TColor::G, and 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
inline

Color components in the range [0,255].

Definition at line 170 of file CRenderizable.h.

References mrpt::utils::TColor::G, and m_color.

◆ getColorR()

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

Color components in the range [0,1].

Definition at line 160 of file CRenderizable.h.

References 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
inline

Color components in the range [0,255].

Definition at line 168 of file CRenderizable.h.

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

◆ getName()

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

Returns the name of the object.

Definition at line 70 of file CRenderizable.h.

References m_name.

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

Here is the caller graph for this function:

◆ getNewTextureNumber()

unsigned int CRenderizable::getNewTextureNumber ( )
staticprotected

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

Returns the lowest, free texture name.

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

Returns the 3D pose of the object as TPose3D.

Definition at line 347 of file CRenderizable.cpp.

References m_pose.

◆ getPosePitch()

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

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 144 of file CRenderizable.h.

References 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
inline

Rotation relative to parent coordinate origin, in radians.

Definition at line 156 of file CRenderizable.h.

References 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
inline

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

Definition at line 111 of file CRenderizable.h.

References m_pose.

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

Here is the caller graph for this function:

◆ getPoseRoll()

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

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 149 of file CRenderizable.h.

References 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
inline

Rotation relative to parent coordinate origin, in radians.

Definition at line 158 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseX()

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

Translation relative to parent coordinate origin.

Definition at line 133 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseY()

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

Translation relative to parent coordinate origin.

Definition at line 135 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseYaw()

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

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 139 of file CRenderizable.h.

References 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
inline

Rotation relative to parent coordinate origin, in radians.

Definition at line 154 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseZ()

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

Translation relative to parent coordinate origin.

Definition at line 137 of file CRenderizable.h.

References m_pose.

◆ GetRuntimeClass()

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

◆ GetRuntimeClassIdStatic()

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

◆ getScaleX()

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

Get the current scaling factor in one axis.

Definition at line 237 of file CRenderizable.h.

References 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
inline

Get the current scaling factor in one axis.

Definition at line 239 of file CRenderizable.h.

References 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
inline

Get the current scaling factor in one axis.

Definition at line 241 of file CRenderizable.h.

References 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
inline
See also
enableShowName

Definition at line 87 of file CRenderizable.h.

References 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
inline

Is the object visible?

See also
setVisibility

Definition at line 71 of file CRenderizable.h.

References m_visible.

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

Here is the caller graph for this function:

◆ readFromStream()

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

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

Parameters
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

Implemented in mrpt::obs::CObservation3DRangeScan, mrpt::nav::CLogFileRecord_ND, mrpt::nav::CLogFileRecord_FullEval, mrpt::maps::CMultiMetricMap, mrpt::utils::CSimpleDatabase, mrpt::utils::CImage, mrpt::obs::CObservationIMU, mrpt::maps::TMapGenericParams, mrpt::poses::CPose3D, mrpt::obs::CObservationRGBD360, mrpt::maps::CRandomFieldGridMap3D, mrpt::detectors::CDetectable3D, mrpt::hmtslam::THypothesisIDSet, mrpt::maps::CMultiMetricMapPDF, mrpt::hmtslam::CLocalMetricHypothesis, mrpt::obs::CObservationVelodyneScan, mrpt::maps::CLandmarksMap, mrpt::hmtslam::CHMTSLAM, mrpt::opengl::COctoMapVoxels, mrpt::kinematics::CKinematicChain, mrpt::maps::COccupancyGridMap2D, mrpt::obs::CObservationGPS, mrpt::obs::CRawlog, mrpt::opengl::COpenGLViewport, mrpt::maps::CHeightGridMap2D, mrpt::opengl::COpenGLScene, mrpt::opengl::CPlanarLaserScan, mrpt::nav::CHolonomicFullEval, mrpt::vision::CFeature, mrpt::nav::CHolonomicND, mrpt::obs::CObservation2DRangeScan, mrpt::obs::CSensoryFrame, mrpt::opengl::CFrustum, mrpt::poses::CPose2DInterpolator, mrpt::poses::CPose3DInterpolator, mrpt::nav::CHolonomicVFF, mrpt::opengl::CEllipsoidInverseDepth3D, mrpt::opengl::CPointCloud, mrpt::opengl::CPointCloudColoured, mrpt::pbmap::PbMap, mrpt::poses::CPose3DQuat, mrpt::pbmap::Plane, mrpt::opengl::CEllipsoid, mrpt::opengl::CEllipsoidInverseDepth2D, mrpt::poses::CPose3DQuatPDFGaussianInf, mrpt::detectors::CDetectable2D, mrpt::hmtslam::CLSLAMParticleData, mrpt::maps::CBeaconMap, mrpt::poses::CPose3DRotVec, mrpt::opengl::CText3D, mrpt::opengl::CVectorField3D, mrpt::poses::CPointPDFParticles, mrpt::poses::CPose3DQuatPDFGaussian, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CEllipsoidRangeBearing2D, mrpt::opengl::CPolyhedron, mrpt::poses::CPose3DPDFGaussianInf, mrpt::maps::CReflectivityGridMap2D, mrpt::obs::CObservationStereoImages, mrpt::opengl::CAssimpModel, mrpt::maps::CBeacon, mrpt::nav::CPTG_DiffDrive_C, mrpt::opengl::CBox, mrpt::poses::CPose2D, mrpt::opengl::CMeshFast, mrpt::poses::CPose3DPDFGaussian, mrpt::hmtslam::CHMHMapNode, mrpt::hmtslam::CRobotPosesGraph, mrpt::obs::CObservationStereoImagesFeatures, mrpt::opengl::CMesh, mrpt::utils::CMHPropertiesValuesList, mrpt::opengl::CMesh3D, mrpt::opengl::CText, mrpt::poses::CPosePDFGaussianInf, mrpt::maps::CHeightGridMap2D_MRF, mrpt::nav::CPTG_DiffDrive_alpha, mrpt::maps::CRBPFParticleData, mrpt::poses::CPoint2D, mrpt::poses::CPointPDFSOG, mrpt::poses::CPose3DPDFParticles, mrpt::poses::CPosePDFParticles, mrpt::poses::CPosePDFSOG, mrpt::hmtslam::CHMHMapArc, mrpt::opengl::CColorBar, mrpt::opengl::CVectorField2D, mrpt::poses::CPose3DPDFSOG, mrpt::maps::CGasConcentrationGridMap2D, mrpt::maps::CWirelessPowerGridMap2D, mrpt::maps::CSimpleMap, mrpt::obs::CObservationImage, mrpt::opengl::CSetOfLines, mrpt::maps::CLandmark, mrpt::hmtslam::CHierarchicalMHMap, mrpt::maps::COctoMap, mrpt::obs::CActionRobotMovement2D, mrpt::obs::CObservationBatteryState, mrpt::opengl::CDisk, mrpt::poses::CPoint3D, mrpt::utils::CStringList, mrpt::utils::TCamera, mrpt::obs::CObservationOdometry, mrpt::obs::CObservationRawDAQ, mrpt::opengl::CCamera, mrpt::opengl::CCylinder, mrpt::opengl::CGridPlaneXY, mrpt::opengl::CGridPlaneXZ, mrpt::poses::CPosePDFGaussian, mrpt::maps::CColouredOctoMap, mrpt::maps::CSimplePointsMap, mrpt::nav::CLogFileRecord, mrpt::obs::CObservationBearingRange, mrpt::obs::CObservationWindSensor, mrpt::opengl::CArrow, mrpt::opengl::CAxis, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CSphere, mrpt::slam::CIncrementalMapPartitioner, mrpt::maps::CColouredPointsMap, mrpt::maps::CWeightedPointsMap, mrpt::obs::CObservationRange, mrpt::opengl::CSetOfObjects, mrpt::obs::CActionCollection, mrpt::obs::CActionRobotMovement3D, mrpt::obs::CObservationWirelessPower, mrpt::opengl::CSetOfTexturedTriangles, mrpt::math::CSplineInterpolator1D, mrpt::nav::CLogFileRecord_VFF, mrpt::nav::CPTG_Holo_Blend, mrpt::obs::CObservation6DFeatures, mrpt::obs::CObservationSkeleton, mrpt::obs::CObservationVisualLandmarks, mrpt::poses::CPosePDFGrid, mrpt::nav::CPTG_DiffDrive_CC, mrpt::nav::CPTG_DiffDrive_CCS, mrpt::nav::CPTG_DiffDrive_CS, mrpt::obs::CObservationBeaconRanges, mrpt::obs::CObservationComment, mrpt::obs::CObservationGasSensors, mrpt::obs::CObservationReflectivity, mrpt::obs::CObservationRFID, mrpt::math::CMatrixD, mrpt::poses::CPoses2DSequence, mrpt::poses::CPoses3DSequence, mrpt::opengl::C3DSScene, mrpt::opengl::COpenGLStandardObject, mrpt::math::CMatrix, mrpt::poses::CPointPDFGaussian, mrpt::utils::TStereoCamera, mrpt::opengl::CSetOfTriangles, mrpt::math::CMatrixB, mrpt::poses::TSimple3DPoint, mrpt::utils::CMemoryChunk, mrpt::utils::CPropertiesValuesList, mrpt::obs::CObservationCANBusJ1939, mrpt::obs::CObservationRobotPose, mrpt::math::CPolygon, mrpt::poses::CPoint2DPDFGaussian, mrpt::utils::CSimpleDatabaseTable, mrpt::utils::CTypeSelector, mrpt::opengl::CSimpleLine, mrpt::opengl::CTexturedPlane, mrpt::kinematics::CVehicleVelCmd_DiffDriven, and mrpt::kinematics::CVehicleVelCmd_Holo.

◆ readFromStreamRender()

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

◆ releaseTextureName()

void CRenderizable::releaseTextureName ( unsigned int  i)
staticprotected

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

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

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

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

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

Here is the caller graph for this function:

◆ renderTextBitmap() [1/2]

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

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

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

Definition at line 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 
)
static

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

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

Definition at line 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)
inline

Changes the default object color.

Returns
a ref to this

Definition at line 248 of file CRenderizable.h.

References 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 
)
inline

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

Returns
a ref to this

Definition at line 257 of file CRenderizable.h.

References R, and setColor_u8().

Here is the call graph for this function:

◆ setColor_u8() [1/2]

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

◆ setColor_u8() [2/2]

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

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

Returns
a ref to this

Definition at line 269 of file CRenderizable.h.

References R, and setColor_u8().

Here is the call graph for this function:

◆ setColorA()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 191 of file CRenderizable.h.

References setColorA_u8().

Here is the call graph for this function:

◆ setColorA_u8()

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

Color components in the range [0,255].

Returns
a ref to this

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

Definition at line 214 of file CRenderizable.h.

References mrpt::utils::TColor::A, and m_color.

Referenced by setColorA(), and mrpt::opengl::CSetOfObjects::setColorA_u8().

Here is the caller graph for this function:

◆ setColorB()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 186 of file CRenderizable.h.

References setColorB_u8().

Here is the call graph for this function:

◆ setColorB_u8()

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

Color components in the range [0,255].

Returns
a ref to this

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

Definition at line 208 of file CRenderizable.h.

References mrpt::utils::TColor::B, and m_color.

Referenced by setColorB(), and mrpt::opengl::CSetOfObjects::setColorB_u8().

Here is the caller graph for this function:

◆ setColorG()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 181 of file CRenderizable.h.

References setColorG_u8().

Here is the call graph for this function:

◆ setColorG_u8()

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

Color components in the range [0,255].

Returns
a ref to this

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

Definition at line 202 of file CRenderizable.h.

References mrpt::utils::TColor::G, and m_color.

Referenced by setColorG(), and mrpt::opengl::CSetOfObjects::setColorG_u8().

Here is the caller graph for this function:

◆ setColorR()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 176 of file CRenderizable.h.

References setColorR_u8().

Here is the call graph for this function:

◆ setColorR_u8()

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

Color components in the range [0,255].

Returns
a ref to this

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

Definition at line 196 of file CRenderizable.h.

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

Referenced by setColorR(), and mrpt::opengl::CSetOfObjects::setColorR_u8().

Here is the caller graph for this function:

◆ setLocation() [1/2]

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

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

Returns
a ref to this

Definition at line 114 of file CRenderizable.h.

References 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)
inline

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

Returns
a ref to this

Definition at line 124 of file CRenderizable.h.

References 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)
inline

Changes the name of the object.

Definition at line 68 of file CRenderizable.h.

References m_name.

◆ setPose() [1/6]

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

◆ setPose() [2/6]

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

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

Definition at line 315 of file CRenderizable.cpp.

References m_pose.

◆ setPose() [3/6]

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

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

Definition at line 320 of file CRenderizable.cpp.

References m_pose.

◆ setPose() [4/6]

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

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

Definition at line 325 of file CRenderizable.cpp.

References m_pose.

◆ setPose() [5/6]

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

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

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

Definition at line 332 of file CRenderizable.cpp.

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

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

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 m_scale_x, m_scale_y, and 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 
)
inline

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 m_scale_x, m_scale_y, and m_scale_z.

◆ setVisibility()

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

Set object visibility (default=true)

See also
isVisible

Definition at line 76 of file CRenderizable.h.

References m_visible.

Referenced by mrpt::hwdrivers::CSkeletonTracker::processPreview(), mrpt::hwdrivers::CSkeletonTracker::processPreviewNone(), and mrpt::graphslam::deciders::CLoopCloserERD< GRAPH_T >::updateMapPartitionsVisualization().

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

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

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

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

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

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

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

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

Parameters
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

Implemented in mrpt::obs::CObservation3DRangeScan, mrpt::nav::CLogFileRecord_ND, mrpt::nav::CLogFileRecord_FullEval, mrpt::maps::CMultiMetricMap, mrpt::utils::CSimpleDatabase, mrpt::utils::CImage, mrpt::obs::CObservationIMU, mrpt::maps::TMapGenericParams, mrpt::poses::CPose3D, mrpt::obs::CObservationRGBD360, mrpt::maps::CRandomFieldGridMap3D, mrpt::detectors::CDetectable3D, mrpt::hmtslam::THypothesisIDSet, mrpt::maps::CMultiMetricMapPDF, mrpt::hmtslam::CLocalMetricHypothesis, mrpt::obs::CObservationVelodyneScan, mrpt::maps::CLandmarksMap, mrpt::hmtslam::CHMTSLAM, mrpt::opengl::COctoMapVoxels, mrpt::kinematics::CKinematicChain, mrpt::maps::COccupancyGridMap2D, mrpt::obs::CObservationGPS, mrpt::obs::CRawlog, mrpt::opengl::COpenGLViewport, mrpt::maps::CHeightGridMap2D, mrpt::opengl::COpenGLScene, mrpt::opengl::CPlanarLaserScan, mrpt::nav::CHolonomicFullEval, mrpt::vision::CFeature, mrpt::nav::CHolonomicND, mrpt::obs::CObservation2DRangeScan, mrpt::obs::CSensoryFrame, mrpt::opengl::CFrustum, mrpt::poses::CPose2DInterpolator, mrpt::poses::CPose3DInterpolator, mrpt::nav::CHolonomicVFF, mrpt::opengl::CEllipsoidInverseDepth3D, mrpt::opengl::CPointCloud, mrpt::opengl::CPointCloudColoured, mrpt::pbmap::PbMap, mrpt::poses::CPose3DQuat, mrpt::pbmap::Plane, mrpt::opengl::CEllipsoid, mrpt::opengl::CEllipsoidInverseDepth2D, mrpt::poses::CPose3DQuatPDFGaussianInf, mrpt::detectors::CDetectable2D, mrpt::hmtslam::CLSLAMParticleData, mrpt::maps::CBeaconMap, mrpt::poses::CPose3DRotVec, mrpt::opengl::CText3D, mrpt::opengl::CVectorField3D, mrpt::poses::CPointPDFParticles, mrpt::poses::CPose3DQuatPDFGaussian, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CEllipsoidRangeBearing2D, mrpt::opengl::CPolyhedron, mrpt::poses::CPose3DPDFGaussianInf, mrpt::maps::CReflectivityGridMap2D, mrpt::obs::CObservationStereoImages, mrpt::opengl::CAssimpModel, mrpt::maps::CBeacon, mrpt::nav::CPTG_DiffDrive_C, mrpt::opengl::CBox, mrpt::poses::CPose2D, mrpt::opengl::CMeshFast, mrpt::poses::CPose3DPDFGaussian, mrpt::hmtslam::CHMHMapNode, mrpt::hmtslam::CRobotPosesGraph, mrpt::obs::CObservationStereoImagesFeatures, mrpt::opengl::CMesh, mrpt::utils::CMHPropertiesValuesList, mrpt::opengl::CMesh3D, mrpt::opengl::CText, mrpt::poses::CPosePDFGaussianInf, mrpt::maps::CHeightGridMap2D_MRF, mrpt::nav::CPTG_DiffDrive_alpha, mrpt::maps::CRBPFParticleData, mrpt::poses::CPoint2D, mrpt::poses::CPointPDFSOG, mrpt::poses::CPose3DPDFParticles, mrpt::poses::CPosePDFParticles, mrpt::poses::CPosePDFSOG, mrpt::hmtslam::CHMHMapArc, mrpt::opengl::CColorBar, mrpt::opengl::CVectorField2D, mrpt::poses::CPose3DPDFSOG, mrpt::maps::CGasConcentrationGridMap2D, mrpt::maps::CWirelessPowerGridMap2D, mrpt::maps::CSimpleMap, mrpt::obs::CObservationImage, mrpt::opengl::CSetOfLines, mrpt::maps::CLandmark, mrpt::hmtslam::CHierarchicalMHMap, mrpt::maps::COctoMap, mrpt::obs::CActionRobotMovement2D, mrpt::obs::CObservationBatteryState, mrpt::opengl::CDisk, mrpt::poses::CPoint3D, mrpt::utils::CStringList, mrpt::utils::TCamera, mrpt::obs::CObservationOdometry, mrpt::obs::CObservationRawDAQ, mrpt::opengl::CCamera, mrpt::opengl::CCylinder, mrpt::opengl::CGridPlaneXY, mrpt::opengl::CGridPlaneXZ, mrpt::poses::CPosePDFGaussian, mrpt::maps::CColouredOctoMap, mrpt::maps::CSimplePointsMap, mrpt::nav::CLogFileRecord, mrpt::obs::CObservationBearingRange, mrpt::obs::CObservationWindSensor, mrpt::opengl::CArrow, mrpt::opengl::CAxis, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CSphere, mrpt::slam::CIncrementalMapPartitioner, mrpt::maps::CColouredPointsMap, mrpt::maps::CWeightedPointsMap, mrpt::obs::CObservationRange, mrpt::opengl::CSetOfObjects, mrpt::obs::CActionCollection, mrpt::obs::CActionRobotMovement3D, mrpt::obs::CObservationWirelessPower, mrpt::opengl::CSetOfTexturedTriangles, mrpt::math::CSplineInterpolator1D, mrpt::nav::CLogFileRecord_VFF, mrpt::nav::CPTG_Holo_Blend, mrpt::obs::CObservation6DFeatures, mrpt::obs::CObservationSkeleton, mrpt::obs::CObservationVisualLandmarks, mrpt::poses::CPosePDFGrid, mrpt::nav::CPTG_DiffDrive_CC, mrpt::nav::CPTG_DiffDrive_CCS, mrpt::nav::CPTG_DiffDrive_CS, mrpt::obs::CObservationBeaconRanges, mrpt::obs::CObservationComment, mrpt::obs::CObservationGasSensors, mrpt::obs::CObservationReflectivity, mrpt::obs::CObservationRFID, mrpt::math::CMatrixD, mrpt::poses::CPoses2DSequence, mrpt::poses::CPoses3DSequence, mrpt::opengl::C3DSScene, mrpt::opengl::COpenGLStandardObject, mrpt::math::CMatrix, mrpt::poses::CPointPDFGaussian, mrpt::utils::TStereoCamera, mrpt::opengl::CSetOfTriangles, mrpt::math::CMatrixB, mrpt::poses::TSimple3DPoint, mrpt::utils::CMemoryChunk, mrpt::utils::CPropertiesValuesList, mrpt::obs::CObservationCANBusJ1939, mrpt::obs::CObservationRobotPose, mrpt::math::CPolygon, mrpt::poses::CPoint2DPDFGaussian, mrpt::utils::CSimpleDatabaseTable, mrpt::utils::CTypeSelector, mrpt::opengl::CSimpleLine, mrpt::opengl::CTexturedPlane, mrpt::kinematics::CVehicleVelCmd_DiffDriven, and mrpt::kinematics::CVehicleVelCmd_Holo.

Referenced by mrpt::utils::CStream::WriteObject(), mrpt::maps::CColouredOctoMap::writeToStream(), and mrpt::maps::COctoMap::writeToStream().

Here is the caller graph for this function:

◆ writeToStreamRender()

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

Friends And Related Function Documentation

◆ mrpt::opengl::COpenGLViewport

friend class mrpt::opengl::COpenGLViewport
friend

Definition at line 47 of file CRenderizable.h.

◆ mrpt::opengl::CSetOfObjects

friend class mrpt::opengl::CSetOfObjects
friend

Definition at line 48 of file CRenderizable.h.

◆ mrpt::utils::CStream

friend class mrpt::utils::CStream
friend

Definition at line 45 of file CRenderizable.h.

Member Data Documentation

◆ m_color

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

◆ m_name

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

Definition at line 51 of file CRenderizable.h.

Referenced by getName(), readFromStreamRender(), setName(), and writeToStreamRender().

◆ m_pose

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

◆ m_scale_x

float mrpt::opengl::CRenderizable::m_scale_x
protected

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

Definition at line 59 of file CRenderizable.h.

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

◆ m_scale_y

float mrpt::opengl::CRenderizable::m_scale_y
protected

Definition at line 59 of file CRenderizable.h.

Referenced by getScaleY(), readFromStreamRender(), setScale(), and writeToStreamRender().

◆ m_scale_z

float mrpt::opengl::CRenderizable::m_scale_z
protected

Definition at line 59 of file CRenderizable.h.

Referenced by getScaleZ(), readFromStreamRender(), setScale(), and writeToStreamRender().

◆ m_show_name

bool mrpt::opengl::CRenderizable::m_show_name
protected

◆ m_visible

bool mrpt::opengl::CRenderizable::m_visible
protected

Is the object visible? (default=true)

Definition at line 61 of file CRenderizable.h.

Referenced by isVisible(), readFromStreamRender(), setVisibility(), and writeToStreamRender().

◆ runtimeClassId

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

Definition at line 45 of file CRenderizable.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