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

Detailed Description

A 2D plane in the XY plane with a texture image.

See also
opengl::COpenGLScene

Definition at line 20 of file CTexturedPlane.h.

#include <mrpt/opengl/CTexturedPlane.h>

Inheritance diagram for mrpt::opengl::CTexturedPlane:

Public Member Functions

 CTexturedPlane (float x_min=-1, float x_max=1, float y_min=-1, float y_max=1)
 
virtual ~CTexturedPlane () override=default
 
void setPlaneCorners (float xMin, float xMax, float yMin, float yMax)
 Set the coordinates of the four corners that define the plane on the XY plane. More...
 
void getPlaneCorners (float &xMin, float &xMax, float &yMin, float &yMax) const
 Get the coordinates of the four corners that define the plane on the XY plane. More...
 
bool traceRay (const mrpt::poses::CPose3D &o, double &dist) const override
 Simulation of ray-trace, given a pose. More...
 
void getBoundingBox (mrpt::math::TPoint3D &bb_min, mrpt::math::TPoint3D &bb_max) const override
 Evaluates the bounding box of this object (including possible children) in the coordinate frame of the object parent. More...
 
virtual shader_list_t requiredShaders () const override
 Returns the ID of the OpenGL shader program required to render this class. More...
 
void render (const RenderContext &rc) const override
 Implements the rendering of 3D objects in each class derived from CRenderizable. More...
 
void renderUpdateBuffers () const override
 Called whenever m_outdatedBuffers is true: used to re-generate OpenGL vertex buffers, etc. More...
 
void freeOpenGLResources () override
 Free opengl buffers. More...
 
void assignImage (const mrpt::img::CImage &img, const mrpt::img::CImage &imgAlpha)
 Assigns a texture and a transparency image, and enables transparency (If the images are not 2^N x 2^M, they will be internally filled to its dimensions to be powers of two) More...
 
void assignImage (const mrpt::img::CImage &img)
 Assigns a texture image, and disable transparency. More...
 
void assignImage (mrpt::img::CImage &&img, mrpt::img::CImage &&imgAlpha)
 Similar to assignImage, but the passed images are moved in (move semantic). More...
 
void assignImage (mrpt::img::CImage &&img)
 Similar to assignImage, but with move semantics. More...
 
bool isLightEnabled () const
 
void enableLight (bool enable=true)
 
virtual void initializeTextures () const override
 VERY IMPORTANT: If you use a multi-thread application, you MUST call this from the same thread that will later destruct the object in order to the OpenGL texture memory to be correctly deleted. More...
 
const mrpt::img::CImagegetTextureImage () const
 
const mrpt::img::CImagegetTextureAlphaImage () const
 
void enableTextureLinearInterpolation (bool enable)
 Enable linear interpolation of textures (default=false, use nearest pixel) 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 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 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
virtual void onUpdateBuffers_TexturedTriangles () override
 Must be implemented in derived classes to update the geometric entities to be drawn in "m_*_buffer" fields. More...
 
Changes the appearance of the object to render
void setName (const std::string &n)
 Changes the name of the object. More...
 
const std::string & getName () const
 Returns the name of the object. More...
 
bool isVisible () const
 Is the object visible? More...
 
void setVisibility (bool visible=true)
 Set object visibility (default=true) More...
 
void enableShowName (bool showName=true)
 Enables or disables showing the name of the object as a label when rendering. More...
 
bool isShowNameEnabled () const
 
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 updatePoly () const
 
void unloadTexture ()
 
void writeToStreamTexturedObject (mrpt::serialization::CArchive &out) const
 
void readFromStreamTexturedObject (mrpt::serialization::CArchive &in)
 
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 = -1.0f
 
float m_xMax = 1.0f
 
float m_yMin = -1.0f
 
float m_yMax = 1.0f
 
bool polygonUpToDate {false}
 
std::vector< mrpt::math::TPolygonWithPlanetmpPoly
 Used for ray-tracing. More...
 
std::vector< mrpt::opengl::TTrianglem_triangles
 List of triangles. More...
 
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 ::CTexturedPlane >
 
using ConstPtr = std::shared_ptr< const mrpt::opengl ::CTexturedPlane >
 
using UniquePtr = std::unique_ptr< mrpt::opengl ::CTexturedPlane >
 
