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

Detailed Description

A cylinder or cone whose base lies in the XY plane.

See also
opengl::COpenGLScene,opengl::CDisk
mrpt::opengl::CCylinder

Definition at line 30 of file CCylinder.h.

#include <mrpt/opengl/CCylinder.h>

Inheritance diagram for mrpt::opengl::CCylinder:
Inheritance graph

Public Member Functions

void render_dl () const MRPT_OVERRIDE
 Render. More...
 
bool traceRay (const mrpt::poses::CPose3D &o, double &dist) const MRPT_OVERRIDE
 Ray tracing. More...
 
void setHasBases (bool top=true, bool bottom=true)
 Configuration of the cylinder's bases display. More...
 
bool hasTopBase () const
 Check whether top base is displayed. More...
 
bool hasBottomBase () const
 Check whether bottom base is displayed. More...
 
void setRadius (float radius)
 Sets both radii to a single value, thus configuring the object as a cylinder. More...
 
void setRadii (float bottom, float top)
 Sets both radii independently. More...
 
void setHeight (float height)
 Chenges cylinder's height. More...
 
float getBottomRadius () const
 Gets the bottom radius. More...
 
float getTopRadius () const
 Gets the top radius. More...
 
float getHeight () const
 Gets the cylinder's height. More...
 
void setSlicesCount (uint32_t slices)
 Gets how many slices are used in the cylinder's lateral area and in its bases. More...
 
void setStacksCount (uint32_t stacks)
 Gets how many stacks are used in the cylinder's lateral area. More...
 
uint32_t getSlicesCount () const
 Sets the amount of slices used to display the object. More...
 
uint32_t getStacksCount () const
 Sets the amount of stacks used to display the object. More...
 
void getBoundingBox (mrpt::math::TPoint3D &bb_min, mrpt::math::TPoint3D &bb_max) const MRPT_OVERRIDE
 Evaluates the bounding box of this object (including possible children) in the coordinate frame of the object parent. More...
 
CRenderizableDisplayListclone () const
 Interface for the stlplus smart pointer class. More...
 
void render () const MRPT_OVERRIDE
 Render the object, regenerating the display list if needed, otherwise just calling it. More...
 
Changes the appearance of the object to render (methods from CRenderizable that need to be redefined)
CRenderizablesetColorR_u8 (const uint8_t r) MRPT_OVERRIDE
 Color components in the range [0,255]. More...
 
CRenderizablesetColorG_u8 (const uint8_t g) MRPT_OVERRIDE
 Color components in the range [0,255]. More...
 
CRenderizablesetColorB_u8 (const uint8_t b) MRPT_OVERRIDE
 Color components in the range [0,255]. More...
 
CRenderizablesetColorA_u8 (const uint8_t a) MRPT_OVERRIDE
 Color components in the range [0,255]. More...
 
CRenderizablesetColor_u8 (const mrpt::utils::TColor &c) MRPT_OVERRIDE
 Changes the default object color. More...
 
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) More...
 
void setName (const std::string &n)
 Changes the name of the object. More...
 
const std::string & getName () const
 Returns the name of the object. More...
 
bool isVisible () const
 Is the object visible? More...
 
void setVisibility (bool visible=true)
 Set object visibility (default=true) More...
 
void enableShowName (bool showName=true)
 Enables or disables showing the name of the object as a label when rendering. More...
 
bool isShowNameEnabled () const
 
CRenderizablesetPose (const mrpt::poses::CPose3D &o)
 Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...
 
CRenderizablesetPose (const mrpt::math::TPose3D &o)
 Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this) More...
 
CRenderizablesetPose (const mrpt::poses::CPoint3D &o)
 Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...
 
CRenderizablesetPose (const mrpt::poses::CPoint2D &o)
 Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...
 
mrpt::math::TPose3D getPose () const
 Returns the 3D pose of the object as TPose3D. More...
 
const mrpt::poses::CPose3DgetPoseRef () const
 Returns a const ref to the 3D pose of the object as mrpt::poses::CPose3D (which explicitly contains the 3x3 rotation matrix) More...
 
CRenderizablesetLocation (double x, double y, double z)
 Changes the location of the object, keeping untouched the orientation. More...
 
CRenderizablesetLocation (const mrpt::math::TPoint3D &p)
 Changes the location of the object, keeping untouched the orientation. More...
 
