Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
mrpt::opengl::CGeneralizedCylinder Class Reference

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.

Definition at line 31 of file CGeneralizedCylinder.h.

#include <mrpt/opengl/CGeneralizedCylinder.h>

Inheritance diagram for mrpt::opengl::CGeneralizedCylinder:
Inheritance graph

Classes

struct  TQuadrilateral
 Auxiliary struct holding any quadrilateral, represented by foour points. More...
 

Public Member Functions

voidoperator new (size_t size)
 
voidoperator new[] (size_t size)
 
void operator delete (void *ptr) noexcept
 
void operator delete[] (void *ptr) noexcept
 
void operator delete (void *memory, void *ptr) noexcept
 
voidoperator new (size_t size, const std::nothrow_t &) noexcept
 
void operator delete (void *ptr, const std::nothrow_t &) noexcept
 
void render_dl () const override
 Render. More...
 
bool traceRay (const mrpt::poses::CPose3D &o, double &dist) const override
 Ray tracing. More...
 
void getAxis (std::vector< mrpt::math::TPoint3D > &a) const
 Get axis's spatial coordinates. More...
 
void getAxis (mrpt::aligned_std_vector< mrpt::poses::CPose3D > &a) const
 Get axis, including angular coordinates. More...
 
void setAxis (const std::vector< mrpt::math::TPoint3D > &a)
 Set the axis points. More...
 
void getGeneratrix (std::vector< mrpt::math::TPoint3D > &g) const
 Get cylinder's profile. More...
 
void setGeneratrix (const std::vector< mrpt::math::TPoint3D > &g)
 Set cylinder's profile. More...
 
bool isClosed () const
 Returns true if each section is a closed polygon. More...
 
void setClosed (bool c=true)
 Set whether each section is a closed polygon or not. More...
 
void getOrigin (CPolyhedron::Ptr &poly) const
 Get a polyhedron containing the starting point of the cylinder (its "base"). More...
 
void getEnd (CPolyhedron::Ptr &poly) const
 Get a polyhedron containing the ending point of the cylinder (its "base"). More...
 
void generateSetOfPolygons (std::vector< mrpt::math::TPolygon3D > &res) const
 Get the cylinder as a set of polygons in 3D. More...
 
void getClosedSection (size_t index1, size_t index2, CPolyhedron::Ptr &poly) const
 Get a polyhedron consisting of a set of closed sections of the cylinder. More...
 
void getClosedSection (size_t index, CPolyhedron::Ptr &poly) const
 Get a polyhedron consisting of a single section of the cylinder. More...
 
size_t getNumberOfSections () const
 Get the number of sections in this cylinder. More...
 
size_t getVisibleSections () const
 Get how many visible sections are in the cylinder. More...
 
void getVisibleSections (size_t &first, size_t &last) const
 Gets the cylinder's visible sections. More...
 
void setAllSectionsVisible ()
 Sets all sections visible. More...
 
void setAllSectionsInvisible (size_t pointer=0)
 Hides all sections. More...
 
void setVisibleSections (size_t first, size_t last)
 Sets which sections are visible. More...
 
void addVisibleSectionAtStart ()
 Adds another visible section at the start of the cylinder. More...
 
void addVisibleSectionAtEnd ()
 Adds another visible section at the end of the cylinder. More...
 
void removeVisibleSectionAtStart ()
 Removes a visible section from the start of the currently visible set. More...
 
void removeVisibleSectionAtEnd ()
 Removes a visible section from the ending of the currently visible set. More...
 
bool getFirstSectionPose (mrpt::poses::CPose3D &p)
 Gets the axis pose of the first section, returning false if there is no such pose. More...
 
bool getLastSectionPose (mrpt::poses::CPose3D &p)
 Gets the axis pose of the last section, returning false if there is no such pose. More...
 
bool getFirstVisibleSectionPose (mrpt::poses::CPose3D &p)
 Gets the axis pose of the first visible section, returning false if there is no such pose. More...
 
bool getLastVisibleSectionPose (mrpt::poses::CPose3D &p)
 Gets the axis pose of the last section, returning false if there is no such pose. More...
 
void updatePolys () const
 Updates the mutable set of polygons used in ray tracing. More...
 
void getBoundingBox (mrpt::math::TPoint3D &bb_min, mrpt::math::TPoint3D &bb_max) const override
 Evaluates the bounding box of this object (including possible children) in the coordinate frame of the object parent. More...
 
 CGeneralizedCylinder ()
 Basic constructor with default initialization. More...
 
 CGeneralizedCylinder (const std::vector< mrpt::math::TPoint3D > &a, const std::vector< mrpt::math::TPoint3D > &g)
 Constructor with axis and generatrix. More...
 
virtual ~CGeneralizedCylinder ()
 Destructor. More...
 
void render () const override
 Render the object, regenerating the display list if needed, otherwise just calling it. More...
 
virtual mxArraywriteToMatlab () const
 Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class. More...
 

Static Public Member Functions

static voidoperator new (size_t size, void *ptr)
 
static CGeneralizedCylinder::Ptr Create (const std::vector< mrpt::math::TPoint3D > &axis, const std::vector< mrpt::math::TPoint3D > &generatrix)
 Creation of generalized cylinder from axis and generatrix. More...
 
static void renderTextBitmap (const char *str, void *fontStyle)
 This method is safe for calling from within ::render() methods. More...
 
static void renderTextBitmap (int screen_x, int screen_y, const std::string &str, float color_r=1, float color_g=1, float color_b=1, mrpt::opengl::TOpenGLFont font=mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24)
 Render a text message in the current rendering context, creating a glViewport in the way (do not call within ::render() methods) More...
 
static int textBitmapWidth (const std::string &str, mrpt::opengl::TOpenGLFont font=mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24)
 Return the exact width in pixels for a given string, as will be rendered by renderTextBitmap(). More...
 

Protected Member Functions

void writeToStreamRender (mrpt::serialization::CArchive &out) const
 
CSerializable virtual methods
uint8_t serializeGetVersion () const override
 Must return the current versioning number of the object. More...
 
void serializeTo (mrpt::serialization::CArchive &out) const override
 Pure virtual method for writing (serializing) to an abstract archive. More...
 
void serializeFrom (mrpt::serialization::CArchive &in, uint8_t serial_version) override
 Pure virtual method for reading (deserializing) from an abstract archive. More...
 

Static Protected Member Functions

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

Protected Attributes

mrpt::aligned_std_vector< mrpt::poses::CPose3Daxis
 Cylinder's axis. More...
 
std::vector< mrpt::math::TPoint3Dgeneratrix
 Object's generatrix, that is, profile which will be extruded. More...
 
std::vector< TQuadrilateralmesh
 Mutable object with mesh information, used to avoid repeated computations. More...
 
mrpt::math::CMatrixTemplate< mrpt::math::TPoint3DpointsMesh
 Mutable object with the cylinder's points, used to avoid repeated computations. More...
 
