mrpt::opengl::CBox Class Reference

Detailed Description

A solid or wireframe box in 3D, defined by 6 rectangular faces parallel to the planes X, Y and Z (note that the object can be translated and rotated afterwards as any other CRenderizable object using the "object pose" in the base class).

Three drawing modes are possible:

• Wireframe: setWireframe(true). Used color is the CRenderizable color
• Solid box: setWireframe(false). Used color is the CRenderizable color
• Solid box with border: setWireframe(false) + enableBoxBorder(true). Solid color is the CRenderizable color, border line can be set with setBoxBorderColor().

See also

opengl::COpenGLScene,opengl::CRenderizable

mrpt::opengl::CBox

Definition at line 37 of file CBox.h.

#include <mrpt/opengl/CBox.h>

Inheritance diagram for mrpt::opengl::CBox:

Public Member Functions
void *	operator new (size_t size)
void *	operator new[] (size_t size)
void	operator delete (void *ptr) throw ()
void	operator delete[] (void *ptr) throw ()
void	operator delete (void *memory, void *ptr) throw ()
void *	operator new (size_t size, const std::nothrow_t &) throw ()
void	operator delete (void *ptr, const std::nothrow_t &) throw ()
void	render_dl () const MRPT_OVERRIDE
	Render. More...
void	getBoundingBox (mrpt::math::TPoint3D &bb_min, mrpt::math::TPoint3D &bb_max) const MRPT_OVERRIDE
	Evaluates the bounding box of this object (including possible children) in the coordinate frame of the object parent. More...
bool	traceRay (const mrpt::poses::CPose3D &o, double &dist) const MRPT_OVERRIDE
	Ray tracing. More...
void	setLineWidth (float width)
float	getLineWidth () const
void	setWireframe (bool is_wireframe=true)
bool	isWireframe () const
void	enableBoxBorder (bool drawBorder=true)
bool	isBoxBorderEnabled () const
void	setBoxBorderColor (const mrpt::utils::TColor &c)
mrpt::utils::TColor	getBoxBorderColor () const
void	setBoxCorners (const mrpt::math::TPoint3D &corner1, const mrpt::math::TPoint3D &corner2)
	Set the position and size of the box, from two corners in 3D. More...
void	getBoxCorners (mrpt::math::TPoint3D &corner1, mrpt::math::TPoint3D &corner2) const
CRenderizableDisplayList *	clone () const
	Interface for the smart pointer class. More...
void	render () const MRPT_OVERRIDE
	Render the object, regenerating the display list if needed, otherwise just calling it. 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...
Changes the appearance of the object to render (methods from CRenderizable that need to be redefined)
CRenderizable &	setColorR_u8 (const uint8_t r) MRPT_OVERRIDE
	Color components in the range [0,255]. More...
CRenderizable &	setColorG_u8 (const uint8_t g) MRPT_OVERRIDE
	Color components in the range [0,255]. More...
CRenderizable &	setColorB_u8 (const uint8_t b) MRPT_OVERRIDE
	Color components in the range [0,255]. More...
CRenderizable &	setColorA_u8 (const uint8_t a) MRPT_OVERRIDE
	Color components in the range [0,255]. More...
CRenderizable &	setColor_u8 (const mrpt::utils::TColor &c) MRPT_OVERRIDE
	Changes the default object color. More...
CRenderizable &	setColor_u8 (uint8_t R, uint8_t G, uint8_t B, uint8_t A=255)
	Color components in the range [0,255]. More...
Changes the appearance of the object to render
void	setName (const std::string &n)
	Changes the name of the object. More...
const std::string &	getName () const
	Returns the name of the object. More...
bool	isVisible () const
	Is the object visible? More...
void	setVisibility (bool visible=true)
	Set object visibility (default=true) More...
void	enableShowName (bool showName=true)
	Enables or disables showing the name of the object as a label when rendering. More...
bool	isShowNameEnabled () const
CRenderizable &	setPose (const mrpt::poses::CPose3D &o)
	Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...
CRenderizable &	setPose (const mrpt::poses::CPose2D &o)
	Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...
CRenderizable &	setPose (const mrpt::math::TPose3D &o)
	Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this) More...
CRenderizable &	setPose (const mrpt::math::TPose2D &o)
	Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this) More...
CRenderizable &	setPose (const mrpt::poses::CPoint3D &o)
	Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...
CRenderizable &	setPose (const mrpt::poses::CPoint2D &o)
	Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...
mrpt::math::TPose3D	getPose () const
	Returns the 3D pose of the object as TPose3D. More...
const mrpt::poses::CPose3D &	getPoseRef () const
	Returns a const ref to the 3D pose of the object as mrpt::poses::CPose3D (which explicitly contains the 3x3 rotation matrix) More...
CRenderizable &	setLocation (double x, double y, double z)
	Changes the location of the object, keeping untouched the orientation. More...
CRenderizable &	setLocation (const mrpt::math::TPoint3D &p)
	Changes the location of the object, keeping untouched the orientation. More...
double	getPoseX () const
	Translation relative to parent coordinate origin. More...
double	getPoseY () const
	Translation relative to parent coordinate origin. More...
double	getPoseZ () const
	Translation relative to parent coordinate origin. More...
double	getPoseYaw () const
	Rotation relative to parent coordinate origin, in DEGREES. More...
double	getPosePitch () const
	Rotation relative to parent coordinate origin, in DEGREES. More...
double	getPoseRoll () const
	Rotation relative to parent coordinate origin, in DEGREES. More...
double	getPoseYawRad () const
	Rotation relative to parent coordinate origin, in radians. More...
double	getPosePitchRad () const
	Rotation relative to parent coordinate origin, in radians. More...
double	getPoseRollRad () const
	Rotation relative to parent coordinate origin, in radians. More...
double	getColorR () const
	Color components in the range [0,1]. More...
double	getColorG () const
	Color components in the range [0,1]. More...
double	getColorB () const
	Color components in the range [0,1]. More...
double	getColorA () const
	Color components in the range [0,1]. More...
uint8_t	getColorR_u8 () const
	Color components in the range [0,255]. More...
uint8_t	getColorG_u8 () const
	Color components in the range [0,255]. More...
uint8_t	getColorB_u8 () const
	Color components in the range [0,255]. More...
uint8_t	getColorA_u8 () const
	Color components in the range [0,255]. More...
CRenderizable &	setColorR (const double r)
	Color components in the range [0,1]. More...
CRenderizable &	setColorG (const double g)
	Color components in the range [0,1]. More...
CRenderizable &	setColorB (const double b)
	Color components in the range [0,1]. More...
CRenderizable &	setColorA (const double a)
	Color components in the range [0,1]. More...
CRenderizable &	setScale (float s)
	Scale to apply to the object, in all three axes (default=1) More...
CRenderizable &	setScale (float sx, float sy, float sz)
	Scale to apply to the object in each axis (default=1) More...
float	getScaleX () const
	Get the current scaling factor in one axis. More...
float	getScaleY () const
	Get the current scaling factor in one axis. More...
float	getScaleZ () const
	Get the current scaling factor in one axis. More...
mrpt::utils::TColorf	getColor () const
	Returns the object color property as a TColorf. More...
