mrpt::opengl Namespace Reference

The namespace for 3D scene representation and rendering. More...

Namespaces
namespace	stock_objects
	A collection of pre-built 3D objects for quick insertion in opengl::COpenGLScene objects.
Classes
class	C3DSScene
	This element keeps a set of objects imported from a 3DStudio file (.3ds). More...
class	CAngularObservationMesh
	A mesh built from a set of 2D laser scan observations. More...
class	CArrow
	A 3D arrow. More...
class	CAxis
	Draw a 3D world axis, with coordinate marks at some regular interval. More...
class	CCamera
	A camera: if added to a scene, the viewpoint defined by this camera will be used instead of the camera parameters set in COpenGLViewport::m_camera. More...
class	CCylinder
	A cylinder or cone whose base lies in the XY plane. More...
class	CDisk
	A planar disk in the XY plane. More...
class	CEllipsoid
	A 2D ellipse or 3D ellipsoid, depending on the size of the m_cov matrix (2x2 or 3x3). More...
class	CFBORender
	A class for rendering 3D scenes off-screen directly into an image using OpenGL extensions (glext). More...
class	CGeneralizedCylinder
	This object represents any figure obtained by extruding any profile along a given axis. More...
class	CGridPlaneXY
	A grid of lines over the XY plane. More...
class	CGridPlaneXZ
	A grid of lines over the XZ plane. More...
class	CMesh
	A set of connected colored triangles. More...
class	COpenGLScene
	This class allows the user to create, load, save, and render 3D scenes using OpenGL primitives. More...
class	COpenGLStandardObject
	Objects of this class represent a generic openGL object without specific geometric properties. More...
class	COpenGLViewport
	A viewport within a COpenGLScene, containing a set of OpenGL objects to render. More...
class	CPlanarLaserScan
	This object renders a 2D laser scan by means of three elements: the points, the line along end-points and the 2D scanned surface. More...
class	CPointCloud
	A cloud of points, all with the same color or each depending on its value along a particular coordinate axis. More...
class	CPointCloudColoured
	A cloud of points, each one with an individual colour (R,G,B). More...
class	CPolyhedron
	This class represents arbitrary polyhedra. More...
class	CRenderizable
	The base class of 3D objects that can be directly rendered through OpenGL. More...
class	CSetOfLines
	A set of independent lines (or segments), one line with its own start and end positions (X,Y,Z). More...
class	CSetOfObjects
	A set of object, which are referenced to the coordinates framework established in this object. More...
class	CSetOfTexturedTriangles
	A set of textured triangles. More...
class	CSetOfTriangles
	A set of colored triangles. More...
class	CSimpleLine
	A line segment. More...
class	CSphere
	A solid or wire-frame sphere. More...
class	CText
	A 2D text (bitmap rendering): it always "faces the observer" despite it's at some 3D location. More...
class	CTexturedPlane
	A 2D plane in the XY plane with a texture image. More...
Typedefs
typedef uint32_t	_GLENUM
typedef std::deque < CRenderizablePtr >	CListOpenGLObjects
	A list of objects pointers, automatically managing memory free at destructor, and managing copies correctly.
Functions
COpenGLScenePtr &	operator<< (COpenGLScenePtr &s, const CRenderizablePtr &r)
	Inserts an openGL object into a scene.
template<class T >
COpenGLScenePtr &	operator<< (COpenGLScenePtr &s, const std::vector< T > &v)
	Inserts any iterable collection of openGL objects into a scene, allowing call chaining.
COpenGLViewportPtr &	operator<< (COpenGLViewportPtr &s, const CRenderizablePtr &r)
	Inserts an openGL object into a viewport.
COpenGLViewportPtr &	operator<< (COpenGLViewportPtr &s, const std::vector< CRenderizablePtr > &v)
	Inserts any iterable set of openGL objects into a viewport.
MRPTDLLIMPEXP mrpt::utils::CStream &	operator>> (mrpt::utils::CStream &in, CPointCloudColoured::TPointColour &o)
MRPTDLLIMPEXP mrpt::utils::CStream &	operator<< (mrpt::utils::CStream &out, const CPointCloudColoured::TPointColour &o)
MRPTDLLIMPEXP mrpt::utils::CStream &	operator>> (mrpt::utils::CStream &in, CPolyhedron::TPolyhedronEdge &o)
	Reads a polyhedron edge from a binary stream.
