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 29 of file CCylinder.h.

#include <mrpt/opengl/CCylinder.h>

Inheritance diagram for mrpt::opengl::CCylinder:

Public Member Functions
void	render_dl () const override
	Render. More...

bool	traceRay (const mrpt::poses::CPose3D &o, double &dist) const 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 override
	Evaluates the bounding box of this object (including possible children) in the coordinate frame of the object parent. More...

	CCylinder ()=default
	Basic empty constructor. More...

	CCylinder (const float baseRadius, const float topRadius, const float height=1, const int slices=10, const int stacks=10)
	Complete constructor. More...

	~CCylinder () override=default
	Destructor. More...

void	render () const override
	Render the object, regenerating the display list if needed, otherwise just calling it. More...

virtual mxArray *	writeToMatlab () 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...

Changes the appearance of the object to render (methods from
CRenderizable that need to be redefined)
CRenderizable &	setColorR_u8 (const uint8_t r) override
	Color components in the range [0,255]. More...

CRenderizable &	setColorG_u8 (const uint8_t g) override
	Color components in the range [0,255]. More...

CRenderizable &	setColorB_u8 (const uint8_t b) override
	Color components in the range [0,255]. More...

CRenderizable &	setColorA_u8 (const uint8_t a) override
	Color components in the range [0,255]. More...

CRenderizable &	setColor_u8 (const mrpt::img::TColor &c) override
	Changes the default object color. More...

CRenderizable &	setColor_u8 (uint8_t R, uint8_t G, uint8_t B, uint8_t A=255)
	Color components in the range [0,255]. More...

Changes the appearance of the object to render
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

CRenderizable &	setPose (const mrpt::poses::CPose3D &o)
	Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...

CRenderizable &	setPose (const mrpt::poses::CPose2D &o)
	Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...

CRenderizable &	setPose (const mrpt::math::TPose3D &o)
	Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this) More...

CRenderizable &	setPose (const mrpt::math::TPose2D &o)
	Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this) More...

CRenderizable &	setPose (const mrpt::poses::CPoint3D &o)
	Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this) More...

