Detailed Description

This object represents any figure obtained by extruding any profile along a given axis.

The profile should lie over a x=0 plane, and the axis must be roughly perpendicular to this plane. In particular, it should be almost perpendicular to the Z axis.

#include <mrpt/opengl/CGeneralizedCylinder.h>

Inheritance diagram for mrpt::opengl::CGeneralizedCylinder:

[legend]

List of all members.

Classes
struct	TQuadrilateral
	Auxiliary struct holding any quadrilateral, represented by foour points. More...
Public Member Functions
void	render_dl () const
	Render.
virtual bool	traceRay (const mrpt::poses::CPose3D &o, double &dist) const
	Ray tracing.
void	getAxis (std::vector< TPoint3D > &a) const
	Get axis's spatial coordinates.
void	getAxis (std::vector< CPose3D > &a) const
	Get axis, including angular coordinates.
void	setAxis (const std::vector< TPoint3D > &a)
	Set the axis points.
void	getGeneratrix (std::vector< TPoint3D > &g) const
	Get cylinder's profile.
void	setGeneratrix (const std::vector< TPoint3D > g)
	Set cylinder's profile.
bool	isClosed () const
	Returns true if each section is a closed polygon.
void	setClosed (bool c=true)
	Set whether each section is a closed polygon or not.
void	getOrigin (CPolyhedronPtr &poly) const
	Get a polyhedron containing the starting point of the cylinder (its "base").
void	getEnd (CPolyhedronPtr &poly) const
	Get a polyhedron containing the ending point of the cylinder (its "base").
void	generateSetOfPolygons (std::vector< TPolygon3D > &res) const
	Get the cylinder as a set of polygons in 3D.
void	getClosedSection (size_t index1, size_t index2, CPolyhedronPtr &poly) const
	Get a polyhedron consisting of a set of closed sections of the cylinder.
void	getClosedSection (size_t index, CPolyhedronPtr &poly) const
	Get a polyhedron consisting of a single section of the cylinder.
size_t	getNumberOfSections () const
	Get the number of sections in this cylinder.
size_t	getVisibleSections () const
	Get how many visible sections are in the cylinder.
void	getVisibleSections (size_t &first, size_t &last) const
	Gets the cylinder's visible sections.
void	setAllSectionsVisible ()
	Sets all sections visible.
void	setAllSectionsInvisible (size_t pointer=0)
	Hides all sections.
void	setVisibleSections (size_t first, size_t last)
	Sets which sections are visible.
void	addVisibleSectionAtStart ()
	Adds another visible section at the start of the cylinder.
void	addVisibleSectionAtEnd ()
	Adds another visible section at the end of the cylinder.
void	removeVisibleSectionAtStart ()
	Removes a visible section from the start of the currently visible set.
void	removeVisibleSectionAtEnd ()
	Removes a visible section from the ending of the currently visible set.
bool	getFirstSectionPose (mrpt::poses::CPose3D &p)
	Gets the axis pose of the first section, returning false if there is no such pose.
bool	getLastSectionPose (mrpt::poses::CPose3D &p)
	Gets the axis pose of the last section, returning false if there is no such pose.
bool	getFirstVisibleSectionPose (mrpt::poses::CPose3D &p)
	Gets the axis pose of the first visible section, returning false if there is no such pose.
bool	getLastVisibleSectionPose (mrpt::poses::CPose3D &p)
	Gets the axis pose of the last section, returning false if there is no such pose.
void	updatePolys () const
	Updates the mutable set of polygons used in ray tracing.
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 CGeneralizedCylinderPtr	Create (const std::vector< TPoint3D > &axis, const std::vector< TPoint3D > &generatrix)
	Creation of generalized cylinder from axis and generatrix.
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	classCRenderizable
RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable
Protected Member Functions
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
vector< CPose3D >	axis
	Cylinder's axis.
vector< TPoint3D >	generatrix
	Object's generatrix, that is, profile which will be extruded.
std::vector< TQuadrilateral >	mesh
	Mutable object with mesh information, used to avoid repeated computations.
