Detailed Description

A 2D plane in the XY plane with a texture image.

See also:: opengl::COpenGLScene

#include <mrpt/opengl/CTexturedPlane.h>

Inheritance diagram for mrpt::opengl::CTexturedPlane:

Public Member Functions
void	setTextureCornerCoords (float tex_x_min, float tex_x_max, float tex_y_min, float tex_y_max)
	Set the texture coordinates of the four corners (in the range 0-1).
void	setPlaneCorners (float xMin, float xMax, float yMin, float yMax)
	Set the coordinates of the four corners that define the plane on the XY plane.
void	getPlaneCorners (float &xMin, float &xMax, float &yMin, float &yMax) const
	Get the coordinates of the four corners that define the plane on the XY plane.
virtual bool	traceRay (const mrpt::poses::CPose3D &o, double &dist) const
	Ray trace.
void	assignImage (const mrpt::utils::CImage &img, const mrpt::utils::CImage &imgAlpha)
	Assigns a texture and a transparency image, and enables transparency (If the images are not 2^N x 2^M, they will be internally filled to its dimensions to be powers of two)
void	assignImage (const mrpt::utils::CImage &img)
	Assigns a texture image, and disable transparency.
void	assignImage_fast (mrpt::utils::CImage &img, mrpt::utils::CImage &imgAlpha)
	Similar to assignImage, but the passed images will be returned as empty: it avoids making a copy of the whole image, just copies a pointer.
void	assignImage_fast (mrpt::utils::CImage &img)
	Similar to assignImage, but the passed images will be returned as empty: it avoids making a copy of the whole image, just copies a pointer.
void	loadTextureInOpenGL () const
	VERY IMPORTANT: If you use a multi-thread application, you MUST call this from the same thread that will later destruct the object in order to the OpenGL texture memory to be correctly deleted.
virtual void	render_dl () const
	Derived classes must implement this method to the render the object.
CRenderizableDisplayList *	clone () const
	Interface for the stlplus smart pointer class.
virtual void	render () const
	Render the object, regenerating the display list if needed, otherwise just calling it.
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).
Changes the appearance of the object to render (methods from CRenderizable that need to be redefined)
virtual CRenderizable &	setColorR_u8 (const uint8_t r)
	Color components in the range [0,255].
virtual CRenderizable &	setColorG_u8 (const uint8_t g)
	Color components in the range [0,255].
virtual CRenderizable &	setColorB_u8 (const uint8_t b)
	Color components in the range [0,255].
virtual CRenderizable &	setColorA_u8 (const uint8_t a)
	Color components in the range [0,255].
virtual CRenderizable &	setColor_u8 (const mrpt::utils::TColor &c)
	Changes the default object color.
Changes the appearance of the object to render
CRenderizable &	setColor_u8 (uint8_t R, uint8_t G, uint8_t B, uint8_t A=255)
	Set the color components of this object (R,G,B,Alpha, in the range 0-1)
void	setName (const std::string &n)
	Changes the name of the object.
const std::string &	getName () const
	Returns the name of the object.
bool	isVisible () const
	Is the object visible?
void	setVisibility (bool visible=true)
	Set object visibility (default=true)
void	enableShowName (bool showName=true)
	Enables or disables showing the name of the object as a label when rendering.
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)
CRenderizable &	setPose (const mrpt::math::TPose3D &o)
	Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this)
CRenderizable &	setPose (const mrpt::poses::CPoint3D &o)
	Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)
CRenderizable &	setPose (const mrpt::poses::CPoint2D &o)
	Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)
mrpt::math::TPose3D	getPose () const
	Returns the 3D pose of the object as TPose3D.
const mrpt::poses::CPose3D &	getPoseRef () const
	Returns a const ref to the 3D pose of the object as CPose3D (which explicitly contains the 3x3 rotation matrix)
CRenderizable &	setLocation (double x, double y, double z)
	Changes the location of the object, keeping untouched the orientation.