CRenderizable &	setColor (const mrpt::utils::TColorf &c)
CRenderizable &	setColor (double R, double G, double B, double A=1)
	Set the color components of this object (R,G,B,Alpha, in the range 0-1) More...
const mrpt::utils::TColor &	getColor_u8 () const
	Returns the object color property as a TColor. More...
RTTI classes and functions
mrpt::utils::CObjectPtr	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)
static CBoxPtr	Create (const mrpt::math::TPoint3D &corner1, const mrpt::math::TPoint3D &corner2, bool is_wireframe=false, float lineWidth=1.0)
	Constructor returning a smart pointer to the newly created object. More...
static void	renderTextBitmap (const char *str, void *fontStyle)
	This method is safe for calling from within ::render() methods. More...
static void	renderTextBitmap (int screen_x, int screen_y, const std::string &str, float color_r=1, float color_g=1, float color_b=1, mrpt::opengl::TOpenGLFont font=mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24)
	Render a text message in the current rendering context, creating a glViewport in the way (do not call within ::render() methods) More...
static int	textBitmapWidth (const std::string &str, mrpt::opengl::TOpenGLFont font=mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24)
	Return the exact width in pixels for a given string, as will be rendered by renderTextBitmap(). More...

Static Public Attributes
static const mrpt::utils::TRuntimeClassId	classCObject
RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCRenderizableDisplayList
RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCRenderizable
RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable

Protected Member Functions
void	writeToStreamRender (utils::CStream &out) const
CSerializable virtual methods
void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const
	Introduces a pure virtual method responsible for writing to a CStream. More...
void	readFromStream (mrpt::utils::CStream &in, int version)
	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...
Methods accesible or implemented by derived classes
EIGEN_STRONG_INLINE void	notifyChange () const
	Must be called to notify that the object has changed (so, the display list must be updated) More...
virtual bool	should_skip_display_list_cache () const
	Optional: If the object has some state in which creating a display list is NOT preferred over direct rendering, implement this method and return "true" in those cases. More...
void	readFromStreamRender (mrpt::utils::CStream &in)

Static Protected Member Functions
static void	checkOpenGLError ()
	Checks glGetError and throws an exception if an error situation is found. More...
static unsigned int	getNewTextureNumber ()
	Returns the lowest next free texture name (avoid using OpenGL's own function since we may call them from different threads and seem it's not cool). More...
static void	releaseTextureName (unsigned int i)

Protected Attributes
mrpt::math::TPoint3D	m_corner_min
mrpt::math::TPoint3D	m_corner_max
	Corners coordinates. More...
bool	m_wireframe
	true: wireframe, false: solid More...
float	m_lineWidth
	For wireframe only. More...
bool	m_draw_border
	Draw line borders to solid box with the given linewidth (default: true) More...
mrpt::utils::TColor	m_solidborder_color
	Color of the solid box borders. More...
std::string	m_name
bool	m_show_name
mrpt::utils::TColor	m_color
	Color components in the range [0,255]. More...
mrpt::poses::CPose3D	m_pose
	6D pose wrt the parent coordinate reference. This class automatically holds the cached 3x3 rotation matrix for quick load into opengl stack. More...
float	m_scale_x
float	m_scale_y
float	m_scale_z
	Scale components to apply to the object (default=1) More...
bool	m_visible
	Is the object visible? (default=true) More...

Private Member Functions
	CBox ()
	Basic empty constructor. More...
	CBox (const mrpt::math::TPoint3D &corner1, const mrpt::math::TPoint3D &corner2, bool is_wireframe=false, float lineWidth=1.0)
	Constructor with all the parameters. More...
virtual	~CBox ()
	Destructor. More...

RTTI stuff
typedef CBoxPtr	Ptr
typedef CBoxPtr	ConstPtr
static mrpt::utils::CLASSINIT	_init_CBox
static mrpt::utils::TRuntimeClassId	classCBox
static const mrpt::utils::TRuntimeClassId *	classinfo
static const mrpt::utils::TRuntimeClassId *	_GetBaseClass ()
virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const
	Returns information about the class of an object in runtime. More...
virtual mrpt::utils::CObject *	duplicate () const
	Returns a copy of the object, indepently of its class. More...
static mrpt::utils::CObject *	CreateObject ()
static CBoxPtr	Create ()

Member Typedef Documentation

ConstPtr

typedef CBoxPtr mrpt::opengl::CBox::ConstPtr

Definition at line 38 of file CBox.h.

Ptr

typedef CBoxPtr mrpt::opengl::CBox::Ptr

A typedef for the associated smart pointer

Definition at line 38 of file CBox.h.

Constructor & Destructor Documentation

CBox() [1/2]

CBox::CBox ( )

private

Basic empty constructor.

Set all parameters to default.

Definition at line 30 of file CBox.cpp.

CBox() [2/2]

CBox::CBox ( const mrpt::math::TPoint3D &  corner1, const mrpt::math::TPoint3D &  corner2, bool  is_wireframe = false, float  lineWidth = 1.0  )

private

Constructor with all the parameters.

Definition at line 40 of file CBox.cpp.

References setBoxCorners().

~CBox()

virtual mrpt::opengl::CBox::~CBox ( )

inlineprivatevirtual

Destructor.

Definition at line 90 of file CBox.h.

Member Function Documentation

_GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::opengl::CBox::_GetBaseClass ( )

staticprotected

checkOpenGLError()

void CRenderizable::checkOpenGLError ( )

staticprotectedinherited

Checks glGetError and throws an exception if an error situation is found.

Definition at line 277 of file CRenderizable.cpp.

References mrpt::opengl::gl_utils::checkOpenGLError().

Referenced by mrpt::opengl::CTexturedObject::loadTextureInOpenGL(), mrpt::opengl::COpenGLViewport::render(), render_dl(), mrpt::opengl::CSimpleLine::render_dl(), mrpt::opengl::CGridPlaneXY::render_dl(), mrpt::opengl::CGridPlaneXZ::render_dl(), mrpt::opengl::CSetOfLines::render_dl(), mrpt::opengl::CVectorField2D::render_dl(), mrpt::opengl::CVectorField3D::render_dl(), mrpt::opengl::CTexturedObject::render_post(), mrpt::opengl::CTexturedObject::render_pre(), and mrpt::opengl::CTexturedPlane::render_texturedobj().

clone()

CRenderizableDisplayList* mrpt::opengl::CRenderizableDisplayList::clone ( ) const

inlineinherited

Interface for the smart pointer class.

Definition at line 71 of file CRenderizableDisplayList.h.

Create() [1/2]

static CBoxPtr mrpt::opengl::CBox::Create ( )

static

Referenced by mrpt::opengl::COctreePointRenderer< CPointCloudColoured >::octree_get_graphics_boundingboxes().

Create() [2/2]

CBoxPtr CBox::Create ( const mrpt::math::TPoint3D &  corner1, const mrpt::math::TPoint3D &  corner2, bool  is_wireframe = false, float  lineWidth = 1.0  )

static

Constructor returning a smart pointer to the newly created object.

Definition at line 26 of file CBox.cpp.

CreateObject()

static mrpt::utils::CObject* mrpt::opengl::CBox::CreateObject ( )

static

duplicate()

virtual mrpt::utils::CObject* mrpt::opengl::CBox::duplicate ( ) const

