Main MRPT website > C++ reference
MRPT logo
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Friends
mrpt::opengl::CSetOfLines Class Reference

Detailed Description

A set of independent lines (or segments), one line with its own start and end positions (X,Y,Z).

See also:
opengl::COpenGLScene
mrpt::opengl::CSetOfLines
preview_CSetOfLines.png

#include <mrpt/opengl/CSetOfLines.h>

Inheritance diagram for mrpt::opengl::CSetOfLines:
Inheritance graph
[legend]

List of all members.

Public Types

typedef std::vector
< TSegment3D >::iterator 
iterator
 Iterator to the set.
typedef std::vector
< TSegment3D >
::reverse_iterator 
reverse_iterator
 Iterator to the set.
typedef std::vector
< TSegment3D >::const_iterator 
const_iterator
 Const iterator to the set.
typedef std::vector
< TSegment3D >
::const_reverse_iterator 
const_reverse_iterator
 Const reverse iterator to the set.

Public Member Functions

void clear ()
 Clear the list of segments.
void setLineWidth (float w)
 Sets the width with which lines will be drawn.
float getLineWidth () const
 Gets the width with which lines are drawn.
void appendLine (const mrpt::math::TSegment3D &sgm)
 Appends a line to the set.
void appendLine (float x0, float y0, float z0, float x1, float y1, float z1)
 Appends a line to the set, given the coordinates of its bounds.
template<class T >
void appendLines (const T &sgms)
 Appends any iterable collection of lines to the set.
template<class T_it >
void appendLines (const T_it &begin, const T_it &end)
 Appends certain amount of lines, located between two iterators, into the set.
void resize (size_t nLines)
 Resizes the set.
void reserve (size_t r)
 Reserves an amount of lines to the set.
template<class T , class U >
void appendLine (T p0, U p1)
 Inserts a line, given its bounds.
size_t getLineCount () const
 Returns the total count of lines in this set.
void setLineByIndex (size_t index, const TSegment3D &segm)
 Sets a specific line in the set, given its index.
void setLineByIndex (size_t index, double x0, double y0, double z0, double x1, double y1, double z1)
 Sets a specific line in the set, given its index.
void getLineByIndex (size_t index, double &x0, double &y0, double &z0, double &x1, double &y1, double &z1) const
 Gets a specific line in the set, given its index.
void render_dl () const
 Render.
const_iterator begin () const
 Beginning const iterator.
iterator begin ()
const_iterator end () const
 Ending const iterator.
iterator end ()
const_reverse_iterator rbegin () const
 Beginning const reverse iterator (actually, accesses the end of the set).
const_reverse_iterator rend () const
 Ending const reverse iterator (actually, refers to the starting point of the set).
CRenderizableDisplayListclone () 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.
virtual bool traceRay (const mrpt::poses::CPose3D &o, double &dist) const
 Simulation of ray-trace, given a pose.
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 CRenderizablesetColorR_u8 (const uint8_t r)
 Color components in the range [0,255].
virtual CRenderizablesetColorG_u8 (const uint8_t g)
 Color components in the range [0,255].
virtual CRenderizablesetColorB_u8 (const uint8_t b)
 Color components in the range [0,255].
virtual CRenderizablesetColorA_u8 (const uint8_t a)
 Color components in the range [0,255].
virtual CRenderizablesetColor_u8 (const mrpt::utils::TColor &c)
 Changes the default object color.
Changes the appearance of the object to render
CRenderizablesetColor_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::stringgetName () 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
CRenderizablesetPose (const mrpt::poses::CPose3D &o)
 Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)
CRenderizablesetPose (const mrpt::math::TPose3D &o)
 Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this)
CRenderizablesetPose (const mrpt::poses::CPoint3D &o)
 Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)