CRenderizable &	setLocation (const mrpt::math::TPoint3D &p)
	Changes the location of the object, keeping untouched the orientation.
double	getPoseX () const
	Translation relative to parent coordinate origin.
double	getPoseY () const
	Translation relative to parent coordinate origin.
double	getPoseZ () const
	Translation relative to parent coordinate origin.
double	getPoseYaw () const
	Rotation relative to parent coordinate origin, in DEGREES.
double	getPosePitch () const
	Rotation relative to parent coordinate origin, in DEGREES.
double	getPoseRoll () const
	Rotation relative to parent coordinate origin, in DEGREES.
double	getPoseYawRad () const
	Rotation relative to parent coordinate origin, in radians.
double	getPosePitchRad () const
	Rotation relative to parent coordinate origin, in radians.
double	getPoseRollRad () const
	Rotation relative to parent coordinate origin, in radians.
double	getColorR () const
	Color components in the range [0,1].
double	getColorG () const
	Color components in the range [0,1].
double	getColorB () const
	Color components in the range [0,1].
double	getColorA () const
	Color components in the range [0,1].
uint8_t	getColorR_u8 () const
	Color components in the range [0,255].
uint8_t	getColorG_u8 () const
	Color components in the range [0,255].
uint8_t	getColorB_u8 () const
	Color components in the range [0,255].
uint8_t	getColorA_u8 () const
	Color components in the range [0,255].
CRenderizable &	setColorR (const double r)
	Color components in the range [0,1].
CRenderizable &	setColorG (const double g)
	Color components in the range [0,1].
CRenderizable &	setColorB (const double b)
	Color components in the range [0,1].
CRenderizable &	setColorA (const double a)
	Color components in the range [0,1].
CRenderizable &	setScale (float s)
	Scale to apply to the object, in all three axes (default=1)
CRenderizable &	setScale (float sx, float sy, float sz)
	Scale to apply to the object in each axis (default=1)
float	getScaleX () const
	Get the current scaling factor in one axis.
float	getScaleY () const
	Get the current scaling factor in one axis.
float	getScaleZ () const
	Get the current scaling factor in one axis.
mrpt::utils::TColorf	getColor () const
	Returns the object color property as a TColorf.
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)
const mrpt::utils::TColor &	getColor_u8 () const
	Returns the object color property as a TColor.
Static Public Member Functions
static CTexturedPlanePtr	Create (float x_min, float x_max, float y_min, float y_max)
	Class factory.
static void	renderTextBitmap (const char str, void fontStyle)
	This method is safe for calling from within ::render() methods.
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)
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().
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	updatePoly () const
void	unloadTexture ()
void	render_texturedobj () const
	Must be implemented by derived classes.
virtual void	render_pre () const
virtual void	render_post () const
void	writeToStreamTexturedObject (mrpt::utils::CStream &out) const
void	readFromStreamTexturedObject (mrpt::utils::CStream &in)
void	writeToStreamRender (utils::CStream &out) const
virtual void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const =0
	Introduces a pure virtual method responsible for writing to a CStream.
virtual void	readFromStream (mrpt::utils::CStream &in, int version)=0
	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.
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)
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.
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.
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).
static void	releaseTextureName (unsigned int i)
Protected Attributes
float	m_tex_x_min
float	m_tex_x_max
float	m_tex_y_min
float	m_tex_y_max
float	m_xMin
float	m_xMax
float	m_yMin
float	m_yMax
bool	polygonUpToDate
std::vector < mrpt::math::TPolygonWithPlane >	tmpPoly
	Used for ray-tracing.
unsigned int	m_glTextureName
bool	m_texture_is_loaded
mrpt::utils::CImage	m_textureImage
mrpt::utils::CImage	m_textureImageAlpha
bool	m_enableTransparency
	Of the texture using "m_textureImageAlpha".