virtual

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

duplicateGetSmartPtr()

mrpt::utils::CObjectPtr 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 162 of file CObject.h.

References mrpt::utils::CObjectPtr.

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

enableBoxBorder()

void mrpt::opengl::CBox::enableBoxBorder ( bool  drawBorder = true )

inline

Definition at line 71 of file CBox.h.

References mrpt::opengl::CRenderizableDisplayList::notifyChange().

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 69 of file CRenderizable.h.

getBoundingBox()

void CBox::getBoundingBox ( mrpt::math::TPoint3D &  bb_min, mrpt::math::TPoint3D &  bb_max  ) const

virtual

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 270 of file CBox.cpp.

References mrpt::poses::CPose3D::composePoint(), m_corner_max, m_corner_min, and mrpt::opengl::CRenderizable::m_pose.

getBoxBorderColor()

mrpt::utils::TColor mrpt::opengl::CBox::getBoxBorderColor ( ) const

inline

Definition at line 75 of file CBox.h.

getBoxCorners()

void mrpt::opengl::CBox::getBoxCorners ( mrpt::math::TPoint3D &  corner1, mrpt::math::TPoint3D &  corner2  ) const

inline

Definition at line 79 of file CBox.h.

getColor()

mrpt::utils::TColorf mrpt::opengl::CRenderizable::getColor ( ) const

inlineinherited

Returns the object color property as a TColorf.

Definition at line 126 of file CRenderizable.h.

Referenced by mrpt::maps::COctoMap::getAsOctoMapVoxels(), and mrpt::maps::CColouredOctoMap::getAsOctoMapVoxels().

getColor_u8()

const mrpt::utils::TColor& mrpt::opengl::CRenderizable::getColor_u8 ( ) const

inlineinherited

Returns the object color property as a TColor.

Definition at line 135 of file CRenderizable.h.

getColorA()

double mrpt::opengl::CRenderizable::getColorA ( ) const

inlineinherited

Color components in the range [0,1].

Definition at line 102 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

getColorA_u8()

uint8_t mrpt::opengl::CRenderizable::getColorA_u8 ( ) const

inlineinherited

Color components in the range [0,255].

Definition at line 107 of file CRenderizable.h.

getColorB()

double mrpt::opengl::CRenderizable::getColorB ( ) const

inlineinherited

Color components in the range [0,1].

Definition at line 101 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

getColorB_u8()

uint8_t mrpt::opengl::CRenderizable::getColorB_u8 ( ) const

inlineinherited

Color components in the range [0,255].

Definition at line 106 of file CRenderizable.h.

getColorG()

double mrpt::opengl::CRenderizable::getColorG ( ) const

inlineinherited

Color components in the range [0,1].

Definition at line 100 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

getColorG_u8()

uint8_t mrpt::opengl::CRenderizable::getColorG_u8 ( ) const

inlineinherited

Color components in the range [0,255].

Definition at line 105 of file CRenderizable.h.

getColorR()

double mrpt::opengl::CRenderizable::getColorR ( ) const

inlineinherited

Color components in the range [0,1].

Definition at line 99 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

getColorR_u8()

uint8_t mrpt::opengl::CRenderizable::getColorR_u8 ( ) const

inlineinherited

Color components in the range [0,255].

Definition at line 104 of file CRenderizable.h.

getLineWidth()

float mrpt::opengl::CBox::getLineWidth ( ) const

inline

Definition at line 66 of file CBox.h.

getName()

const std::string& mrpt::opengl::CRenderizable::getName ( ) const

inlineinherited

Returns the name of the object.

Definition at line 64 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

getNewTextureNumber()

unsigned int CRenderizable::getNewTextureNumber ( )

staticprotectedinherited

Returns the lowest next free texture name (avoid using OpenGL's own function since we may call them from different threads and seem it's not cool).

Returns the lowest, free texture name.

Definition at line 77 of file CRenderizable.cpp.

References TOpenGLNameBooker::instance(), MAX_GL_TEXTURE_IDS, MAX_GL_TEXTURE_IDS_MASK, MRPT_END, MRPT_START, and THROW_EXCEPTION_FMT.

Referenced by mrpt::opengl::CTexturedObject::loadTextureInOpenGL().

getPose()

mrpt::math::TPose3D CRenderizable::getPose ( ) const

inherited

Returns the 3D pose of the object as TPose3D.

Definition at line 321 of file CRenderizable.cpp.

References mrpt::opengl::CRenderizable::m_pose.

getPosePitch()

double mrpt::opengl::CRenderizable::getPosePitch ( ) const

inlineinherited

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 93 of file CRenderizable.h.

References mrpt::mrpt::utils::RAD2DEG().

getPosePitchRad()

double mrpt::opengl::CRenderizable::getPosePitchRad ( ) const

inlineinherited

Rotation relative to parent coordinate origin, in radians.

Definition at line 96 of file CRenderizable.h.

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 81 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

getPoseRoll()

double mrpt::opengl::CRenderizable::getPoseRoll ( ) const

inlineinherited

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 94 of file CRenderizable.h.

References mrpt::mrpt::utils::RAD2DEG().

getPoseRollRad()

double mrpt::opengl::CRenderizable::getPoseRollRad ( ) const

inlineinherited

Rotation relative to parent coordinate origin, in radians.

Definition at line 97 of file CRenderizable.h.

getPoseX()

double mrpt::opengl::CRenderizable::getPoseX ( ) const

inlineinherited

Translation relative to parent coordinate origin.

Definition at line 89 of file CRenderizable.h.

getPoseY()

double mrpt::opengl::CRenderizable::getPoseY ( ) const

inlineinherited

Translation relative to parent coordinate origin.

Definition at line 90 of file CRenderizable.h.

getPoseYaw()

double mrpt::opengl::CRenderizable::getPoseYaw ( ) const

inlineinherited

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 92 of file CRenderizable.h.

References mrpt::mrpt::utils::RAD2DEG().

getPoseYawRad()

double mrpt::opengl::CRenderizable::getPoseYawRad ( ) const

inlineinherited

Rotation relative to parent coordinate origin, in radians.

Definition at line 95 of file CRenderizable.h.

getPoseZ()

double mrpt::opengl::CRenderizable::getPoseZ ( ) const

inlineinherited

Translation relative to parent coordinate origin.

Definition at line 91 of file CRenderizable.h.

GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::opengl::CBox::GetRuntimeClass ( ) const

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::opengl::CRenderizableDisplayList.

getScaleX()

float mrpt::opengl::CRenderizable::getScaleX ( ) const

inlineinherited

Get the current scaling factor in one axis.

Definition at line 121 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

getScaleY()

float mrpt::opengl::CRenderizable::getScaleY ( ) const

inlineinherited

Get the current scaling factor in one axis.

Definition at line 122 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

getScaleZ()

float mrpt::opengl::CRenderizable::getScaleZ ( ) const

inlineinherited

Get the current scaling factor in one axis.

Definition at line 123 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

isBoxBorderEnabled()

bool mrpt::opengl::CBox::isBoxBorderEnabled ( ) const

inline

Definition at line 72 of file CBox.h.

isShowNameEnabled()

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

inlineinherited

See also

enableShowName

Definition at line 70 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