double getPoseX () const
 Translation relative to parent coordinate origin. More...
 
double getPoseY () const
 Translation relative to parent coordinate origin. More...
 
double getPoseZ () const
 Translation relative to parent coordinate origin. More...
 
double getPoseYaw () const
 Rotation relative to parent coordinate origin, in DEGREES. More...
 
double getPosePitch () const
 Rotation relative to parent coordinate origin, in DEGREES. More...
 
double getPoseRoll () const
 Rotation relative to parent coordinate origin, in DEGREES. More...
 
double getPoseYawRad () const
 Rotation relative to parent coordinate origin, in radians. More...
 
double getPosePitchRad () const
 Rotation relative to parent coordinate origin, in radians. More...
 
double getPoseRollRad () const
 Rotation relative to parent coordinate origin, in radians. More...
 
double getColorR () const
 Color components in the range [0,1]. More...
 
double getColorG () const
 Color components in the range [0,1]. More...
 
double getColorB () const
 Color components in the range [0,1]. More...
 
double getColorA () const
 Color components in the range [0,1]. More...
 
uint8_t getColorR_u8 () const
 Color components in the range [0,255]. More...
 
uint8_t getColorG_u8 () const
 Color components in the range [0,255]. More...
 
uint8_t getColorB_u8 () const
 Color components in the range [0,255]. More...
 
uint8_t getColorA_u8 () const
 Color components in the range [0,255]. More...
 
CRenderizablesetColorR (const double r)
 Color components in the range [0,1]. More...
 
CRenderizablesetColorG (const double g)
 Color components in the range [0,1]. More...
 
CRenderizablesetColorB (const double b)
 Color components in the range [0,1]. More...
 
CRenderizablesetColorA (const double a)
 Color components in the range [0,1]. More...
 
CRenderizablesetScale (float s)
 Scale to apply to the object, in all three axes (default=1) More...
 
CRenderizablesetScale (float sx, float sy, float sz)
 Scale to apply to the object in each axis (default=1) More...
 
float getScaleX () const
 Get the current scaling factor in one axis. More...
 
float getScaleY () const
 Get the current scaling factor in one axis. More...
 
float getScaleZ () const
 Get the current scaling factor in one axis. More...
 
mrpt::utils::TColorf getColor () const
 Returns the object color property as a TColorf. More...
 
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) More...
 
const mrpt::utils::TColorgetColor_u8 () const
 Returns the object color property as a TColor. More...
 

Static Public Member Functions

static CCylinderPtr Create (const float baseRadius, const float topRadius, const float height=1, const int slices=10, const int stacks=10)
 Constructor with two radii. More...
 
static void renderTextBitmap (const char *str, void *fontStyle)
 This method is safe for calling from within render() methods. More...
 
static void renderTextBitmap (int screen_x, int screen_y, const std::string &str, float color_r=1, float color_g=1, float color_b=1, mrpt::opengl::TOpenGLFont font=mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24)
 Render a text message in the current rendering context, creating a glViewport in the way (do not call within render() methods) More...
 
static int textBitmapWidth (const std::string &str, mrpt::opengl::TOpenGLFont font=mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24)
 Return the exact width in pixels for a given string, as will be rendered by renderTextBitmap(). More...
 

Static Public Attributes

RTTI stuff <br>
static const mrpt::utils::TRuntimeClassId classCRenderizableDisplayList
 
RTTI stuff <br>
static const mrpt::utils::TRuntimeClassId classCRenderizable
 

Protected Member Functions

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

Static Protected Member Functions

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

Protected Attributes

float mBaseRadius
 Cylinder's radii. More...
 
float mTopRadius
 
float mHeight
 Cylinder's height. More...
 
uint32_t mSlices
 Implementation parameters on which depend the number of actually rendered polygons. More...
 
uint32_t mStacks
 
bool mHasTopBase
 Boolean parameters about including the bases in the object. More...
 
bool mHasBottomBase
 
std::string m_name
 
bool m_show_name
 
mrpt::utils::TColor m_color
 Color components in the range [0,255]. More...
 
mrpt::poses::CPose3D m_pose
 6D pose wrt the parent coordinate reference. This class automatically holds the cached 3x3 rotation matrix for quick load into opengl stack. More...
 