MRPTDLLIMPEXP mrpt::utils::CStream &	operator<< (mrpt::utils::CStream &out, const CPolyhedron::TPolyhedronEdge &o)
	Writes a polyhedron edge to a binary stream.
MRPTDLLIMPEXP mrpt::utils::CStream &	operator>> (mrpt::utils::CStream &in, CPolyhedron::TPolyhedronFace &o)
	Reads a polyhedron face from a binary stream.
MRPTDLLIMPEXP mrpt::utils::CStream &	operator<< (mrpt::utils::CStream &out, const CPolyhedron::TPolyhedronFace &o)
	Writes a polyhedron face to a binary stream.
MRPTDLLIMPEXP CRenderizablePtr &	operator<< (CRenderizablePtr &r, const mrpt::poses::CPose3D &p)
	Applies a CPose3D transformation to the object.
template<class T >
CSetOfLinesPtr &	operator<< (CSetOfLinesPtr &l, const T &s)
	Inserts a set of segments into the list.
template<>
CSetOfLinesPtr &	operator<< (CSetOfLinesPtr &l, const mrpt::math::TSegment3D &s)
	Inserts a segment into the list.
CSetOfObjectsPtr &	operator<< (CSetOfObjectsPtr &s, const CRenderizablePtr &r)
	Inserts an object into the list.
template<class T >
CSetOfObjectsPtr &	operator<< (CSetOfObjectsPtr &o, const std::vector< T > &v)
	Inserts a set of objects into the list.
template<class T >
CSetOfTrianglesPtr &	operator<< (CSetOfTrianglesPtr &s, const T &t)
	Inserts a set of triangles into the list; note that this method allows to pass another CSetOfTriangles as argument.
template<>
CSetOfTrianglesPtr &	operator<< (CSetOfTrianglesPtr &s, const CSetOfTriangles::TTriangle &t)
	Inserts a triangle into the list.
Variables
class MRPTDLLIMPEXP	C3DSScene
class MRPTDLLIMPEXP	CAngularObservationMesh
class MRPTDLLIMPEXP	CArrow
class MRPTDLLIMPEXP	CAxis
class MRPTDLLIMPEXP	CCylinder
class MRPTDLLIMPEXP	CDisk
class MRPTDLLIMPEXP	CEllipsoid
class MRPTDLLIMPEXP	CGeneralizedCylinder
class MRPTDLLIMPEXP	CGridPlaneXY
class MRPTDLLIMPEXP	CGridPlaneXZ
class MRPTDLLIMPEXP	CMesh
class MRPTDLLIMPEXP	COpenGLStandardObject
class MRPTDLLIMPEXP	CPlanarLaserScan
class MRPTDLLIMPEXP	CPointCloud
class MRPTDLLIMPEXP	CPointCloudColoured
class MRPTDLLIMPEXP	CPolyhedron
class MRPTDLLIMPEXP	CSetOfLines
class MRPTDLLIMPEXP	CSetOfObjects
class MRPTDLLIMPEXP	CSetOfTexturedTriangles
class MRPTDLLIMPEXP	CSetOfTriangles
class MRPTDLLIMPEXP	CSimpleLine
class MRPTDLLIMPEXP	CSphere
class MRPTDLLIMPEXP	CText
class MRPTDLLIMPEXP	CTexturedPlane

---

Detailed Description

The namespace for 3D scene representation and rendering.

---

Typedef Documentation

typedef uint32_t mrpt::opengl::_GLENUM

Definition at line 38 of file COpenGLStandardObject.h.

typedef std::deque<CRenderizablePtr> mrpt::opengl::CListOpenGLObjects

A list of objects pointers, automatically managing memory free at destructor, and managing copies correctly.

Definition at line 42 of file CSetOfObjects.h.

---

Function Documentation

template<>

CSetOfTrianglesPtr& mrpt::opengl::operator<<	(	CSetOfTrianglesPtr &	s,
		const CSetOfTriangles::TTriangle &	t
	)			[inline]

Inserts a triangle into the list.

Allows call chaining.

See also:

mrpt::opengl::CSetOfTriangles::insertTriangle

Definition at line 216 of file CSetOfTriangles.h.

template<class T >

CSetOfTrianglesPtr& mrpt::opengl::operator<<	(	CSetOfTrianglesPtr &	s,
		const T &	t
	)			[inline]

Inserts a set of triangles into the list; note that this method allows to pass another CSetOfTriangles as argument.

Allows call chaining.

See also:

mrpt::opengl::CSetOfTriangles::insertTriangle

Definition at line 209 of file CSetOfTriangles.h.

template<class T >

CSetOfObjectsPtr& mrpt::opengl::operator<<	(	CSetOfObjectsPtr &	o,
		const std::vector< T > &	v
	)			[inline]

Inserts a set of objects into the list.

Allows call chaining.

See also:

mrpt::opengl::CSetOfObjects::insert

Definition at line 171 of file CSetOfObjects.h.

CSetOfObjectsPtr& mrpt::opengl::operator<<	(	CSetOfObjectsPtr &	s,
		const CRenderizablePtr &	r
	)			[inline]

Inserts an object into the list.

Allows call chaining.

See also:

mrpt::opengl::CSetOfObjects::insert

Definition at line 164 of file CSetOfObjects.h.

template<>

CSetOfLinesPtr& mrpt::opengl::operator<<	(	CSetOfLinesPtr &	l,
		const mrpt::math::TSegment3D &	s
	)			[inline]

Inserts a segment into the list.

Allows call chaining.

See also:

mrpt::opengl::CSetOfLines::appendLine(const TSegment &)

Definition at line 212 of file CSetOfLines.h.

template<class T >

CSetOfLinesPtr& mrpt::opengl::operator<<	(	CSetOfLinesPtr &	l,
		const T &	s
	)			[inline]

Inserts a set of segments into the list.

Allows call chaining.

See also:

mrpt::opengl::CSetOfLines::appendLines

Definition at line 205 of file CSetOfLines.h.

MRPTDLLIMPEXP CRenderizablePtr& mrpt::opengl::operator<<	(	CRenderizablePtr &	r,
		const mrpt::poses::CPose3D &	p
	)

Applies a CPose3D transformation to the object.

Note that this method doesn't set the pose to the given value, but combines it with the existing one.

See also:

setPose

MRPTDLLIMPEXP mrpt::utils::CStream& mrpt::opengl::operator<<	(	mrpt::utils::CStream &	out,
		const CPolyhedron::TPolyhedronFace &	o
	)

Writes a polyhedron face to a binary stream.

MRPTDLLIMPEXP mrpt::utils::CStream& mrpt::opengl::operator<<	(	mrpt::utils::CStream &	out,
		const CPolyhedron::TPolyhedronEdge &	o
	)

Writes a polyhedron edge to a binary stream.

MRPTDLLIMPEXP mrpt::utils::CStream& mrpt::opengl::operator<<	(	mrpt::utils::CStream &	out,
		const CPointCloudColoured::TPointColour &	o
	)

COpenGLViewportPtr& mrpt::opengl::operator<<	(	COpenGLViewportPtr &	s,
		const std::vector< CRenderizablePtr > &	v
	)			[inline]

Inserts any iterable set of openGL objects into a viewport.

Allows call chaining.

See also:

mrpt::opengl::COpenGLViewport::insert

Definition at line 226 of file COpenGLViewport.h.

COpenGLViewportPtr& mrpt::opengl::operator<<	(	COpenGLViewportPtr &	s,
		const CRenderizablePtr &	r
	)			[inline]

Inserts an openGL object into a viewport.

Allows call chaining.

See also:

mrpt::opengl::COpenGLViewport::insert

Definition at line 218 of file COpenGLViewport.h.

template<class T >

COpenGLScenePtr& mrpt::opengl::operator<<	(	COpenGLScenePtr &	s,
		const std::vector< T > &	v
	)			[inline]

Inserts any iterable collection of openGL objects into a scene, allowing call chaining.

See also:

mrpt::opengl::COpenGLScene::insert

Definition at line 211 of file COpenGLScene.h.

COpenGLScenePtr& mrpt::opengl::operator<<	(	COpenGLScenePtr &	s,
		const CRenderizablePtr &	r
	)			[inline]

Inserts an openGL object into a scene.

Allows call chaining.

See also:

mrpt::opengl::COpenGLScene::insert

Definition at line 203 of file COpenGLScene.h.

MRPTDLLIMPEXP mrpt::utils::CStream& mrpt::opengl::operator>>	(	mrpt::utils::CStream &	in,
		CPolyhedron::TPolyhedronFace &	o
	)

Reads a polyhedron face from a binary stream.

MRPTDLLIMPEXP mrpt::utils::CStream& mrpt::opengl::operator>>	(	mrpt::utils::CStream &	in,
		CPolyhedron::TPolyhedronEdge &	o
	)