bool meshUpToDate
 Mutable flag which tells if recalculations are needed. More...
 
std::vector< mrpt::math::TPolygonWithPlanepolys
 Mutable set of data used in ray tracing. More...
 
bool polysUpToDate
 Mutable flag telling whether ray tracing temporary data must be recalculated or not. More...
 
bool closed
 Boolean variable which determines if the profile is closed at each section. More...
 
bool fullyVisible
 Flag to determine whether the object is fully visible or only some sections are. More...
 
size_t firstSection
 First visible section, if fullyVisible is set to false. More...
 
size_t lastSection
 Last visible section, if fullyVisible is set to false. More...
 
std::string m_name
 
bool m_show_name
 
mrpt::img::TColor m_color
 Color components in the range [0,255]. More...
 
mrpt::poses::CPose3D m_pose
 6D pose wrt the parent coordinate reference. More...
 
float m_scale_x
 Scale components to apply to the object (default=1) More...
 
float m_scale_y
 
float m_scale_z
 
bool m_visible
 Is the object visible? (default=true) More...
 

Private Member Functions

void generatePoses (const std::vector< mrpt::math::TPoint3D > &pIn, mrpt::aligned_std_vector< mrpt::poses::CPose3D > &pOut)
 Updates the axis, transforming each point into a pose pointing to the next section. More...
 
void updateMesh () const
 Updates the mutable mesh. More...
 
void getMeshIterators (const std::vector< TQuadrilateral > &m, std::vector< TQuadrilateral >::const_iterator &begin, std::vector< TQuadrilateral >::const_iterator &end) const
 Given a vector of polyhedrons, gets the starting and ending iterators to the section to be actually rendered. More...
 

Private Attributes