isVisible()

bool mrpt::opengl::CRenderizable::isVisible ( ) const

inlineinherited

Is the object visible?

See also

setVisibility

Definition at line 66 of file CRenderizable.h.

Referenced by mrpt::opengl::gl_utils::renderSetOfObjects().

isWireframe()

bool mrpt::opengl::CBox::isWireframe ( ) const

inline

Definition at line 69 of file CBox.h.

notifyChange()

EIGEN_STRONG_INLINE void mrpt::opengl::CRenderizableDisplayList::notifyChange ( ) const

inlineprotectedinherited

Must be called to notify that the object has changed (so, the display list must be updated)

Definition at line 49 of file CRenderizableDisplayList.h.

Referenced by mrpt::opengl::CGeneralizedCylinder::addVisibleSectionAtEnd(), mrpt::opengl::CGeneralizedCylinder::addVisibleSectionAtStart(), mrpt::opengl::CMeshFast::adjustGridToImageAR(), mrpt::opengl::CMesh::adjustGridToImageAR(), mrpt::opengl::CVectorField2D::adjustVectorFieldToGrid(), mrpt::opengl::CSetOfLines::appendLine(), mrpt::opengl::CSetOfLines::appendLines(), mrpt::opengl::CTexturedObject::assignImage(), mrpt::opengl::CMeshFast::assignImage(), mrpt::opengl::CMesh::assignImage(), mrpt::opengl::CTexturedObject::assignImage_fast(), mrpt::opengl::CMeshFast::assignImageAndZ(), mrpt::opengl::CMesh::assignImageAndZ(), mrpt::opengl::CSetOfLines::begin(), mrpt::opengl::CSetOfLines::clear(), mrpt::opengl::C3DSScene::clear(), mrpt::opengl::CVectorField2D::clear(), mrpt::opengl::CAssimpModel::clear(), mrpt::opengl::CVectorField3D::clear(), mrpt::opengl::CPlanarLaserScan::clear(), mrpt::opengl::COctoMapVoxels::clear(), mrpt::opengl::CSetOfTexturedTriangles::clearTriangles(), mrpt::opengl::CSetOfTriangles::clearTriangles(), mrpt::opengl::COpenGLStandardObject::disable(), mrpt::opengl::COpenGLStandardObject::enable(), mrpt::opengl::CSimpleLine::enableAntiAliasing(), mrpt::opengl::CGridPlaneXY::enableAntiAliasing(), mrpt::opengl::CGridPlaneXZ::enableAntiAliasing(), mrpt::opengl::CMesh3D::enableAntiAliasing(), mrpt::opengl::CVectorField2D::enableAntiAliasing(), mrpt::opengl::CSetOfLines::enableAntiAliasing(), mrpt::opengl::CVectorField3D::enableAntiAliasing(), enableBoxBorder(), mrpt::opengl::CVectorField3D::enableColorFromModule(), mrpt::opengl::CMesh::enableColorFromZ(), mrpt::opengl::CMeshFast::enableColorFromZ(), mrpt::opengl::COctoMapVoxels::enableCubeTransparency(), mrpt::opengl::CColorBar::enableDepthTest(), mrpt::opengl::CEllipsoid::enableDrawSolid3D(), mrpt::opengl::C3DSScene::enableExtraAmbientLight(), mrpt::opengl::CMesh3D::enableFaceNormals(), mrpt::opengl::COctoMapVoxels::enableLights(), mrpt::opengl::CPlanarLaserScan::enableLine(), mrpt::opengl::CPlanarLaserScan::enablePoints(), mrpt::opengl::CSphere::enableRadiusIndependentOfEyeDistance(), 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::CMesh3D::enableTransparency(), mrpt::opengl::CMesh::enableTransparency(), mrpt::opengl::CMeshFast::enableTransparency(), mrpt::opengl::CSetOfTriangles::enableTransparency(), mrpt::opengl::CAngularObservationMesh::enableTransparency(), mrpt::opengl::CMesh::enableWireFrame(), mrpt::opengl::CSetOfLines::end(), mrpt::opengl::C3DSScene::evaluateAnimation(), mrpt::opengl::COctoMapVoxels::getGridCubeRef(), mrpt::opengl::CSetOfTexturedTriangles::getTriangle(), mrpt::opengl::COctoMapVoxels::getVoxel(), mrpt::opengl::COctoMapVoxels::getVoxelRef(), mrpt::opengl::CSetOfTexturedTriangles::insertTriangle(), mrpt::opengl::CSetOfTriangles::insertTriangle(), mrpt::opengl::CSetOfTriangles::insertTriangles(), mrpt::opengl::C3DSScene::loadFrom3DSFile(), mrpt::opengl::CMesh3D::loadMesh(), mrpt::opengl::CAssimpModel::loadScene(), mrpt::opengl::COctoMapVoxels::push_back_GridCube(), mrpt::opengl::COctoMapVoxels::push_back_Voxel(), mrpt::opengl::COpenGLStandardObject::readFromStream(), mrpt::opengl::CSimpleLine::readFromStream(), mrpt::opengl::CTexturedPlane::readFromStream(), mrpt::opengl::CCylinder::readFromStream(), mrpt::opengl::C3DSScene::readFromStream(), mrpt::opengl::CSetOfTriangles::readFromStream(), mrpt::opengl::CColorBar::readFromStream(), mrpt::opengl::CArrow::readFromStream(), mrpt::opengl::CAxis::readFromStream(), mrpt::opengl::CDisk::readFromStream(), mrpt::opengl::CSphere::readFromStream(), mrpt::opengl::CGridPlaneXY::readFromStream(), mrpt::opengl::CGridPlaneXZ::readFromStream(), mrpt::opengl::CSetOfLines::readFromStream(), readFromStream(), mrpt::opengl::CVectorField2D::readFromStream(), mrpt::opengl::CMesh::readFromStream(), mrpt::opengl::CEllipsoidRangeBearing2D::readFromStream(), mrpt::opengl::CMeshFast::readFromStream(), mrpt::opengl::CAssimpModel::readFromStream(), mrpt::opengl::CEllipsoid::readFromStream(), mrpt::opengl::CText3D::readFromStream(), mrpt::opengl::CEllipsoidInverseDepth2D::readFromStream(), mrpt::opengl::CVectorField3D::readFromStream(), mrpt::opengl::CEllipsoidInverseDepth3D::readFromStream(), mrpt::opengl::CFrustum::readFromStream(), mrpt::opengl::COctoMapVoxels::readFromStream(), mrpt::opengl::CTexturedObject::readFromStreamTexturedObject(), mrpt::opengl::CSetOfTriangles::reserve(), mrpt::opengl::CSetOfLines::reserve(), mrpt::opengl::COctoMapVoxels::reserveVoxels(), 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::CEllipsoid::set2DsegmentsCount(), mrpt::opengl::CEllipsoid::set3DsegmentsCount(), mrpt::opengl::CGeneralizedCylinder::setAllSectionsInvisible(), mrpt::opengl::CGeneralizedCylinder::setAllSectionsVisible(), mrpt::opengl::CArrow::setArrowEnds(), mrpt::opengl::CArrow::setArrowYawPitchRoll(), mrpt::opengl::CGeneralizedCylinder::setAxis(), mrpt::opengl::CAxis::setAxisLimits(), setBoxBorderColor(), setBoxCorners(), mrpt::opengl::CGeneralizedCylinder::setClosed(), 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::CEllipsoid::setCovMatrix(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::setCovMatrixAndMean(), mrpt::opengl::CDisk::setDiskRadius(), mrpt::opengl::COpenGLStandardObject::setFlags(), mrpt::opengl::CText3D::setFont(), mrpt::opengl::CAxis::setFrequency(), mrpt::opengl::CGeneralizedCylinder::setGeneratrix(), mrpt::opengl::CVectorField2D::setGridCenterAndCellSize(), mrpt::opengl::CGridPlaneXZ::setGridFrequency(), mrpt::opengl::CGridPlaneXY::setGridFrequency(), mrpt::opengl::CMesh::setGridLimits(), mrpt::opengl::CMeshFast::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::CSimpleLine::setLineWidth(), mrpt::opengl::CGridPlaneXZ::setLineWidth(), mrpt::opengl::CGridPlaneXY::setLineWidth(), mrpt::opengl::CAxis::setLineWidth(), mrpt::opengl::CSetOfLines::setLineWidth(), mrpt::opengl::CFrustum::setLineWidth(), setLineWidth(), mrpt::opengl::CEllipsoid::setLineWidth(), mrpt::opengl::CVectorField2D::setLineWidth(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::setLineWidth(), mrpt::opengl::CVectorField3D::setLineWidth(), mrpt::opengl::CDisk::setLoopsCount(), mrpt::opengl::CMesh::setMask(), mrpt::opengl::CVectorField3D::setMaxSpeedForColor(), mrpt::opengl::CVectorField3D::setMotionFieldColormap(), mrpt::opengl::CFrustum::setNearFarPlanes(), mrpt::opengl::COpenGLStandardObject::setNormal(), mrpt::opengl::CSphere::setNumberDivsLatitude(), mrpt::opengl::CSphere::setNumberDivsLongitude(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::setNumberOfSegments(), mrpt::opengl::CFrustum::setPlaneColor(), mrpt::opengl::CTexturedPlane::setPlaneCorners(), mrpt::opengl::CGridPlaneXY::setPlaneLimits(), mrpt::opengl::CGridPlaneXZ::setPlaneLimits(), mrpt::opengl::CGridPlaneXZ::setPlaneYcoord(), mrpt::opengl::CGridPlaneXY::setPlaneZcoord(), mrpt::opengl::CVectorField2D::setPointColor(), mrpt::opengl::CVectorField3D::setPointColor(), mrpt::opengl::CVectorField3D::setPointCoordinates(), mrpt::opengl::CVectorField2D::setPointSize(), mrpt::opengl::CVectorField3D::setPointSize(), mrpt::opengl::CEllipsoid::setQuantiles(), 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::CCylinder::setSlicesCount(), mrpt::opengl::CArrow::setSmallRadius(), mrpt::opengl::CCylinder::setStacksCount(), mrpt::opengl::CText3D::setString(), mrpt::opengl::CText3D::setTextKerning(), mrpt::opengl::CAxis::setTextScale(), mrpt::opengl::CText3D::setTextSpacing(), mrpt::opengl::CText3D::setTextStyle(), mrpt::opengl::CTexturedPlane::setTextureCornerCoords(), mrpt::opengl::CMesh::setUV(), 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::CGeneralizedCylinder::setVisibleSections(), mrpt::opengl::COctoMapVoxels::setVisualizationMode(), mrpt::opengl::COctoMapVoxels::setVoxelAsPointsSize(), setWireframe(), mrpt::opengl::CAngularObservationMesh::setWireframe(), mrpt::opengl::CMeshFast::setXBounds(), mrpt::opengl::CMesh::setXBounds(), mrpt::opengl::CMeshFast::setXMax(), mrpt::opengl::CMesh::setXMax(), mrpt::opengl::CMeshFast::setXMin(), mrpt::opengl::CMesh::setXMin(), mrpt::opengl::CMeshFast::setYBounds(), mrpt::opengl::CMesh::setYBounds(), mrpt::opengl::CMeshFast::setYMax(), mrpt::opengl::CMesh::setYMax(), mrpt::opengl::CMeshFast::setYMin(), mrpt::opengl::CMesh::setYMin(), mrpt::opengl::CMesh::setZ(), mrpt::opengl::CMeshFast::setZ(), mrpt::opengl::COctoMapVoxels::showGridLines(), mrpt::opengl::COctoMapVoxels::showVoxels(), mrpt::opengl::COctoMapVoxels::showVoxelsAsPoints(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::thisclass_readFromStream(), mrpt::opengl::CMesh::updateColorsMatrix(), mrpt::opengl::CMeshFast::updateColorsMatrix(), mrpt::opengl::CMeshFast::updatePoints(), mrpt::opengl::CMesh::updatePolygons(), mrpt::opengl::CSetOfTriangles::updatePolygons(), and mrpt::opengl::CMesh::updateTriangles().

operator delete() [1/3]

void mrpt::opengl::CBox::operator delete ( void *  ptr ) throw ( )

inline

Definition at line 38 of file CBox.h.

operator delete() [2/3]

void mrpt::opengl::CBox::operator delete ( void *  memory, void *  ptr  ) throw ( )

inline

Definition at line 38 of file CBox.h.

operator delete() [3/3]

void mrpt::opengl::CBox::operator delete ( void *  ptr, const std::nothrow_t &    ) throw ( )

inline

Definition at line 38 of file CBox.h.

operator delete[]()

void mrpt::opengl::CBox::operator delete[] ( void *  ptr ) throw ( )

inline

Definition at line 38 of file CBox.h.

operator new() [1/3]

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

inlinestatic

Definition at line 38 of file CBox.h.

operator new() [2/3]

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

inline

Definition at line 38 of file CBox.h.

operator new() [3/3]

void* mrpt::opengl::CBox::operator new ( size_t  size )

inline

Definition at line 38 of file CBox.h.

operator new[]()

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

inline

Definition at line 38 of file CBox.h.

readFromStream()

void CBox::readFromStream ( mrpt::utils::CStream &  in, int  version  )

protectedvirtual

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.

Parameters

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.

Exceptions

std::exception

On any error, see CStream::ReadBuffer

See also

CStream

Implements mrpt::utils::CSerializable.

Definition at line 224 of file CBox.cpp.

References m_corner_max, m_corner_min, m_draw_border, m_lineWidth, m_solidborder_color, m_wireframe, MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, mrpt::opengl::CRenderizableDisplayList::notifyChange(), mrpt::opengl::CRenderizableDisplayList::readFromStreamRender(), version, mrpt::math::TPoint3D::x, mrpt::math::TPoint3D::y, and mrpt::math::TPoint3D::z.

readFromStreamRender()

void mrpt::opengl::CRenderizableDisplayList::readFromStreamRender ( mrpt::utils::CStream &  in )

inlineprotectedinherited

Definition at line 58 of file CRenderizableDisplayList.h.

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

Referenced by mrpt::opengl::CSimpleLine::readFromStream(), mrpt::opengl::CTexturedPlane::readFromStream(), mrpt::opengl::CGridPlaneXY::readFromStream(), mrpt::opengl::CGridPlaneXZ::readFromStream(), mrpt::opengl::CSetOfLines::readFromStream(), mrpt::opengl::CVectorField2D::readFromStream(), readFromStream(), mrpt::opengl::CText3D::readFromStream(), mrpt::opengl::CVectorField3D::readFromStream(), and mrpt::opengl::CFrustum::readFromStream().

releaseTextureName()

void CRenderizable::releaseTextureName ( unsigned int  i )

staticprotectedinherited

Definition at line 102 of file CRenderizable.cpp.

References TOpenGLNameBooker::cs, TOpenGLNameBooker::freeTextureNames, TOpenGLNameBooker::instance(), and TOpenGLNameBooker::next_free_texture.

Referenced by mrpt::opengl::CTexturedObject::unloadTexture().

render()

void CRenderizableDisplayList::render ( ) const

virtualinherited

Render the object, regenerating the display list if needed, otherwise just calling it.

Implements mrpt::opengl::CRenderizable.

Definition at line 81 of file CRenderizableDisplayList.cpp.

References TAuxDLData::getSingleton(), GL_COMPILE, GL_NO_ERROR, glCallList(), glDeleteLists(), glEndList(), glGenLists(), glGetError(), glNewList(), INVALID_DISPLAY_LIST_ID, mrpt::opengl::CRenderizableDisplayList::m_dl, mrpt::opengl::CRenderizableDisplayList::m_dl_recreate, mrpt::opengl::CRenderizableDisplayList::render_dl(), and mrpt::opengl::CRenderizableDisplayList::should_skip_display_list_cache().

render_dl()

void CBox::render_dl ( ) const

virtual

Render.

See also

mrpt::opengl::CRenderizable

Implements mrpt::opengl::CRenderizableDisplayList.

Definition at line 52 of file CBox.cpp.

References mrpt::utils::TColor::A, mrpt::utils::TColor::B, mrpt::opengl::CRenderizable::checkOpenGLError(), mrpt::utils::TColor::G, GL_BLEND, GL_DEPTH_TEST, GL_LIGHTING, GL_LINE_STRIP, GL_NORMALIZE, GL_ONE_MINUS_SRC_ALPHA, GL_SRC_ALPHA, GL_TRIANGLES, glBegin(), glBlendFunc(), glColor4ub(), glDisable(), glEnable(), glEnd(), glLineWidth(), glVertex3d(), mrpt::opengl::CRenderizable::m_color, m_corner_max, m_corner_min, m_draw_border, m_lineWidth, m_solidborder_color, m_wireframe, mrpt::utils::TColor::R, mrpt::opengl::gl_utils::renderTriangleWithNormal(), mrpt::math::TPoint3D::x, mrpt::math::TPoint3D::y, and mrpt::math::TPoint3D::z.

renderTextBitmap() [1/2]

void CRenderizable::renderTextBitmap ( const char *  str, void *  fontStyle  )

staticinherited

This method is safe for calling from within ::render() methods.

See also

renderTextBitmap, mrpt::opengl::gl_utils

renderTextBitmap

Definition at line 351 of file CRenderizable.cpp.

References mrpt::opengl::gl_utils::renderTextBitmap().

renderTextBitmap() [2/2]

void CRenderizable::renderTextBitmap ( int  screen_x, int  screen_y, const std::string &  str, float  color_r = 1, float  color_g = 1, float  color_b = 1, mrpt::opengl::TOpenGLFont  font = mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24  )

staticinherited

Render a text message in the current rendering context, creating a glViewport in the way (do not call within ::render() methods)

• Coordinates (x,y) are 2D pixels, starting at bottom-left of the viewport. Negative numbers will wrap to the opposite side of the viewport (e.g. x=-10 means 10px fromt the right).
• The text color is defined by (color_r,color_g,color_b), each float numbers in the range [0,1].

  See also

  renderTextBitmap, textBitmapWidth, mrpt::opengl::gl_utils

Definition at line 286 of file gl_utils.cpp.

References aux_mrptfont2glutfont(), GL_DEPTH_TEST, GL_MODELVIEW, GL_PROJECTION, GL_TRANSFORM_BIT, GL_VIEWPORT, GL_VIEWPORT_BIT, glColor3f(), glDisable(), glEnable(), glGetIntegerv(), glLoadIdentity(), glMatrixMode(), glPopAttrib(), glPopMatrix(), glPushAttrib(), glPushMatrix(), glRasterPos3f(), glViewport(), and MRPT_UNUSED_PARAM.

setBoxBorderColor()

void mrpt::opengl::CBox::setBoxBorderColor ( const mrpt::utils::TColor &  c )

inline

Definition at line 74 of file CBox.h.

References mrpt::opengl::CRenderizableDisplayList::notifyChange().

setBoxCorners()

void CBox::setBoxCorners	(	const mrpt::math::TPoint3D &	corner1,
		const mrpt::math::TPoint3D &	corner2
	)

Set the position and size of the box, from two corners in 3D.

Definition at line 248 of file CBox.cpp.

References m_corner_max, m_corner_min, min, mrpt::opengl::CRenderizableDisplayList::notifyChange(), mrpt::math::TPoint3D::x, mrpt::math::TPoint3D::y, and mrpt::math::TPoint3D::z.

Referenced by CBox().

setColor() [1/2]

CRenderizable& mrpt::opengl::CRenderizable::setColor ( const mrpt::utils::TColorf &  c )

inlineinherited

Parameters

c	Changes the default object color

Returns

a ref to this

Definition at line 127 of file CRenderizable.h.

setColor() [2/2]

CRenderizable& mrpt::opengl::CRenderizable::setColor ( double  R, double  G, double  B, double  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 133 of file CRenderizable.h.

References R.

setColor_u8() [1/2]

CRenderizable& mrpt::opengl::CRenderizableDisplayList::setColor_u8 ( const mrpt::utils::TColor &  c )

inlinevirtualinherited

Changes the default object color.

Returns

a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 86 of file CRenderizableDisplayList.h.

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

setColor_u8() [2/2]

CRenderizable& mrpt::opengl::CRenderizableDisplayList::setColor_u8 ( uint8_t  R, uint8_t  G, uint8_t  B, uint8_t  A = 255  )

inlineinherited

Color components in the range [0,255].

Returns

a ref to this

Definition at line 87 of file CRenderizableDisplayList.h.

References R, and mrpt::opengl::CRenderizable::setColor_u8().

setColorA()

CRenderizable& mrpt::opengl::CRenderizable::setColorA ( const double  a )

inlineinherited

Color components in the range [0,1].

Returns

a ref to this

Definition at line 112 of file CRenderizable.h.

setColorA_u8()

CRenderizable& mrpt::opengl::CRenderizableDisplayList::setColorA_u8 ( const uint8_t  a )

inlinevirtualinherited

Color components in the range [0,255].

Returns

a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 85 of file CRenderizableDisplayList.h.

Referenced by mrpt::nav::ClearanceDiagram::renderAs3DObject().

setColorB()

CRenderizable& mrpt::opengl::CRenderizable::setColorB ( const double  b )

inlineinherited

Color components in the range [0,1].

Returns

a ref to this

Definition at line 111 of file CRenderizable.h.

setColorB_u8()

CRenderizable& mrpt::opengl::CRenderizableDisplayList::setColorB_u8 ( const uint8_t  b )

inlinevirtualinherited

Color components in the range [0,255].

Returns

a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 84 of file CRenderizableDisplayList.h.

setColorG()

CRenderizable& mrpt::opengl::CRenderizable::setColorG ( const double  g )

inlineinherited

Color components in the range [0,1].

Returns

a ref to this

Definition at line 110 of file CRenderizable.h.

setColorG_u8()

CRenderizable& mrpt::opengl::CRenderizableDisplayList::setColorG_u8 ( const uint8_t  g )

inlinevirtualinherited

Color components in the range [0,255].

Returns

a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 83 of file CRenderizableDisplayList.h.

setColorR()

CRenderizable& mrpt::opengl::CRenderizable::setColorR ( const double  r )

inlineinherited

Color components in the range [0,1].

Returns

a ref to this

Definition at line 109 of file CRenderizable.h.

setColorR_u8()

CRenderizable& mrpt::opengl::CRenderizableDisplayList::setColorR_u8 ( const uint8_t  r )

inlinevirtualinherited

Color components in the range [0,255].

Returns

a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 82 of file CRenderizableDisplayList.h.

setLineWidth()

void mrpt::opengl::CBox::setLineWidth ( float  width )

inline

Definition at line 65 of file CBox.h.

References mrpt::opengl::CRenderizableDisplayList::notifyChange().

setLocation() [1/2]

CRenderizable& mrpt::opengl::CRenderizable::setLocation ( double  x, double  y, double  z  )

inlineinherited

Changes the location of the object, keeping untouched the orientation.

Returns

a ref to this

Definition at line 84 of file CRenderizable.h.

setLocation() [2/2]

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

inlineinherited

Changes the location of the object, keeping untouched the orientation.

Returns

a ref to this

Definition at line 87 of file CRenderizable.h.

setName()

void mrpt::opengl::CRenderizable::setName ( const std::string &  n )

inlineinherited

Changes the name of the object.

Definition at line 63 of file CRenderizable.h.

setPose() [1/6]

CRenderizable & CRenderizable::setPose ( const mrpt::poses::CPose3D &  o )

inherited

Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)

Definition at line 285 of file CRenderizable.cpp.

References mrpt::opengl::CRenderizable::m_pose.

setPose() [2/6]

CRenderizable & CRenderizable::setPose ( const mrpt::poses::CPose2D &  o )

inherited

Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)

Definition at line 290 of file CRenderizable.cpp.

References mrpt::opengl::CRenderizable::m_pose.

setPose() [3/6]

CRenderizable & CRenderizable::setPose ( const mrpt::math::TPose3D &  o )

inherited

Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this)

Definition at line 295 of file CRenderizable.cpp.

References mrpt::opengl::CRenderizable::m_pose.

setPose() [4/6]

CRenderizable & CRenderizable::setPose ( const mrpt::math::TPose2D &  o )

inherited

Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this)

Definition at line 300 of file CRenderizable.cpp.

References mrpt::opengl::CRenderizable::m_pose.

setPose() [5/6]

CRenderizable & CRenderizable::setPose ( const mrpt::poses::CPoint3D &  o )

inherited

Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)

