MRPT  2.0.3
List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
mrpt::opengl::CSetOfObjects Class Reference

Detailed Description

A set of object, which are referenced to the coordinates framework established in this object.

It can be established a hierarchy of "CSetOfObjects", where the coordinates framework of each one will be referenced to the parent's one. The list of child objects is accessed directly as in the class "COpenGLScene"

See also
opengl::COpenGLScene

Definition at line 26 of file CSetOfObjects.h.

#include <mrpt/opengl/CSetOfObjects.h>

Inheritance diagram for mrpt::opengl::CSetOfObjects:

Public Types

using const_iterator = CListOpenGLObjects::const_iterator
 
using iterator = CListOpenGLObjects::iterator
 

Public Member Functions

 CSetOfObjects ()=default
 
virtual ~CSetOfObjects () override=default
 
const_iterator begin () const
 
const_iterator end () const
 
iterator begin ()
 
iterator end ()
 
template<class T >
void insertCollection (const T &objs)
 Inserts a set of objects into the list. More...
 
void insert (const CRenderizable::Ptr &newObject)
 Insert a new object to the list. More...
 
template<class T_it >
void insert (const T_it &begin, const T_it &end)
 Inserts a set of objects, bounded by iterators, into the list. More...
 
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 enqueForRenderRecursive (const mrpt::opengl::TRenderMatrices &state, RenderQueue &rq) const override
 
void freeOpenGLResources () override
 Free opengl buffers. More...
 
void initializeTextures () const override
 Initializes all textures (loads them into opengl memory). More...
 
void clear ()
 Clear the list of objects in the scene, deleting objects' memory. More...
 
size_t size ()
 Returns number of objects. More...
 
bool empty () const
 Returns true if there are no objects. More...
 
CRenderizable::Ptr getByName (const std::string &str)
 Returns the first object with a given name, or a nullptr pointer if not found. More...
 
template<typename T >
T::Ptr getByClass (size_t ith=0) const
 Returns the i'th object of a given class (or of a descendant class), or nullptr (an empty smart pointer) if not found. More...
 
void removeObject (const CRenderizable::Ptr &obj)
 Removes the given object from the scene (it also deletes the object to free its memory). More...
 
void dumpListOfObjects (std::vector< std::string > &lst)
 Retrieves a list of all objects in text form
More...
 
bool traceRay (const mrpt::poses::CPose3D &o, double &dist) const override
 Simulation of ray-trace, given a pose. More...
 
CRenderizablesetColor_u8 (const mrpt::img::TColor &c) override
 
CRenderizablesetColorR_u8 (const uint8_t r) override
 Color components in the range [0,255]. More...
 
CRenderizablesetColorG_u8 (const uint8_t g) override
 Color components in the range [0,255]. More...
 
CRenderizablesetColorB_u8 (const uint8_t b) override
 Color components in the range [0,255]. More...
 
CRenderizablesetColorA_u8 (const uint8_t a) override
 Color components in the range [0,255]. More...
 
bool contains (const CRenderizable::Ptr &obj) const
 
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 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...
 

Static Public Member Functions

pose_pdf -> 3d objects auxiliary templates
static CSetOfObjects::Ptr posePDF2opengl (const mrpt::poses::CPosePDF &o)
 Returns a representation of a the PDF - this is just an auxiliary function, it's more natural to call mrpt::poses::CPosePDF::getAs3DObject
More...
 
static CSetOfObjects::Ptr posePDF2opengl (const mrpt::poses::CPointPDF &o)
 Returns a representation of a the PDF - this is just an auxiliary function, it's more natural to call mrpt::poses::CPointPDF::getAs3DObject
More...
 
static CSetOfObjects::Ptr posePDF2opengl (const mrpt::poses::CPose3DPDF &o)
 Returns a representation of a the PDF - this is just an auxiliary function, it's more natural to call mrpt::poses::CPose3DPDF::getAs3DObject
More...
 
static CSetOfObjects::Ptr posePDF2opengl (const mrpt::poses::CPose3DQuatPDF &o)
 Returns a representation of a the PDF - this is just an auxiliary function, it's more natural to call mrpt::poses::CPose3DQuatPDF::getAs3DObject
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...
 

Protected Attributes

CListOpenGLObjects m_objects
 The list of child objects. 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 ::CSetOfObjects >
 
using ConstPtr = std::shared_ptr< const mrpt::opengl ::CSetOfObjects >
 