int	r_width
int	r_height
	Size of the texture image, rounded up to next power of 2.
int	m_fill_x_left
int	m_fill_y_top
int	m_fill_x_right
int	m_fill_y_bottom
	The size of the fill in pixels in the textured image, w.r.t the image passed by the user.
std::string	m_name
bool	m_show_name
mrpt::utils::TColor	m_color
	Color components in the range [0,255].
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.
float	m_scale_x
float	m_scale_y
float	m_scale_z
	Scale components to apply to the object (default=1)
bool	m_visible
	Is the object visible? (default=true)
Private Member Functions
	CTexturedPlane (float x_min=-1, float x_max=1, float y_min=-1, float y_max=1)
	Constructor.
virtual	~CTexturedPlane ()
	Private, virtual destructor: only can be deleted from smart pointers.
Friends
class	mrpt::opengl::COpenGLViewport
class	mrpt::opengl::CSetOfObjects
RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCTexturedObject
class	mrpt::utils::CStream
RTTI stuff
typedef CTexturedPlanePtr	SmartPtr
static mrpt::utils::CLASSINIT	_init_CTexturedPlane
static mrpt::utils::TRuntimeClassId	classCTexturedPlane
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.
virtual mrpt::utils::CObject *	duplicate () const
	Returns a copy of the object, indepently of its class.
static mrpt::utils::CObject *	CreateObject ()
static CTexturedPlanePtr	Create ()

Member Typedef Documentation

typedef CTexturedPlanePtr mrpt::opengl::CTexturedPlane::SmartPtr

A typedef for the associated smart pointer

Definition at line 48 of file CTexturedPlane.h.

Constructor & Destructor Documentation

mrpt::opengl::CTexturedPlane::CTexturedPlane	(	float	x_min = `-1`,
		float	x_max = `1`,
		float	y_min = `-1`,
		float	y_max = `1`
	)		`[private]`

Constructor.

virtual mrpt::opengl::CTexturedPlane::~CTexturedPlane ( ) [private, virtual]

Private, virtual destructor: only can be deleted from smart pointers.

Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::opengl::CTexturedPlane::_GetBaseClass ( ) [static, protected]

Reimplemented from mrpt::opengl::CTexturedObject.

void mrpt::opengl::CTexturedObject::assignImage	(	const mrpt::utils::CImage &	img,
		const mrpt::utils::CImage &	imgAlpha
	)		`[inherited]`

Assigns a texture and a transparency image, and enables transparency (If the images are not 2^N x 2^M, they will be internally filled to its dimensions to be powers of two)

Note:: Images are copied, the original ones can be deleted.

void mrpt::opengl::CTexturedObject::assignImage ( const mrpt::utils::CImage & img ) [inherited]

Assigns a texture image, and disable transparency.

Note:: Images are copied, the original ones can be deleted.

void mrpt::opengl::CTexturedObject::assignImage_fast	(	mrpt::utils::CImage &	img,
		mrpt::utils::CImage &	imgAlpha
	)		`[inherited]`

Similar to assignImage, but the passed images will be returned as empty: it avoids making a copy of the whole image, just copies a pointer.

void mrpt::opengl::CTexturedObject::assignImage_fast ( mrpt::utils::CImage & img ) [inherited]

Similar to assignImage, but the passed images will be returned as empty: it avoids making a copy of the whole image, just copies a pointer.

static void mrpt::opengl::CRenderizable::checkOpenGLError ( ) [static, protected, inherited]

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

CRenderizableDisplayList* mrpt::opengl::CRenderizableDisplayList::clone ( ) const [inline, inherited]

Interface for the stlplus smart pointer class.

Reimplemented from mrpt::opengl::CRenderizable.

Definition at line 90 of file CRenderizableDisplayList.h.

static CTexturedPlanePtr mrpt::opengl::CTexturedPlane::Create ( ) [static]