Reads a polyhedron edge from a binary stream.

MRPTDLLIMPEXP mrpt::utils::CStream& mrpt::opengl::operator>>	(	mrpt::utils::CStream &	in,
		CPointCloudColoured::TPointColour &	o
	)

---

Variable Documentation

class MRPTDLLIMPEXP mrpt::opengl::C3DSScene

Definition at line 39 of file C3DSScene.h.

class MRPTDLLIMPEXP mrpt::opengl::CAngularObservationMesh

Definition at line 44 of file CAngularObservationMesh.h.

class MRPTDLLIMPEXP mrpt::opengl::CArrow

Definition at line 37 of file CArrow.h.

Referenced by mrpt::opengl::CArrow::Create().

class MRPTDLLIMPEXP mrpt::opengl::CAxis

Definition at line 37 of file CAxis.h.

Referenced by mrpt::opengl::CAxis::Create().

class MRPTDLLIMPEXP mrpt::opengl::CCylinder

Definition at line 35 of file CCylinder.h.

Referenced by mrpt::opengl::CCylinder::Create().

class MRPTDLLIMPEXP mrpt::opengl::CDisk

Definition at line 39 of file CDisk.h.

Referenced by mrpt::opengl::CDisk::Create().

class MRPTDLLIMPEXP mrpt::opengl::CEllipsoid

Definition at line 38 of file CEllipsoid.h.

class MRPTDLLIMPEXP mrpt::opengl::CGeneralizedCylinder

Definition at line 40 of file CGeneralizedCylinder.h.

Referenced by mrpt::opengl::CGeneralizedCylinder::Create().

class MRPTDLLIMPEXP mrpt::opengl::CGridPlaneXY

Definition at line 38 of file CGridPlaneXY.h.

Referenced by mrpt::opengl::CGridPlaneXY::Create().

class MRPTDLLIMPEXP mrpt::opengl::CGridPlaneXZ

Definition at line 38 of file CGridPlaneXZ.h.

Referenced by mrpt::opengl::CGridPlaneXZ::Create().

class MRPTDLLIMPEXP mrpt::opengl::CMesh

Definition at line 42 of file CMesh.h.

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

class MRPTDLLIMPEXP mrpt::opengl::COpenGLStandardObject

Definition at line 41 of file COpenGLStandardObject.h.

Referenced by mrpt::opengl::COpenGLStandardObject::Create().

class MRPTDLLIMPEXP mrpt::opengl::CPlanarLaserScan

Definition at line 44 of file CPlanarLaserScan.h.

class MRPTDLLIMPEXP mrpt::opengl::CPointCloud

Definition at line 41 of file CPointCloud.h.

class MRPTDLLIMPEXP mrpt::opengl::CPointCloudColoured

Definition at line 42 of file CPointCloudColoured.h.

class MRPTDLLIMPEXP mrpt::opengl::CPolyhedron

Definition at line 41 of file CPolyhedron.h.

Referenced by mrpt::opengl::CPolyhedron::Create(), mrpt::opengl::CPolyhedron::CreateEmpty(), and mrpt::opengl::CPolyhedron::CreateNoCheck().

class MRPTDLLIMPEXP mrpt::opengl::CSetOfLines

Definition at line 42 of file CSetOfLines.h.

Referenced by mrpt::opengl::CSetOfLines::Create().

class MRPTDLLIMPEXP mrpt::opengl::CSetOfObjects

Definition at line 38 of file CSetOfObjects.h.

class MRPTDLLIMPEXP mrpt::opengl::CSetOfTexturedTriangles

Definition at line 38 of file CSetOfTexturedTriangles.h.

class MRPTDLLIMPEXP mrpt::opengl::CSetOfTriangles

Definition at line 38 of file CSetOfTriangles.h.

class MRPTDLLIMPEXP mrpt::opengl::CSimpleLine

Definition at line 37 of file CSimpleLine.h.

class MRPTDLLIMPEXP mrpt::opengl::CSphere

Definition at line 37 of file CSphere.h.

Referenced by mrpt::opengl::CSphere::Create().

class MRPTDLLIMPEXP mrpt::opengl::CText

Definition at line 38 of file CText.h.

class MRPTDLLIMPEXP mrpt::opengl::CTexturedPlane

Definition at line 39 of file CTexturedPlane.h.

Referenced by mrpt::opengl::CTexturedPlane::Create().