float m_scale_x
 
float m_scale_y
 
float m_scale_z
 Scale components to apply to the object (default=1) More...
 
bool m_visible
 Is the object visible? (default=true) More...
 

Private Member Functions

 CCylinder ()
 Basic empty constructor. More...
 
 CCylinder (const float baseRadius, const float topRadius, const float height, const int slices, const int stacks)
 Complete constructor. More...
 
virtual ~CCylinder ()
 Destructor. More...
 
bool getRadius (float Z, float &r) const
 Gets the radius of the circunference located at certain height, returning false if the cylinder doesn't get that high. More...
 
bool reachesHeight (float Z) const
 Checks whether the cylinder exists at some height. 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 <br>

typedef CCylinderPtr SmartPtr
 
static mrpt::utils::CLASSINIT _init_CCylinder
 
static mrpt::utils::TRuntimeClassId classCCylinder
 
static const mrpt::utils::TRuntimeClassIdclassinfo
 
static const mrpt::utils::TRuntimeClassId_GetBaseClass ()
 
virtual const mrpt::utils::TRuntimeClassIdGetRuntimeClass () const MRPT_OVERRIDE
 
virtual mrpt::utils::CObjectduplicate () const MRPT_OVERRIDE
 
static mrpt::utils::CObjectCreateObject ()
 
static CCylinderPtr Create ()
 

Member Typedef Documentation

◆ SmartPtr

A typedef for the associated smart pointer

Definition at line 31 of file CCylinder.h.

Constructor & Destructor Documentation

◆ CCylinder() [1/2]

mrpt::opengl::CCylinder::CCylinder ( )
inlineprivate

Basic empty constructor.

Set all parameters to default.

Definition at line 158 of file CCylinder.h.

◆ CCylinder() [2/2]

mrpt::opengl::CCylinder::CCylinder ( const float  baseRadius,
const float  topRadius,
const float  height,
const int  slices,
const int  stacks 
)
inlineprivate

Complete constructor.

Allows the configuration of every parameter.

Definition at line 162 of file CCylinder.h.

◆ ~CCylinder()

virtual mrpt::opengl::CCylinder::~CCylinder ( )
inlineprivatevirtual

Destructor.

Definition at line 166 of file CCylinder.h.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId * mrpt::opengl::CCylinder::_GetBaseClass ( )
staticprotected

◆ checkOpenGLError()

static void mrpt::opengl::CRenderizable::checkOpenGLError ( )
staticprotectedinherited

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

◆ clone()

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

Interface for the stlplus smart pointer class.

Definition at line 71 of file CRenderizableDisplayList.h.

◆ Create() [1/2]

static CCylinderPtr mrpt::opengl::CCylinder::Create ( )
static

◆ Create() [2/2]

static CCylinderPtr mrpt::opengl::CCylinder::Create ( const float  baseRadius,
const float  topRadius,
const float  height = 1,
const int  slices = 10,
const int  stacks = 10 
)
static

Constructor with two radii.

Allows the construction of any cylinder.

◆ CreateObject()

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

◆ duplicate()

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

◆ enableShowName()

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

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

Definition at line 69 of file CRenderizable.h.

◆ getBottomRadius()

float mrpt::opengl::CCylinder::getBottomRadius ( ) const
inline

Gets the bottom radius.

Definition at line 110 of file CCylinder.h.

◆ getBoundingBox()

void mrpt::opengl::CCylinder::getBoundingBox ( mrpt::math::TPoint3D bb_min,
mrpt::math::TPoint3D bb_max 
) const
virtual

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

Implements mrpt::opengl::CRenderizable.

◆ getColor()

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

Returns the object color property as a TColorf.

Definition at line 124 of file CRenderizable.h.

◆ getColor_u8()

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

Returns the object color property as a TColor.

Definition at line 133 of file CRenderizable.h.

◆ getColorA()

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

Color components in the range [0,1].

Definition at line 100 of file CRenderizable.h.

◆ getColorA_u8()

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

Color components in the range [0,255].

Definition at line 105 of file CRenderizable.h.

◆ getColorB()

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

Color components in the range [0,1].

Definition at line 99 of file CRenderizable.h.

◆ getColorB_u8()

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

Color components in the range [0,255].

Definition at line 104 of file CRenderizable.h.

