Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Public Member Functions | Static Public Member Functions | Protected Types | Static Protected Member Functions | Protected Attributes
mrpt::opengl::COpenGLScene Class Reference

Detailed Description

This class allows the user to create, load, save, and render 3D scenes using OpenGL primitives.

The class can be understood as a program to be run over OpenGL, containing a sequence of viewport definitions, rendering primitives, etc...

It can contain from 1 up to any number of Viewports, each one associated a set of OpenGL objects and, optionally, a preferred camera position. Both orthogonal (2D/3D) and projection camera models can be used for each viewport independently, greatly increasing the possibilities of rendered scenes.

An object of COpenGLScene always contains at least one viewport (utils::COpenGLViewport), named "main". Optionally, any number of other viewports may exist. Viewports are referenced by their names, case-sensitive strings. Each viewport contains a different 3D scene (i.e. they render different objects), though a mechanism exist to share the same 3D scene by a number of viewports so memory is not wasted replicating the same objects (see COpenGLViewport::setCloneView ).

The main rendering method, COpenGLScene::render(), assumes a viewport has been set-up for the entire target window. That method will internally make the required calls to opengl for creating the additional viewports. Note that only the depth buffer is cleared by default for each (non-main) viewport, to allow transparencies. This can be disabled by the approppriate member in COpenGLViewport.

An object COpenGLScene can be saved to a ".3Dscene" file using CFileOutputStream, for posterior visualization from the standalone application SceneViewer. It can be also displayed in real-time using gui::CDisplayWindow3D.

Definition at line 59 of file COpenGLScene.h.

#include <mrpt/opengl/COpenGLScene.h>

Inheritance diagram for mrpt::opengl::COpenGLScene:
Inheritance graph

Public Member Functions

voidoperator new (size_t size)
 
voidoperator new[] (size_t size)
 
void operator delete (void *ptr) noexcept
 
void operator delete[] (void *ptr) noexcept
 
void operator delete (void *memory, void *ptr) noexcept
 
voidoperator new (size_t size, const std::nothrow_t &) noexcept
 
void operator delete (void *ptr, const std::nothrow_t &) noexcept
 
 COpenGLScene ()
 Constructor. More...
 
virtual ~COpenGLScene ()
 Destructor: More...
 
COpenGLSceneoperator= (const COpenGLScene &obj)
 Copy operator: More...
 
 COpenGLScene (const COpenGLScene &obj)
 Copy constructor: More...
 
template<class T >
void insertCollection (const T &objs, const std::string &vpn=std::string("main"))
 Inserts a set of objects into the scene, in the given viewport ("main" by default). More...
 
void insert (const CRenderizable::Ptr &newObject, const std::string &viewportName=std::string("main"))
 Insert a new object into the scene, in the given viewport (by default, into the "main" viewport). More...
 
template<class T_it >
void insert (const T_it &begin, const T_it &end, const std::string &vpn=std::string("main"))
 Inserts a set of objects into the scene, in the given viewport ("main" by default). More...
 
COpenGLViewport::Ptr createViewport (const std::string &viewportName)
 Creates a new viewport, adding it to the scene and returning a pointer to the new object. More...
 
COpenGLViewport::Ptr getViewport (const std::string &viewportName=std::string("main")) const
 Returns the viewport with the given name, or nullptr if it does not exist; note that the default viewport is named "main" and initially occupies the entire rendering area. More...
 
void render () const
 Render this scene. More...
 
size_t viewportsCount () const
 
void clear (bool createMainViewport=true)
 Clear the list of objects and viewports in the scene, deleting objects' memory, and leaving just the default viewport with the default values. More...
 
void enableFollowCamera (bool enabled)
 If disabled (default), the SceneViewer application will ignore the camera of the "main" viewport and keep the viewport selected by the user by hand; otherwise, the camera in the "main" viewport prevails. More...
 
bool followCamera () const
 Return the value of "followCamera". More...
 
CRenderizable::Ptr getByName (const std::string &str, const std::string &viewportName=std::string("main"))
 Returns the first object with a given name, or nullptr (an empty smart pointer) if not found. More...
 
template<typename T >
T::Ptr getByClass (const 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, const std::string &viewportName=std::string("main"))
 Removes the given object from the scene (it also deletes the object to free its memory). More...
 
void initializeAllTextures ()
 Initializes all textures in the scene (See opengl::CTexturedPlane::loadTextureInOpenGL) More...
 
void dumpListOfObjects (std::vector< std::string > &lst)
 Retrieves a list of all objects in text form. More...
 
bool saveToFile (const std::string &fil) const
 Saves the scene to a 3Dscene file, loadable by the application SceneViewer3D. More...
 
bool loadFromFile (const std::string &fil)
 Loads the scene from a 3Dscene file, the format used by the application SceneViewer3D. More...
 