static CTexturedPlanePtr mrpt::opengl::CTexturedPlane::Create	(	float	x_min,
		float	x_max,
		float	y_min,
		float	y_max
	)		`[inline, static]`

Class factory.

Definition at line 91 of file CTexturedPlane.h.

References mrpt::opengl::CTexturedPlane.

static mrpt::utils::CObject* mrpt::opengl::CTexturedPlane::CreateObject ( ) [static]

virtual mrpt::utils::CObject* mrpt::opengl::CTexturedPlane::duplicate ( ) const [virtual]

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

Implements mrpt::utils::CObject.

mrpt::utils::CObjectPtr mrpt::utils::CObject::duplicateGetSmartPtr ( ) const [inline, inherited]

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 151 of file CObject.h.

void mrpt::opengl::CRenderizable::enableShowName ( bool showName = true ) [inline, inherited]

Enables or disables showing the name of the object as a label when rendering.

Definition at line 95 of file CRenderizable.h.

mrpt::utils::TColorf mrpt::opengl::CRenderizable::getColor ( ) const [inline, inherited]

Returns the object color property as a TColorf.

Definition at line 150 of file CRenderizable.h.

const mrpt::utils::TColor& mrpt::opengl::CRenderizable::getColor_u8 ( ) const [inline, inherited]

Returns the object color property as a TColor.

Definition at line 159 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getColorA ( ) const [inline, inherited]

Color components in the range [0,1].

Definition at line 126 of file CRenderizable.h.

uint8_t mrpt::opengl::CRenderizable::getColorA_u8 ( ) const [inline, inherited]

Color components in the range [0,255].

Definition at line 131 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getColorB ( ) const [inline, inherited]

Color components in the range [0,1].

Definition at line 125 of file CRenderizable.h.

uint8_t mrpt::opengl::CRenderizable::getColorB_u8 ( ) const [inline, inherited]

Color components in the range [0,255].

Definition at line 130 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getColorG ( ) const [inline, inherited]

Color components in the range [0,1].

Definition at line 124 of file CRenderizable.h.

uint8_t mrpt::opengl::CRenderizable::getColorG_u8 ( ) const [inline, inherited]

Color components in the range [0,255].

Definition at line 129 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getColorR ( ) const [inline, inherited]

Color components in the range [0,1].

Definition at line 123 of file CRenderizable.h.

uint8_t mrpt::opengl::CRenderizable::getColorR_u8 ( ) const [inline, inherited]

Color components in the range [0,255].

Definition at line 128 of file CRenderizable.h.

const std::string& mrpt::opengl::CRenderizable::getName ( ) const [inline, inherited]

Returns the name of the object.

Definition at line 90 of file CRenderizable.h.

static unsigned int mrpt::opengl::CRenderizable::getNewTextureNumber ( ) [static, protected, inherited]

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

void mrpt::opengl::CTexturedPlane::getPlaneCorners	(	float &	xMin,
		float &	xMax,
		float &	yMin,
		float &	yMax
	)		const `[inline]`

Get the coordinates of the four corners that define the plane on the XY plane.

Definition at line 84 of file CTexturedPlane.h.

mrpt::math::TPose3D mrpt::opengl::CRenderizable::getPose ( ) const [inherited]

Returns the 3D pose of the object as TPose3D.

double mrpt::opengl::CRenderizable::getPosePitch ( ) const [inline, inherited]

Rotation relative to parent coordinate origin, in **DEGREES**.

Definition at line 117 of file CRenderizable.h.

References mrpt::utils::RAD2DEG().

double mrpt::opengl::CRenderizable::getPosePitchRad ( ) const [inline, inherited]

Rotation relative to parent coordinate origin, in radians.

Definition at line 120 of file CRenderizable.h.

const mrpt::poses::CPose3D& mrpt::opengl::CRenderizable::getPoseRef ( ) const [inline, inherited]

Returns a const ref to the 3D pose of the object as CPose3D (which explicitly contains the 3x3 rotation matrix)