◆ getColorG()

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

Color components in the range [0,1].

Definition at line 98 of file CRenderizable.h.

◆ getColorG_u8()

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

Color components in the range [0,255].

Definition at line 103 of file CRenderizable.h.

◆ getColorR()

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

Color components in the range [0,1].

Definition at line 97 of file CRenderizable.h.

◆ getColorR_u8()

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

Color components in the range [0,255].

Definition at line 102 of file CRenderizable.h.

◆ getHeight()

float mrpt::opengl::CCylinder::getHeight ( ) const
inline

Gets the cylinder's height.

Definition at line 122 of file CCylinder.h.

◆ getName()

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

Returns the name of the object.

Definition at line 64 of file CRenderizable.h.

◆ getNewTextureNumber()

static unsigned int mrpt::opengl::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).


◆ getPose()

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

Returns the 3D pose of the object as TPose3D.

◆ getPosePitch()

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

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 91 of file CRenderizable.h.

References mrpt::utils::RAD2DEG().

◆ getPosePitchRad()

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

Rotation relative to parent coordinate origin, in radians.

Definition at line 94 of file CRenderizable.h.

◆ getPoseRef()

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

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

Definition at line 79 of file CRenderizable.h.

◆ getPoseRoll()

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

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 92 of file CRenderizable.h.

References mrpt::utils::RAD2DEG().

◆ getPoseRollRad()

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

Rotation relative to parent coordinate origin, in radians.

Definition at line 95 of file CRenderizable.h.

◆ getPoseX()

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

Translation relative to parent coordinate origin.

Definition at line 87 of file CRenderizable.h.

◆ getPoseY()

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

Translation relative to parent coordinate origin.

Definition at line 88 of file CRenderizable.h.

◆ getPoseYaw()

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

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 90 of file CRenderizable.h.

References mrpt::utils::RAD2DEG().

◆ getPoseYawRad()

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

Rotation relative to parent coordinate origin, in radians.

Definition at line 93 of file CRenderizable.h.

◆ getPoseZ()

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

Translation relative to parent coordinate origin.

Definition at line 89 of file CRenderizable.h.

◆ getRadius()

bool mrpt::opengl::CCylinder::getRadius ( float  Z,
float &  r 
) const
inlineprivate

Gets the radius of the circunference located at certain height, returning false if the cylinder doesn't get that high.

Definition at line 170 of file CCylinder.h.

◆ GetRuntimeClass()

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

◆ getScaleX()

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

Get the current scaling factor in one axis.

Definition at line 119 of file CRenderizable.h.

◆ getScaleY()

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

Get the current scaling factor in one axis.

Definition at line 120 of file CRenderizable.h.

◆ getScaleZ()

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

Get the current scaling factor in one axis.

Definition at line 121 of file CRenderizable.h.

◆ getSlicesCount()

uint32_t mrpt::opengl::CCylinder::getSlicesCount ( ) const
inline

Sets the amount of slices used to display the object.

Definition at line 142 of file CCylinder.h.

◆ getStacksCount()

uint32_t mrpt::opengl::CCylinder::getStacksCount ( ) const
inline

Sets the amount of stacks used to display the object.

Definition at line 148 of file CCylinder.h.

◆ getTopRadius()

float mrpt::opengl::CCylinder::getTopRadius ( ) const
inline

Gets the top radius.

Definition at line 116 of file CCylinder.h.

◆ hasBottomBase()

bool mrpt::opengl::CCylinder::hasBottomBase ( ) const
inline

Check whether bottom base is displayed.

See also
hasTopBase

Definition at line 80 of file CCylinder.h.

◆ hasTopBase()

bool mrpt::opengl::CCylinder::hasTopBase ( ) const
inline

Check whether top base is displayed.

See also
hasBottomBase

Definition at line 73 of file CCylinder.h.

◆ isShowNameEnabled()

bool mrpt::opengl::CRenderizable::isShowNameEnabled ( ) const
inlineinherited
See also
enableShowName

Definition at line 70 of file CRenderizable.h.

◆ isVisible()

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

Is the object visible?

See also
setVisibility

Definition at line 66 of file CRenderizable.h.

◆ notifyChange()

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

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

Definition at line 49 of file CRenderizableDisplayList.h.