Parameters

o	Set the 3D pose from a mrpt::poses::CPose3D object

Definition at line 306 of file CRenderizable.cpp.

References mrpt::opengl::CRenderizable::m_pose, mrpt::poses::CPose3D::setFromValues(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::y().

setPose() [6/6]

CRenderizable & CRenderizable::setPose ( const mrpt::poses::CPoint2D &  o )

inherited

Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)

Parameters

o	Set the 3D pose from a mrpt::poses::CPose3D object

Definition at line 311 of file CRenderizable.cpp.

References mrpt::opengl::CRenderizable::m_pose, mrpt::poses::CPose3D::setFromValues(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x(), and mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::y().

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 119 of file CRenderizable.h.

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

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 120 of file CRenderizable.h.

setVisibility()

void mrpt::opengl::CRenderizable::setVisibility ( bool  visible = true )

inlineinherited

Set object visibility (default=true)

See also

isVisible

Definition at line 67 of file CRenderizable.h.

setWireframe()

void mrpt::opengl::CBox::setWireframe ( bool  is_wireframe = true )

inline

Definition at line 68 of file CBox.h.

References mrpt::opengl::CRenderizableDisplayList::notifyChange().

should_skip_display_list_cache()

virtual bool mrpt::opengl::CRenderizableDisplayList::should_skip_display_list_cache ( ) const

inlineprotectedvirtualinherited

Optional: If the object has some state in which creating a display list is NOT preferred over direct rendering, implement this method and return "true" in those cases.

Reimplemented in mrpt::opengl::CSphere.

Definition at line 56 of file CRenderizableDisplayList.h.

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

textBitmapWidth()

int CRenderizable::textBitmapWidth ( const std::string &  str, mrpt::opengl::TOpenGLFont  font = mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24  )

staticinherited

Return the exact width in pixels for a given string, as will be rendered by renderTextBitmap().

See also

renderTextBitmap, mrpt::opengl::gl_utils

renderTextBitmap

Definition at line 359 of file CRenderizable.cpp.

References mrpt::opengl::gl_utils::textBitmapWidth().

traceRay()

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

virtual

Ray tracing.

See also

mrpt::opengl::CRenderizable

Reimplemented from mrpt::opengl::CRenderizable.

Definition at line 263 of file CBox.cpp.

References MRPT_UNUSED_PARAM, and THROW_EXCEPTION.

writeToMatlab()

virtual mxArray* mrpt::utils::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 NULL is class does not support conversion to MATLAB.

Definition at line 79 of file CSerializable.h.

writeToStream()

void CBox::writeToStream ( mrpt::utils::CStream &  out, int *  getVersion  ) const

protectedvirtual

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.

Parameters

out	The output binary stream where object must be dumped.
getVersion	If NULL, 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.

Exceptions

std::exception

On any error, see CStream::WriteBuffer

See also

CStream

Implements mrpt::utils::CSerializable.

Definition at line 206 of file CBox.cpp.

References m_corner_max, m_corner_min, m_draw_border, m_lineWidth, m_solidborder_color, m_wireframe, version, mrpt::opengl::CRenderizable::writeToStreamRender(), mrpt::math::TPoint3D::x, mrpt::math::TPoint3D::y, and mrpt::math::TPoint3D::z.

writeToStreamRender()

void CRenderizable::writeToStreamRender ( utils::CStream &  out ) const

protectedinherited

Definition at line 112 of file CRenderizable.cpp.

References mrpt::utils::TColor::A, mrpt::utils::TColor::B, mrpt::utils::TColor::G, mrpt::opengl::CRenderizable::m_color, mrpt::opengl::CRenderizable::m_name, mrpt::opengl::CRenderizable::m_pose, mrpt::opengl::CRenderizable::m_scale_x, mrpt::opengl::CRenderizable::m_scale_y, mrpt::opengl::CRenderizable::m_scale_z, mrpt::opengl::CRenderizable::m_show_name, mrpt::opengl::CRenderizable::m_visible, mrpt::poses::CPose3D::pitch(), mrpt::utils::TColor::R, mrpt::poses::CPose3D::roll(), mrpt::utils::CStream::WriteBuffer(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::x(), mrpt::poses::CPoseOrPoint< DERIVEDCLASS >::y(), and mrpt::poses::CPose3D::yaw().

Referenced by mrpt::opengl::CSimpleLine::writeToStream(), mrpt::opengl::CTexturedPlane::writeToStream(), mrpt::opengl::CGridPlaneXY::writeToStream(), mrpt::opengl::CGridPlaneXZ::writeToStream(), mrpt::opengl::CSetOfLines::writeToStream(), mrpt::opengl::CVectorField2D::writeToStream(), writeToStream(), mrpt::opengl::CText3D::writeToStream(), mrpt::opengl::CVectorField3D::writeToStream(), and mrpt::opengl::CFrustum::writeToStream().

Member Data Documentation

_init_CBox

mrpt::utils::CLASSINIT mrpt::opengl::CBox::_init_CBox

staticprotected

Definition at line 38 of file CBox.h.

classCBox

mrpt::utils::TRuntimeClassId mrpt::opengl::CBox::classCBox

static

Definition at line 38 of file CBox.h.

classCObject

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject

staticinherited

Definition at line 118 of file CObject.h.

classCRenderizable

const mrpt::utils::TRuntimeClassId mrpt::opengl::CRenderizable::classCRenderizable

staticinherited

Definition at line 46 of file CRenderizable.h.

classCRenderizableDisplayList

const mrpt::utils::TRuntimeClassId mrpt::opengl::CRenderizableDisplayList::classCRenderizableDisplayList

staticinherited

Definition at line 38 of file CRenderizableDisplayList.h.

classCSerializable

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable

staticinherited

Definition at line 42 of file CSerializable.h.

classinfo

const mrpt::utils::TRuntimeClassId* mrpt::opengl::CBox::classinfo

static

Definition at line 38 of file CBox.h.

m_color

mrpt::utils::TColor mrpt::opengl::CRenderizable::m_color

protectedinherited

Color components in the range [0,255].

Definition at line 54 of file CRenderizable.h.

Referenced by mrpt::opengl::CMesh3D::CMesh3D(), mrpt::opengl::CVectorField2D::CVectorField2D(), mrpt::opengl::CVectorField3D::CVectorField3D(), mrpt::opengl::CRenderizable::readFromStreamRender(), render_dl(), mrpt::opengl::CSimpleLine::render_dl(), mrpt::opengl::CText3D::render_dl(), mrpt::opengl::CSetOfLines::render_dl(), mrpt::opengl::CVectorField2D::render_dl(), mrpt::opengl::CVectorField3D::render_dl(), mrpt::opengl::CTexturedObject::render_post(), mrpt::opengl::CTexturedObject::render_pre(), mrpt::opengl::CRenderizable::setColor_u8(), and mrpt::opengl::CRenderizable::writeToStreamRender().

m_corner_max

mrpt::math::TPoint3D mrpt::opengl::CBox::m_corner_max

protected

Corners coordinates.

Definition at line 41 of file CBox.h.

Referenced by getBoundingBox(), readFromStream(), render_dl(), setBoxCorners(), and writeToStream().

m_corner_min

mrpt::math::TPoint3D mrpt::opengl::CBox::m_corner_min

protected

Definition at line 41 of file CBox.h.

Referenced by getBoundingBox(), readFromStream(), render_dl(), setBoxCorners(), and writeToStream().

m_draw_border

bool mrpt::opengl::CBox::m_draw_border

protected

Draw line borders to solid box with the given linewidth (default: true)

Definition at line 44 of file CBox.h.

Referenced by readFromStream(), render_dl(), and writeToStream().

m_lineWidth

float mrpt::opengl::CBox::m_lineWidth

protected

For wireframe only.

Definition at line 43 of file CBox.h.

Referenced by readFromStream(), render_dl(), and writeToStream().

m_name

std::string mrpt::opengl::CRenderizable::m_name

protectedinherited

Definition at line 52 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::readFromStreamRender(), and mrpt::opengl::CRenderizable::writeToStreamRender().

m_pose

mrpt::poses::CPose3D mrpt::opengl::CRenderizable::m_pose

protectedinherited

6D pose wrt the parent coordinate reference. This class automatically holds the cached 3x3 rotation matrix for quick load into opengl stack.

Definition at line 55 of file CRenderizable.h.

Referenced by mrpt::opengl::C3DSScene::getBoundingBox(), mrpt::opengl::CAssimpModel::getBoundingBox(), getBoundingBox(), mrpt::opengl::CSimpleLine::getBoundingBox(), mrpt::opengl::CTexturedPlane::getBoundingBox(), mrpt::opengl::CGridPlaneXY::getBoundingBox(), mrpt::opengl::CGridPlaneXZ::getBoundingBox(), mrpt::opengl::CText3D::getBoundingBox(), mrpt::opengl::CFrustum::getBoundingBox(), mrpt::opengl::CMesh3D::getBoundingBox(), mrpt::opengl::CVectorField2D::getBoundingBox(), mrpt::opengl::CSetOfLines::getBoundingBox(), mrpt::opengl::CVectorField3D::getBoundingBox(), mrpt::opengl::CRenderizable::getPose(), mrpt::opengl::CRenderizable::readFromStreamRender(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::render_dl(), mrpt::opengl::CRenderizable::setPose(), mrpt::opengl::CTexturedPlane::traceRay(), and mrpt::opengl::CRenderizable::writeToStreamRender().

m_scale_x

float mrpt::opengl::CRenderizable::m_scale_x

protectedinherited

Definition at line 56 of file CRenderizable.h.

Referenced by mrpt::opengl::CText3D::getBoundingBox(), mrpt::opengl::CRenderizable::readFromStreamRender(), and mrpt::opengl::CRenderizable::writeToStreamRender().

m_scale_y

float mrpt::opengl::CRenderizable::m_scale_y

protectedinherited

Definition at line 56 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::readFromStreamRender(), and mrpt::opengl::CRenderizable::writeToStreamRender().

m_scale_z

float mrpt::opengl::CRenderizable::m_scale_z

protectedinherited

Scale components to apply to the object (default=1)

Definition at line 56 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::readFromStreamRender(), and mrpt::opengl::CRenderizable::writeToStreamRender().

m_show_name

bool mrpt::opengl::CRenderizable::m_show_name

protectedinherited

Definition at line 53 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::readFromStreamRender(), and mrpt::opengl::CRenderizable::writeToStreamRender().

m_solidborder_color

mrpt::utils::TColor mrpt::opengl::CBox::m_solidborder_color

protected

Color of the solid box borders.

Definition at line 45 of file CBox.h.

Referenced by readFromStream(), render_dl(), and writeToStream().

m_visible

bool mrpt::opengl::CRenderizable::m_visible

protectedinherited

Is the object visible? (default=true)

Definition at line 57 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::readFromStreamRender(), and mrpt::opengl::CRenderizable::writeToStreamRender().

m_wireframe

bool mrpt::opengl::CBox::m_wireframe

protected

true: wireframe, false: solid

Definition at line 42 of file CBox.h.

Referenced by readFromStream(), render_dl(), and writeToStream().