CMatrixTemplate< TPoint3D >	pointsMesh
	Mutable object with the cylinder's points, used to avoid repeated computations.
bool	meshUpToDate
	Mutable flag which tells if recalculations are needed.
vector< TPolygonWithPlane >	polys
	Mutable set of data used in ray tracing.
bool	polysUpToDate
	Mutable flag telling whether ray tracing temporary data must be recalculated or not.
bool	closed
	Boolean variable which determines if the profile is closed at each section.
bool	fullyVisible
	Flag to determine whether the object is fully visible or only some sections are.
size_t	firstSection
	First visible section, if fullyVisible is set to false.
size_t	lastSection
	Last visible section, if fullyVisible is set to false.
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
void	generatePoses (const std::vector< TPoint3D > &pIn, std::vector< CPose3D > &pOut)
	Updates the axis, transforming each point into a pose pointing to the next section.
void	updateMesh () const
	Updates the mutable mesh.
void	getMeshIterators (const vector< TQuadrilateral > &m, vector< TQuadrilateral >::const_iterator &begin, vector< TQuadrilateral >::const_iterator &end) const
	Given a vector of polyhedrons, gets the starting and ending iterators to the section to be actually rendered.
	CGeneralizedCylinder ()
	Basic constructor with default initialization.
	CGeneralizedCylinder (const std::vector< TPoint3D > &a, const std::vector< TPoint3D > &g)
	Constructor with axis and generatrix.
virtual	~CGeneralizedCylinder ()
	Destructor.
Friends
class	mrpt::opengl::COpenGLViewport
class	mrpt::opengl::CSetOfObjects
RTTI stuff
typedef CGeneralizedCylinderPtr	SmartPtr
static mrpt::utils::CLASSINIT	_init_CGeneralizedCylinder
static mrpt::utils::TRuntimeClassId	classCGeneralizedCylinder
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 CGeneralizedCylinderPtr	Create ()
RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCRenderizableDisplayList
class	mrpt::utils::CStream

Member Typedef Documentation

typedef CGeneralizedCylinderPtr mrpt::opengl::CGeneralizedCylinder::SmartPtr

A typedef for the associated smart pointer

Definition at line 49 of file CGeneralizedCylinder.h.

Constructor & Destructor Documentation

mrpt::opengl::CGeneralizedCylinder::CGeneralizedCylinder ( ) [inline, private]

Basic constructor with default initialization.

Definition at line 372 of file CGeneralizedCylinder.h.

mrpt::opengl::CGeneralizedCylinder::CGeneralizedCylinder	(	const std::vector< TPoint3D > &	a,
		const std::vector< TPoint3D > &	g
	)		`[inline, private]`

Constructor with axis and generatrix.

Definition at line 376 of file CGeneralizedCylinder.h.

virtual mrpt::opengl::CGeneralizedCylinder::~CGeneralizedCylinder ( ) [inline, private, virtual]

Destructor.

Definition at line 382 of file CGeneralizedCylinder.h.

Member Function Documentation

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

Reimplemented from mrpt::opengl::CRenderizableDisplayList.

void mrpt::opengl::CGeneralizedCylinder::addVisibleSectionAtEnd ( ) [inline]

Adds another visible section at the end of the cylinder.

The cylinder must have an invisible section to display.

Exceptions:

std::logic_error if there is no section to add to the displaying set.

See also:: addVisibleSectionAtStart,removeVisibleSectionAtStart,removeVisibleSectionAtEnd

Definition at line 319 of file CGeneralizedCylinder.h.

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

void mrpt::opengl::CGeneralizedCylinder::addVisibleSectionAtStart ( ) [inline]

Adds another visible section at the start of the cylinder.

The cylinder must have an invisble section to display.

Exceptions:

std::logic_error if there is no section to add to the displaying set.

See also:: addVisibleSectionAtEnd,removeVisibleSectionAtStart,removeVisibleSectionAtEnd

Definition at line 309 of file CGeneralizedCylinder.h.

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

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 CGeneralizedCylinderPtr mrpt::opengl::CGeneralizedCylinder::Create ( ) [static]