bool traceRay (const mrpt::poses::CPose3D &o, double &dist) const
 Traces a ray. More...
 
void getBoundingBox (mrpt::math::TPoint3D &bb_min, mrpt::math::TPoint3D &bb_max, const std::string &vpn=std::string("main")) const
 Evaluates the bounding box of the scene in the given viewport (default: "main"). More...
 
template<typename FUNCTOR >
void visitAllObjects (FUNCTOR functor) const
 Recursive depth-first visit all objects in all viewports of the scene, calling the user-supplied function The passed function must accept only one argument of type "const mrpt::opengl::CRenderizable::Ptr &". More...
 
template<typename FUNCTOR , typename EXTRA_PARAM >
void visitAllObjects (FUNCTOR functor, const EXTRA_PARAM &userParam) const
 Recursive depth-first visit all objects in all viewports of the scene, calling the user-supplied function The passed function must accept a first argument of type "const mrpt::opengl::CRenderizable::Ptr &" and a second one of type EXTRA_PARAM. 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...
 
RTTI classes and functions for polymorphic hierarchies
mrpt::rtti::CObject::Ptr duplicateGetSmartPtr () const
 Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More...
 

Static Public Member Functions

static voidoperator new (size_t size, void *ptr)
 

Protected Types

using TListViewports = std::vector< COpenGLViewport::Ptr >
 

Protected Member Functions

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

Static Protected Member Functions

template<typename FUNCTOR >
static void internal_visitAllObjects (FUNCTOR functor, const CRenderizable::Ptr &o)
 

Protected Attributes

bool m_followCamera
 
TListViewports m_viewports
 The list of viewports, indexed by name. More...
 

RTTI stuff

using Ptr = std::shared_ptr< COpenGLScene >
 
using ConstPtr = std::shared_ptr< const COpenGLScene >
 
using UniquePtr = std::unique_ptr< COpenGLScene >
 
using ConstUniquePtr = std::unique_ptr< const COpenGLScene >
 
static mrpt::rtti::CLASSINIT _init_COpenGLScene
 
static const mrpt::rtti::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "COpenGLScene"
 
static const mrpt::rtti::TRuntimeClassId_GetBaseClass ()
 
static constexpr auto getClassName ()
 
static const mrpt::rtti::TRuntimeClassIdGetRuntimeClassIdStatic ()
 
static mrpt::rtti::CObjectCreateObject ()
 
template<typename... Args>
static Ptr Create (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 61 of file COpenGLScene.h.

◆ ConstUniquePtr

Definition at line 61 of file COpenGLScene.h.

◆ Ptr

A type for the associated smart pointer

Definition at line 61 of file COpenGLScene.h.

◆ TListViewports

Definition at line 251 of file COpenGLScene.h.

◆ UniquePtr

Definition at line 61 of file COpenGLScene.h.

Constructor & Destructor Documentation

◆ COpenGLScene() [1/2]

COpenGLScene::COpenGLScene ( )

Constructor.

Definition at line 44 of file COpenGLScene.cpp.

◆ ~COpenGLScene()

COpenGLScene::~COpenGLScene ( )
virtual

Destructor:

Definition at line 56 of file COpenGLScene.cpp.

References clear().

◆ COpenGLScene() [2/2]

COpenGLScene::COpenGLScene ( const COpenGLScene obj)

Copy constructor:

Definition at line 48 of file COpenGLScene.cpp.

Member Function Documentation

◆ _GetBaseClass()

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

◆ clear()

void COpenGLScene::clear ( bool  createMainViewport = true)

Clear the list of objects and viewports in the scene, deleting objects' memory, and leaving just the default viewport with the default values.

Definition at line 60 of file COpenGLScene.cpp.

References createViewport(), and m_viewports.

Referenced by mrpt::hmtslam::CHierarchicalMapMHPartition::getAs3DScene(), operator=(), serializeFrom(), and ~COpenGLScene().

◆ clone()

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

Definition at line 61 of file COpenGLScene.h.

◆ CreateObject()

static mrpt::rtti::CObject* mrpt::opengl::COpenGLScene::CreateObject ( )
static

◆ CreateUnique()

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

Definition at line 61 of file COpenGLScene.h.

◆ createViewport()

COpenGLViewport::Ptr COpenGLScene::createViewport ( const std::string viewportName)

Creates a new viewport, adding it to the scene and returning a pointer to the new object.

Names (case-sensitive) cannot be duplicated: if the name provided coincides with an already existing viewport, a pointer to the existing object will be returned. The first, default viewport, is named "main".

Definition at line 238 of file COpenGLScene.cpp.

References getViewport(), m_viewports, MRPT_END, and MRPT_START.

Referenced by clear().

◆ dumpListOfObjects()

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

Retrieves a list of all objects in text form.

Definition at line 223 of file COpenGLScene.cpp.

References m_viewports.

◆ duplicateGetSmartPtr()

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

Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).