using UniquePtr = std::unique_ptr< mrpt::opengl ::CSetOfObjects >
 
using ConstUniquePtr = std::unique_ptr< const mrpt::opengl ::CSetOfObjects >
 
static const mrpt::rtti::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "mrpt::opengl" "::" "CSetOfObjects"
 
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

◆ const_iterator

using mrpt::opengl::CSetOfObjects::const_iterator = CListOpenGLObjects::const_iterator

Definition at line 41 of file CSetOfObjects.h.

◆ ConstPtr

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

Definition at line 28 of file CSetOfObjects.h.

◆ ConstUniquePtr

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

Definition at line 28 of file CSetOfObjects.h.

◆ iterator

using mrpt::opengl::CSetOfObjects::iterator = CListOpenGLObjects::iterator

Definition at line 42 of file CSetOfObjects.h.

◆ Ptr

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

A type for the associated smart pointer

Definition at line 28 of file CSetOfObjects.h.

◆ UniquePtr

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

Definition at line 28 of file CSetOfObjects.h.

Constructor & Destructor Documentation

◆ CSetOfObjects()

mrpt::opengl::CSetOfObjects::CSetOfObjects ( )
default

◆ ~CSetOfObjects()

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

Member Function Documentation

◆ _GetBaseClass()

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

◆ begin() [1/2]

iterator mrpt::opengl::CSetOfObjects::begin ( )
inline

Definition at line 46 of file CSetOfObjects.h.

References m_objects.

◆ begin() [2/2]

const_iterator mrpt::opengl::CSetOfObjects::begin ( ) const
inline

Definition at line 44 of file CSetOfObjects.h.

References m_objects.

Referenced by insert().

◆ clear()

void CSetOfObjects::clear ( )

◆ clone()

virtual mrpt::rtti::CObject* mrpt::opengl::CSetOfObjects::clone ( ) const
overridevirtual

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

Implements mrpt::rtti::CObject.

◆ contains()

bool CSetOfObjects::contains ( const CRenderizable::Ptr obj) const

Definition at line 175 of file CSetOfObjects.cpp.

References mrpt::containers::find().

◆ Create()

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

◆ CreateAlloc()

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

Definition at line 28 of file CSetOfObjects.h.

◆ CreateObject()

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

◆ CreateUnique()

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

Definition at line 28 of file CSetOfObjects.h.

◆ dumpListOfObjects()

void CSetOfObjects::dumpListOfObjects ( std::vector< std::string > &  lst)

Retrieves a list of all objects in text form

Definition at line 95 of file CSetOfObjects.cpp.

References CLASS_ID_NAMESPACE, and dumpListOfObjects().

Referenced by dumpListOfObjects().

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

◆ empty()

bool mrpt::opengl::CSetOfObjects::empty ( ) const
inline

Returns true if there are no objects.


Definition at line 98 of file CSetOfObjects.h.

References m_objects.

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

◆ end() [1/2]

iterator mrpt::opengl::CSetOfObjects::end ( )
inline

Definition at line 47 of file CSetOfObjects.h.

References m_objects.

◆ end() [2/2]

const_iterator mrpt::opengl::CSetOfObjects::end ( ) const
inline

Definition at line 45 of file CSetOfObjects.h.

References m_objects.

Referenced by insert().

