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 60 of file COpenGLScene.h.
#include <mrpt/opengl/COpenGLScene.h>
Public Member Functions | |
void * | operator new (size_t size) |
void * | operator new[] (size_t size) |
void | operator delete (void *ptr) noexcept |
void | operator delete[] (void *ptr) noexcept |
void | operator delete (void *memory, void *ptr) noexcept |
void * | operator 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... | |
COpenGLScene & | operator= (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 (mrpt::utils::CStringList &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 mxArray * | writeToMatlab () 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 | |
mrpt::utils::CObject::Ptr | duplicateGetSmartPtr () const |
Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More... | |
Static Public Member Functions | |
static void * | operator new (size_t size, void *ptr) |
Protected Types | |
typedef std::vector< COpenGLViewport::Ptr > | TListViewports |
Protected Member Functions | |
CSerializable virtual methods | |
void | writeToStream (mrpt::utils::CStream &out, int *getVersion) const override |
Introduces a pure virtual method responsible for writing to a CStream. More... | |
void | readFromStream (mrpt::utils::CStream &in, int version) override |
Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More... | |
Static Protected Member Functions | |
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 > |
static mrpt::utils::CLASSINIT | _init_COpenGLScene |
static const mrpt::utils::TRuntimeClassId | runtimeClassId |
static constexpr const char * | className = "COpenGLScene" |
static const mrpt::utils::TRuntimeClassId * | _GetBaseClass () |
static const mrpt::utils::TRuntimeClassId & | GetRuntimeClassIdStatic () |
static mrpt::utils::CObject * | CreateObject () |
template<typename... Args> | |
static Ptr | Create (Args &&... args) |
virtual const mrpt::utils::TRuntimeClassId * | GetRuntimeClass () const override |
Returns information about the class of an object in runtime. More... | |
virtual mrpt::utils::CObject * | clone () const override |
Returns a deep copy (clone) of the object, indepently of its class. More... | |
using mrpt::opengl::COpenGLScene::ConstPtr = std::shared_ptr<const COpenGLScene > |
Definition at line 62 of file COpenGLScene.h.
using mrpt::opengl::COpenGLScene::Ptr = std::shared_ptr< COpenGLScene > |
A typedef for the associated smart pointer
Definition at line 62 of file COpenGLScene.h.
|
protected |
Definition at line 252 of file COpenGLScene.h.
COpenGLScene::COpenGLScene | ( | ) |
Constructor.
Definition at line 46 of file COpenGLScene.cpp.
|
virtual |
Destructor:
Definition at line 58 of file COpenGLScene.cpp.
References clear().
COpenGLScene::COpenGLScene | ( | const COpenGLScene & | obj | ) |
Copy constructor:
Definition at line 50 of file COpenGLScene.cpp.
|
staticprotected |
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 62 of file COpenGLScene.cpp.
References createViewport(), and m_viewports.
Referenced by mrpt::hmtslam::CHierarchicalMapMHPartition::getAs3DScene(), operator=(), readFromStream(), and ~COpenGLScene().
|
overridevirtual |
Returns a deep copy (clone) of the object, indepently of its class.
Implements mrpt::utils::CObject.
|
inlinestatic |
Definition at line 62 of file COpenGLScene.h.
|
static |
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 250 of file COpenGLScene.cpp.
References getViewport(), m_viewports, MRPT_END, and MRPT_START.
Referenced by clear().
void COpenGLScene::dumpListOfObjects | ( | mrpt::utils::CStringList & | lst | ) |
Retrieves a list of all objects in text form.
Definition at line 234 of file COpenGLScene.cpp.
References mrpt::utils::CStringList::add(), mrpt::utils::CStringList::clear(), and m_viewports.
|
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.
Definition at line 145 of file COpenGLScene.h.
References m_followCamera.
Referenced by mrpt::hmtslam::CHMTSLAM::LSLAM_process_message_from_AA().
|
inline |
Return the value of "followCamera".
Definition at line 149 of file COpenGLScene.h.
References m_followCamera.
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 346 of file COpenGLScene.cpp.
References ASSERTMSG_, and getViewport().
|
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:
By default (ith=0), the first observation is returned.
Definition at line 166 of file COpenGLScene.h.
References m_viewports, MRPT_END, and MRPT_START.
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 210 of file COpenGLScene.cpp.
References m_viewports, and MRPT_UNUSED_PARAM.
|
overridevirtual |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::utils::CSerializable.
|
static |
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 268 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().
void COpenGLScene::initializeAllTextures | ( | ) |
Initializes all textures in the scene (See opengl::CTexturedPlane::loadTextureInOpenGL)
Definition at line 224 of file COpenGLScene.cpp.
References m_viewports.
void COpenGLScene::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).
The viewport must be created previously, an exception will be raised if the given name does not correspond to an existing viewport.
Definition at line 189 of file COpenGLScene.cpp.
References m_viewports, MRPT_END, MRPT_START, and THROW_EXCEPTION_FMT.
Referenced by mrpt::hmtslam::CHierarchicalMapMHPartition::getAs3DScene(), insert(), insertCollection(), mrpt::hmtslam::CHMTSLAM::LSLAM_process_message_from_AA(), mrpt::nav::PlannerTPS_VirtualBase::renderMoveTree(), mrpt::maps::COctoMapBase< octomap::OcTree, octomap::OcTreeNode >::saveMetricMapRepresentationToFile(), mrpt::maps::CBeaconMap::saveMetricMapRepresentationToFile(), and mrpt::maps::CLandmarksMap::saveMetricMapRepresentationToFile().
|
inline |
Inserts a set of objects into the scene, in the given viewport ("main" by default).
Definition at line 108 of file COpenGLScene.h.
References begin(), and insert().
|
inline |
Inserts a set of objects into the scene, in the given viewport ("main" by default).
Any iterable object will be accepted.
Definition at line 86 of file COpenGLScene.h.
References insert().
|
inlinestaticprotected |
Definition at line 258 of file COpenGLScene.h.
References IS_CLASS.
Referenced by visitAllObjects().
bool COpenGLScene::loadFromFile | ( | const std::string & | fil | ) |
Loads the scene from a 3Dscene file, the format used by the application SceneViewer3D.
Definition at line 331 of file COpenGLScene.cpp.
Definition at line 62 of file COpenGLScene.h.
Definition at line 62 of file COpenGLScene.h.
|
inlinenoexcept |
Definition at line 62 of file COpenGLScene.h.
Definition at line 62 of file COpenGLScene.h.
Definition at line 62 of file COpenGLScene.h.
|
inlinenoexcept |
Definition at line 62 of file COpenGLScene.h.
|
inline |
Definition at line 62 of file COpenGLScene.h.
|
inline |
Definition at line 62 of file COpenGLScene.h.
COpenGLScene & COpenGLScene::operator= | ( | const COpenGLScene & | obj | ) |
Copy operator:
Definition at line 72 of file COpenGLScene.cpp.
References clear(), m_followCamera, and m_viewports.
|
overrideprotectedvirtual |
Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.
in | The input binary stream where the object data must read from. |
version | The version of the object stored in the stream: use this version number in your code to know how to read the incoming data. |
std::exception | On any error, see CStream::ReadBuffer |
Implements mrpt::utils::CSerializable.
Definition at line 140 of file COpenGLScene.cpp.
References clear(), m_followCamera, mrpt::opengl::COpenGLViewport::m_parent, m_viewports, and MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.
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 282 of file COpenGLScene.cpp.
References ASSERT_, getViewport(), MRPT_END, and MRPT_START.
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().
bool COpenGLScene::saveToFile | ( | const std::string & | fil | ) | const |
Saves the scene to a 3Dscene file, loadable by the application SceneViewer3D.
Definition at line 318 of file COpenGLScene.cpp.
References CFileGZOutputStream.
Referenced by mrpt::nav::PlannerRRT_SE2_TPS::solve().
bool COpenGLScene::traceRay | ( | const mrpt::poses::CPose3D & | o, |
double & | dist | ||
) | const |
|
inline |
Definition at line 134 of file COpenGLScene.h.
References m_viewports.
|
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 225 of file COpenGLScene.h.
References internal_visitAllObjects(), m_viewports, MRPT_END, and MRPT_START.
Referenced by visitAllObjects().
|
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 243 of file COpenGLScene.h.
References visitAllObjects().
|
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.
mxArray
(caller is responsible of memory freeing) or nullptr is class does not support conversion to MATLAB. Definition at line 89 of file CSerializable.h.
|
overrideprotectedvirtual |
Introduces a pure virtual method responsible for writing to a CStream.
This can not be used directly be users, instead use "stream << object;" for writing it to a stream.
out | The output binary stream where object must be dumped. |
getVersion | If nullptr, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data. |
std::exception | On any error, see CStream::WriteBuffer |
Implements mrpt::utils::CSerializable.
Definition at line 119 of file COpenGLScene.cpp.
References m_followCamera, and m_viewports.
|
staticprotected |
Definition at line 62 of file COpenGLScene.h.
|
static |
Definition at line 62 of file COpenGLScene.h.
|
protected |
Definition at line 250 of file COpenGLScene.h.
Referenced by enableFollowCamera(), followCamera(), operator=(), readFromStream(), and writeToStream().
|
protected |
The list of viewports, indexed by name.
Definition at line 255 of file COpenGLScene.h.
Referenced by clear(), createViewport(), dumpListOfObjects(), getByClass(), getByName(), getViewport(), initializeAllTextures(), insert(), operator=(), readFromStream(), render(), traceRay(), viewportsCount(), visitAllObjects(), and writeToStream().
|
staticprotected |
Definition at line 62 of file COpenGLScene.h.
Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ae4571287 Thu Nov 23 00:06:53 2017 +0100 at dom oct 27 23:51:55 CET 2019 |