static CGeneralizedCylinderPtr mrpt::opengl::CGeneralizedCylinder::Create	(	const std::vector< TPoint3D > &	axis,
		const std::vector< TPoint3D > &	generatrix
	)		`[inline, static]`

Creation of generalized cylinder from axis and generatrix.

Definition at line 157 of file CGeneralizedCylinder.h.

References mrpt::opengl::CGeneralizedCylinder.

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

virtual mrpt::utils::CObject* mrpt::opengl::CGeneralizedCylinder::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.

void mrpt::opengl::CGeneralizedCylinder::generatePoses	(	const std::vector< TPoint3D > &	pIn,
		std::vector< CPose3D > &	pOut
	)		`[private]`

Updates the axis, transforming each point into a pose pointing to the next section.

void mrpt::opengl::CGeneralizedCylinder::generateSetOfPolygons ( std::vector< TPolygon3D > & res ) const

Get the cylinder as a set of polygons in 3D.

See also:: mrpt::math::TPolygon3D

void mrpt::opengl::CGeneralizedCylinder::getAxis ( std::vector< TPoint3D > & a ) const [inline]

Get axis's spatial coordinates.

Definition at line 173 of file CGeneralizedCylinder.h.

void mrpt::opengl::CGeneralizedCylinder::getAxis ( std::vector< CPose3D > & a ) const [inline]

Get axis, including angular coordinates.

Definition at line 186 of file CGeneralizedCylinder.h.

void mrpt::opengl::CGeneralizedCylinder::getClosedSection	(	size_t	index1,
		size_t	index2,
		CPolyhedronPtr &	poly
	)		const

Get a polyhedron consisting of a set of closed sections of the cylinder.

See also:: mrpt::opengl::CPolyhedron

void mrpt::opengl::CGeneralizedCylinder::getClosedSection	(	size_t	index,
		CPolyhedronPtr &	poly
	)		const `[inline]`

Get a polyhedron consisting of a single section of the cylinder.

See also:: mrpt::opengl::CPolyhedron

Definition at line 250 of file CGeneralizedCylinder.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.

void mrpt::opengl::CGeneralizedCylinder::getEnd ( CPolyhedronPtr & poly ) const

Get a polyhedron containing the ending point of the cylinder (its "base").

See also:: getOrigin,mrpt::opengl::CPolyhedron

bool mrpt::opengl::CGeneralizedCylinder::getFirstSectionPose ( mrpt::poses::CPose3D & p )

Gets the axis pose of the first section, returning false if there is no such pose.

bool mrpt::opengl::CGeneralizedCylinder::getFirstVisibleSectionPose ( mrpt::poses::CPose3D & p )

Gets the axis pose of the first visible section, returning false if there is no such pose.

void mrpt::opengl::CGeneralizedCylinder::getGeneratrix ( std::vector< TPoint3D > & g ) const [inline]

Get cylinder's profile.

Definition at line 201 of file CGeneralizedCylinder.h.

bool mrpt::opengl::CGeneralizedCylinder::getLastSectionPose ( mrpt::poses::CPose3D & p )

Gets the axis pose of the last section, returning false if there is no such pose.

bool mrpt::opengl::CGeneralizedCylinder::getLastVisibleSectionPose ( mrpt::poses::CPose3D & p )

Gets the axis pose of the last section, returning false if there is no such pose.

void mrpt::opengl::CGeneralizedCylinder::getMeshIterators	(	const vector< TQuadrilateral > &	m,
		vector< TQuadrilateral >::const_iterator &	begin,
		vector< TQuadrilateral >::const_iterator &	end
	)		const `[private]`

Given a vector of polyhedrons, gets the starting and ending iterators to the section to be actually rendered.

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

size_t mrpt::opengl::CGeneralizedCylinder::getNumberOfSections ( ) const [inline]

Get the number of sections in this cylinder.

Definition at line 256 of file CGeneralizedCylinder.h.

void mrpt::opengl::CGeneralizedCylinder::getOrigin ( CPolyhedronPtr & poly ) const