Definition at line 105 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getPoseRoll ( ) const [inline, inherited]

Rotation relative to parent coordinate origin, in **DEGREES**.

Definition at line 118 of file CRenderizable.h.

References mrpt::utils::RAD2DEG().

double mrpt::opengl::CRenderizable::getPoseRollRad ( ) const [inline, inherited]

Rotation relative to parent coordinate origin, in radians.

Definition at line 121 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getPoseX ( ) const [inline, inherited]

Translation relative to parent coordinate origin.

Definition at line 113 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getPoseY ( ) const [inline, inherited]

Translation relative to parent coordinate origin.

Definition at line 114 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getPoseYaw ( ) const [inline, inherited]

Rotation relative to parent coordinate origin, in **DEGREES**.

Definition at line 116 of file CRenderizable.h.

References mrpt::utils::RAD2DEG().

double mrpt::opengl::CRenderizable::getPoseYawRad ( ) const [inline, inherited]

Rotation relative to parent coordinate origin, in radians.

Definition at line 119 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getPoseZ ( ) const [inline, inherited]

Translation relative to parent coordinate origin.

Definition at line 115 of file CRenderizable.h.

virtual const mrpt::utils::TRuntimeClassId* mrpt::opengl::CTexturedPlane::GetRuntimeClass ( ) const [virtual]

Returns information about the class of an object in runtime.

Reimplemented from mrpt::opengl::CTexturedObject.

float mrpt::opengl::CRenderizable::getScaleX ( ) const [inline, inherited]

Get the current scaling factor in one axis.

Definition at line 145 of file CRenderizable.h.

float mrpt::opengl::CRenderizable::getScaleY ( ) const [inline, inherited]

Get the current scaling factor in one axis.

Definition at line 146 of file CRenderizable.h.

float mrpt::opengl::CRenderizable::getScaleZ ( ) const [inline, inherited]

Get the current scaling factor in one axis.

Definition at line 147 of file CRenderizable.h.

bool mrpt::opengl::CRenderizable::isShowNameEnabled ( ) const [inline, inherited]

See also:: enableShowName

Definition at line 96 of file CRenderizable.h.

bool mrpt::opengl::CRenderizable::isVisible ( ) const [inline, inherited]

Is the object visible?

See also:: setVisibility

Definition at line 92 of file CRenderizable.h.

void mrpt::opengl::CTexturedObject::loadTextureInOpenGL ( ) const [inherited]

VERY IMPORTANT: If you use a multi-thread application, you MUST call this from the same thread that will later destruct the object in order to the OpenGL texture memory to be correctly deleted.

Calling this method more than once has no effects. If you use one thread, this method will be automatically called when rendering, so there is no need to explicitly call it.

EIGEN_STRONG_INLINE void mrpt::opengl::CRenderizableDisplayList::notifyChange ( ) const [inline, protected, inherited]

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

Definition at line 68 of file CRenderizableDisplayList.h.

virtual void mrpt::utils::CSerializable::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)		`[protected, pure virtual, inherited]`

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

Implemented in mrpt::math::CMatrixD, and mrpt::math::CMatrix.

void mrpt::opengl::CRenderizableDisplayList::readFromStreamRender ( mrpt::utils::CStream & in ) [inline, protected, inherited]

Reimplemented from mrpt::opengl::CRenderizable.

Definition at line 77 of file CRenderizableDisplayList.h.

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

void mrpt::opengl::CTexturedObject::readFromStreamTexturedObject ( mrpt::utils::CStream & in ) [protected, inherited]

static void mrpt::opengl::CRenderizable::releaseTextureName ( unsigned int i ) [static, protected, inherited]

virtual void mrpt::opengl::CRenderizableDisplayList::render ( ) const [virtual, inherited]

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

Implements mrpt::opengl::CRenderizable.