Referenced by mrpt::opengl::CGeneralizedCylinder::addVisibleSectionAtEnd(), mrpt::opengl::CGeneralizedCylinder::addVisibleSectionAtStart(), mrpt::opengl::CMesh::adjustGridToImageAR(), mrpt::opengl::CMeshFast::adjustGridToImageAR(), mrpt::opengl::CSetOfLines::appendLine(), mrpt::opengl::CSetOfLines::appendLines(), mrpt::opengl::CSetOfLines::begin(), mrpt::opengl::CSetOfLines::clear(), mrpt::opengl::CVectorField2D::clear(), mrpt::opengl::CVectorField3D::clear(), mrpt::opengl::CSetOfTexturedTriangles::clearTriangles(), mrpt::opengl::CSetOfTriangles::clearTriangles(), mrpt::opengl::COpenGLStandardObject::enable(), mrpt::opengl::CGridPlaneXY::enableAntiAliasing(), mrpt::opengl::CGridPlaneXZ::enableAntiAliasing(), mrpt::opengl::CSetOfLines::enableAntiAliasing(), mrpt::opengl::CSimpleLine::enableAntiAliasing(), mrpt::opengl::CVectorField2D::enableAntiAliasing(), mrpt::opengl::CVectorField3D::enableAntiAliasing(), mrpt::opengl::CMesh3D::enableAntiAliasing(), mrpt::opengl::CBox::enableBoxBorder(), mrpt::opengl::CVectorField3D::enableColorFromModule(), mrpt::opengl::CMesh::enableColorFromZ(), mrpt::opengl::CMeshFast::enableColorFromZ(), mrpt::opengl::COctoMapVoxels::enableCubeTransparency(), mrpt::opengl::CEllipsoid::enableDrawSolid3D(), mrpt::opengl::C3DSScene::enableExtraAmbientLight(), mrpt::opengl::CMesh3D::enableFaceNormals(), mrpt::opengl::COctoMapVoxels::enableLights(), mrpt::opengl::CPlanarLaserScan::enableLine(), mrpt::opengl::CPlanarLaserScan::enablePoints(), mrpt::opengl::CSphere::enableRadiusIndependentOfEyeDistance(), mrpt::opengl::CMesh3D::enableShowEdges(), mrpt::opengl::CMesh3D::enableShowFaces(), mrpt::opengl::CVectorField3D::enableShowPoints(), mrpt::opengl::CMesh3D::enableShowVertices(), mrpt::opengl::CPlanarLaserScan::enableSurface(), mrpt::opengl::CAxis::enableTickMarks(), mrpt::opengl::CAngularObservationMesh::enableTransparency(), mrpt::opengl::CMesh::enableTransparency(), mrpt::opengl::CMesh3D::enableTransparency(), mrpt::opengl::CMeshFast::enableTransparency(), mrpt::opengl::CSetOfTriangles::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::COctoMapVoxels::push_back_GridCube(), mrpt::opengl::COctoMapVoxels::push_back_Voxel(), mrpt::opengl::CSetOfLines::reserve(), mrpt::opengl::CSetOfTriangles::reserve(), mrpt::opengl::COctoMapVoxels::reserveVoxels(), mrpt::opengl::CSetOfLines::resize(), mrpt::opengl::CVectorField2D::resize(), mrpt::opengl::CVectorField3D::resize(), mrpt::opengl::COctoMapVoxels::resizeGridCubes(), mrpt::opengl::COctoMapVoxels::resizeVoxels(), mrpt::opengl::COctoMapVoxels::resizeVoxelSets(), mrpt::opengl::CEllipsoid::set2DsegmentsCount(), mrpt::opengl::CEllipsoid::set3DsegmentsCount(), mrpt::opengl::CGeneralizedCylinder::setAllSectionsInvisible(), mrpt::opengl::CGeneralizedCylinder::setAllSectionsVisible(), mrpt::opengl::CArrow::setArrowEnds(), mrpt::opengl::CArrow::setArrowYawPitchRoll(), mrpt::opengl::CGeneralizedCylinder::setAxis(), mrpt::opengl::CAxis::setAxisLimits(), mrpt::opengl::CBox::setBoxBorderColor(), mrpt::opengl::CGeneralizedCylinder::setClosed(), mrpt::opengl::CGeneralizedEllipsoidTemplate< DIM >::setCovMatrixAndMean(), mrpt::opengl::CDisk::setDiskRadius(), mrpt::opengl::COpenGLStandardObject::setFlags(), mrpt::opengl::CText3D::setFont(), mrpt::opengl::CAxis::setFrequency(), mrpt::opengl::CGeneralizedCylinder::setGeneratrix(), mrpt::opengl::CVectorField2D::setGridCenterAndCellSize(), mrpt::opengl::CGridPlaneXY::setGridFrequency(), mrpt::opengl::CGridPlaneXZ::setGridFrequency(), mrpt::opengl::CVectorField2D::setGridLimits(), mrpt::opengl::CMesh::setGridLimits(), mrpt::opengl::CMeshFast::setGridLimits(), mrpt::opengl::COctoMapVoxels::setGridLinesColor(), mrpt::opengl::COctoMapVoxels::setGridLinesWidth(), setHasBases(), mrpt::opengl::CArrow::setHeadRatio(), setHeight(), mrpt::opengl::CArrow::setLargeRadius(), mrpt::opengl::CSetOfLines::setLineByIndex(), mrpt::opengl::CSimpleLine::setLineCoords(), mrpt::opengl::CVectorField2D::setLineWidth(), mrpt::opengl::CVectorField3D::setLineWidth(), mrpt::opengl::CPolyhedron::setLineWidth(), mrpt::opengl::CAxis::setLineWidth(), mrpt::opengl::CEllipsoid::setLineWidth(), mrpt::opengl::CGeneralizedEllipsoidTemplate< DIM >::setLineWidth(), mrpt::opengl::CGridPlaneXY::setLineWidth(), mrpt::opengl::CGridPlaneXZ::setLineWidth(), mrpt::opengl::CSetOfLines::setLineWidth(), mrpt::opengl::CSimpleLine::setLineWidth(), mrpt::opengl::CBox::setLineWidth(), mrpt::opengl::CFrustum::setLineWidth(), mrpt::opengl::CDisk::setLoopsCount(), mrpt::opengl::CVectorField3D::setMaxSpeedForColor(), mrpt::opengl::CVectorField3D::setMotionFieldColormap(), mrpt::opengl::COpenGLStandardObject::setNormal(), mrpt::opengl::CSphere::setNumberDivsLatitude(), mrpt::opengl::CSphere::setNumberDivsLongitude(), mrpt::opengl::CGeneralizedEllipsoidTemplate< DIM >::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< DIM >::setQuantiles(), setRadii(), mrpt::opengl::CSphere::setRadius(), setRadius(), mrpt::opengl::CPlanarLaserScan::setScan(), mrpt::opengl::CDisk::setSlicesCount(), setSlicesCount(), mrpt::opengl::CArrow::setSmallRadius(), setStacksCount(), mrpt::opengl::CText3D::setString(), mrpt::opengl::CText3D::setTextKerning(), mrpt::opengl::CText3D::setTextSpacing(), mrpt::opengl::CText3D::setTextStyle(), mrpt::opengl::CTexturedPlane::setTextureCornerCoords(), mrpt::opengl::CVectorField2D::setVectorField(), mrpt::opengl::CVectorField3D::setVectorField(), mrpt::opengl::CVectorField2D::setVectorFieldColor(), mrpt::opengl::CVectorField3D::setVectorFieldColor(), mrpt::opengl::CGeneralizedCylinder::setVisibleSections(), mrpt::opengl::COctoMapVoxels::setVisualizationMode(), mrpt::opengl::COctoMapVoxels::setVoxelAsPointsSize(), mrpt::opengl::CAngularObservationMesh::setWireframe(), mrpt::opengl::CPolyhedron::setWireframe(), mrpt::opengl::CBox::setWireframe(), mrpt::opengl::CMesh::setXBounds(), mrpt::opengl::CMeshFast::setXBounds(), mrpt::opengl::CMesh::setXMax(), mrpt::opengl::CMeshFast::setXMax(), mrpt::opengl::CMesh::setXMin(), mrpt::opengl::CMeshFast::setXMin(), mrpt::opengl::CMesh::setYBounds(), mrpt::opengl::CMeshFast::setYBounds(), mrpt::opengl::CMesh::setYMax(), mrpt::opengl::CMeshFast::setYMax(), mrpt::opengl::CMesh::setYMin(), mrpt::opengl::CMeshFast::setYMin(), mrpt::opengl::COctoMapVoxels::showGridLines(), mrpt::opengl::COctoMapVoxels::showVoxels(), mrpt::opengl::COctoMapVoxels::showVoxelsAsPoints(), and mrpt::opengl::CGeneralizedEllipsoidTemplate< DIM >::thisclass_readFromStream().

