MRPT  2.0.2
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
mrpt::opengl::CAxis Class Reference

Detailed Description

Draw a 3D world axis, with coordinate marks at some regular interval.

See also
opengl::COpenGLScene
mrpt::opengl::CAxis
preview_CAxis.png

Definition at line 29 of file CAxis.h.

#include <mrpt/opengl/CAxis.h>

Inheritance diagram for mrpt::opengl::CAxis:

Public Member Functions

 CAxis (float xmin=-1.0f, float ymin=-1.0f, float zmin=-1.0f, float xmax=1.0f, float ymax=1.0f, float zmax=1.0f, float frecuency=1.f, float lineWidth=3.0f, bool marks=true)
 Constructor. More...
 
virtual ~CAxis () override=default
 
void setAxisLimits (float xmin, float ymin, float zmin, float xmax, float ymax, float zmax)
 
void setFrequency (float f)
 Changes the frequency of the "ticks". More...
 
float getFrequency () const
 
void setTextScale (float f)
 Changes the size of text labels (default:0.25) More...
 
float getTextScale () const
 
void setTextLabelOrientation (int axis, float yaw_deg, float pitch_deg, float roll_deg)
 axis: {0,1,2}=>{X,Y,Z} More...
 
void getTextLabelOrientation (int axis, float &yaw_deg, float &pitch_deg, float &roll_deg) const
 axis: {0,1,2}=>{X,Y,Z} More...
 
void enableTickMarks (bool v=true)
 
void enableTickMarks (bool show_x, bool show_y, bool show_z)
 
void setTickMarksLength (float len)
 As a ratio of "marks frequency" (default: 0.05) More...
 
float getTickMarksLength (float len)
 
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...
 
virtual shader_list_t requiredShaders () const override
 Returns the ID of the OpenGL shader program required to render this class. More...
 
void renderUpdateBuffers () const override
 Called whenever m_outdatedBuffers is true: used to re-generate OpenGL vertex buffers, etc. More...
 
void setLineWidth (float w)
 
float getLineWidth () const
 
void enableAntiAliasing (bool enable=true)
 
bool isAntiAliasingEnabled () const
 
void freeOpenGLResources () override
 Free opengl buffers. More...
 
virtual void enqueForRenderRecursive ([[maybe_unused]] const mrpt::opengl::TRenderMatrices &state, [[maybe_unused]] RenderQueue &rq) const
 Process all children objects recursively, if the object is a container. More...
 
void updateBuffers () const
 Calls renderUpdateBuffers() and clear the flag that is set with notifyChange() More...
 
void notifyChange () const
 Call to enable calling renderUpdateBuffers() before the next render() rendering iteration. More...
 
bool hasToUpdateBuffers () const
 Returns whether notifyChange() has been invoked since the last call to renderUpdateBuffers(), meaning the latter needs to be called again before rendering. More...
 
virtual bool traceRay (const mrpt::poses::CPose3D &o, double &dist) const
 Simulation of ray-trace, given a pose. More...
 
virtual mrpt::math::TPoint3Df getLocalRepresentativePoint () const
 Provide a representative point (in object local coordinates), used to sort objects by eye-distance while rendering with transparencies (Default=[0,0,0]) More...
 
void setLocalRepresentativePoint (const mrpt::math::TPoint3Df &p)
 See getLocalRepresentativePoint() More...
 
mrpt::opengl::CTextlabelObject () const
 Returns or constructs (in its first invokation) the associated mrpt::opengl::CText object representing the label of the object. More...
 
virtual void initializeTextures () const
 Initializes all textures (loads them into opengl memory). 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...
 
Renderizable shader API virtual methods
void onUpdateBuffers_Wireframe () override
 Must be implemented in derived classes to update the geometric entities to be drawn in "m_*_buffer" fields. More...
 
void render (const RenderContext &rc) const override
 Implements the rendering of 3D objects in each class derived from CRenderizable. More...
 
void enqueForRenderRecursive (const mrpt::opengl::TRenderMatrices &state, RenderQueue &rq) const override
 
Changes the appearance of the object to render
void setName (const std::string &n)
 Changes the name of the object. More...
 
const std::string & getName () const
 Returns the name of the object. More...
 
bool isVisible () const
 Is the object visible? More...
 
void setVisibility (bool visible=true)
 Set object visibility (default=true) More...
 
void enableShowName (bool showName=true)
 Enables or disables showing the name of the object as a label when rendering. More...
 
bool isShowNameEnabled () const
 
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...
 
float getColorR () const
 Color components in the range [0,1]. More...
 
float getColorG () const
 Color components in the range [0,1]. More...
 
float getColorB () const
 Color components in the range [0,1]. More...
 
float 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 float r)
 Color components in the range [0,1]. More...
 
CRenderizablesetColorG (const float g)
 Color components in the range [0,1]. More...
 