◆ enqueForRenderRecursive() [1/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().

◆ enqueForRenderRecursive() [2/2]

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

Definition at line 42 of file CSetOfObjects.cpp.

References mrpt::opengl::enqueForRendering().

◆ freeOpenGLResources()

void mrpt::opengl::CSetOfObjects::freeOpenGLResources ( )
inlineoverridevirtual

Free opengl buffers.

Implements mrpt::opengl::CRenderizable.

Definition at line 80 of file CSetOfObjects.h.

References m_objects.

◆ getBoundingBox()

void CSetOfObjects::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 227 of file CSetOfObjects.cpp.

References bb_max, bb_min, mrpt::keep_max(), mrpt::keep_min(), mrpt::math::TPoint3D_data< T >::x, mrpt::math::TPoint3D_data< T >::y, and mrpt::math::TPoint3D_data< T >::z.

◆ getByClass()

template<typename T >
T::Ptr mrpt::opengl::CSetOfObjects::getByClass ( size_t  ith = 0) const

Returns the i'th object of a given class (or of a descendant class), or nullptr (an empty smart pointer) if not found.

Example:

CSphere::Ptr obs = myscene.getByClass<CSphere>();

By default (ith=0), the first observation is returned.

Definition at line 193 of file CSetOfObjects.h.

References CLASS_ID_NAMESPACE, m_objects, MRPT_END, and MRPT_START.

◆ getByName()

CRenderizable::Ptr CSetOfObjects::getByName ( const std::string &  str)

Returns the first object with a given name, or a nullptr pointer if not found.

Definition at line 207 of file CSetOfObjects.cpp.

References CLASS_ID_NAMESPACE.

◆ getClassName()

static constexpr auto mrpt::opengl::CSetOfObjects::getClassName ( )
inlinestaticconstexpr

Definition at line 28 of file CSetOfObjects.h.

◆ getColor()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns information about the class of an object in runtime.

Reimplemented from mrpt::opengl::CRenderizable.

◆ GetRuntimeClassIdStatic()

static const mrpt::rtti::TRuntimeClassId& mrpt::opengl::CSetOfObjects::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().

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

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

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

◆ initializeTextures()

void mrpt::opengl::CSetOfObjects::initializeTextures ( ) const
inlineoverridevirtual

Initializes all textures (loads them into opengl memory).

Reimplemented from mrpt::opengl::CRenderizable.

Definition at line 85 of file CSetOfObjects.h.

References m_objects.

◆ insert() [1/2]

void CSetOfObjects::insert ( const CRenderizable::Ptr newObject)

◆ insert() [2/2]

template<class T_it >
void mrpt::opengl::CSetOfObjects::insert ( const T_it &  begin,
const T_it &  end 
)
inline

Inserts a set of objects, bounded by iterators, into the list.

Definition at line 62 of file CSetOfObjects.h.

References begin(), end(), and insert().

◆ insertCollection()

template<class T >
void mrpt::opengl::CSetOfObjects::insertCollection ( const T &  objs)
inline

Inserts a set of objects into the list.

Definition at line 51 of file CSetOfObjects.h.

References insert().

◆ isShowNameEnabled()

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

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

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

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

◆ 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(), mrpt::opengl::CTexturedPlane::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::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(), 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::CPolyhedron::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().

◆ posePDF2opengl() [1/4]

CSetOfObjects::Ptr CSetOfObjects::posePDF2opengl ( const mrpt::poses::CPointPDF o)
static

Returns a representation of a the PDF - this is just an auxiliary function, it's more natural to call mrpt::poses::CPointPDF::getAs3DObject

Definition at line 134 of file pose_pdfs.cpp.

References ASSERT_, mrpt::opengl::CEllipsoid3D::Create(), mrpt::opengl::CEllipsoid2D::Create(), mrpt::opengl::CPointCloud::Create(), IS_CLASS, and POINT_COLOR.

◆ posePDF2opengl() [2/4]

CSetOfObjects::Ptr CSetOfObjects::posePDF2opengl ( const mrpt::poses::CPose3DPDF o)
static

Returns a representation of a the PDF - this is just an auxiliary function, it's more natural to call mrpt::poses::CPose3DPDF::getAs3DObject

Definition at line 219 of file pose_pdfs.cpp.

References ASSERT_, mrpt::opengl::stock_objects::CornerXYZ(), mrpt::opengl::stock_objects::CornerXYZSimple(), IS_CLASS, POSE_AXIS_SCALE, and POSE_COLOR.

◆ posePDF2opengl() [3/4]

CSetOfObjects::Ptr CSetOfObjects::posePDF2opengl ( const mrpt::poses::CPose3DQuatPDF o)
static

Returns a representation of a the PDF - this is just an auxiliary function, it's more natural to call mrpt::poses::CPose3DQuatPDF::getAs3DObject

Definition at line 291 of file pose_pdfs.cpp.

References ASSERT_, mrpt::opengl::stock_objects::CornerXYZ(), mrpt::opengl::CEllipsoid3D::Create(), IS_CLASS, POSE_AXIS_SCALE, and POSE_COLOR.

◆ posePDF2opengl() [4/4]

CSetOfObjects::Ptr CSetOfObjects::posePDF2opengl ( const mrpt::poses::CPosePDF o)
static

Returns a representation of a the PDF - this is just an auxiliary function, it's more natural to call mrpt::poses::CPosePDF::getAs3DObject

Definition at line 44 of file pose_pdfs.cpp.

References ASSERT_, mrpt::opengl::CSetOfLines::Create(), mrpt::opengl::CEllipsoid2D::Create(), mrpt::opengl::CPointCloud::Create(), mrpt::d2f(), IS_CLASS, POSE_COLOR, POSE_POINT_SIZE, POSE_TAIL_LENGTH, and POSE_TAIL_WIDTH.

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

◆ readFromStreamRender()

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

◆ removeObject()

void CSetOfObjects::removeObject ( const CRenderizable::Ptr obj)

Removes the given object from the scene (it also deletes the object to free its memory).

Definition at line 120 of file CSetOfObjects.cpp.

References CLASS_ID_NAMESPACE.

◆ render()

void CSetOfObjects::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 37 of file CSetOfObjects.cpp.

◆ renderUpdateBuffers()

void CSetOfObjects::renderUpdateBuffers ( ) const
overridevirtual

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.

Definition at line 32 of file CSetOfObjects.cpp.

◆ requiredShaders()

shader_list_t mrpt::opengl::CSetOfObjects::requiredShaders ( ) const
inlineoverridevirtual

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

See also
DefaultShaderID

Reimplemented from mrpt::opengl::CRenderizable.

Definition at line 67 of file CSetOfObjects.h.

References mrpt::opengl::DefaultShaderID::WIREFRAME.

◆ serializeFrom() [1/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.

◆ serializeFrom() [2/2]

void CSetOfObjects::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 61 of file CSetOfObjects.cpp.

References mrpt::containers::clear(), and MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

◆ serializeGetVersion()

uint8_t CSetOfObjects::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 48 of file CSetOfObjects.cpp.

◆ serializeTo() [1/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.

◆ serializeTo() [2/2]

void CSetOfObjects::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 49 of file CSetOfObjects.cpp.

References out.

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

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

◆ setColor_u8() [1/2]

CRenderizable & CSetOfObjects::setColor_u8 ( const mrpt::img::TColor c)
overridevirtual

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

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

◆ setColorA_u8()

CRenderizable & CSetOfObjects::setColorA_u8 ( const uint8_t  a)
overridevirtual

Color components in the range [0,255].

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Definition at line 198 of file CSetOfObjects.cpp.

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

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

◆ setColorB_u8()

CRenderizable & CSetOfObjects::setColorB_u8 ( const uint8_t  b)
overridevirtual

Color components in the range [0,255].

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Definition at line 192 of file CSetOfObjects.cpp.

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

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

◆ setColorG_u8()

CRenderizable & CSetOfObjects::setColorG_u8 ( const uint8_t  g)
overridevirtual

Color components in the range [0,255].

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Definition at line 186 of file CSetOfObjects.cpp.

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

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

◆ setColorR_u8()

CRenderizable & CSetOfObjects::setColorR_u8 ( const uint8_t  r)
overridevirtual

Color components in the range [0,255].

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Definition at line 180 of file CSetOfObjects.cpp.

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

◆ setLocalRepresentativePoint()

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

◆ setLocation() [1/2]

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

◆ setLocation() [2/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().

◆ 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::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() [2/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() [3/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().

◆ setPose() [4/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().

◆ setPose() [5/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() [6/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().

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

◆ size()

size_t mrpt::opengl::CSetOfObjects::size ( )
inline

Returns number of objects.


Definition at line 96 of file CSetOfObjects.h.

References m_objects.

◆ traceRay()

bool CSetOfObjects::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 134 of file CSetOfObjects.cpp.

◆ updateBuffers()

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

◆ 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

Member Data Documentation

◆ className

constexpr const char* mrpt::opengl::CSetOfObjects::className = "mrpt::opengl" "::" "CSetOfObjects"
staticconstexpr

Definition at line 28 of file CSetOfObjects.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_objects

CListOpenGLObjects mrpt::opengl::CSetOfObjects::m_objects
protected

The list of child objects.

Objects are automatically deleted when calling "clear" or in the destructor.

Definition at line 35 of file CSetOfObjects.h.

Referenced by begin(), empty(), end(), freeOpenGLResources(), getByClass(), initializeTextures(), and size().

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

◆ runtimeClassId

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

Definition at line 28 of file CSetOfObjects.h.

mrpt::opengl::CSphere::Ptr
std::shared_ptr< mrpt::opengl ::CSphere > Ptr
Definition: CSphere.h:31



Page generated by Doxygen 1.8.17 for MRPT 2.0.3 at Fri May 15 23:51:15 UTC 2020