◆ reachesHeight()

bool mrpt::opengl::CCylinder::reachesHeight ( float  Z) const
inlineprivate

Checks whether the cylinder exists at some height.

Definition at line 178 of file CCylinder.h.

◆ readFromStream()

void mrpt::opengl::CCylinder::readFromStream ( mrpt::utils::CStream in,
int  version 
)
protected

◆ readFromStreamRender()

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

◆ releaseTextureName()

static void mrpt::opengl::CRenderizable::releaseTextureName ( unsigned int  i)
staticprotectedinherited

◆ render()

void mrpt::opengl::CRenderizableDisplayList::render ( ) const
virtualinherited

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

Implements mrpt::opengl::CRenderizable.

◆ render_dl()

void mrpt::opengl::CCylinder::render_dl ( ) const
virtual

◆ renderTextBitmap() [1/2]

static void mrpt::opengl::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() [2/2]

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

◆ setColor() [1/2]

CRenderizable & mrpt::opengl::CRenderizable::setColor ( const mrpt::utils::TColorf c)
inlineinherited
Parameters
cChanges the default object color
Returns
a ref to this

Definition at line 125 of file CRenderizable.h.

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

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

◆ setColor_u8() [1/2]

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

Changes the default object color.

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 86 of file CRenderizableDisplayList.h.

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