CRenderizablesetColorB (const float b)
 Color components in the range [0,1]. More...
 
CRenderizablesetColorA (const float 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::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 (float R, float G, float B, float 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...
 
virtual CRenderizablesetColor_u8 (const mrpt::img::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 for polymorphic hierarchies
mrpt::rtti::CObject::Ptr duplicateGetSmartPtr () const
 Makes a deep copy of the object and returns a smart pointer to it. More...
 

Protected Member Functions

void writeToStreamRender (mrpt::serialization::CArchive &out) const
 
void readFromStreamRender (mrpt::serialization::CArchive &in)
 
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...
 
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...
 

Protected Attributes

float m_xmin
 
float m_ymin
 
float m_zmin
 
float m_xmax
 
float m_ymax
 
float m_zmax
 
float m_frequency
 
std::array< bool, 3 > m_marks = {false, false, false}
 draw marks for X,Y,Z More...
 
float m_textScale {0.10f}
 
float m_textRot [3][3]
 
float m_markLen {0.07f}
 
mrpt::opengl::CListOpenGLObjects m_gl_labels
 
float m_lineWidth = 1.0f
 
bool m_antiAliasing = false
 
std::vector< mrpt::math::TPoint3Dfm_vertex_buffer_data
 
std::vector< mrpt::img::TColorm_color_buffer_data
 
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...
 
bool m_outdatedBuffers = true
 
mrpt::math::TPoint3Df m_representativePoint {0, 0, 0}
 
std::shared_ptr< mrpt::opengl::CTextm_label_obj
 Optional pointer to a mrpt::opengl::CText. More...
 

RTTI stuff

using Ptr = std::shared_ptr< mrpt::opengl ::CAxis >
 
using ConstPtr = std::shared_ptr< const mrpt::opengl ::CAxis >
 
using UniquePtr = std::unique_ptr< mrpt::opengl ::CAxis >
 
using ConstUniquePtr = std::unique_ptr< const mrpt::opengl ::CAxis >
 
static const mrpt::rtti::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "mrpt::opengl" "::" "CAxis"
 
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

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

Definition at line 31 of file CAxis.h.

◆ ConstUniquePtr

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

Definition at line 31 of file CAxis.h.

◆ Ptr

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

A type for the associated smart pointer

Definition at line 31 of file CAxis.h.

◆ UniquePtr

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

Definition at line 31 of file CAxis.h.

Constructor & Destructor Documentation

◆ CAxis()

CAxis::CAxis ( float  xmin = -1.0f,
float  ymin = -1.0f,
float  zmin = -1.0f,
float  xmax = 1.0f,
float  ymax = 1.0f,
float  zmax = 1.0f,
float  frecuency = 1.f,
float  lineWidth = 3.0f,
bool  marks = true 
)

Constructor.

Definition at line 25 of file CAxis.cpp.

References mrpt::opengl::CRenderizableShaderWireFrame::setLineWidth().

Here is the call graph for this function:

◆ ~CAxis()

virtual mrpt::opengl::CAxis::~CAxis ( )
overridevirtualdefault

Member Function Documentation

◆ _GetBaseClass()

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

◆ clone()

virtual mrpt::rtti::CObject* mrpt::opengl::CAxis::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::CAxis::Create ( Args &&...  args)
inlinestatic

Definition at line 31 of file CAxis.h.

Referenced by mrpt::detectors::CFaceDetection::experimental_viewRegions().

Here is the caller graph for this function:

◆ CreateAlloc()

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

Definition at line 31 of file CAxis.h.

◆ CreateObject()

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

◆ CreateUnique()

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

Definition at line 31 of file CAxis.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 204 of file CObject.h.

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

Referenced by mrpt::obs::CRawlog::insert().

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

◆ enableAntiAliasing()

void mrpt::opengl::CRenderizableShaderWireFrame::enableAntiAliasing ( bool  enable = true)
inlineinherited

Definition at line 49 of file CRenderizableShaderWireFrame.h.

References mrpt::opengl::CRenderizableShaderWireFrame::m_antiAliasing, and mrpt::opengl::CRenderizable::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 90 of file CRenderizable.h.

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

◆ enableTickMarks() [1/2]

void CAxis::enableTickMarks ( bool  v = true)

Definition at line 237 of file CAxis.cpp.

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

Here is the call graph for this function:

◆ enableTickMarks() [2/2]

void CAxis::enableTickMarks ( bool  show_x,
bool  show_y,
bool  show_z 
)

Definition at line 242 of file CAxis.cpp.

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

Here is the call graph for this function:

◆ enqueForRenderRecursive() [1/2]

void CAxis::enqueForRenderRecursive ( const mrpt::opengl::TRenderMatrices state,
RenderQueue rq 
) const
override

Definition at line 149 of file CAxis.cpp.

References mrpt::opengl::enqueForRendering().

Here is the call graph for this function:

◆ enqueForRenderRecursive() [2/2]

virtual void mrpt::opengl::CRenderizable::enqueForRenderRecursive ( [[maybe_unused] ] const mrpt::opengl::TRenderMatrices state,
[[maybe_unused] ] RenderQueue rq 
) const
inlinevirtualinherited

Process all children objects recursively, if the object is a container.

Definition at line 285 of file CRenderizable.h.

Referenced by mrpt::opengl::enqueForRendering().

Here is the caller graph for this function:

◆ freeOpenGLResources()

void mrpt::opengl::CRenderizableShaderWireFrame::freeOpenGLResources ( )
inlineoverridevirtualinherited

Free opengl buffers.

Implements mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CVectorField3D, mrpt::opengl::CVectorField2D, mrpt::opengl::CGeneralizedEllipsoidTemplate< 2 >, mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >, and mrpt::opengl::CSetOfLines.

Definition at line 57 of file CRenderizableShaderWireFrame.h.

References mrpt::opengl::COpenGLVertexArrayObject::destroy(), mrpt::opengl::COpenGLBuffer::destroy(), mrpt::opengl::CRenderizableShaderWireFrame::m_colorBuffer, mrpt::opengl::CRenderizableShaderWireFrame::m_vao, and mrpt::opengl::CRenderizableShaderWireFrame::m_vertexBuffer.

Referenced by mrpt::opengl::CSetOfLines::freeOpenGLResources(), mrpt::opengl::CMesh3D::freeOpenGLResources(), mrpt::opengl::CPolyhedron::freeOpenGLResources(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::freeOpenGLResources(), mrpt::opengl::CVectorField2D::freeOpenGLResources(), mrpt::opengl::CBox::freeOpenGLResources(), mrpt::opengl::CMesh::freeOpenGLResources(), mrpt::opengl::CFrustum::freeOpenGLResources(), mrpt::opengl::CAssimpModel::freeOpenGLResources(), mrpt::opengl::CColorBar::freeOpenGLResources(), mrpt::opengl::CPlanarLaserScan::freeOpenGLResources(), mrpt::opengl::CVectorField3D::freeOpenGLResources(), mrpt::opengl::COctoMapVoxels::freeOpenGLResources(), and mrpt::opengl::CAngularObservationMesh::freeOpenGLResources().

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

◆ getBoundingBox()

void CAxis::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 214 of file CAxis.cpp.

References bb_max, and bb_min.

◆ getClassName()

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

Definition at line 31 of file CAxis.h.

◆ getColor()

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

Returns the object color property as a TColorf.

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

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

◆ getColorA()

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

Color components in the range [0,1].

Definition at line 164 of file CRenderizable.h.

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

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

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

◆ getColorB()

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

Color components in the range [0,1].

Definition at line 162 of file CRenderizable.h.

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

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

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

◆ getColorG()

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

Color components in the range [0,1].

Definition at line 160 of file CRenderizable.h.

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

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

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

◆ getColorR()

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

Color components in the range [0,1].

Definition at line 158 of file CRenderizable.h.

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

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

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

◆ getFrequency()

float CAxis::getFrequency ( ) const

Definition at line 236 of file CAxis.cpp.

◆ getLineWidth()

float mrpt::opengl::CRenderizableShaderWireFrame::getLineWidth ( ) const
inlineinherited

◆ getLocalRepresentativePoint()

virtual mrpt::math::TPoint3Df mrpt::opengl::CRenderizable::getLocalRepresentativePoint ( ) const
inlinevirtualinherited

Provide a representative point (in object local coordinates), used to sort objects by eye-distance while rendering with transparencies (Default=[0,0,0])

Reimplemented in mrpt::opengl::CPlanarLaserScan.

Definition at line 341 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_representativePoint.

Referenced by mrpt::opengl::enqueForRendering().

Here is the caller graph for this function:

◆ getName()

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

Returns the name of the object.

Definition at line 75 of file CRenderizable.h.

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

Referenced by mrpt::opengl::enqueForRendering().

Here is the caller graph for this function:

◆ getPose()

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

Returns the 3D pose of the object as TPose3D.

Definition at line 223 of file CRenderizable.cpp.

Referenced by mrpt::opengl::COpenGLViewport::renderNormalSceneMode().

Here is the caller graph for this function:

◆ getPosePitch()

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

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 148 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 154 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 117 of file CRenderizable.h.

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

Referenced by mrpt::opengl::enqueForRendering().

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 150 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 156 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 140 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 142 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 146 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 152 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 144 of file CRenderizable.h.

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

◆ GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::opengl::CAxis::GetRuntimeClass ( ) const
overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::opengl::CRenderizableShaderWireFrame.

◆ GetRuntimeClassIdStatic()

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

◆ getScaleX()

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

Get the current scaling factor in one axis.

Definition at line 223 of file CRenderizable.h.

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

Referenced by mrpt::opengl::enqueForRendering().

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

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

Referenced by mrpt::opengl::enqueForRendering().

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

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

Referenced by mrpt::opengl::enqueForRendering().

Here is the caller graph for this function:

◆ getTextLabelOrientation()

void CAxis::getTextLabelOrientation ( int  axis,
float &  yaw_deg,
float &  pitch_deg,
float &  roll_deg 
) const

axis: {0,1,2}=>{X,Y,Z}

Definition at line 275 of file CAxis.cpp.

References ASSERT_.

◆ getTextScale()

float CAxis::getTextScale ( ) const

Definition at line 255 of file CAxis.cpp.

◆ getTickMarksLength()

float mrpt::opengl::CAxis::getTickMarksLength ( float  len)
inline

Definition at line 69 of file CAxis.h.

References m_markLen.

◆ hasToUpdateBuffers()

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

Returns whether notifyChange() has been invoked since the last call to renderUpdateBuffers(), meaning the latter needs to be called again before rendering.

Definition at line 324 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_outdatedBuffers.

Referenced by mrpt::opengl::enqueForRendering().

Here is the caller graph for this function:

◆ initializeTextures()

virtual void mrpt::opengl::CRenderizable::initializeTextures ( ) const
inlinevirtualinherited

Initializes all textures (loads them into opengl memory).

Reimplemented in mrpt::opengl::CSetOfObjects, and mrpt::opengl::CRenderizableShaderTexturedTriangles.

Definition at line 362 of file CRenderizable.h.

◆ isAntiAliasingEnabled()

bool mrpt::opengl::CRenderizableShaderWireFrame::isAntiAliasingEnabled ( ) const
inlineinherited

◆ isShowNameEnabled()

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

Definition at line 92 of file CRenderizable.h.

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

Referenced by mrpt::opengl::enqueForRendering().

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

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

Referenced by mrpt::opengl::enqueForRendering().

Here is the caller graph for this function:

◆ labelObject()

CText & CRenderizable::labelObject ( ) const
inherited

Returns or constructs (in its first invokation) the associated mrpt::opengl::CText object representing the label of the object.

See also
enableShowName()

Definition at line 238 of file CRenderizable.cpp.

References mrpt::opengl::CText::setString().

Referenced by mrpt::opengl::enqueForRendering().

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

◆ notifyChange()

void mrpt::opengl::CRenderizable::notifyChange ( ) const
inlineinherited

Call to enable calling renderUpdateBuffers() before the next render() rendering iteration.

Definition at line 315 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_outdatedBuffers.

Referenced by mrpt::opengl::CMeshFast::adjustGridToImageAR(), mrpt::opengl::CMesh::adjustGridToImageAR(), mrpt::opengl::CVectorField2D::adjustVectorFieldToGrid(), mrpt::opengl::CSetOfLines::appendLine(), mrpt::opengl::CSetOfLines::appendLines(), mrpt::opengl::CRenderizableShaderTexturedTriangles::assignImage(), mrpt::opengl::CMeshFast::assignImage(), mrpt::opengl::CMesh::assignImage(), mrpt::opengl::CMeshFast::assignImageAndZ(), mrpt::opengl::CMesh::assignImageAndZ(), mrpt::opengl::CSetOfLines::begin(), mrpt::opengl::CSetOfLines::clear(), mrpt::opengl::CVectorField2D::clear(), mrpt::opengl::CAssimpModel::clear(), mrpt::opengl::CPlanarLaserScan::clear(), mrpt::opengl::CVectorField3D::clear(), mrpt::opengl::CPointCloud::clear(), mrpt::opengl::CPointCloudColoured::clear(), mrpt::opengl::COctoMapVoxels::clear(), mrpt::opengl::CSetOfTexturedTriangles::clearTriangles(), mrpt::opengl::CSetOfTriangles::clearTriangles(), mrpt::opengl::CRenderizableShaderWireFrame::enableAntiAliasing(), mrpt::opengl::CVectorField2D::enableAntiAliasing(), mrpt::opengl::CSetOfLines::enableAntiAliasing(), mrpt::opengl::CBox::enableBoxBorder(), mrpt::opengl::CVectorField3D::enableColorFromModule(), mrpt::opengl::CPointCloud::enableColorFromX(), mrpt::opengl::CPointCloud::enableColorFromY(), mrpt::opengl::CMeshFast::enableColorFromZ(), mrpt::opengl::CMesh::enableColorFromZ(), mrpt::opengl::CPointCloud::enableColorFromZ(), mrpt::opengl::COctoMapVoxels::enableCubeTransparency(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::enableDrawSolid3D(), mrpt::opengl::CMesh3D::enableFaceNormals(), mrpt::opengl::COctoMapVoxels::enableLights(), mrpt::opengl::CPlanarLaserScan::enableLine(), mrpt::opengl::CPlanarLaserScan::enablePoints(), mrpt::opengl::CPointCloud::enablePointSmooth(), mrpt::opengl::CMesh3D::enableShowEdges(), mrpt::opengl::CMesh3D::enableShowFaces(), mrpt::opengl::CVectorField3D::enableShowPoints(), mrpt::opengl::CMesh3D::enableShowVertices(), mrpt::opengl::CPlanarLaserScan::enableSurface(), enableTickMarks(), mrpt::opengl::CMeshFast::enableTransparency(), mrpt::opengl::CMesh::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::CPointCloud::insertPoint(), mrpt::opengl::CSetOfTexturedTriangles::insertTriangle(), mrpt::opengl::CSetOfTriangles::insertTriangle(), mrpt::opengl::CSetOfTriangles::insertTriangles(), mrpt::opengl::CPointCloud::loadFromPointsList(), mrpt::opengl::CPointCloudColoured::loadFromPointsMap(), mrpt::opengl::CPointCloud::loadFromPointsMap(), mrpt::opengl::CMesh3D::loadMesh(), mrpt::opengl::CAssimpModel::loadScene(), mrpt::opengl::CPointCloudColoured::push_back(), mrpt::opengl::COctoMapVoxels::push_back_GridCube(), mrpt::opengl::COctoMapVoxels::push_back_Voxel(), mrpt::opengl::CRenderizableShaderTexturedTriangles::readFromStreamTexturedObject(), mrpt::opengl::CSetOfTriangles::reserve(), mrpt::opengl::CSetOfLines::reserve(), mrpt::opengl::COctoMapVoxels::reserveVoxels(), mrpt::opengl::CPointCloudColoured::resize(), 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::CArrow::serializeFrom(), mrpt::opengl::CSphere::serializeFrom(), mrpt::opengl::CGridPlaneXY::serializeFrom(), serializeFrom(), mrpt::opengl::CGridPlaneXZ::serializeFrom(), mrpt::opengl::CDisk::serializeFrom(), mrpt::opengl::CSetOfLines::serializeFrom(), mrpt::opengl::CColorBar::serializeFrom(), mrpt::opengl::CVectorField2D::serializeFrom(), mrpt::opengl::CMeshFast::serializeFrom(), mrpt::opengl::CMesh::serializeFrom(), mrpt::opengl::CVectorField3D::serializeFrom(), mrpt::opengl::CBox::serializeFrom(), mrpt::opengl::CText3D::serializeFrom(), mrpt::opengl::CAssimpModel::serializeFrom(), mrpt::opengl::CPolyhedron::serializeFrom(), mrpt::opengl::CPointCloudColoured::serializeFrom(), mrpt::opengl::CFrustum::serializeFrom(), mrpt::opengl::COctoMapVoxels::serializeFrom(), mrpt::opengl::CPointCloud::setAllPoints(), mrpt::opengl::CPointCloud::setAllPointsFast(), mrpt::opengl::CArrow::setArrowEnds(), setAxisLimits(), mrpt::opengl::CBox::setBoxBorderColor(), mrpt::opengl::CBox::setBoxCorners(), mrpt::opengl::CSetOfTriangles::setColor_u8(), mrpt::opengl::CSetOfTriangles::setColorA_u8(), mrpt::opengl::CColorBar::setColorAndValueLimits(), mrpt::opengl::CSetOfTriangles::setColorB_u8(), mrpt::opengl::CSetOfTriangles::setColorG_u8(), mrpt::opengl::CColorBar::setColormap(), mrpt::opengl::CSetOfTriangles::setColorR_u8(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::setCovMatrixAndMean(), mrpt::opengl::CDisk::setDiskRadius(), mrpt::opengl::CText::setFont(), mrpt::opengl::CText3D::setFont(), setFrequency(), 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::CRenderizableShaderWireFrame::setLineWidth(), mrpt::opengl::CBox::setLineWidth(), mrpt::opengl::CMesh::setMask(), mrpt::opengl::CVectorField3D::setMaxSpeedForColor(), mrpt::opengl::CVectorField3D::setMotionFieldColormap(), mrpt::opengl::CFrustum::setNearFarPlanes(), mrpt::opengl::CSphere::setNumberDivsLatitude(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::setNumberOfSegments(), mrpt::opengl::CFrustum::setPlaneColor(), mrpt::opengl::CTexturedPlane::setPlaneCorners(), mrpt::opengl::CGridPlaneXZ::setPlaneLimits(), mrpt::opengl::CGridPlaneXY::setPlaneLimits(), mrpt::opengl::CGridPlaneXZ::setPlaneYcoord(), mrpt::opengl::CGridPlaneXY::setPlaneZcoord(), mrpt::opengl::CPointCloudColoured::setPoint(), mrpt::opengl::CPointCloud::setPoint(), mrpt::opengl::CVectorField2D::setPointColor(), mrpt::opengl::CVectorField3D::setPointColor(), mrpt::opengl::CVectorField3D::setPointCoordinates(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::setQuantiles(), mrpt::opengl::CCylinder::setRadii(), mrpt::opengl::CSphere::setRadius(), mrpt::opengl::CCylinder::setRadius(), mrpt::opengl::CPlanarLaserScan::setScan(), mrpt::opengl::CDisk::setSlicesCount(), mrpt::opengl::CArrow::setSlicesCount(), mrpt::opengl::CCylinder::setSlicesCount(), mrpt::opengl::CArrow::setSmallRadius(), mrpt::opengl::CText::setString(), mrpt::opengl::CText3D::setString(), mrpt::opengl::CText3D::setTextKerning(), setTextScale(), mrpt::opengl::CText3D::setTextSpacing(), mrpt::opengl::CText3D::setTextStyle(), setTickMarksLength(), 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::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::CMeshFast::updateColorsMatrix(), mrpt::opengl::CMesh::updateColorsMatrix(), mrpt::opengl::CMeshFast::updatePoints(), mrpt::opengl::CSetOfTriangles::updatePolygons(), mrpt::opengl::CMesh::updatePolygons(), and mrpt::opengl::CMesh::updateTriangles().

◆ onUpdateBuffers_Wireframe()

void CAxis::onUpdateBuffers_Wireframe ( )
overridevirtual

Must be implemented in derived classes to update the geometric entities to be drawn in "m_*_buffer" fields.

Implements mrpt::opengl::CRenderizableShaderWireFrame.

Definition at line 60 of file CAxis.cpp.

References mrpt::opengl::CText3D::Create(), mrpt::DEG2RAD(), mrpt::opengl::FILL, mrpt::opengl::internal::glSetFont(), mrpt::opengl::CRenderizableShaderWireFrame::m_color_buffer_data, mrpt::opengl::CRenderizableShaderWireFrame::m_vertex_buffer_data, and mrpt::system::os::sprintf().

Here is the call graph for this function:

◆ readFromStreamRender()

void CRenderizable::readFromStreamRender ( mrpt::serialization::CArchive in)
protectedinherited

Definition at line 99 of file CRenderizable.cpp.

References mrpt::obs::gnss::pitch, mrpt::serialization::CArchive::ReadBuffer(), mrpt::obs::gnss::roll, THROW_EXCEPTION, and THROW_EXCEPTION_FMT.

Referenced by mrpt::opengl::CGridPlaneXY::serializeFrom(), mrpt::opengl::CGridPlaneXZ::serializeFrom(), mrpt::opengl::CSetOfLines::serializeFrom(), mrpt::opengl::CVectorField3D::serializeFrom(), mrpt::opengl::CPolyhedron::serializeFrom(), and mrpt::opengl::CFrustum::serializeFrom().

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

◆ render()

void CAxis::render ( const RenderContext rc) const
overridevirtual

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

This can be called more than once (one per required shader program) if the object registered several shaders.

See also
renderUpdateBuffers

Implements mrpt::opengl::CRenderizable.

Definition at line 156 of file CAxis.cpp.

References mrpt::opengl::CRenderizableShaderWireFrame::render().

Here is the call graph for this function:

◆ renderUpdateBuffers()

void mrpt::opengl::CRenderizableShaderWireFrame::renderUpdateBuffers ( ) const
overridevirtualinherited

◆ requiredShaders()

virtual shader_list_t mrpt::opengl::CRenderizableShaderWireFrame::requiredShaders ( ) const
inlineoverridevirtualinherited

◆ serializeFrom() [1/2]

void CAxis::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 180 of file CAxis.cpp.

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

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 CAxis::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 165 of file CAxis.cpp.

◆ serializeTo() [1/2]

void CAxis::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 166 of file CAxis.cpp.

References out.

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

◆ setAxisLimits()

void CAxis::setAxisLimits ( float  xmin,
float  ymin,
float  zmin,
float  xmax,
float  ymax,
float  zmax 
)

Definition at line 256 of file CAxis.cpp.

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

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

References mrpt::img::TColorf::A, mrpt::img::TColorf::B, mrpt::f2u8(), mrpt::img::TColorf::G, mrpt::img::TColorf::R, and mrpt::opengl::CRenderizable::setColor_u8().

Here is the call graph for this function:

◆ setColor() [2/2]

CRenderizable& mrpt::opengl::CRenderizable::setColor ( float  R,
float  G,
float  B,
float  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 242 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ setColor_u8() [1/2]

CRenderizable & CRenderizable::setColor_u8 ( const mrpt::img::TColor c)
virtualinherited

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

Definition at line 229 of file CRenderizable.cpp.

References mrpt::img::TColor::A, mrpt::img::TColor::B, mrpt::img::TColor::G, and mrpt::img::TColor::R.

Referenced by mrpt::opengl::CRenderizable::setColor(), and mrpt::opengl::CRenderizable::setColor_u8().

Here is the caller graph for this function:

◆ setColor_u8() [2/2]

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

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

Returns
a ref to this

Definition at line 254 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ setColorA()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 180 of file CRenderizable.h.

References mrpt::f2u8(), and mrpt::opengl::CRenderizable::setColorA_u8().

Here is the call graph for this function:

◆ setColorA_u8()

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

Color components in the range [0,255].

Returns
a ref to this

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

Definition at line 200 of file CRenderizable.h.

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

Referenced by mrpt::nav::ClearanceDiagram::renderAs3DObject(), mrpt::opengl::CRenderizable::setColorA(), and mrpt::opengl::CSetOfObjects::setColorA_u8().

Here is the caller graph for this function:

◆ setColorB()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 178 of file CRenderizable.h.

References mrpt::f2u8(), and mrpt::opengl::CRenderizable::setColorB_u8().

Here is the call graph for this function:

◆ setColorB_u8()

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

Color components in the range [0,255].

Returns
a ref to this

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

Definition at line 194 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ setColorG()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 176 of file CRenderizable.h.

References mrpt::f2u8(), and mrpt::opengl::CRenderizable::setColorG_u8().

Here is the call graph for this function:

◆ setColorG_u8()

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

Color components in the range [0,255].

Returns
a ref to this

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

Definition at line 188 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ setColorR()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 174 of file CRenderizable.h.

References mrpt::f2u8(), and mrpt::opengl::CRenderizable::setColorR_u8().

Here is the call graph for this function:

◆ setColorR_u8()

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

Color components in the range [0,255].

Returns
a ref to this

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

Definition at line 182 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ setFrequency()

void CAxis::setFrequency ( float  f)

Changes the frequency of the "ticks".

Definition at line 230 of file CAxis.cpp.

References ASSERT_, and mrpt::opengl::CRenderizable::notifyChange().

Here is the call graph for this function:

◆ setLineWidth()

void mrpt::opengl::CRenderizableShaderWireFrame::setLineWidth ( float  w)
inlineinherited

Definition at line 43 of file CRenderizableShaderWireFrame.h.

References mrpt::opengl::CRenderizableShaderWireFrame::m_lineWidth, and mrpt::opengl::CRenderizable::notifyChange().

Referenced by CAxis(), mrpt::opengl::CBox::CBox(), mrpt::opengl::CFrustum::CFrustum(), and mrpt::opengl::COctoMapVoxels::onUpdateBuffers_Wireframe().

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

◆ setLocalRepresentativePoint()

void mrpt::opengl::CRenderizable::setLocalRepresentativePoint ( const mrpt::math::TPoint3Df p)
inlineinherited

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

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

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

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

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

◆ setPose() [1/6]

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

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

Definition at line 189 of file CRenderizable.cpp.

Referenced by mrpt::opengl::COpenGLViewport::setCurrentCameraFromPose().

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

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

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

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

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

References 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 208 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 215 of file CRenderizable.h.

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

◆ setTextLabelOrientation()

void CAxis::setTextLabelOrientation ( int  axis,
float  yaw_deg,
float  pitch_deg,
float  roll_deg 
)

axis: {0,1,2}=>{X,Y,Z}

Definition at line 267 of file CAxis.cpp.

References ASSERT_.

◆ setTextScale()

void CAxis::setTextScale ( float  f)

Changes the size of text labels (default:0.25)

Definition at line 249 of file CAxis.cpp.

References ASSERT_, and mrpt::opengl::CRenderizable::notifyChange().

Here is the call graph for this function:

◆ setTickMarksLength()

void CAxis::setTickMarksLength ( float  len)

As a ratio of "marks frequency" (default: 0.05)

Definition at line 54 of file CAxis.cpp.

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

Here is the call graph for this function:

◆ setVisibility()

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

Set object visibility (default=true)

See also
isVisible

Definition at line 81 of file CRenderizable.h.

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

◆ traceRay()

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

Simulation of ray-trace, given a pose.

Returns true if the ray effectively collisions with the object (returning the distance to the origin of the ray in "dist"), or false in other case. "dist" variable yields undefined behaviour when false is returned

Reimplemented in mrpt::opengl::CPolyhedron, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CMesh, mrpt::opengl::CSetOfObjects, mrpt::opengl::CFrustum, mrpt::opengl::CSetOfTriangles, mrpt::opengl::CAssimpModel, mrpt::opengl::CBox, mrpt::opengl::CTexturedPlane, mrpt::opengl::CDisk, mrpt::opengl::CSetOfTexturedTriangles, mrpt::opengl::CEllipsoid2D, mrpt::opengl::CSphere, mrpt::opengl::CEllipsoid3D, and mrpt::opengl::CCylinder.

Definition at line 224 of file CRenderizable.cpp.

◆ updateBuffers()

void mrpt::opengl::CRenderizable::updateBuffers ( ) const
inlineinherited

Calls renderUpdateBuffers() and clear the flag that is set with notifyChange()

Definition at line 307 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_outdatedBuffers, and mrpt::opengl::CRenderizable::renderUpdateBuffers().

Referenced by mrpt::opengl::enqueForRendering().

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

◆ writeToMatlab()

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

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

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

Definition at line 90 of file CSerializable.h.

◆ writeToStreamRender()

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

Definition at line 44 of file CRenderizable.cpp.

References out.

Referenced by mrpt::opengl::CGridPlaneXY::serializeTo(), mrpt::opengl::CGridPlaneXZ::serializeTo(), mrpt::opengl::CSetOfLines::serializeTo(), mrpt::opengl::CVectorField3D::serializeTo(), mrpt::opengl::CPolyhedron::serializeTo(), and mrpt::opengl::CFrustum::serializeTo().

Here is the caller graph for this function:

Member Data Documentation

◆ className

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

Definition at line 31 of file CAxis.h.

◆ m_antiAliasing

bool mrpt::opengl::CRenderizableShaderWireFrame::m_antiAliasing = false
protectedinherited

◆ m_color

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

◆ m_color_buffer_data

std::vector<mrpt::img::TColor> mrpt::opengl::CRenderizableShaderWireFrame::m_color_buffer_data
mutableprotectedinherited

◆ m_frequency

float mrpt::opengl::CAxis::m_frequency
protected

Definition at line 78 of file CAxis.h.

◆ m_gl_labels

mrpt::opengl::CListOpenGLObjects mrpt::opengl::CAxis::m_gl_labels
protected

Definition at line 85 of file CAxis.h.

◆ m_label_obj

std::shared_ptr<mrpt::opengl::CText> mrpt::opengl::CRenderizable::m_label_obj
mutableprotectedinherited

Optional pointer to a mrpt::opengl::CText.

Definition at line 372 of file CRenderizable.h.

◆ m_lineWidth

float mrpt::opengl::CRenderizableShaderWireFrame::m_lineWidth = 1.0f
protectedinherited

◆ m_markLen

float mrpt::opengl::CAxis::m_markLen {0.07f}
protected

Definition at line 83 of file CAxis.h.

Referenced by getTickMarksLength().

◆ m_marks

std::array<bool, 3> mrpt::opengl::CAxis::m_marks = {false, false, false}
protected

draw marks for X,Y,Z

Definition at line 80 of file CAxis.h.

◆ m_name

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

◆ m_outdatedBuffers

bool mrpt::opengl::CRenderizable::m_outdatedBuffers = true
protectedinherited

◆ m_pose

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

◆ m_representativePoint

mrpt::math::TPoint3Df mrpt::opengl::CRenderizable::m_representativePoint {0, 0, 0}
protectedinherited

◆ m_scale_x

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

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

Definition at line 64 of file CRenderizable.h.

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

◆ m_scale_y

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

◆ m_scale_z

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

◆ m_show_name

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

◆ m_textRot

float mrpt::opengl::CAxis::m_textRot[3][3]
protected

Definition at line 82 of file CAxis.h.

◆ m_textScale

float mrpt::opengl::CAxis::m_textScale {0.10f}
protected

Definition at line 81 of file CAxis.h.

◆ m_vertex_buffer_data

std::vector<mrpt::math::TPoint3Df> mrpt::opengl::CRenderizableShaderWireFrame::m_vertex_buffer_data
mutableprotectedinherited

◆ m_visible

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

Is the object visible? (default=true)

Definition at line 66 of file CRenderizable.h.

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

◆ m_xmax

float mrpt::opengl::CAxis::m_xmax
protected

Definition at line 77 of file CAxis.h.

◆ m_xmin

float mrpt::opengl::CAxis::m_xmin
protected

Definition at line 76 of file CAxis.h.

◆ m_ymax

float mrpt::opengl::CAxis::m_ymax
protected

Definition at line 77 of file CAxis.h.

◆ m_ymin

float mrpt::opengl::CAxis::m_ymin
protected

Definition at line 76 of file CAxis.h.

◆ m_zmax

float mrpt::opengl::CAxis::m_zmax
protected

Definition at line 77 of file CAxis.h.

◆ m_zmin

float mrpt::opengl::CAxis::m_zmin
protected

Definition at line 76 of file CAxis.h.

◆ runtimeClassId

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

Definition at line 31 of file CAxis.h.




Page generated by Doxygen 1.8.14 for MRPT 2.0.2 Git: 9b4fd2465 Mon May 4 16:59:08 2020 +0200 at lun may 4 17:26:07 CEST 2020