Definition at line 169 of file CObject.h.

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

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

◆ enableFollowCamera()

void mrpt::opengl::COpenGLScene::enableFollowCamera ( bool  enabled)
inline

If disabled (default), the SceneViewer application will ignore the camera of the "main" viewport and keep the viewport selected by the user by hand; otherwise, the camera in the "main" viewport prevails.

See also
followCamera

Definition at line 144 of file COpenGLScene.h.

References m_followCamera.

Referenced by mrpt::hmtslam::CHMTSLAM::LSLAM_process_message_from_AA().

◆ followCamera()

bool mrpt::opengl::COpenGLScene::followCamera ( ) const
inline

Return the value of "followCamera".

See also
enableFollowCamera

Definition at line 148 of file COpenGLScene.h.

References m_followCamera.

◆ getBoundingBox()

void COpenGLScene::getBoundingBox ( mrpt::math::TPoint3D bb_min,
mrpt::math::TPoint3D bb_max,
const std::string vpn = std::string("main") 
) const

Evaluates the bounding box of the scene in the given viewport (default: "main").

Evaluates the bounding box of this object (including possible children) in the coordinate frame of the object parent.

Definition at line 336 of file COpenGLScene.cpp.

References ASSERTMSG_, and getViewport().

◆ getByClass()

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

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 165 of file COpenGLScene.h.

References m_viewports, MRPT_END, and MRPT_START.

◆ getByName()

CRenderizable::Ptr COpenGLScene::getByName ( const std::string str,
const std::string viewportName = std::string("main") 
)

Returns the first object with a given name, or nullptr (an empty smart pointer) if not found.

Definition at line 199 of file COpenGLScene.cpp.

References m_viewports, and MRPT_UNUSED_PARAM.

◆ getClassName()

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

Definition at line 61 of file COpenGLScene.h.

◆ GetRuntimeClass()

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

Returns information about the class of an object in runtime.

Reimplemented from mrpt::serialization::CSerializable.

◆ GetRuntimeClassIdStatic()

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

◆ getViewport()

COpenGLViewport::Ptr COpenGLScene::getViewport ( const std::string viewportName = std::string("main")) const

Returns the viewport with the given name, or nullptr if it does not exist; note that the default viewport is named "main" and initially occupies the entire rendering area.

Definition at line 256 of file COpenGLScene.cpp.

References m_viewports, MRPT_END, and MRPT_START.

Referenced by createViewport(), getBoundingBox(), mrpt::opengl::CFBORender::getCamera(), removeObject(), and mrpt::opengl::CFBORender::setCamera().

◆ initializeAllTextures()

void COpenGLScene::initializeAllTextures ( )

Initializes all textures in the scene (See opengl::CTexturedPlane::loadTextureInOpenGL)

Definition at line 213 of file COpenGLScene.cpp.

References m_viewports.

◆ insert() [1/2]

void COpenGLScene::insert ( const CRenderizable::Ptr newObject,
const std::string viewportName = std::string("main") 
)

◆ insert() [2/2]

template<class T_it >
void mrpt::opengl::COpenGLScene::insert ( const T_it &  begin,
const T_it &  end,
const std::string vpn = std::string("main") 
)
inline

Inserts a set of objects into the scene, in the given viewport ("main" by default).

See also
createViewport,getViewport

Definition at line 107 of file COpenGLScene.h.

References begin(), and insert().

◆ insertCollection()

template<class T >
void mrpt::opengl::COpenGLScene::insertCollection ( const T &  objs,
const std::string vpn = std::string("main") 
)
inline

Inserts a set of objects into the scene, in the given viewport ("main" by default).

Any iterable object will be accepted.

See also
createViewport,getViewport

Definition at line 85 of file COpenGLScene.h.

References insert().

◆ internal_visitAllObjects()

template<typename FUNCTOR >
static void mrpt::opengl::COpenGLScene::internal_visitAllObjects ( FUNCTOR  functor,
const CRenderizable::Ptr o 
)
inlinestaticprotected

Definition at line 257 of file COpenGLScene.h.

References IS_CLASS.

Referenced by visitAllObjects().

◆ loadFromFile()

bool COpenGLScene::loadFromFile ( const std::string fil)

Loads the scene from a 3Dscene file, the format used by the application SceneViewer3D.

See also
saveToFile
Returns
false on any error.

Definition at line 320 of file COpenGLScene.cpp.

References mrpt::serialization::archiveFrom().

◆ operator delete() [1/3]