unsigned int m_dl
 Display list ID, for derived classes that want to use it (it's automatically deleted and freed on destruction of this base class). More...
 
bool m_dl_recreate
 If using display lists, this is true when the list must be updated (the object changes, it's the first rendering, etc...). More...
 

RTTI stuff


using Ptr = std::shared_ptr< CGeneralizedCylinder >
 
using ConstPtr = std::shared_ptr< const CGeneralizedCylinder >
 
using UniquePtr = std::unique_ptr< CGeneralizedCylinder >
 
using ConstUniquePtr = std::unique_ptr< const CGeneralizedCylinder >
 
static mrpt::rtti::CLASSINIT _init_CGeneralizedCylinder
 
static const mrpt::rtti::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "CGeneralizedCylinder"
 
static const mrpt::rtti::TRuntimeClassId_GetBaseClass ()
 
static constexpr auto getClassName ()
 
static const mrpt::rtti::TRuntimeClassIdGetRuntimeClassIdStatic ()
 
static mrpt::rtti::CObjectCreateObject ()
 
template<typename... Args>
static Ptr Create (Args &&... args)
 
template<typename... Args>
static UniquePtr CreateUnique (Args &&... args)
 
virtual const mrpt::rtti::TRuntimeClassIdGetRuntimeClass () const override
 Returns information about the class of an object in runtime. More...
 
virtual mrpt::rtti::CObjectclone () const override
 Returns a deep copy (clone) of the object, indepently of its class. More...
 

Member Typedef Documentation

◆ ConstPtr

Definition at line 33 of file CGeneralizedCylinder.h.

◆ ConstUniquePtr

Definition at line 33 of file CGeneralizedCylinder.h.

◆ Ptr

A type for the associated smart pointer

Definition at line 33 of file CGeneralizedCylinder.h.

◆ UniquePtr

Definition at line 33 of file CGeneralizedCylinder.h.

Constructor & Destructor Documentation

◆ CGeneralizedCylinder() [1/2]

mrpt::opengl::CGeneralizedCylinder::CGeneralizedCylinder ( )
inline

Basic constructor with default initialization.

Definition at line 409 of file CGeneralizedCylinder.h.

◆ CGeneralizedCylinder() [2/2]

mrpt::opengl::CGeneralizedCylinder::CGeneralizedCylinder ( const std::vector< mrpt::math::TPoint3D > &  a,
const std::vector< mrpt::math::TPoint3D > &  g 
)
inline

Constructor with axis and generatrix.

Definition at line 422 of file CGeneralizedCylinder.h.

References axis, and generatePoses().

◆ ~CGeneralizedCylinder()

virtual mrpt::opengl::CGeneralizedCylinder::~CGeneralizedCylinder ( )
inlinevirtual

Destructor.

Definition at line 437 of file CGeneralizedCylinder.h.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::rtti::TRuntimeClassId* mrpt::opengl::CGeneralizedCylinder::_GetBaseClass ( )
staticprotected

◆ addVisibleSectionAtEnd()

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_errorif there is no section to add to the displaying set.
See also
addVisibleSectionAtStart,removeVisibleSectionAtStart,removeVisibleSectionAtEnd

Definition at line 332 of file CGeneralizedCylinder.h.

References fullyVisible, getNumberOfSections(), lastSection, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

◆ addVisibleSectionAtStart()

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_errorif there is no section to add to the displaying set.
See also
addVisibleSectionAtEnd,removeVisibleSectionAtStart,removeVisibleSectionAtEnd

Definition at line 317 of file CGeneralizedCylinder.h.

References firstSection, fullyVisible, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

◆ checkOpenGLError()

void CRenderizable::checkOpenGLError ( )
staticprotectedinherited

◆ clone()

virtual mrpt::rtti::CObject* mrpt::opengl::CGeneralizedCylinder::clone ( ) const
overridevirtual

Returns a deep copy (clone) of the object, indepently of its class.

Implements mrpt::rtti::CObject.

◆ Create() [1/2]

template<typename... Args>
static Ptr mrpt::opengl::CGeneralizedCylinder::Create ( Args &&...  args)
inlinestatic

Definition at line 33 of file CGeneralizedCylinder.h.

◆ Create() [2/2]

static CGeneralizedCylinder::Ptr mrpt::opengl::CGeneralizedCylinder::Create ( const std::vector< mrpt::math::TPoint3D > &  axis,
const std::vector< mrpt::math::TPoint3D > &  generatrix 
)
static

Creation of generalized cylinder from axis and generatrix.

◆ CreateObject()

static mrpt::rtti::CObject* mrpt::opengl::CGeneralizedCylinder::CreateObject ( )
static

◆ CreateUnique()

template<typename... Args>
static UniquePtr mrpt::opengl::CGeneralizedCylinder::CreateUnique ( Args &&...  args)
inlinestatic

Definition at line 33 of file CGeneralizedCylinder.h.

◆ duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr CObject::duplicateGetSmartPtr ( ) const
inlineinherited

Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).

Definition at line 169 of file CObject.h.

References mrpt::rtti::CObject::clone().

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

◆ enableShowName()

void mrpt::opengl::CRenderizable::enableShowName ( bool  showName = true)
inlineinherited

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

Definition at line 85 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_show_name.

◆ generatePoses()

void CGeneralizedCylinder::generatePoses ( const std::vector< mrpt::math::TPoint3D > &  pIn,
mrpt::aligned_std_vector< mrpt::poses::CPose3D > &  pOut 
)
private

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

Definition at line 324 of file CGeneralizedCylinder.cpp.

Referenced by CGeneralizedCylinder(), and setAxis().

◆ generateSetOfPolygons()

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

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

See also
mrpt::math::TPolygon3D

Definition at line 227 of file CGeneralizedCylinder.cpp.

◆ getAxis() [1/2]

void mrpt::opengl::CGeneralizedCylinder::getAxis ( mrpt::aligned_std_vector< mrpt::poses::CPose3D > &  a) const
inline

Get axis, including angular coordinates.

Definition at line 173 of file CGeneralizedCylinder.h.

References axis.

◆ getAxis() [2/2]

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

Get axis's spatial coordinates.

Definition at line 158 of file CGeneralizedCylinder.h.

References axis.

◆ getBoundingBox()

void CGeneralizedCylinder::getBoundingBox ( mrpt::math::TPoint3D bb_min,
mrpt::math::TPoint3D bb_max 
) const
overridevirtual

Evaluates the bounding box of this object (including possible children) in the coordinate frame of the object parent.

Implements mrpt::opengl::CRenderizable.

Definition at line 384 of file CGeneralizedCylinder.cpp.

◆ getClassName()

static constexpr auto mrpt::opengl::CGeneralizedCylinder::getClassName ( )
inlinestaticconstexpr

Definition at line 33 of file CGeneralizedCylinder.h.

◆ getClosedSection() [1/2]

void mrpt::opengl::CGeneralizedCylinder::getClosedSection ( size_t  index,
CPolyhedron::Ptr poly 
) const
inline

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

See also
mrpt::opengl::CPolyhedron

Definition at line 243 of file CGeneralizedCylinder.h.

References getClosedSection().

◆ getClosedSection() [2/2]

void CGeneralizedCylinder::getClosedSection ( size_t  index1,
size_t  index2,
CPolyhedron::Ptr poly 
) const

◆ getColor()

mrpt::img::TColorf mrpt::opengl::CRenderizable::getColor ( ) const
inlineinherited

Returns the object color property as a TColorf.

Definition at line 234 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_color.

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

◆ getColor_u8()

const mrpt::img::TColor& mrpt::opengl::CRenderizable::getColor_u8 ( ) const
inlineinherited

Returns the object color property as a TColor.

Definition at line 254 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_color.

◆ getColorA()

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

Color components in the range [0,1].

Definition at line 157 of file CRenderizable.h.

References mrpt::img::TColor::A, and mrpt::opengl::CRenderizable::m_color.

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

◆ getColorA_u8()

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

Color components in the range [0,255].

Definition at line 165 of file CRenderizable.h.

References mrpt::img::TColor::A, and mrpt::opengl::CRenderizable::m_color.

◆ getColorB()

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

Color components in the range [0,1].

Definition at line 155 of file CRenderizable.h.

References mrpt::img::TColor::B, and mrpt::opengl::CRenderizable::m_color.

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

◆ getColorB_u8()

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

Color components in the range [0,255].

Definition at line 163 of file CRenderizable.h.

References mrpt::img::TColor::B, and mrpt::opengl::CRenderizable::m_color.

◆ getColorG()

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

Color components in the range [0,1].

Definition at line 153 of file CRenderizable.h.

References mrpt::img::TColor::G, and mrpt::opengl::CRenderizable::m_color.

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

◆ getColorG_u8()

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

Color components in the range [0,255].

Definition at line 161 of file CRenderizable.h.

References mrpt::img::TColor::G, and mrpt::opengl::CRenderizable::m_color.

◆ getColorR()

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

Color components in the range [0,1].

Definition at line 151 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_color, and mrpt::img::TColor::R.

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

◆ getColorR_u8()

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

Color components in the range [0,255].

Definition at line 159 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_color, and mrpt::img::TColor::R.

◆ getEnd()

void CGeneralizedCylinder::getEnd ( CPolyhedron::Ptr poly) const

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

See also
getOrigin,mrpt::opengl::CPolyhedron

Definition at line 216 of file CGeneralizedCylinder.cpp.

References generatePolygon().

◆ getFirstSectionPose()

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

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

Definition at line 354 of file CGeneralizedCylinder.cpp.

◆ getFirstVisibleSectionPose()

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

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

Definition at line 368 of file CGeneralizedCylinder.cpp.

◆ getGeneratrix()

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

Get cylinder's profile.

Definition at line 190 of file CGeneralizedCylinder.h.

References generatrix.

◆ getLastSectionPose()

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

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

Definition at line 361 of file CGeneralizedCylinder.cpp.

◆ getLastVisibleSectionPose()

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

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

Definition at line 376 of file CGeneralizedCylinder.cpp.

◆ getMeshIterators()

void CGeneralizedCylinder::getMeshIterators ( const std::vector< TQuadrilateral > &  m,
std::vector< TQuadrilateral >::const_iterator begin,
std::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.

Definition at line 65 of file CGeneralizedCylinder.cpp.

References begin().

◆ getName()

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

Returns the name of the object.

Definition at line 70 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_name.

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

◆ getNewTextureNumber()

unsigned int CRenderizable::getNewTextureNumber ( )
staticprotectedinherited

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

Returns the lowest, free texture name.


Definition at line 71 of file CRenderizable.cpp.

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

◆ getNumberOfSections()

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

Get the number of sections in this cylinder.

Definition at line 250 of file CGeneralizedCylinder.h.

References axis.

Referenced by addVisibleSectionAtEnd(), getVisibleSections(), and setVisibleSections().

◆ getOrigin()

void CGeneralizedCylinder::getOrigin ( CPolyhedron::Ptr poly) const

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

See also
getEnd,mrpt::opengl::CPolyhedron

Definition at line 205 of file CGeneralizedCylinder.cpp.

References generatePolygon().

◆ getPose()

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

Returns the 3D pose of the object as TPose3D.

Definition at line 343 of file CRenderizable.cpp.

References mrpt::poses::CPose3D::asTPose(), and mrpt::opengl::CRenderizable::m_pose.

◆ getPosePitch()

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

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 141 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, mrpt::poses::CPose3D::pitch(), and mrpt::RAD2DEG().

◆ getPosePitchRad()

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

Rotation relative to parent coordinate origin, in radians.

Definition at line 147 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, and mrpt::poses::CPose3D::pitch().

◆ getPoseRef()

const mrpt::poses::CPose3D& mrpt::opengl::CRenderizable::getPoseRef ( ) const
inlineinherited

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

Definition at line 111 of file CRenderizable.h.

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

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

◆ getPoseRoll()

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

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 143 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, mrpt::RAD2DEG(), and mrpt::poses::CPose3D::roll().

◆ getPoseRollRad()

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

Rotation relative to parent coordinate origin, in radians.

Definition at line 149 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, and mrpt::poses::CPose3D::roll().

◆ getPoseX()

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

Translation relative to parent coordinate origin.

Definition at line 133 of file CRenderizable.h.

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

◆ getPoseY()

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

Translation relative to parent coordinate origin.

Definition at line 135 of file CRenderizable.h.

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

◆ getPoseYaw()

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

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 139 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, mrpt::RAD2DEG(), and mrpt::poses::CPose3D::yaw().

◆ getPoseYawRad()

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

Rotation relative to parent coordinate origin, in radians.

Definition at line 145 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_pose, and mrpt::poses::CPose3D::yaw().

◆ getPoseZ()

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

Translation relative to parent coordinate origin.

Definition at line 137 of file CRenderizable.h.

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

◆ GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::opengl::CGeneralizedCylinder::GetRuntimeClass ( ) const
overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::opengl::CRenderizableDisplayList.

◆ GetRuntimeClassIdStatic()

static const mrpt::rtti::TRuntimeClassId& mrpt::opengl::CGeneralizedCylinder::GetRuntimeClassIdStatic ( )
static

◆ getScaleX()

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

Get the current scaling factor in one axis.

Definition at line 228 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_scale_x.

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

◆ getScaleY()

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

Get the current scaling factor in one axis.

Definition at line 230 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_scale_y.

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

◆ getScaleZ()

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

Get the current scaling factor in one axis.

Definition at line 232 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_scale_z.

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

◆ getVisibleSections() [1/2]

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

Get how many visible sections are in the cylinder.

Definition at line 257 of file CGeneralizedCylinder.h.

References firstSection, fullyVisible, getNumberOfSections(), and lastSection.

◆ getVisibleSections() [2/2]

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

Gets the cylinder's visible sections.

Definition at line 265 of file CGeneralizedCylinder.h.

References firstSection, fullyVisible, getNumberOfSections(), and lastSection.

◆ isClosed()

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

Returns true if each section is a closed polygon.

Definition at line 206 of file CGeneralizedCylinder.h.

References closed.

◆ isShowNameEnabled()

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

◆ isVisible()

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

Is the object visible?

See also
setVisibility

Definition at line 71 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_visible.

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

◆ notifyChange()

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

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

Definition at line 57 of file CRenderizableDisplayList.h.

References mrpt::opengl::CRenderizableDisplayList::m_dl_recreate.

Referenced by addVisibleSectionAtEnd(), addVisibleSectionAtStart(), mrpt::opengl::CMeshFast::adjustGridToImageAR(), mrpt::opengl::CMesh::adjustGridToImageAR(), mrpt::opengl::CVectorField2D::adjustVectorFieldToGrid(), mrpt::opengl::CSetOfLines::appendLine(), mrpt::opengl::CSetOfLines::appendLines(), mrpt::opengl::CTexturedObject::assignImage(), mrpt::opengl::CMeshFast::assignImage(), mrpt::opengl::CMesh::assignImage(), mrpt::opengl::CTexturedObject::assignImage_fast(), mrpt::opengl::CMeshFast::assignImageAndZ(), mrpt::opengl::CMesh::assignImageAndZ(), mrpt::opengl::CSetOfLines::begin(), mrpt::opengl::CSetOfLines::clear(), mrpt::opengl::CVectorField2D::clear(), mrpt::opengl::CAssimpModel::clear(), mrpt::opengl::CPlanarLaserScan::clear(), mrpt::opengl::CVectorField3D::clear(), mrpt::opengl::COctoMapVoxels::clear(), mrpt::opengl::CSetOfTexturedTriangles::clearTriangles(), mrpt::opengl::CSetOfTriangles::clearTriangles(), mrpt::opengl::COpenGLStandardObject::disable(), mrpt::opengl::COpenGLStandardObject::enable(), mrpt::opengl::CSimpleLine::enableAntiAliasing(), mrpt::opengl::CGridPlaneXZ::enableAntiAliasing(), mrpt::opengl::CGridPlaneXY::enableAntiAliasing(), mrpt::opengl::CMesh3D::enableAntiAliasing(), mrpt::opengl::CSetOfLines::enableAntiAliasing(), mrpt::opengl::CVectorField2D::enableAntiAliasing(), mrpt::opengl::CVectorField3D::enableAntiAliasing(), mrpt::opengl::CBox::enableBoxBorder(), mrpt::opengl::CVectorField3D::enableColorFromModule(), mrpt::opengl::CMeshFast::enableColorFromZ(), mrpt::opengl::CMesh::enableColorFromZ(), mrpt::opengl::COctoMapVoxels::enableCubeTransparency(), mrpt::opengl::CColorBar::enableDepthTest(), mrpt::opengl::CEllipsoid::enableDrawSolid3D(), mrpt::opengl::CMesh3D::enableFaceNormals(), mrpt::opengl::COctoMapVoxels::enableLights(), mrpt::opengl::CPlanarLaserScan::enableLine(), mrpt::opengl::CPlanarLaserScan::enablePoints(), mrpt::opengl::CSphere::enableRadiusIndependentOfEyeDistance(), mrpt::opengl::CMesh3D::enableShowEdges(), mrpt::opengl::CMesh3D::enableShowFaces(), mrpt::opengl::CVectorField3D::enableShowPoints(), mrpt::opengl::CMesh3D::enableShowVertices(), mrpt::opengl::CPlanarLaserScan::enableSurface(), mrpt::opengl::CAxis::enableTickMarks(), mrpt::opengl::CMesh3D::enableTransparency(), mrpt::opengl::CMeshFast::enableTransparency(), mrpt::opengl::CMesh::enableTransparency(), mrpt::opengl::CSetOfTriangles::enableTransparency(), mrpt::opengl::CAngularObservationMesh::enableTransparency(), mrpt::opengl::CMesh::enableWireFrame(), mrpt::opengl::CSetOfLines::end(), mrpt::opengl::COctoMapVoxels::getGridCubeRef(), mrpt::opengl::CSetOfTexturedTriangles::getTriangle(), mrpt::opengl::COctoMapVoxels::getVoxel(), mrpt::opengl::COctoMapVoxels::getVoxelRef(), mrpt::opengl::CSetOfTexturedTriangles::insertTriangle(), mrpt::opengl::CSetOfTriangles::insertTriangle(), mrpt::opengl::CSetOfTriangles::insertTriangles(), mrpt::opengl::CMesh3D::loadMesh(), mrpt::opengl::CAssimpModel::loadScene(), mrpt::opengl::COctoMapVoxels::push_back_GridCube(), mrpt::opengl::COctoMapVoxels::push_back_Voxel(), mrpt::opengl::CRenderizableDisplayList::readFromStreamRender(), mrpt::opengl::CTexturedObject::readFromStreamTexturedObject(), mrpt::opengl::CSetOfTriangles::reserve(), mrpt::opengl::CSetOfLines::reserve(), mrpt::opengl::COctoMapVoxels::reserveVoxels(), mrpt::opengl::CSetOfLines::resize(), mrpt::opengl::CVectorField2D::resize(), mrpt::opengl::CVectorField3D::resize(), mrpt::opengl::COctoMapVoxels::resizeGridCubes(), mrpt::opengl::COctoMapVoxels::resizeVoxels(), mrpt::opengl::COctoMapVoxels::resizeVoxelSets(), mrpt::opengl::CSimpleLine::serializeFrom(), mrpt::opengl::CTexturedPlane::serializeFrom(), mrpt::opengl::CSetOfTriangles::serializeFrom(), mrpt::opengl::COpenGLStandardObject::serializeFrom(), mrpt::opengl::CSphere::serializeFrom(), mrpt::opengl::CAxis::serializeFrom(), mrpt::opengl::CArrow::serializeFrom(), mrpt::opengl::CGridPlaneXY::serializeFrom(), mrpt::opengl::CGridPlaneXZ::serializeFrom(), mrpt::opengl::CCylinder::serializeFrom(), mrpt::opengl::CDisk::serializeFrom(), mrpt::opengl::CSetOfLines::serializeFrom(), mrpt::opengl::CVectorField2D::serializeFrom(), mrpt::opengl::CColorBar::serializeFrom(), mrpt::opengl::CMesh::serializeFrom(), mrpt::opengl::CMeshFast::serializeFrom(), mrpt::opengl::CVectorField3D::serializeFrom(), mrpt::opengl::CBox::serializeFrom(), mrpt::opengl::CAssimpModel::serializeFrom(), mrpt::opengl::CPolyhedron::serializeFrom(), mrpt::opengl::CText3D::serializeFrom(), mrpt::opengl::CEllipsoid::serializeFrom(), mrpt::opengl::CFrustum::serializeFrom(), mrpt::opengl::COctoMapVoxels::serializeFrom(), mrpt::opengl::CEllipsoid::set2DsegmentsCount(), mrpt::opengl::CEllipsoid::set3DsegmentsCount(), setAllSectionsInvisible(), setAllSectionsVisible(), mrpt::opengl::CArrow::setArrowEnds(), mrpt::opengl::CArrow::setArrowYawPitchRoll(), setAxis(), mrpt::opengl::CAxis::setAxisLimits(), mrpt::opengl::CBox::setBoxBorderColor(), mrpt::opengl::CBox::setBoxCorners(), setClosed(), mrpt::opengl::CRenderizableDisplayList::setColor_u8(), mrpt::opengl::CSetOfTriangles::setColor_u8(), mrpt::opengl::CRenderizableDisplayList::setColorA_u8(), mrpt::opengl::CSetOfTriangles::setColorA_u8(), mrpt::opengl::CColorBar::setColorAndValueLimits(), mrpt::opengl::CRenderizableDisplayList::setColorB_u8(), mrpt::opengl::CSetOfTriangles::setColorB_u8(), mrpt::opengl::CRenderizableDisplayList::setColorG_u8(), mrpt::opengl::CSetOfTriangles::setColorG_u8(), mrpt::opengl::CColorBar::setColormap(), mrpt::opengl::CRenderizableDisplayList::setColorR_u8(), mrpt::opengl::CSetOfTriangles::setColorR_u8(), mrpt::opengl::CEllipsoid::setCovMatrix(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::setCovMatrixAndMean(), mrpt::opengl::CDisk::setDiskRadius(), mrpt::opengl::COpenGLStandardObject::setFlags(), mrpt::opengl::CText3D::setFont(), mrpt::opengl::CAxis::setFrequency(), setGeneratrix(), mrpt::opengl::CVectorField2D::setGridCenterAndCellSize(), mrpt::opengl::CGridPlaneXZ::setGridFrequency(), mrpt::opengl::CGridPlaneXY::setGridFrequency(), mrpt::opengl::CMeshFast::setGridLimits(), mrpt::opengl::CMesh::setGridLimits(), mrpt::opengl::CVectorField2D::setGridLimits(), mrpt::opengl::COctoMapVoxels::setGridLinesColor(), mrpt::opengl::COctoMapVoxels::setGridLinesWidth(), mrpt::opengl::CCylinder::setHasBases(), mrpt::opengl::CArrow::setHeadRatio(), mrpt::opengl::CCylinder::setHeight(), mrpt::opengl::CFrustum::setHorzFOV(), mrpt::opengl::CFrustum::setHorzFOVAsymmetric(), mrpt::opengl::CArrow::setLargeRadius(), mrpt::opengl::CSetOfLines::setLineByIndex(), mrpt::opengl::CSimpleLine::setLineCoords(), mrpt::opengl::CSimpleLine::setLineWidth(), mrpt::opengl::CGridPlaneXY::setLineWidth(), mrpt::opengl::CGridPlaneXZ::setLineWidth(), mrpt::opengl::CAxis::setLineWidth(), mrpt::opengl::CSetOfLines::setLineWidth(), mrpt::opengl::CFrustum::setLineWidth(), mrpt::opengl::CBox::setLineWidth(), mrpt::opengl::CVectorField2D::setLineWidth(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::setLineWidth(), mrpt::opengl::CEllipsoid::setLineWidth(), mrpt::opengl::CVectorField3D::setLineWidth(), mrpt::opengl::CPolyhedron::setLineWidth(), mrpt::opengl::CDisk::setLoopsCount(), mrpt::opengl::CMesh::setMask(), mrpt::opengl::CVectorField3D::setMaxSpeedForColor(), mrpt::opengl::CVectorField3D::setMotionFieldColormap(), mrpt::opengl::CFrustum::setNearFarPlanes(), mrpt::opengl::COpenGLStandardObject::setNormal(), mrpt::opengl::CSphere::setNumberDivsLatitude(), mrpt::opengl::CSphere::setNumberDivsLongitude(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::setNumberOfSegments(), mrpt::opengl::CFrustum::setPlaneColor(), mrpt::opengl::CTexturedPlane::setPlaneCorners(), mrpt::opengl::CGridPlaneXY::setPlaneLimits(), mrpt::opengl::CGridPlaneXZ::setPlaneLimits(), mrpt::opengl::CGridPlaneXZ::setPlaneYcoord(), mrpt::opengl::CGridPlaneXY::setPlaneZcoord(), mrpt::opengl::CVectorField2D::setPointColor(), mrpt::opengl::CVectorField3D::setPointColor(), mrpt::opengl::CVectorField3D::setPointCoordinates(), mrpt::opengl::CVectorField2D::setPointSize(), mrpt::opengl::CVectorField3D::setPointSize(), mrpt::opengl::CEllipsoid::setQuantiles(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::setQuantiles(), mrpt::opengl::CCylinder::setRadii(), mrpt::opengl::CSphere::setRadius(), mrpt::opengl::CCylinder::setRadius(), mrpt::opengl::CPlanarLaserScan::setScan(), mrpt::opengl::CDisk::setSlicesCount(), mrpt::opengl::CCylinder::setSlicesCount(), mrpt::opengl::CArrow::setSmallRadius(), mrpt::opengl::CCylinder::setStacksCount(), mrpt::opengl::CText3D::setString(), mrpt::opengl::CText3D::setTextKerning(), mrpt::opengl::CAxis::setTextScale(), mrpt::opengl::CText3D::setTextSpacing(), mrpt::opengl::CText3D::setTextStyle(), mrpt::opengl::CTexturedPlane::setTextureCornerCoords(), mrpt::opengl::CMesh::setUV(), mrpt::opengl::CVectorField2D::setVectorField(), mrpt::opengl::CVectorField3D::setVectorField(), mrpt::opengl::CVectorField2D::setVectorFieldColor(), mrpt::opengl::CVectorField3D::setVectorFieldColor(), mrpt::opengl::CFrustum::setVertFOV(), mrpt::opengl::CFrustum::setVertFOVAsymmetric(), mrpt::opengl::CSetOfLines::setVerticesPointSize(), setVisibleSections(), mrpt::opengl::COctoMapVoxels::setVisualizationMode(), mrpt::opengl::COctoMapVoxels::setVoxelAsPointsSize(), mrpt::opengl::CBox::setWireframe(), mrpt::opengl::CAngularObservationMesh::setWireframe(), mrpt::opengl::CPolyhedron::setWireframe(), mrpt::opengl::CMeshFast::setXBounds(), mrpt::opengl::CMesh::setXBounds(), mrpt::opengl::CMeshFast::setXMax(), mrpt::opengl::CMesh::setXMax(), mrpt::opengl::CMeshFast::setXMin(), mrpt::opengl::CMesh::setXMin(), mrpt::opengl::CMeshFast::setYBounds(), mrpt::opengl::CMesh::setYBounds(), mrpt::opengl::CMeshFast::setYMax(), mrpt::opengl::CMesh::setYMax(), mrpt::opengl::CMeshFast::setYMin(), mrpt::opengl::CMesh::setYMin(), mrpt::opengl::CMeshFast::setZ(), mrpt::opengl::CMesh::setZ(), mrpt::opengl::COctoMapVoxels::showGridLines(), mrpt::opengl::COctoMapVoxels::showVoxels(), mrpt::opengl::COctoMapVoxels::showVoxelsAsPoints(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::thisclass_readFromStream(), mrpt::opengl::CMesh::updateColorsMatrix(), mrpt::opengl::CMeshFast::updateColorsMatrix(), mrpt::opengl::CMeshFast::updatePoints(), mrpt::opengl::CSetOfTriangles::updatePolygons(), mrpt::opengl::CMesh::updatePolygons(), and mrpt::opengl::CMesh::updateTriangles().

◆ operator delete() [1/3]

void mrpt::opengl::CGeneralizedCylinder::operator delete ( void memory,
void ptr 
)
inlinenoexcept

Definition at line 33 of file CGeneralizedCylinder.h.

◆ operator delete() [2/3]

void mrpt::opengl::CGeneralizedCylinder::operator delete ( void ptr)
inlinenoexcept

Definition at line 33 of file CGeneralizedCylinder.h.

◆ operator delete() [3/3]

void mrpt::opengl::CGeneralizedCylinder::operator delete ( void ptr,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 33 of file CGeneralizedCylinder.h.

◆ operator delete[]()

void mrpt::opengl::CGeneralizedCylinder::operator delete[] ( void ptr)
inlinenoexcept

Definition at line 33 of file CGeneralizedCylinder.h.

◆ operator new() [1/3]

void* mrpt::opengl::CGeneralizedCylinder::operator new ( size_t  size)
inline

Definition at line 33 of file CGeneralizedCylinder.h.

◆ operator new() [2/3]

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

Definition at line 33 of file CGeneralizedCylinder.h.

◆ operator new() [3/3]

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

Definition at line 33 of file CGeneralizedCylinder.h.

◆ operator new[]()

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

Definition at line 33 of file CGeneralizedCylinder.h.

◆ readFromStreamRender()

void mrpt::opengl::CRenderizableDisplayList::readFromStreamRender ( mrpt::serialization::CArchive in)
inlineprotectedinherited

◆ releaseTextureName()

void CRenderizable::releaseTextureName ( unsigned int  i)
staticprotectedinherited

◆ removeVisibleSectionAtEnd()

void CGeneralizedCylinder::removeVisibleSectionAtEnd ( )

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

Exceptions
std::logic_errorwhen there is no such section.
See also
addVisibleSectionAtStart,addVisibleSectionAtEnd,removeVisibleSectionAtStart

Definition at line 292 of file CGeneralizedCylinder.cpp.

◆ removeVisibleSectionAtStart()

void CGeneralizedCylinder::removeVisibleSectionAtStart ( )

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

Exceptions
std::logic_errorif there are no visible sections.
See also
addVisibleSectionAtStart,addVisibleSectionAtEnd,removeVisibleSectionAtEnd

Definition at line 277 of file CGeneralizedCylinder.cpp.

◆ render()

void CRenderizableDisplayList::render ( ) const
overridevirtualinherited

◆ render_dl()

void CGeneralizedCylinder::render_dl ( ) const
overridevirtual

◆ renderTextBitmap() [1/2]

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

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

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

Definition at line 367 of file CRenderizable.cpp.

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

◆ renderTextBitmap() [2/2]

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

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

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

Definition at line 318 of file gl_utils.cpp.

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

◆ serializeFrom()

void CGeneralizedCylinder::serializeFrom ( mrpt::serialization::CArchive in,
uint8_t  serial_version 
)
overrideprotectedvirtual

Pure virtual method for reading (deserializing) from an abstract archive.

Users don't call this method directly. Instead, use stream >> object;.

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 I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 163 of file CGeneralizedCylinder.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

◆ serializeGetVersion()

uint8_t CGeneralizedCylinder::serializeGetVersion ( ) const
overrideprotectedvirtual

Must return the current versioning number of the object.

Start in zero for new classes, and increments each time there is a change in the stored format.

Implements mrpt::serialization::CSerializable.

Definition at line 155 of file CGeneralizedCylinder.cpp.

◆ serializeTo()

void CGeneralizedCylinder::serializeTo ( mrpt::serialization::CArchive out) const
overrideprotectedvirtual

Pure virtual method for writing (serializing) to an abstract archive.

Users don't call this method directly. Instead, use stream << object;.

Exceptions
std::exceptionOn any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 156 of file CGeneralizedCylinder.cpp.

◆ setAllSectionsInvisible()

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

◆ setAllSectionsVisible()

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

Sets all sections visible.

Definition at line 281 of file CGeneralizedCylinder.h.

References fullyVisible, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

◆ setAxis()

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

◆ setClosed()

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

Set whether each section is a closed polygon or not.

Definition at line 210 of file CGeneralizedCylinder.h.

References closed, meshUpToDate, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

◆ setColor() [1/2]

CRenderizable& mrpt::opengl::CRenderizable::setColor ( const mrpt::img::TColorf c)
inlineinherited

Changes the default object color.

Returns
a ref to this

Definition at line 239 of file CRenderizable.h.

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

◆ setColor() [2/2]

CRenderizable& mrpt::opengl::CRenderizable::setColor ( double  R,
double  G,
double  B,
double  A = 1 
)
inlineinherited

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

Returns
a ref to this

Definition at line 248 of file CRenderizable.h.

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

◆ setColor_u8() [1/2]

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

Changes the default object color.

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 113 of file CRenderizableDisplayList.h.

References mrpt::opengl::CRenderizableDisplayList::notifyChange(), and mrpt::opengl::CRenderizable::setColor_u8().

◆ setColor_u8() [2/2]

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

Color components in the range [0,255].

Returns
a ref to this

Definition at line 120 of file CRenderizableDisplayList.h.

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

◆ setColorA()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 182 of file CRenderizable.h.

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

◆ setColorA_u8()

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

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

References mrpt::img::TColor::A, mrpt::opengl::CRenderizable::m_color, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

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

◆ setColorB()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 177 of file CRenderizable.h.

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

◆ setColorB_u8()

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

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

References mrpt::img::TColor::B, mrpt::opengl::CRenderizable::m_color, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

◆ setColorG()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 172 of file CRenderizable.h.

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

◆ setColorG_u8()

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

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

References mrpt::img::TColor::G, mrpt::opengl::CRenderizable::m_color, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

◆ setColorR()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 167 of file CRenderizable.h.

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

◆ setColorR_u8()

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

Color components in the range [0,255].

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 85 of file CRenderizableDisplayList.h.

References mrpt::opengl::CRenderizable::m_color, mrpt::opengl::CRenderizableDisplayList::notifyChange(), and mrpt::img::TColor::R.

◆ setGeneratrix()

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

Set cylinder's profile.

Definition at line 197 of file CGeneralizedCylinder.h.

References generatrix, meshUpToDate, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

◆ setLocation() [1/2]

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

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

Returns
a ref to this

Definition at line 124 of file CRenderizable.h.

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

◆ setLocation() [2/2]

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

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

Returns
a ref to this

Definition at line 114 of file CRenderizable.h.

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

◆ setName()

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

Changes the name of the object.

Definition at line 68 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_name.

◆ setPose() [1/6]

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

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

Definition at line 324 of file CRenderizable.cpp.

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

◆ setPose() [2/6]

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

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

Definition at line 319 of file CRenderizable.cpp.

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

◆ setPose() [3/6]

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

◆ setPose() [4/6]

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

◆ setPose() [5/6]

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

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

Definition at line 314 of file CRenderizable.cpp.

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

◆ setPose() [6/6]

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

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

Definition at line 309 of file CRenderizable.cpp.

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

◆ setScale() [1/2]

CRenderizable& mrpt::opengl::CRenderizable::setScale ( float  s)
inlineinherited

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

Returns
a ref to this

Definition at line 213 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_scale_x, mrpt::opengl::CRenderizable::m_scale_y, and mrpt::opengl::CRenderizable::m_scale_z.

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

◆ setScale() [2/2]

CRenderizable& mrpt::opengl::CRenderizable::setScale ( float  sx,
float  sy,
float  sz 
)
inlineinherited

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

Returns
a ref to this

Definition at line 220 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_scale_x, mrpt::opengl::CRenderizable::m_scale_y, and mrpt::opengl::CRenderizable::m_scale_z.

◆ setVisibility()

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

Set object visibility (default=true)

See also
isVisible

Definition at line 76 of file CRenderizable.h.

References mrpt::opengl::CRenderizable::m_visible.

◆ setVisibleSections()

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

Sets which sections are visible.

Exceptions
std::logic_erroron wrongly defined bounds.

Definition at line 300 of file CGeneralizedCylinder.h.

References firstSection, fullyVisible, getNumberOfSections(), lastSection, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

◆ should_skip_display_list_cache()

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

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

Reimplemented in mrpt::opengl::CSphere.

Definition at line 64 of file CRenderizableDisplayList.h.

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

◆ textBitmapWidth()

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

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

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

Definition at line 376 of file CRenderizable.cpp.

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

◆ traceRay()

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

Ray tracing.

See also
mrpt::opengl::CRenderizable.

Reimplemented from mrpt::opengl::CRenderizable.

Definition at line 128 of file CGeneralizedCylinder.cpp.

References mrpt::math::traceRay().

◆ updateMesh()

void CGeneralizedCylinder::updateMesh ( ) const
private

Updates the mutable mesh.

Definition at line 134 of file CGeneralizedCylinder.cpp.

References createMesh(), and G.

◆ updatePolys()

void CGeneralizedCylinder::updatePolys ( ) const

Updates the mutable set of polygons used in ray tracing.

Definition at line 308 of file CGeneralizedCylinder.cpp.

◆ writeToMatlab()

virtual mxArray* mrpt::serialization::CSerializable::writeToMatlab ( ) const
inlinevirtualinherited

Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class.

Returns
A new mxArray (caller is responsible of memory freeing) or nullptr is class does not support conversion to MATLAB.

Definition at line 70 of file CSerializable.h.

◆ writeToStreamRender()

void CRenderizable::writeToStreamRender ( mrpt::serialization::CArchive out) const
protectedinherited

Member Data Documentation

◆ _init_CGeneralizedCylinder

mrpt::rtti::CLASSINIT mrpt::opengl::CGeneralizedCylinder::_init_CGeneralizedCylinder
staticprotected

Definition at line 33 of file CGeneralizedCylinder.h.

◆ axis

mrpt::aligned_std_vector<mrpt::poses::CPose3D> mrpt::opengl::CGeneralizedCylinder::axis
protected

Cylinder's axis.

It's represented as a pose because it holds the angle to get to the next pose.

Definition at line 102 of file CGeneralizedCylinder.h.

Referenced by CGeneralizedCylinder(), getAxis(), getNumberOfSections(), and setAxis().

◆ className

constexpr const char* mrpt::opengl::CGeneralizedCylinder::className = "CGeneralizedCylinder"
staticconstexpr

Definition at line 33 of file CGeneralizedCylinder.h.

◆ closed

bool mrpt::opengl::CGeneralizedCylinder::closed
protected

Boolean variable which determines if the profile is closed at each section.

Definition at line 123 of file CGeneralizedCylinder.h.

Referenced by isClosed(), and setClosed().

◆ firstSection

size_t mrpt::opengl::CGeneralizedCylinder::firstSection
protected

First visible section, if fullyVisible is set to false.

See also
fullyVisible,lastSection

Definition at line 131 of file CGeneralizedCylinder.h.

Referenced by addVisibleSectionAtStart(), getVisibleSections(), setAllSectionsInvisible(), and setVisibleSections().

◆ fullyVisible

bool mrpt::opengl::CGeneralizedCylinder::fullyVisible
protected

Flag to determine whether the object is fully visible or only some sections are.

Definition at line 126 of file CGeneralizedCylinder.h.

Referenced by addVisibleSectionAtEnd(), addVisibleSectionAtStart(), getVisibleSections(), setAllSectionsInvisible(), setAllSectionsVisible(), setAxis(), and setVisibleSections().

◆ generatrix

std::vector<mrpt::math::TPoint3D> mrpt::opengl::CGeneralizedCylinder::generatrix
protected

Object's generatrix, that is, profile which will be extruded.

Definition at line 104 of file CGeneralizedCylinder.h.

Referenced by getGeneratrix(), and setGeneratrix().

◆ lastSection

size_t mrpt::opengl::CGeneralizedCylinder::lastSection
protected

Last visible section, if fullyVisible is set to false.

See also
fullyVisible,firstSection

Definition at line 136 of file CGeneralizedCylinder.h.

Referenced by addVisibleSectionAtEnd(), getVisibleSections(), setAllSectionsInvisible(), and setVisibleSections().

◆ m_color

mrpt::img::TColor mrpt::opengl::CRenderizable::m_color
protectedinherited

◆ m_dl

unsigned int mrpt::opengl::CRenderizableDisplayList::m_dl
mutableprivateinherited

Display list ID, for derived classes that want to use it (it's automatically deleted and freed on destruction of this base class).

Definition at line 46 of file CRenderizableDisplayList.h.

Referenced by mrpt::opengl::CRenderizableDisplayList::render(), and mrpt::opengl::CRenderizableDisplayList::~CRenderizableDisplayList().

◆ m_dl_recreate

bool mrpt::opengl::CRenderizableDisplayList::m_dl_recreate
mutableprivateinherited

If using display lists, this is true when the list must be updated (the object changes, it's the first rendering, etc...).

Definition at line 49 of file CRenderizableDisplayList.h.

Referenced by mrpt::opengl::CRenderizableDisplayList::notifyChange(), and mrpt::opengl::CRenderizableDisplayList::render().

◆ m_name

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

◆ m_pose

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

6D pose wrt the parent coordinate reference.

This class automatically holds the cached 3x3 rotation matrix for quick load into opengl stack.

Definition at line 57 of file CRenderizable.h.

Referenced by mrpt::opengl::CAssimpModel::getBoundingBox(), mrpt::opengl::CBox::getBoundingBox(), mrpt::opengl::CSimpleLine::getBoundingBox(), mrpt::opengl::CTexturedPlane::getBoundingBox(), mrpt::opengl::CGridPlaneXY::getBoundingBox(), mrpt::opengl::CText3D::getBoundingBox(), mrpt::opengl::CGridPlaneXZ::getBoundingBox(), mrpt::opengl::CFrustum::getBoundingBox(), mrpt::opengl::CPlanarLaserScan::getBoundingBox(), mrpt::opengl::CPolyhedron::getBoundingBox(), mrpt::opengl::CSetOfLines::getBoundingBox(), mrpt::opengl::CVectorField2D::getBoundingBox(), mrpt::opengl::CVectorField3D::getBoundingBox(), mrpt::opengl::CRenderizable::getPose(), mrpt::opengl::CRenderizable::getPosePitch(), mrpt::opengl::CRenderizable::getPosePitchRad(), mrpt::opengl::CRenderizable::getPoseRef(), mrpt::opengl::CRenderizable::getPoseRoll(), mrpt::opengl::CRenderizable::getPoseRollRad(), mrpt::opengl::CRenderizable::getPoseX(), mrpt::opengl::CRenderizable::getPoseY(), mrpt::opengl::CRenderizable::getPoseYaw(), mrpt::opengl::CRenderizable::getPoseYawRad(), mrpt::opengl::CRenderizable::getPoseZ(), mrpt::opengl::CPolyhedron::getSetOfPolygonsAbsolute(), mrpt::opengl::CRenderizable::readFromStreamRender(), mrpt::opengl::CGeneralizedEllipsoidTemplate< 3 >::render_dl(), mrpt::opengl::CRenderizable::setLocation(), mrpt::opengl::CRenderizable::setPose(), mrpt::opengl::CTexturedPlane::traceRay(), mrpt::opengl::CPolyhedron::traceRay(), and mrpt::opengl::CRenderizable::writeToStreamRender().

◆ m_scale_x

float mrpt::opengl::CRenderizable::m_scale_x
protectedinherited

◆ m_scale_y

float mrpt::opengl::CRenderizable::m_scale_y
protectedinherited

◆ m_scale_z

float mrpt::opengl::CRenderizable::m_scale_z
protectedinherited

◆ m_show_name

bool mrpt::opengl::CRenderizable::m_show_name
protectedinherited

◆ m_visible

bool mrpt::opengl::CRenderizable::m_visible
protectedinherited

◆ mesh

std::vector<TQuadrilateral> mrpt::opengl::CGeneralizedCylinder::mesh
mutableprotected

Mutable object with mesh information, used to avoid repeated computations.


Definition at line 107 of file CGeneralizedCylinder.h.

◆ meshUpToDate

bool mrpt::opengl::CGeneralizedCylinder::meshUpToDate
mutableprotected

Mutable flag which tells if recalculations are needed.

Definition at line 112 of file CGeneralizedCylinder.h.

Referenced by setAxis(), setClosed(), and setGeneratrix().

◆ pointsMesh

mrpt::math::CMatrixTemplate<mrpt::math::TPoint3D> mrpt::opengl::CGeneralizedCylinder::pointsMesh
mutableprotected

Mutable object with the cylinder's points, used to avoid repeated computations.

Definition at line 110 of file CGeneralizedCylinder.h.

◆ polys

std::vector<mrpt::math::TPolygonWithPlane> mrpt::opengl::CGeneralizedCylinder::polys
mutableprotected

Mutable set of data used in ray tracing.

See also
mrpt::math::TPolygonWithPlane

Definition at line 117 of file CGeneralizedCylinder.h.

◆ polysUpToDate

bool mrpt::opengl::CGeneralizedCylinder::polysUpToDate
mutableprotected

Mutable flag telling whether ray tracing temporary data must be recalculated or not.

Definition at line 120 of file CGeneralizedCylinder.h.

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::opengl::CGeneralizedCylinder::runtimeClassId
staticprotected

Definition at line 33 of file CGeneralizedCylinder.h.




Page generated by Doxygen 1.8.17 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at miƩ 12 jul 2023 10:03:34 CEST