CRenderizable &	setPose (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::CPose3D &	getPoseRef () const
	Returns a const ref to the 3D pose of the object as mrpt::poses::CPose3D (which explicitly contains the 3x3 rotation matrix) More...

CRenderizable &	setLocation (double x, double y, double z)
	Changes the location of the object, keeping untouched the orientation. More...

CRenderizable &	setLocation (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...

CRenderizable &	setColorR (const double r)
	Color components in the range [0,1]. More...

CRenderizable &	setColorG (const double g)
	Color components in the range [0,1]. More...

CRenderizable &	setColorB (const double b)
	Color components in the range [0,1]. More...

CRenderizable &	setColorA (const double a)
	Color components in the range [0,1]. More...

CRenderizable &	setScale (float s)
	Scale to apply to the object, in all three axes (default=1) More...

CRenderizable &	setScale (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::img::TColorf	getColor () const
	Returns the object color property as a TColorf. More...

CRenderizable &	setColor (const mrpt::img::TColorf &c)
	Changes the default object color. More...

CRenderizable &	setColor (double R, double G, double B, double A=1)
	Set the color components of this object (R,G,B,Alpha, in the range 0-1) More...

const mrpt::img::TColor &	getColor_u8 () const
	Returns the object color property as a TColor. More...

RTTI classes and functions for polymorphic hierarchies
mrpt::rtti::CObject::Ptr	duplicateGetSmartPtr () const
	Makes a deep copy of the object and returns a smart pointer to it. More...

Static Public Member Functions
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...

Methods accesible or implemented by derived classes
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::serialization::CArchive &in)

CSerializable virtual methods
virtual void	serializeTo (CSchemeArchiveBase &out) const
	Virtual method for writing (serializing) to an abstract schema based archive. More...

virtual void	serializeFrom (CSchemeArchiveBase &in)
	Virtual method for reading (deserializing) from an abstract schema based 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
float	mBaseRadius {1}
	Cylinder's radii. More...

float	mTopRadius {1}

float	mHeight {1}
	Cylinder's height. More...

uint32_t	mSlices {10}
	Implementation parameters on which depend the number of actually rendered polygons. More...

uint32_t	mStacks {10}

bool	mHasTopBase {true}
	Boolean parameters about including the bases in the object. More...

bool	mHasBottomBase {true}

std::string	m_name

bool	m_show_name {false}

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 {1}
	Scale components to apply to the object (default=1) More...

float	m_scale_y {1}

float	m_scale_z {1}

bool	m_visible {true}
	Is the object visible? (default=true) More...

Private Member Functions
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...

RTTI stuff
using	Ptr = std::shared_ptr< CCylinder >

using	ConstPtr = std::shared_ptr< const CCylinder >

using	UniquePtr = std::unique_ptr< CCylinder >

using	ConstUniquePtr = std::unique_ptr< const CCylinder >

static mrpt::rtti::CLASSINIT	_init_CCylinder

static const mrpt::rtti::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CCylinder"

static const mrpt::rtti::TRuntimeClassId *	_GetBaseClass ()

static constexpr auto	getClassName ()

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

static std::shared_ptr< CObject >	CreateObject ()

template<typename... Args>
static Ptr	Create (Args &&... args)

template<typename Alloc , typename... Args>
static Ptr	CreateAlloc (const Alloc &alloc, Args &&... args)

template<typename... Args>
static UniquePtr	CreateUnique (Args &&... args)

virtual const mrpt::rtti::TRuntimeClassId *	GetRuntimeClass () const override
	Returns information about the class of an object in runtime. More...

virtual mrpt::rtti::CObject *	clone () const override
	Returns a deep copy (clone) of the object, indepently of its class. More...

Member Typedef Documentation

◆ ConstPtr

using mrpt::opengl::CCylinder::ConstPtr = std::shared_ptr<const CCylinder >

Definition at line 31 of file CCylinder.h.

◆ ConstUniquePtr

using mrpt::opengl::CCylinder::ConstUniquePtr = std::unique_ptr<const CCylinder >

Definition at line 31 of file CCylinder.h.

◆ Ptr

using mrpt::opengl::CCylinder::Ptr = std::shared_ptr< CCylinder >

A type for the associated smart pointer

Definition at line 31 of file CCylinder.h.

◆ UniquePtr

using mrpt::opengl::CCylinder::UniquePtr = std::unique_ptr< CCylinder >

Definition at line 31 of file CCylinder.h.

Constructor & Destructor Documentation

◆ CCylinder() [1/2]

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

default

Basic empty constructor.

Set all parameters to default.

◆ CCylinder() [2/2]

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

inline

Complete constructor.

Allows the configuration of every parameter.Constructor with two radii. Allows the construction of any cylinder.

Definition at line 165 of file CCylinder.h.

◆ ~CCylinder()

mrpt::opengl::CCylinder::~CCylinder ( )

overridedefault

Destructor.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::rtti::TRuntimeClassId* mrpt::opengl::CCylinder::_GetBaseClass ( )

staticprotected

◆ checkOpenGLError()

void CRenderizable::checkOpenGLError ( )

staticprotectedinherited

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

Definition at line 295 of file CRenderizable.cpp.

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

Referenced by mrpt::opengl::COpenGLViewport::render(), mrpt::opengl::CBox::render_dl(), mrpt::opengl::CPlanarLaserScan::render_dl(), mrpt::opengl::CSetOfLines::render_dl(), mrpt::opengl::CVectorField2D::render_dl(), mrpt::opengl::CVectorField3D::render_dl(), and mrpt::opengl::CPolyhedron::render_dl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone()

virtual mrpt::rtti::CObject* mrpt::opengl::CCylinder::clone ( ) const

overridevirtual

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

Implements mrpt::rtti::CObject.

◆ Create()

template<typename... Args>

static Ptr mrpt::opengl::CCylinder::Create ( Args &&... args )

inlinestatic

Definition at line 31 of file CCylinder.h.

Referenced by addBar_A(), and addBar_D().

Here is the caller graph for this function:

◆ CreateAlloc()

template<typename Alloc , typename... Args>

static Ptr mrpt::opengl::CCylinder::CreateAlloc	(	const Alloc &	alloc,
		Args &&...	args
	)

inlinestatic

Definition at line 31 of file CCylinder.h.

◆ CreateObject()

static std::shared_ptr<CObject> mrpt::opengl::CCylinder::CreateObject ( )

static

◆ CreateUnique()

template<typename... Args>

static UniquePtr mrpt::opengl::CCylinder::CreateUnique ( Args &&... args )

inlinestatic

Definition at line 31 of file CCylinder.h.

◆ duplicateGetSmartPtr()

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

inlineinherited

Makes a deep copy of the object and returns a smart pointer to it.

Definition at line 200 of file CObject.h.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

◆ getBottomRadius()

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

inline

Gets the bottom radius.

Definition at line 116 of file CCylinder.h.

References mBaseRadius.

◆ getBoundingBox()

void CCylinder::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 240 of file CCylinder.cpp.

References bb_max, and bb_min.

◆ getClassName()

static constexpr auto mrpt::opengl::CCylinder::getClassName ( )

inlinestatic

Definition at line 31 of file CCylinder.h.

◆ getColor()

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

inlineinherited

Returns the object color property as a TColorf.

Definition at line 231 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getColor_u8()

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

inlineinherited

Returns the object color property as a TColor.

Definition at line 250 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 154 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getColorA_u8()

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

inlineinherited

Color components in the range [0,255].

Definition at line 162 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 152 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getColorB_u8()

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

inlineinherited

Color components in the range [0,255].

Definition at line 160 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 150 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getColorG_u8()

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

inlineinherited

Color components in the range [0,255].

Definition at line 158 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 148 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getColorR_u8()

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

inlineinherited

Color components in the range [0,255].

Definition at line 156 of file CRenderizable.h.

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

◆ getHeight()

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

inline

Gets the cylinder's height.

Definition at line 124 of file CCylinder.h.

References mHeight.

◆ getName()

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

inlineinherited

Returns the name of the object.

Definition at line 67 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ 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 65 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ getPose()

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

inherited

Returns the 3D pose of the object as TPose3D.

Definition at line 337 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ getPosePitch()

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

inlineinherited

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 138 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPosePitchRad()

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

inlineinherited

Rotation relative to parent coordinate origin, in radians.

Definition at line 144 of file CRenderizable.h.

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

Here is the call graph for this function:

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

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

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

Here is the caller graph for this function:

◆ getPoseRoll()

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

inlineinherited

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 140 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseRollRad()

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

inlineinherited

Rotation relative to parent coordinate origin, in radians.

Definition at line 146 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseX()

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

inlineinherited

Translation relative to parent coordinate origin.

Definition at line 130 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseY()

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

inlineinherited

Translation relative to parent coordinate origin.

Definition at line 132 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseYaw()

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

inlineinherited

Rotation relative to parent coordinate origin, in DEGREES.

Definition at line 136 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseYawRad()

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

inlineinherited

Rotation relative to parent coordinate origin, in radians.

Definition at line 142 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ getPoseZ()

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

inlineinherited

Translation relative to parent coordinate origin.

Definition at line 134 of file CRenderizable.h.

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

◆ 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 185 of file CCylinder.h.

References mBaseRadius, mHeight, mTopRadius, and reachesHeight().

Here is the call graph for this function:

◆ GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::opengl::CCylinder::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::CCylinder::GetRuntimeClassIdStatic ( )

static

◆ getScaleX()

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

inlineinherited

Get the current scaling factor in one axis.

Definition at line 225 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getScaleY()

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

inlineinherited

Get the current scaling factor in one axis.

Definition at line 227 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getScaleZ()

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

inlineinherited

Get the current scaling factor in one axis.

Definition at line 229 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ getSlicesCount()

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

inline

Sets the amount of slices used to display the object.

Definition at line 145 of file CCylinder.h.

References mSlices.

◆ getStacksCount()

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

inline

Sets the amount of stacks used to display the object.

Definition at line 149 of file CCylinder.h.

References mStacks.

◆ getTopRadius()

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

inline

Gets the top radius.

Definition at line 120 of file CCylinder.h.

References mTopRadius.

◆ hasBottomBase()

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

inline

Check whether bottom base is displayed.

See also: hasTopBase

Definition at line 84 of file CCylinder.h.

References mHasBottomBase.

◆ hasTopBase()

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

inline

Check whether top base is displayed.

See also: hasBottomBase

Definition at line 79 of file CCylinder.h.

References mHasTopBase.

◆ isShowNameEnabled()

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

inlineinherited

See also: enableShowName

Definition at line 84 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ isVisible()

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

inlineinherited

Is the object visible?

See also: setVisibility

Definition at line 68 of file CRenderizable.h.

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

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

Here is the caller graph for this function:

◆ notifyChange()

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

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

◆ reachesHeight()

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

inlineprivate

Checks whether the cylinder exists at some height.

Definition at line 194 of file CCylinder.h.

References mHeight.

Referenced by getRadius().

Here is the caller graph for this function:

◆ readFromStreamRender()

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

inlineprotectedinherited

Definition at line 62 of file CRenderizableDisplayList.h.

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

Referenced by mrpt::opengl::CSetOfLines::serializeFrom(), mrpt::opengl::CVectorField2D::serializeFrom(), mrpt::opengl::CVectorField3D::serializeFrom(), mrpt::opengl::CBox::serializeFrom(), mrpt::opengl::CPolyhedron::serializeFrom(), mrpt::opengl::CFrustum::serializeFrom(), and mrpt::opengl::CPlanarLaserScan::serializeFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ releaseTextureName()

void CRenderizable::releaseTextureName ( unsigned int i )

staticprotectedinherited

Definition at line 93 of file CRenderizable.cpp.

References TOpenGLNameBooker::cs, TOpenGLNameBooker::freeTextureNames, TOpenGLNameBooker::instance(), and TOpenGLNameBooker::next_free_texture.

Here is the call graph for this function:

◆ render()

void CRenderizableDisplayList::render ( ) const

overridevirtualinherited

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

Implements mrpt::opengl::CRenderizable.

Definition at line 80 of file CRenderizableDisplayList.cpp.

References TAuxDLData::getSingleton(), GL_COMPILE, GL_NO_ERROR, glCallList(), glDeleteLists(), glEndList(), glGenLists(), glGetError(), glNewList(), INVALID_DISPLAY_LIST_ID, mrpt::opengl::CRenderizableDisplayList::m_dl, mrpt::opengl::CRenderizableDisplayList::m_dl_recreate, mrpt::opengl::CRenderizableDisplayList::render_dl(), and mrpt::opengl::CRenderizableDisplayList::should_skip_display_list_cache().

Here is the call graph for this function:

◆ render_dl()

void CCylinder::render_dl ( ) const

overridevirtual

Render.

See also: mrpt::opengl::CRenderizable

Implements mrpt::opengl::CRenderizableDisplayList.

Definition at line 30 of file CCylinder.cpp.

References mrpt::opengl::gl_utils::checkOpenGLError(), GL_BLEND, GL_ONE_MINUS_SRC_ALPHA, GL_SRC_ALPHA, glBlendFunc(), glDisable(), glEnable(), glPopMatrix(), glPushMatrix(), and glTranslatef().

Here is the call graph for this function:

◆ 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 361 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ 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 332 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.

Here is the call graph for this function:

◆ serializeFrom() [1/2]

void CCylinder::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

in	The input binary stream where the object data must read from.
version	The version of the object stored in the stream: use this version number in your code to know how to read the incoming data.

Exceptions

std::exception On any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 75 of file CCylinder.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, and SCHEMA_DESERIALIZE_DATATYPE_VERSION.

◆ serializeFrom() [2/2]

virtual void mrpt::serialization::CSerializable::serializeFrom ( CSchemeArchiveBase & in )

inlineprotectedvirtualinherited

Virtual method for reading (deserializing) from an abstract schema based archive.

Definition at line 74 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ serializeGetVersion()

uint8_t CCylinder::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 96 of file CCylinder.cpp.

◆ serializeTo() [1/2]

void CCylinder::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::exception On any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 64 of file CCylinder.cpp.

References SCHEMA_SERIALIZE_DATATYPE_VERSION.

◆ serializeTo() [2/2]

virtual void mrpt::serialization::CSerializable::serializeTo ( CSchemeArchiveBase & out ) const

inlineprotectedvirtualinherited

Virtual method for writing (serializing) to an abstract schema based archive.

Definition at line 64 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

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

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

Referenced by mrpt::hwdrivers::CSkeletonTracker::processPreview().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Here is the call graph for this function:

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

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

Here is the call graph for this function:

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

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

Here is the call graph for this function:

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

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

Here is the call graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Here is the call graph for this function:

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

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

Here is the call graph for this function:

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

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

Here is the call graph for this function:

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

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

Here is the call graph for this function:

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

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

Here is the call graph for this function:

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

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

Here is the call graph for this function:

◆ setHasBases()

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

inline

Configuration of the cylinder's bases display.

Definition at line 69 of file CCylinder.h.

References mHasBottomBase, mHasTopBase, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

Here is the call graph for this function:

◆ setHeight()

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

inline

Chenges cylinder's height.

Definition at line 108 of file CCylinder.h.

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

Here is the call graph for this function:

◆ setLocation() [1/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 111 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ setLocation() [2/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 121 of file CRenderizable.h.

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

Here is the call graph for this function:

◆ setName()

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

inlineinherited

Changes the name of the object.

Definition at line 65 of file CRenderizable.h.

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

◆ setPose() [1/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 303 of file CRenderizable.cpp.

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

Referenced by mrpt::hwdrivers::CSkeletonTracker::processPreview().

Here is the caller graph for this function:

◆ setPose() [2/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 308 of file CRenderizable.cpp.

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

◆ setPose() [3/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 313 of file CRenderizable.cpp.

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

◆ setPose() [4/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 318 of file CRenderizable.cpp.

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

◆ setPose() [5/6]

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

inherited

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

Set the 3D pose from a mrpt::poses::CPose3D object.

Definition at line 325 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ setPose() [6/6]

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

inherited

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

Set the 3D pose from a mrpt::poses::CPose3D object.

Definition at line 331 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ setRadii()

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

inline

Sets both radii independently.

See also: setRadius

Definition at line 99 of file CCylinder.h.

References mBaseRadius, mTopRadius, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

Here is the call graph for this function:

◆ 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 90 of file CCylinder.h.

References mBaseRadius, mTopRadius, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

Here is the call graph for this function:

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

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

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

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

◆ 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 129 of file CCylinder.h.

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

Here is the call graph for this function:

◆ 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 137 of file CCylinder.h.

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

Here is the call graph for this function:

◆ setVisibility()

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

inlineinherited

Set object visibility (default=true)

See also: isVisible

Definition at line 73 of file CRenderizable.h.

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

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

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

Here is the caller graph for this function:

◆ 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 370 of file CRenderizable.cpp.

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

Here is the call graph for this function:

◆ traceRay()

bool CCylinder::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 157 of file CCylinder.cpp.

References mrpt::math::createFromPoseX(), mrpt::math::TLine3D::director, mrpt::math::getEpsilon(), mrpt::math::TLine3D::pBase, solveEqn(), mrpt::square(), mrpt::math::TLine3D::unitarize(), mrpt::math::TPoint3D_data::x, mrpt::math::TPoint3D_data::y, and mrpt::math::TPoint3D_data::z.

Here is the call graph for this function:

◆ 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 90 of file CSerializable.h.

◆ writeToStreamRender()

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

protectedinherited

Definition at line 104 of file CRenderizable.cpp.

Referenced by mrpt::opengl::CSetOfLines::serializeTo(), mrpt::opengl::CVectorField2D::serializeTo(), mrpt::opengl::CVectorField3D::serializeTo(), mrpt::opengl::CBox::serializeTo(), mrpt::opengl::CPolyhedron::serializeTo(), mrpt::opengl::CFrustum::serializeTo(), and mrpt::opengl::CPlanarLaserScan::serializeTo().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ _init_CCylinder

mrpt::rtti::CLASSINIT mrpt::opengl::CCylinder::_init_CCylinder

staticprotected

Definition at line 31 of file CCylinder.h.

◆ className

constexpr const char* mrpt::opengl::CCylinder::className = "CCylinder"

static

Definition at line 31 of file CCylinder.h.

◆ m_color

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

protectedinherited

Color components in the range [0,255].

Definition at line 51 of file CRenderizable.h.

◆ m_name

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

protectedinherited

Definition at line 48 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::getName(), mrpt::opengl::CRenderizable::readFromStreamRender(), mrpt::opengl::CRenderizable::setName(), and mrpt::opengl::CRenderizable::writeToStreamRender().

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

◆ m_scale_x

float mrpt::opengl::CRenderizable::m_scale_x {1}

protectedinherited

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

Definition at line 56 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::getScaleX(), mrpt::opengl::CRenderizable::readFromStreamRender(), mrpt::opengl::CRenderizable::setScale(), and mrpt::opengl::CRenderizable::writeToStreamRender().

◆ m_scale_y

float mrpt::opengl::CRenderizable::m_scale_y {1}

protectedinherited

Definition at line 56 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::getScaleY(), mrpt::opengl::CRenderizable::readFromStreamRender(), mrpt::opengl::CRenderizable::setScale(), and mrpt::opengl::CRenderizable::writeToStreamRender().

◆ m_scale_z

float mrpt::opengl::CRenderizable::m_scale_z {1}

protectedinherited

Definition at line 56 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::getScaleZ(), mrpt::opengl::CRenderizable::readFromStreamRender(), mrpt::opengl::CRenderizable::setScale(), and mrpt::opengl::CRenderizable::writeToStreamRender().

◆ m_show_name

bool mrpt::opengl::CRenderizable::m_show_name {false}

protectedinherited

Definition at line 49 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::enableShowName(), mrpt::opengl::CRenderizable::isShowNameEnabled(), mrpt::opengl::CRenderizable::readFromStreamRender(), and mrpt::opengl::CRenderizable::writeToStreamRender().

◆ m_visible

bool mrpt::opengl::CRenderizable::m_visible {true}

protectedinherited

Is the object visible? (default=true)

Definition at line 58 of file CRenderizable.h.

Referenced by mrpt::opengl::CRenderizable::isVisible(), mrpt::opengl::CRenderizable::readFromStreamRender(), mrpt::opengl::CRenderizable::setVisibility(), and mrpt::opengl::CRenderizable::writeToStreamRender().

◆ mBaseRadius

float mrpt::opengl::CCylinder::mBaseRadius {1}

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 39 of file CCylinder.h.

Referenced by getBottomRadius(), getRadius(), setRadii(), and setRadius().

◆ mHasBottomBase

bool mrpt::opengl::CCylinder::mHasBottomBase {true}

protected

Definition at line 54 of file CCylinder.h.

Referenced by hasBottomBase(), and setHasBases().

◆ mHasTopBase

bool mrpt::opengl::CCylinder::mHasTopBase {true}

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 54 of file CCylinder.h.

Referenced by hasTopBase(), and setHasBases().

◆ mHeight

float mrpt::opengl::CCylinder::mHeight {1}

protected

Cylinder's height.

Definition at line 43 of file CCylinder.h.

Referenced by getHeight(), getRadius(), reachesHeight(), and setHeight().

◆ mSlices

uint32_t mrpt::opengl::CCylinder::mSlices {10}

protected

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

Definition at line 48 of file CCylinder.h.

Referenced by getSlicesCount(), and setSlicesCount().

◆ mStacks

uint32_t mrpt::opengl::CCylinder::mStacks {10}

protected

Definition at line 48 of file CCylinder.h.

Referenced by getStacksCount(), and setStacksCount().

◆ mTopRadius

float mrpt::opengl::CCylinder::mTopRadius {1}

protected

Definition at line 39 of file CCylinder.h.

Referenced by getRadius(), getTopRadius(), setRadii(), and setRadius().

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::opengl::CCylinder::runtimeClassId

staticprotected

Definition at line 31 of file CCylinder.h.

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ ConstUniquePtr

◆ Ptr

◆ UniquePtr

Constructor & Destructor Documentation

◆ CCylinder() [1/2]

◆ CCylinder() [2/2]

◆ ~CCylinder()

Member Function Documentation

◆ _GetBaseClass()

◆ checkOpenGLError()

◆ clone()

◆ Create()

◆ CreateAlloc()

◆ CreateObject()

◆ CreateUnique()

◆ duplicateGetSmartPtr()

◆ enableShowName()

◆ getBottomRadius()

◆ getBoundingBox()

◆ getClassName()

◆ getColor()

◆ getColor_u8()

◆ getColorA()

◆ getColorA_u8()

◆ getColorB()

◆ getColorB_u8()

◆ getColorG()

◆ getColorG_u8()

◆ getColorR()

◆ getColorR_u8()

◆ getHeight()

◆ getName()

◆ getNewTextureNumber()

◆ getPose()

◆ getPosePitch()

◆ getPosePitchRad()

◆ getPoseRef()

◆ getPoseRoll()

◆ getPoseRollRad()

◆ getPoseX()

◆ getPoseY()

◆ getPoseYaw()

◆ getPoseYawRad()

◆ getPoseZ()

◆ getRadius()

◆ GetRuntimeClass()

◆ GetRuntimeClassIdStatic()

◆ getScaleX()

◆ getScaleY()

◆ getScaleZ()

◆ getSlicesCount()

◆ getStacksCount()

◆ getTopRadius()

◆ hasBottomBase()

◆ hasTopBase()

◆ isShowNameEnabled()

◆ isVisible()

◆ notifyChange()

◆ reachesHeight()

◆ readFromStreamRender()

◆ releaseTextureName()

◆ render()

◆ render_dl()

◆ renderTextBitmap() [1/2]

◆ renderTextBitmap() [2/2]

◆ serializeFrom() [1/2]

◆ serializeFrom() [2/2]

◆ serializeGetVersion()

◆ serializeTo() [1/2]

◆ serializeTo() [2/2]