virtual void mrpt::opengl::CTexturedObject::render_dl ( ) const [virtual, inherited]

Derived classes must implement this method to the render the object.

Implements mrpt::opengl::CRenderizableDisplayList.

virtual void mrpt::opengl::CTexturedObject::render_post ( ) const [protected, virtual, inherited]

virtual void mrpt::opengl::CTexturedObject::render_pre ( ) const [protected, virtual, inherited]

void mrpt::opengl::CTexturedPlane::render_texturedobj ( ) const [protected, virtual]

Must be implemented by derived classes.

Implements mrpt::opengl::CTexturedObject.

static void mrpt::opengl::CRenderizable::renderTextBitmap	(	const char *	str,
		void *	fontStyle
	)		`[static, inherited]`

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

See also:: renderTextBitmap, mrpt::opengl::gl_utils

static void mrpt::opengl::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`
	)		`[static, inherited]`

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

CRenderizable& mrpt::opengl::CRenderizable::setColor ( const mrpt::utils::TColorf & c ) [inline, inherited]

Parameters:

c	Changes the default object color

Returns:: a ref to this

Definition at line 151 of file CRenderizable.h.

References mrpt::utils::TColorf::R, mrpt::utils::TColorf::G, mrpt::utils::TColorf::B, and mrpt::utils::TColorf::A.

CRenderizable& mrpt::opengl::CRenderizable::setColor	(	double	R,
		double	G,
		double	B,
		double	A = `1`
	)		`[inline, inherited]`

Set the color components of this object (R,G,B,Alpha, in the range 0-1)

Returns:: a ref to this

Definition at line 157 of file CRenderizable.h.

virtual CRenderizable& mrpt::opengl::CRenderizableDisplayList::setColor_u8 ( const mrpt::utils::TColor & c ) [inline, virtual, inherited]

Changes the default object color.

Returns:: a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 106 of file CRenderizableDisplayList.h.

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

CRenderizable& mrpt::opengl::CRenderizable::setColor_u8	(	uint8_t	R,
		uint8_t	G,
		uint8_t	B,
		uint8_t	A = `255`
	)		`[inline, inherited]`

Set the color components of this object (R,G,B,Alpha, in the range 0-1)

Returns:: a ref to this

Definition at line 164 of file CRenderizable.h.

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

Referenced by mrpt::opengl::CRenderizable::setColor_u8().

CRenderizable& mrpt::opengl::CRenderizable::setColorA ( const double a ) [inline, inherited]

Color components in the range [0,1].

Returns:: a ref to this

Definition at line 136 of file CRenderizable.h.

virtual CRenderizable& mrpt::opengl::CRenderizableDisplayList::setColorA_u8 ( const uint8_t a ) [inline, virtual, inherited]

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 105 of file CRenderizableDisplayList.h.

CRenderizable& mrpt::opengl::CRenderizable::setColorB ( const double b ) [inline, inherited]

Color components in the range [0,1].

Returns:: a ref to this

Definition at line 135 of file CRenderizable.h.

virtual CRenderizable& mrpt::opengl::CRenderizableDisplayList::setColorB_u8 ( const uint8_t b ) [inline, virtual, inherited]

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 104 of file CRenderizableDisplayList.h.

CRenderizable& mrpt::opengl::CRenderizable::setColorG ( const double g ) [inline, inherited]

Color components in the range [0,1].

Returns:: a ref to this

Definition at line 134 of file CRenderizable.h.

virtual CRenderizable& mrpt::opengl::CRenderizableDisplayList::setColorG_u8 ( const uint8_t g ) [inline, virtual, inherited]

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 103 of file CRenderizableDisplayList.h.

CRenderizable& mrpt::opengl::CRenderizable::setColorR ( const double r ) [inline, inherited]

Color components in the range [0,1].

Returns:: a ref to this

Definition at line 133 of file CRenderizable.h.

virtual CRenderizable& mrpt::opengl::CRenderizableDisplayList::setColorR_u8 ( const uint8_t r ) [inline, virtual, inherited]

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 102 of file CRenderizableDisplayList.h.

CRenderizable& mrpt::opengl::CRenderizable::setLocation	(	double	x,
		double	y,
		double	z
	)		`[inline, inherited]`

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

Returns:: a ref to this

Definition at line 108 of file CRenderizable.h.

CRenderizable& mrpt::opengl::CRenderizable::setLocation ( const mrpt::math::TPoint3D & p ) [inline, inherited]

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

Returns:: a ref to this

Definition at line 111 of file CRenderizable.h.

References mrpt::math::TPoint3D::x, mrpt::math::TPoint3D::y, and mrpt::math::TPoint3D::z.

void mrpt::opengl::CRenderizable::setName ( const std::string & n ) [inline, inherited]

Changes the name of the object.

Definition at line 89 of file CRenderizable.h.

void mrpt::opengl::CTexturedPlane::setPlaneCorners	(	float	xMin,
		float	xMax,
		float	yMin,
		float	yMax
	)		`[inline]`

Set the coordinates of the four corners that define the plane on the XY plane.

Definition at line 75 of file CTexturedPlane.h.

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

CRenderizable& mrpt::opengl::CRenderizable::setPose ( const mrpt::poses::CPose3D & o ) [inherited]

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

CRenderizable& mrpt::opengl::CRenderizable::setPose ( const mrpt::math::TPose3D & o ) [inherited]

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

CRenderizable& mrpt::opengl::CRenderizable::setPose ( const mrpt::poses::CPoint3D & o ) [inherited]

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

CRenderizable& mrpt::opengl::CRenderizable::setPose ( const mrpt::poses::CPoint2D & o ) [inherited]

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

CRenderizable& mrpt::opengl::CRenderizable::setScale ( float s ) [inline, inherited]

Scale to apply to the object, in all three axes (default=1)

Returns:: a ref to this

Definition at line 143 of file CRenderizable.h.

CRenderizable& mrpt::opengl::CRenderizable::setScale	(	float	sx,
		float	sy,
		float	sz
	)		`[inline, inherited]`

Scale to apply to the object in each axis (default=1)

Returns:: a ref to this

Definition at line 144 of file CRenderizable.h.

void mrpt::opengl::CTexturedPlane::setTextureCornerCoords	(	float	tex_x_min,
		float	tex_x_max,
		float	tex_y_min,
		float	tex_y_max
	)		`[inline]`

Set the texture coordinates of the four corners (in the range 0-1).

Definition at line 65 of file CTexturedPlane.h.

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

void mrpt::opengl::CRenderizable::setVisibility ( bool visible = true ) [inline, inherited]

Set object visibility (default=true)

See also:: isVisible

Definition at line 93 of file CRenderizable.h.

virtual bool mrpt::opengl::CRenderizableDisplayList::should_skip_display_list_cache ( ) const [inline, protected, virtual, inherited]

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 75 of file CRenderizableDisplayList.h.

static int mrpt::opengl::CRenderizable::textBitmapWidth	(	const std::string &	str,
		mrpt::opengl::TOpenGLFont	font = `mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24`
	)		`[static, inherited]`

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

See also:: renderTextBitmap, mrpt::opengl::gl_utils

virtual bool mrpt::opengl::CTexturedPlane::traceRay	(	const mrpt::poses::CPose3D &	o,
		double &	dist
	)		const `[virtual]`

Ray trace.

Reimplemented from mrpt::opengl::CRenderizable.

void mrpt::opengl::CTexturedPlane::unloadTexture ( ) [protected]

Reimplemented from mrpt::opengl::CTexturedObject.

void mrpt::opengl::CTexturedPlane::updatePoly ( ) const [protected]

virtual void mrpt::utils::CSerializable::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const `[protected, pure virtual, inherited]`

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