using ConstUniquePtr = std::unique_ptr< const mrpt::opengl ::CTexturedPlane >
 
static const mrpt::rtti::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "mrpt::opengl" "::" "CTexturedPlane"
 
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

Definition at line 22 of file CTexturedPlane.h.

◆ ConstUniquePtr

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

Definition at line 22 of file CTexturedPlane.h.

◆ Ptr

A type for the associated smart pointer

Definition at line 22 of file CTexturedPlane.h.

◆ UniquePtr

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

Definition at line 22 of file CTexturedPlane.h.

Constructor & Destructor Documentation

◆ CTexturedPlane()

CTexturedPlane::CTexturedPlane ( float  x_min = -1,
float  x_max = 1,
float  y_min = -1,
float  y_max = 1 
)

Definition at line 24 of file CTexturedPlane.cpp.

◆ ~CTexturedPlane()

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

Member Function Documentation

◆ _GetBaseClass()

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

◆ assignImage() [1/4]

void CRenderizableShaderTexturedTriangles::assignImage ( const mrpt::img::CImage img,
const mrpt::img::CImage imgAlpha 
)
inherited

Assigns a texture and a transparency image, and enables transparency (If the images are not 2^N x 2^M, they will be internally filled to its dimensions to be powers of two)

Note
Images are copied, the original ones can be deleted.

Definition at line 168 of file CRenderizableShaderTexturedTriangles.cpp.

References MRPT_END, MRPT_START, and mrpt::opengl::CRenderizable::notifyChange().

Referenced by mrpt::opengl::CMesh::assignImage(), and mrpt::opengl::CMesh::assignImageAndZ().

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

◆ assignImage() [2/4]

void CRenderizableShaderTexturedTriangles::assignImage ( const mrpt::img::CImage img)
inherited

Assigns a texture image, and disable transparency.

Note
Images are copied, the original ones can be deleted.

Definition at line 186 of file CRenderizableShaderTexturedTriangles.cpp.

References MRPT_END, MRPT_START, and mrpt::opengl::CRenderizable::notifyChange().

Here is the call graph for this function:

◆ assignImage() [3/4]

void CRenderizableShaderTexturedTriangles::assignImage ( mrpt::img::CImage &&  img,
mrpt::img::CImage &&  imgAlpha 
)
inherited

Similar to assignImage, but the passed images are moved in (move semantic).

Definition at line 202 of file CRenderizableShaderTexturedTriangles.cpp.

References MRPT_END, MRPT_START, and mrpt::opengl::CRenderizable::notifyChange().

Here is the call graph for this function:

◆ assignImage() [4/4]

void CRenderizableShaderTexturedTriangles::assignImage ( mrpt::img::CImage &&  img)
inherited

Similar to assignImage, but with move semantics.

Definition at line 219 of file CRenderizableShaderTexturedTriangles.cpp.

References MRPT_END, MRPT_START, and mrpt::opengl::CRenderizable::notifyChange().

Here is the call graph for this function:

◆ clone()

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

Definition at line 22 of file CTexturedPlane.h.

Referenced by mrpt::maps::COccupancyGridMap2D::getAs3DObject(), and mrpt::opengl::COpenGLViewport::internal_enableImageView().

Here is the caller graph for this function:

◆ CreateAlloc()

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

Definition at line 22 of file CTexturedPlane.h.

◆ CreateObject()

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

◆ CreateUnique()

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

Definition at line 22 of file CTexturedPlane.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:

◆ enableLight()

void mrpt::opengl::CRenderizableShaderTexturedTriangles::enableLight ( bool  enable = true)
inlineinherited

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

◆ enableTextureLinearInterpolation()

void mrpt::opengl::CRenderizableShaderTexturedTriangles::enableTextureLinearInterpolation ( bool  enable)
inlineinherited

Enable linear interpolation of textures (default=false, use nearest pixel)

Definition at line 91 of file CRenderizableShaderTexturedTriangles.h.

References mrpt::opengl::CRenderizableShaderTexturedTriangles::m_textureInterpolate.

◆ enqueForRenderRecursive()

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::CRenderizableShaderTexturedTriangles::freeOpenGLResources ( )
inlineoverridevirtualinherited

Free opengl buffers.

Implements mrpt::opengl::CRenderizable.

Definition at line 45 of file CRenderizableShaderTexturedTriangles.h.

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