CRenderizablesetPose (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::CPose3DgetPoseRef () const
 Returns a const ref to the 3D pose of the object as CPose3D (which explicitly contains the 3x3 rotation matrix)
CRenderizablesetLocation (double x, double y, double z)
 Changes the location of the object, keeping untouched the orientation.
CRenderizablesetLocation (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].
CRenderizablesetColorR (const double r)
 Color components in the range [0,1].
CRenderizablesetColorG (const double g)
 Color components in the range [0,1].
CRenderizablesetColorB (const double b)
 Color components in the range [0,1].
CRenderizablesetColorA (const double a)
 Color components in the range [0,1].
CRenderizablesetScale (float s)
 Scale to apply to the object, in all three axes (default=1)
CRenderizablesetScale (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.
CRenderizablesetColor (const mrpt::utils::TColorf &c)
CRenderizablesetColor (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::TColorgetColor_u8 () const
 Returns the object color property as a TColor.

Static Public Member Functions

static CSetOfLinesPtr Create (const std::vector< TSegment3D > &sgms)
 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 
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

std::vector< TSegment3DmSegments
float mLineWidth
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

 CSetOfLines ()
 Constructor.
 CSetOfLines (const std::vector< TSegment3D > &sgms)
 Constructor with a initial set of lines.
virtual ~CSetOfLines ()
 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 
classCRenderizableDisplayList
class mrpt::utils::CStream

RTTI stuff

typedef CSetOfLinesPtr SmartPtr
static mrpt::utils::CLASSINIT _init_CSetOfLines
static mrpt::utils::TRuntimeClassId classCSetOfLines
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::CObjectduplicate () const
 Returns a copy of the object, indepently of its class.
static mrpt::utils::CObjectCreateObject ()
static CSetOfLinesPtr Create ()

Member Typedef Documentation

Const iterator to the set.

Definition at line 189 of file CSetOfLines.h.

Const reverse iterator to the set.

Definition at line 193 of file CSetOfLines.h.

Iterator to the set.

Definition at line 183 of file CSetOfLines.h.

Iterator to the set.

Definition at line 184 of file CSetOfLines.h.

A typedef for the associated smart pointer

Definition at line 60 of file CSetOfLines.h.


Constructor & Destructor Documentation

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

Constructor.

Definition at line 228 of file CSetOfLines.h.

mrpt::opengl::CSetOfLines::CSetOfLines ( const std::vector< TSegment3D > &  sgms) [inline, private]

Constructor with a initial set of lines.

Definition at line 232 of file CSetOfLines.h.

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

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

Definition at line 236 of file CSetOfLines.h.


Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::opengl::CSetOfLines::_GetBaseClass ( ) [static, protected]
void mrpt::opengl::CSetOfLines::appendLine ( const mrpt::math::TSegment3D sgm) [inline]

Appends a line to the set.

Definition at line 89 of file CSetOfLines.h.

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

void mrpt::opengl::CSetOfLines::appendLine ( float  x0,
float  y0,
float  z0,
float  x1,
float  y1,
float  z1 
) [inline]

Appends a line to the set, given the coordinates of its bounds.

Definition at line 96 of file CSetOfLines.h.

References mrpt::math::TSegment3D, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

template<class T , class U >
void mrpt::opengl::CSetOfLines::appendLine ( p0,
p1 
) [inline]

Inserts a line, given its bounds.

Works with any pair of objects with access to x, y and z members.

Definition at line 136 of file CSetOfLines.h.

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

template<class T >
void mrpt::opengl::CSetOfLines::appendLines ( const T &  sgms) [inline]

Appends any iterable collection of lines to the set.

Note that this includes another CSetOfLines.

See also:
appendLine

Definition at line 104 of file CSetOfLines.h.

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

template<class T_it >
void mrpt::opengl::CSetOfLines::appendLines ( const T_it &  begin,
const T_it &  end 
) [inline]

Appends certain amount of lines, located between two iterators, into the set.

See also:
appendLine

Definition at line 112 of file CSetOfLines.h.

References begin(), end(), and mrpt::opengl::CRenderizableDisplayList::notifyChange().

const_iterator mrpt::opengl::CSetOfLines::begin ( ) const [inline]

Beginning const iterator.

See also:
end,rbegin,rend

Definition at line 198 of file CSetOfLines.h.

iterator mrpt::opengl::CSetOfLines::begin ( ) [inline]
static void mrpt::opengl::CRenderizable::checkOpenGLError ( ) [static, protected, inherited]

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

void mrpt::opengl::CSetOfLines::clear ( void  ) [inline]

Clear the list of segments.

Definition at line 69 of file CSetOfLines.h.

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

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 CSetOfLinesPtr mrpt::opengl::CSetOfLines::Create ( ) [static]
static CSetOfLinesPtr mrpt::opengl::CSetOfLines::Create ( const std::vector< TSegment3D > &  sgms) [inline, static]

Class factory.

Definition at line 175 of file CSetOfLines.h.

References mrpt::opengl::CSetOfLines.

static mrpt::utils::CObject* mrpt::opengl::CSetOfLines::CreateObject ( ) [static]
virtual mrpt::utils::CObject* mrpt::opengl::CSetOfLines::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.

const_iterator mrpt::opengl::CSetOfLines::end ( ) const [inline]

Ending const iterator.

See also:
begin,rend,rbegin

Definition at line 206 of file CSetOfLines.h.

iterator mrpt::opengl::CSetOfLines::end ( ) [inline]
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::CSetOfLines::getLineByIndex ( size_t  index,
double &  x0,
double &  y0,
double &  z0,
double &  x1,
double &  y1,
double &  z1 
) const [inline]

Gets a specific line in the set, given its index.

See also:
getLineByIndex

Definition at line 163 of file CSetOfLines.h.

References ASSERT_.

size_t mrpt::opengl::CSetOfLines::getLineCount ( ) const [inline]

Returns the total count of lines in this set.

Definition at line 143 of file CSetOfLines.h.

float mrpt::opengl::CSetOfLines::getLineWidth ( ) const [inline]

Gets the width with which lines are drawn.

Definition at line 83 of file CSetOfLines.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).

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::CSetOfLines::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.

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.

Referenced by mrpt::opengl::C3DSScene::enableExtraAmbientLight(), mrpt::opengl::CAngularObservationMesh::setWireframe(), mrpt::opengl::CAngularObservationMesh::enableTransparency(), mrpt::opengl::CArrow::setArrowEnds(), mrpt::opengl::CArrow::setHeadRatio(), mrpt::opengl::CArrow::setSmallRadius(), mrpt::opengl::CArrow::setLargeRadius(), mrpt::opengl::CArrow::setArrowYawPitchRoll(), mrpt::opengl::CAxis::setAxisLimits(), mrpt::opengl::CAxis::setFrequency(), mrpt::opengl::CAxis::setLineWidth(), mrpt::opengl::CAxis::enableTickMarks(), mrpt::opengl::CBox::setLineWidth(), mrpt::opengl::CBox::setWireframe(), mrpt::opengl::CCylinder::setHasBases(), mrpt::opengl::CCylinder::setRadius(), mrpt::opengl::CCylinder::setRadii(), mrpt::opengl::CCylinder::setHeight(), mrpt::opengl::CCylinder::setSlicesCount(), mrpt::opengl::CCylinder::setStacksCount(), mrpt::opengl::CDisk::setDiskRadius(), mrpt::opengl::CDisk::setSlicesCount(), mrpt::opengl::CDisk::setLoopsCount(), mrpt::opengl::CEllipsoid::enableDrawSolid3D(), mrpt::opengl::CEllipsoid::setQuantiles(), mrpt::opengl::CEllipsoid::set2DsegmentsCount(), mrpt::opengl::CEllipsoid::set3DsegmentsCount(), mrpt::opengl::CGeneralizedCylinder::setAxis(), mrpt::opengl::CGeneralizedCylinder::setGeneratrix(), mrpt::opengl::CGeneralizedCylinder::setClosed(), mrpt::opengl::CGeneralizedCylinder::setAllSectionsVisible(), mrpt::opengl::CGeneralizedCylinder::setAllSectionsInvisible(), mrpt::opengl::CGeneralizedCylinder::setVisibleSections(), mrpt::opengl::CGeneralizedCylinder::addVisibleSectionAtStart(), mrpt::opengl::CGeneralizedCylinder::addVisibleSectionAtEnd(), mrpt::opengl::CGridPlaneXY::setPlaneLimits(), mrpt::opengl::CGridPlaneXY::setPlaneZcoord(), mrpt::opengl::CGridPlaneXY::setGridFrequency(), mrpt::opengl::CGridPlaneXZ::setPlaneLimits(), mrpt::opengl::CGridPlaneXZ::setPlaneYcoord(), mrpt::opengl::CGridPlaneXZ::setGridFrequency(), mrpt::opengl::CMesh::setGridLimits(), mrpt::opengl::CMesh::enableTransparency(), mrpt::opengl::CMesh::enableWireFrame(), mrpt::opengl::CMesh::enableColorFromZ(), mrpt::opengl::CMesh::setXMin(), mrpt::opengl::CMesh::setXMax(), mrpt::opengl::CMesh::setYMin(), mrpt::opengl::CMesh::setYMax(), mrpt::opengl::CMesh::setXBounds(), mrpt::opengl::CMesh::setYBounds(), mrpt::opengl::COpenGLStandardObject::enable(), mrpt::opengl::COpenGLStandardObject::disable(), mrpt::opengl::COpenGLStandardObject::setFlags(), mrpt::opengl::COpenGLStandardObject::setNormal(), mrpt::opengl::CPlanarLaserScan::enablePoints(), mrpt::opengl::CPlanarLaserScan::enableLine(), mrpt::opengl::CPlanarLaserScan::enableSurface(), mrpt::opengl::CPlanarLaserScan::setScan(), mrpt::opengl::CPolyhedron::setWireframe(), mrpt::opengl::CPolyhedron::setLineWidth(), clear(), setLineWidth(), appendLine(), appendLines(), resize(), reserve(), setLineByIndex(), begin(), end(), mrpt::opengl::CSetOfTexturedTriangles::clearTriangles(), mrpt::opengl::CSetOfTexturedTriangles::getTriangle(), mrpt::opengl::CSetOfTexturedTriangles::insertTriangle(), mrpt::opengl::CSetOfTriangles::clearTriangles(), mrpt::opengl::CSetOfTriangles::insertTriangle(), mrpt::opengl::CSetOfTriangles::insertTriangles(), mrpt::opengl::CSetOfTriangles::reserve(), mrpt::opengl::CSetOfTriangles::enableTransparency(), mrpt::opengl::CSimpleLine::setLineWidth(), mrpt::opengl::CSimpleLine::setLineCoords(), mrpt::opengl::CSphere::setRadius(), mrpt::opengl::CSphere::setNumberDivsLongitude(), mrpt::opengl::CSphere::setNumberDivsLatitude(), mrpt::opengl::CSphere::enableRadiusIndependentOfEyeDistance(), mrpt::opengl::CText3D::setString(), mrpt::opengl::CText3D::setFont(), mrpt::opengl::CText3D::setTextStyle(), mrpt::opengl::CText3D::setTextSpacing(), mrpt::opengl::CText3D::setTextKerning(), mrpt::opengl::CTexturedPlane::setTextureCornerCoords(), and mrpt::opengl::CTexturedPlane::setPlaneCorners().

const_reverse_iterator mrpt::opengl::CSetOfLines::rbegin ( ) const [inline]

Beginning const reverse iterator (actually, accesses the end of the set).

See also:
rend,begin,end

Definition at line 214 of file CSetOfLines.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:
inThe input binary stream where the object data must read from.
versionThe 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::exceptionOn 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]
static void mrpt::opengl::CRenderizable::releaseTextureName ( unsigned int  i) [static, protected, inherited]
const_reverse_iterator mrpt::opengl::CSetOfLines::rend ( ) const [inline]

Ending const reverse iterator (actually, refers to the starting point of the set).

See also:
rbegin,end,begin

Definition at line 221 of file CSetOfLines.h.

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::CSetOfLines::render_dl ( ) const [virtual]
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::CSetOfLines::reserve ( size_t  r) [inline]

Reserves an amount of lines to the set.

This method should be used when some known amount of lines is going to be inserted, so that only a memory allocation is needed.

See also:
resize

Definition at line 129 of file CSetOfLines.h.

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

void mrpt::opengl::CSetOfLines::resize ( size_t  nLines) [inline]

Resizes the set.

See also:
reserve

Definition at line 121 of file CSetOfLines.h.

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

CRenderizable& mrpt::opengl::CRenderizable::setColor ( const mrpt::utils::TColorf c) [inline, inherited]
Parameters:
cChanges 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::CSetOfLines::setLineByIndex ( size_t  index,
const TSegment3D segm 
)

Sets a specific line in the set, given its index.

See also:
appendLine
void mrpt::opengl::CSetOfLines::setLineByIndex ( size_t  index,
double  x0,
double  y0,
double  z0,
double  x1,
double  y1,
double  z1 
) [inline]

Sets a specific line in the set, given its index.

See also:
appendLine

Definition at line 155 of file CSetOfLines.h.

References mrpt::math::TSegment3D, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

void mrpt::opengl::CSetOfLines::setLineWidth ( float  w) [inline]

Sets the width with which lines will be drawn.

Definition at line 76 of file CSetOfLines.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.

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

Simulation of ray-trace, given a pose.

Returns true if the ray effectively collisions with the object (returning the distance to the origin of the ray in "dist"), or false in other case. "dist" variable yields undefined behaviour when false is returned

Reimplemented in mrpt::opengl::CPolyhedron, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CMesh, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CSetOfObjects, mrpt::opengl::CSetOfTriangles, mrpt::opengl::CEllipsoid, mrpt::opengl::CSetOfTexturedTriangles, mrpt::opengl::CTexturedPlane, mrpt::opengl::CSphere, mrpt::opengl::CCylinder, mrpt::opengl::C3DSScene, mrpt::opengl::CDisk, and mrpt::opengl::CBox.

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:
outThe output binary stream where object must be dumped.
getVersionIf 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::exceptionOn any error, see CStream::WriteBuffer
See also:
CStream

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

void mrpt::opengl::CRenderizable::writeToStreamRender ( utils::CStream out) const [protected, inherited]

Friends And Related Function Documentation

friend class mrpt::opengl::COpenGLViewport [friend, inherited]

Definition at line 74 of file CRenderizable.h.

friend class mrpt::opengl::CSetOfObjects [friend, inherited]

Definition at line 75 of file CRenderizable.h.

friend class mrpt::utils::CStream [friend, inherited]

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CTexturedObject.

Definition at line 57 of file CRenderizableDisplayList.h.


Member Data Documentation

Definition at line 60 of file CSetOfLines.h.

Definition at line 139 of file CObject.h.

Definition at line 72 of file CRenderizable.h.

Definition at line 57 of file CRenderizableDisplayList.h.

Definition at line 56 of file CSerializable.h.

Definition at line 60 of file CSetOfLines.h.

Definition at line 60 of file CSetOfLines.h.

Color components in the range [0,255].

Definition at line 80 of file CRenderizable.h.

Definition at line 78 of file CRenderizable.h.

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

float mrpt::opengl::CRenderizable::m_scale_x [protected, inherited]

Definition at line 82 of file CRenderizable.h.

float mrpt::opengl::CRenderizable::m_scale_y [protected, inherited]

Definition at line 82 of file CRenderizable.h.

float mrpt::opengl::CRenderizable::m_scale_z [protected, inherited]

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

Definition at line 82 of file CRenderizable.h.

bool mrpt::opengl::CRenderizable::m_show_name [protected, inherited]

Definition at line 79 of file CRenderizable.h.

bool mrpt::opengl::CRenderizable::m_visible [protected, inherited]

Is the object visible? (default=true)

Definition at line 83 of file CRenderizable.h.

Definition at line 63 of file CSetOfLines.h.

Definition at line 62 of file CSetOfLines.h.




Page generated by Doxygen 1.7.5 for MRPT 0.9.5 SVN: at Thu Oct 13 21:25:36 UTC 2011