void mrpt::opengl::COpenGLScene::operator delete ( void ptr,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 61 of file COpenGLScene.h.

◆ operator delete() [2/3]

void mrpt::opengl::COpenGLScene::operator delete ( void memory,
void ptr 
)
inlinenoexcept

Definition at line 61 of file COpenGLScene.h.

◆ operator delete() [3/3]

void mrpt::opengl::COpenGLScene::operator delete ( void ptr)
inlinenoexcept

Definition at line 61 of file COpenGLScene.h.

◆ operator delete[]()

void mrpt::opengl::COpenGLScene::operator delete[] ( void ptr)
inlinenoexcept

Definition at line 61 of file COpenGLScene.h.

◆ operator new() [1/3]

void* mrpt::opengl::COpenGLScene::operator new ( size_t  size)
inline

Definition at line 61 of file COpenGLScene.h.

◆ operator new() [2/3]

static void* mrpt::opengl::COpenGLScene::operator new ( size_t  size,
void ptr 
)
inlinestatic

Definition at line 61 of file COpenGLScene.h.

◆ operator new() [3/3]

void* mrpt::opengl::COpenGLScene::operator new ( size_t  size,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 61 of file COpenGLScene.h.

◆ operator new[]()

void* mrpt::opengl::COpenGLScene::operator new[] ( size_t  size)
inline

Definition at line 61 of file COpenGLScene.h.

◆ operator=()

COpenGLScene & COpenGLScene::operator= ( const COpenGLScene obj)

Copy operator:

Definition at line 70 of file COpenGLScene.cpp.

References clear(), m_followCamera, and m_viewports.

◆ removeObject()

void COpenGLScene::removeObject ( const CRenderizable::Ptr obj,
const std::string viewportName = std::string("main") 
)

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

Definition at line 270 of file COpenGLScene.cpp.

References ASSERT_, getViewport(), MRPT_END, and MRPT_START.

◆ render()

void COpenGLScene::render ( ) const

Render this scene.

Definition at line 90 of file COpenGLScene.cpp.

References GL_VIEWPORT, glGetIntegerv(), glViewport(), m_viewports, MRPT_END, MRPT_START, and THROW_EXCEPTION.

Referenced by mrpt::opengl::CFBORender::getFrame2().

◆ saveToFile()

bool COpenGLScene::saveToFile ( const std::string fil) const

◆ serializeFrom()

void COpenGLScene::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 128 of file COpenGLScene.cpp.

References clear(), m_followCamera, m_viewports, and MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

◆ serializeGetVersion()

uint8_t COpenGLScene::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 115 of file COpenGLScene.cpp.

◆ serializeTo()

void COpenGLScene::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 116 of file COpenGLScene.cpp.

References m_followCamera, and m_viewports.

◆ traceRay()

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

Traces a ray.

Definition at line 282 of file COpenGLScene.cpp.

References m_viewports.

◆ viewportsCount()

size_t mrpt::opengl::COpenGLScene::viewportsCount ( ) const
inline

Definition at line 133 of file COpenGLScene.h.

References m_viewports.

◆ visitAllObjects() [1/2]

template<typename FUNCTOR >
void mrpt::opengl::COpenGLScene::visitAllObjects ( FUNCTOR  functor) const
inline

Recursive depth-first visit all objects in all viewports of the scene, calling the user-supplied function The passed function must accept only one argument of type "const mrpt::opengl::CRenderizable::Ptr &".

Definition at line 224 of file COpenGLScene.h.

References internal_visitAllObjects(), m_viewports, MRPT_END, and MRPT_START.

Referenced by visitAllObjects().

◆ visitAllObjects() [2/2]

template<typename FUNCTOR , typename EXTRA_PARAM >
void mrpt::opengl::COpenGLScene::visitAllObjects ( FUNCTOR  functor,
const EXTRA_PARAM &  userParam 
) const
inline

Recursive depth-first visit all objects in all viewports of the scene, calling the user-supplied function The passed function must accept a first argument of type "const mrpt::opengl::CRenderizable::Ptr &" and a second one of type EXTRA_PARAM.

Definition at line 242 of file COpenGLScene.h.

References visitAllObjects().

◆ 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 70 of file CSerializable.h.

Member Data Documentation

◆ _init_COpenGLScene

mrpt::rtti::CLASSINIT mrpt::opengl::COpenGLScene::_init_COpenGLScene
staticprotected

Definition at line 61 of file COpenGLScene.h.

◆ className

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

Definition at line 61 of file COpenGLScene.h.

◆ m_followCamera

bool mrpt::opengl::COpenGLScene::m_followCamera
protected

◆ m_viewports

TListViewports mrpt::opengl::COpenGLScene::m_viewports
protected

◆ runtimeClassId

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

Definition at line 61 of file COpenGLScene.h.




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at lun oct 28 00:14:14 CET 2019