Referenced by mrpt::opengl::CMesh::freeOpenGLResources().

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

◆ getBoundingBox()

void CTexturedPlane::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 124 of file CTexturedPlane.cpp.

References bb_max, and bb_min.

◆ getClassName()

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

Definition at line 22 of file CTexturedPlane.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.

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

◆ getPlaneCorners()

void mrpt::opengl::CTexturedPlane::getPlaneCorners ( float &  xMin,
float &  xMax,
float &  yMin,
float &  yMax 
) const
inline

Get the coordinates of the four corners that define the plane on the XY plane.

Definition at line 58 of file CTexturedPlane.h.

References m_xMax, m_xMin, m_yMax, and m_yMin.

◆ 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::CTexturedPlane::GetRuntimeClass ( ) const
overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::opengl::CRenderizableShaderTexturedTriangles.

◆ GetRuntimeClassIdStatic()

static const mrpt::rtti::TRuntimeClassId& mrpt::opengl::CTexturedPlane::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:

◆ getTextureAlphaImage()

const mrpt::img::CImage& mrpt::opengl::CRenderizableShaderTexturedTriangles::getTextureAlphaImage ( ) const
inlineinherited

◆ getTextureImage()

const mrpt::img::CImage& mrpt::opengl::CRenderizableShaderTexturedTriangles::getTextureImage ( ) const
inlineinherited

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

void CRenderizableShaderTexturedTriangles::initializeTextures ( ) const
overridevirtualinherited

VERY IMPORTANT: If you use a multi-thread application, you MUST call this from the same thread that will later destruct the object in order to the OpenGL texture memory to be correctly deleted.

Calling this method more than once has no effects. If you use one thread, this method will be automatically called when rendering, so there is no need to explicitly call it.

Reimplemented from mrpt::opengl::CRenderizable.

Definition at line 263 of file CRenderizableShaderTexturedTriangles.cpp.