◆ setColor_u8() [2/2]

CRenderizable & mrpt::opengl::CRenderizable::setColor_u8 ( uint8_t  R,
uint8_t  G,
uint8_t  B,
uint8_t  A = 255 
)
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 138 of file CRenderizable.h.

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

Referenced by 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 110 of file CRenderizable.h.

◆ setColorA_u8()

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

Color components in the range [0,255].

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 85 of file CRenderizableDisplayList.h.

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

◆ setColorB_u8()

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

Color components in the range [0,255].

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 84 of file CRenderizableDisplayList.h.

◆ setColorG()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 108 of file CRenderizable.h.

◆ setColorG_u8()

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

Color components in the range [0,255].

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 83 of file CRenderizableDisplayList.h.

◆ setColorR()

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

Color components in the range [0,1].

Returns
a ref to this

Definition at line 107 of file CRenderizable.h.

◆ setColorR_u8()

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

Color components in the range [0,255].

Returns
a ref to this

Reimplemented from mrpt::opengl::CRenderizable.

Reimplemented in mrpt::opengl::CSetOfTriangles.

Definition at line 82 of file CRenderizableDisplayList.h.

◆ setHasBases()

void mrpt::opengl::CCylinder::setHasBases ( bool  top = true,
bool  bottom = true 
)
inline

Configuration of the cylinder's bases display.

Definition at line 64 of file CCylinder.h.

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

◆ setHeight()

void mrpt::opengl::CCylinder::setHeight ( float  height)
inline

Chenges cylinder's height.

Definition at line 103 of file CCylinder.h.

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

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

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

◆ setName()

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

Changes the name of the object.

Definition at line 63 of file CRenderizable.h.

◆ setPose() [1/4]

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)

◆ setPose() [2/4]

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)

◆ setPose() [3/4]

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)

◆ setPose() [4/4]

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)

◆ setRadii()

void mrpt::opengl::CCylinder::setRadii ( float  bottom,
float  top 
)
inline

Sets both radii independently.

See also
setRadius

Definition at line 95 of file CCylinder.h.

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

◆ setRadius()

void mrpt::opengl::CCylinder::setRadius ( float  radius)
inline

Sets both radii to a single value, thus configuring the object as a cylinder.

See also
setRadii

Definition at line 87 of file CCylinder.h.

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

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

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

◆ setSlicesCount()

void mrpt::opengl::CCylinder::setSlicesCount ( uint32_t  slices)
inline

Gets how many slices are used in the cylinder's lateral area and in its bases.

Definition at line 128 of file CCylinder.h.

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