Get a polyhedron containing the starting point of the cylinder (its "base").

See also:: getEnd,mrpt::opengl::CPolyhedron

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::CGeneralizedCylinder::GetRuntimeClass ( ) const [virtual]

Returns information about the class of an object in runtime.

Reimplemented from mrpt::opengl::CRenderizableDisplayList.

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.

size_t mrpt::opengl::CGeneralizedCylinder::getVisibleSections ( ) const [inline]

Get how many visible sections are in the cylinder.

Definition at line 262 of file CGeneralizedCylinder.h.

void mrpt::opengl::CGeneralizedCylinder::getVisibleSections	(	size_t &	first,
		size_t &	last
	)		const `[inline]`

Gets the cylinder's visible sections.

Definition at line 268 of file CGeneralizedCylinder.h.

bool mrpt::opengl::CGeneralizedCylinder::isClosed ( ) const [inline]

Returns true if each section is a closed polygon.

Definition at line 215 of file CGeneralizedCylinder.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.

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

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

void mrpt::opengl::CGeneralizedCylinder::removeVisibleSectionAtEnd ( )

Removes a visible section from the ending of the currently visible set.

Exceptions:

std::logic_error when there is no such section.

See also:: addVisibleSectionAtStart,addVisibleSectionAtEnd,removeVisibleSectionAtStart

void mrpt::opengl::CGeneralizedCylinder::removeVisibleSectionAtStart ( )

Removes a visible section from the start of the currently visible set.

Exceptions:

std::logic_error if there are no visible sections.

See also:: addVisibleSectionAtStart,addVisibleSectionAtEnd,removeVisibleSectionAtEnd

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.

void mrpt::opengl::CGeneralizedCylinder::render_dl ( ) const [virtual]

Render.

See also:: mrpt::opengl::CRenderizable

Implements mrpt::opengl::CRenderizableDisplayList.

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

void mrpt::opengl::CGeneralizedCylinder::setAllSectionsInvisible ( size_t pointer = 0 ) [inline]

Hides all sections.

Definition at line 287 of file CGeneralizedCylinder.h.

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

void mrpt::opengl::CGeneralizedCylinder::setAllSectionsVisible ( ) [inline]

Sets all sections visible.

Definition at line 280 of file CGeneralizedCylinder.h.

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

void mrpt::opengl::CGeneralizedCylinder::setAxis ( const std::vector< TPoint3D > & a ) [inline]

Set the axis points.

Definition at line 192 of file CGeneralizedCylinder.h.

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

void mrpt::opengl::CGeneralizedCylinder::setClosed ( bool c = true ) [inline]

Set whether each section is a closed polygon or not.

Definition at line 221 of file CGeneralizedCylinder.h.

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

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.

void mrpt::opengl::CGeneralizedCylinder::setGeneratrix ( const std::vector< TPoint3D > g ) [inline]

Set cylinder's profile.

Definition at line 207 of file CGeneralizedCylinder.h.

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

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.

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::CRenderizable::setVisibility ( bool visible = true ) [inline, inherited]

Set object visibility (default=true)

See also:: isVisible

Definition at line 93 of file CRenderizable.h.

void mrpt::opengl::CGeneralizedCylinder::setVisibleSections	(	size_t	first,
		size_t	last
	)		`[inline]`

Sets which sections are visible.

Exceptions:

std::logic_error on wrongly defined bounds.

Definition at line 297 of file CGeneralizedCylinder.h.

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

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::CGeneralizedCylinder::traceRay	(	const mrpt::poses::CPose3D &	o,
		double &	dist
	)		const `[virtual]`

Ray tracing.

See also:: mrpt::opengl::CRenderizable.

Reimplemented from mrpt::opengl::CRenderizable.

void mrpt::opengl::CGeneralizedCylinder::updateMesh ( ) const [private]

Updates the mutable mesh.

void mrpt::opengl::CGeneralizedCylinder::updatePolys ( ) const

Updates the mutable set of polygons used in ray tracing.

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