References ASSERT_, ASSERT_EQUAL_, mrpt::img::D8U, mrpt::opengl::internal::data, mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::dump_to_pool(), mrpt::system::CTimeLogger::enter(), mrpt::format(), mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::getInstance(), mrpt::img::IMG_INTERP_LINEAR, mrpt::system::CTimeLogger::leave(), reserveDataBuffer(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ isLightEnabled()

bool mrpt::opengl::CRenderizableShaderTexturedTriangles::isLightEnabled ( ) 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(), mrpt::opengl::CAxis::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(), serializeFrom(), mrpt::opengl::CSetOfTriangles::serializeFrom(), mrpt::opengl::CArrow::serializeFrom(), mrpt::opengl::CSphere::serializeFrom(), mrpt::opengl::CGridPlaneXY::serializeFrom(), mrpt::opengl::CAxis::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(), mrpt::opengl::CAxis::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(), mrpt::opengl::CAxis::setFrequency(), mrpt::opengl::CVectorField2D::setGridCenterAndCellSize(), mrpt::opengl::CGridPlaneXY::setGridFrequency(), mrpt::opengl::CGridPlaneXZ::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(), setPlaneCorners(), mrpt::opengl::CGridPlaneXY::setPlaneLimits(), mrpt::opengl::CGridPlaneXZ::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(), mrpt::opengl::CAxis::setTextScale(), mrpt::opengl::CText3D::setTextSpacing(), mrpt::opengl::CText3D::setTextStyle(), mrpt::opengl::CAxis::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_TexturedTriangles()

void CTexturedPlane::onUpdateBuffers_TexturedTriangles ( )
overridevirtual

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

Implements mrpt::opengl::CRenderizableShaderTexturedTriangles.

Definition at line 34 of file CTexturedPlane.cpp.

References mrpt::opengl::CRenderizableShaderTexturedTriangles::m_triangles, MRPT_END, MRPT_START, and mrpt::opengl::TTriangle::vertices.

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

◆ readFromStreamTexturedObject()

void CRenderizableShaderTexturedTriangles::readFromStreamTexturedObject ( mrpt::serialization::CArchive in)
protectedinherited

Definition at line 523 of file CRenderizableShaderTexturedTriangles.cpp.

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

Here is the call graph for this function:

◆ render()

void mrpt::opengl::CRenderizableShaderTexturedTriangles::render ( const RenderContext rc) const
overridevirtualinherited

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.

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

Here is the caller graph for this function:

◆ renderUpdateBuffers()

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

Called whenever m_outdatedBuffers is true: used to re-generate OpenGL vertex buffers, etc.

before they are sent for rendering in render()

Implements mrpt::opengl::CRenderizable.

Referenced by mrpt::opengl::CMesh::renderUpdateBuffers().

Here is the caller graph for this function:

◆ requiredShaders()

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

Returns the ID of the OpenGL shader program required to render this class.

See also
DefaultShaderID

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CMesh.

Definition at line 33 of file CRenderizableShaderTexturedTriangles.h.

References mrpt::opengl::DefaultShaderID::TEXTURED_TRIANGLES.

◆ serializeFrom() [1/2]

void CTexturedPlane::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 82 of file CTexturedPlane.cpp.

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

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

◆ serializeTo() [1/2]

void CTexturedPlane::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 72 of file CTexturedPlane.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:

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

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

◆ setPlaneCorners()

void mrpt::opengl::CTexturedPlane::setPlaneCorners ( float  xMin,
float  xMax,
float  yMin,
float  yMax 
)
inline

Set the coordinates of the four corners that define the plane on the XY plane.

Definition at line 46 of file CTexturedPlane.h.

References m_xMax, m_xMin, m_yMax, m_yMin, mrpt::opengl::CRenderizable::notifyChange(), and polygonUpToDate.

Here is the call graph for this function:

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

◆ 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 CTexturedPlane::traceRay ( const mrpt::poses::CPose3D o,
double &  dist 
) const
overridevirtual

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 from mrpt::opengl::CRenderizable.

Definition at line 105 of file CTexturedPlane.cpp.

References tmpPoly, and mrpt::math::traceRay().

Here is the call graph for this function:

◆ unloadTexture()

void mrpt::opengl::CTexturedPlane::unloadTexture ( )
protected

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

◆ updatePoly()

void CTexturedPlane::updatePoly ( ) const
protected

Definition at line 111 of file CTexturedPlane.cpp.

References tmpPoly.

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

◆ writeToStreamTexturedObject()

void CRenderizableShaderTexturedTriangles::writeToStreamTexturedObject ( mrpt::serialization::CArchive out) const
protectedinherited

Definition at line 512 of file CRenderizableShaderTexturedTriangles.cpp.

References out.

Member Data Documentation

◆ className

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

Definition at line 22 of file CTexturedPlane.h.

◆ m_color

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

◆ 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_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_triangles

std::vector<mrpt::opengl::TTriangle> mrpt::opengl::CRenderizableShaderTexturedTriangles::m_triangles
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::CTexturedPlane::m_xMax = 1.0f
protected

Definition at line 25 of file CTexturedPlane.h.

Referenced by getPlaneCorners(), and setPlaneCorners().

◆ m_xMin

float mrpt::opengl::CTexturedPlane::m_xMin = -1.0f
protected

Definition at line 25 of file CTexturedPlane.h.

Referenced by getPlaneCorners(), and setPlaneCorners().

◆ m_yMax

float mrpt::opengl::CTexturedPlane::m_yMax = 1.0f
protected

Definition at line 26 of file CTexturedPlane.h.

Referenced by getPlaneCorners(), and setPlaneCorners().

◆ m_yMin

float mrpt::opengl::CTexturedPlane::m_yMin = -1.0f
protected

Definition at line 26 of file CTexturedPlane.h.

Referenced by getPlaneCorners(), and setPlaneCorners().

◆ polygonUpToDate

bool mrpt::opengl::CTexturedPlane::polygonUpToDate {false}
mutableprotected

Definition at line 28 of file CTexturedPlane.h.

Referenced by setPlaneCorners().

◆ runtimeClassId

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

Definition at line 22 of file CTexturedPlane.h.

◆ tmpPoly

std::vector<mrpt::math::TPolygonWithPlane> mrpt::opengl::CTexturedPlane::tmpPoly
mutableprotected

Used for ray-tracing.

Definition at line 30 of file CTexturedPlane.h.




Page generated by Doxygen 1.8.14 for MRPT 2.0.1 Git: 0fef1a6d7 Fri Apr 3 23:00:21 2020 +0200 at vie abr 3 23:20:28 CEST 2020