◆ setStacksCount()

void mrpt::opengl::CCylinder::setStacksCount ( uint32_t  stacks)
inline

Gets how many stacks are used in the cylinder's lateral area.

Definition at line 135 of file CCylinder.h.

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

◆ setVisibility()

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

Set object visibility (default=true)

See also
isVisible

Definition at line 67 of file CRenderizable.h.

◆ should_skip_display_list_cache()

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

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

Reimplemented in mrpt::opengl::CSphere.

Definition at line 56 of file CRenderizableDisplayList.h.

◆ textBitmapWidth()

static int mrpt::opengl::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

◆ traceRay()

bool mrpt::opengl::CCylinder::traceRay ( const mrpt::poses::CPose3D o,
double &  dist 
) const
virtual

Ray tracing.

See also
mrpt::opengl::CRenderizable

Reimplemented from mrpt::opengl::CRenderizable.

◆ writeToStream()

void mrpt::opengl::CCylinder::writeToStream ( mrpt::utils::CStream out,
int *  getVersion 
) const
protected

◆ writeToStreamRender()

void mrpt::opengl::CRenderizable::writeToStreamRender ( utils::CStream out) const
protectedinherited

Member Data Documentation

◆ _init_CCylinder

mrpt::utils::CLASSINIT mrpt::opengl::CCylinder::_init_CCylinder
staticprotected

Definition at line 31 of file CCylinder.h.

◆ classCCylinder

mrpt::utils::TRuntimeClassId mrpt::opengl::CCylinder::classCCylinder
static

Definition at line 31 of file CCylinder.h.

◆ classCRenderizable

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

Definition at line 46 of file CRenderizable.h.

◆ classCRenderizableDisplayList

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

Definition at line 38 of file CRenderizableDisplayList.h.

◆ classinfo

const mrpt::utils::TRuntimeClassId* mrpt::opengl::CCylinder::classinfo
static

Definition at line 31 of file CCylinder.h.

◆ m_color

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

Color components in the range [0,255].

Definition at line 54 of file CRenderizable.h.

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

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

◆ m_name

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

Definition at line 52 of file CRenderizable.h.

◆ m_pose

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

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

Definition at line 55 of file CRenderizable.h.

Referenced by mrpt::opengl::CGeneralizedEllipsoidTemplate< DIM >::render_dl().

◆ m_scale_x

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

Definition at line 56 of file CRenderizable.h.

◆ m_scale_y

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

Definition at line 56 of file CRenderizable.h.

◆ m_scale_z

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

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

Definition at line 56 of file CRenderizable.h.

◆ m_show_name

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

Definition at line 53 of file CRenderizable.h.

◆ m_visible

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

Is the object visible? (default=true)

Definition at line 57 of file CRenderizable.h.

◆ mBaseRadius

float mrpt::opengl::CCylinder::mBaseRadius
protected

Cylinder's radii.

If mBaseRadius==mTopRadius, then the object is an actual cylinder. If both differ, it's a truncated cone. If one of the radii is zero, the object is a cone.

Definition at line 36 of file CCylinder.h.

◆ mHasBottomBase

bool mrpt::opengl::CCylinder::mHasBottomBase
protected

Definition at line 48 of file CCylinder.h.

◆ mHasTopBase

bool mrpt::opengl::CCylinder::mHasTopBase
protected

Boolean parameters about including the bases in the object.

If both mHasTopBase and mHasBottomBase are set to false, only the lateral area is displayed.

Definition at line 48 of file CCylinder.h.

◆ mHeight

float mrpt::opengl::CCylinder::mHeight
protected

Cylinder's height.

Definition at line 40 of file CCylinder.h.

◆ mSlices

uint32_t mrpt::opengl::CCylinder::mSlices
protected

Implementation parameters on which depend the number of actually rendered polygons.

Definition at line 44 of file CCylinder.h.

◆ mStacks

uint32_t mrpt::opengl::CCylinder::mStacks
protected

Definition at line 44 of file CCylinder.h.

◆ mTopRadius

float mrpt::opengl::CCylinder::mTopRadius
protected

Definition at line 36 of file CCylinder.h.




Page generated by Doxygen 1.9.5 for MRPT 1.4.0 SVN: at Sun Nov 27 02:56:59 UTC 2022