MRPT logo

mrpt::opengl::CCylinder Class Reference

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

#include <mrpt/opengl/CCylinder.h>

Inheritance diagram for mrpt::opengl::CCylinder:

mrpt::opengl::CRenderizable mrpt::utils::CSerializable

List of all members.

Public Member Functions

void render () const
 Render.
virtual bool traceRay (const mrpt::poses::CPose3D &o, float &dist) const
 Simulation of ray-trace, given a pose.
void setHasBases (bool top=true, bool bottom=true)
bool hasTopBase () const
bool hasBottomBase () const
void setRadius (float radius)
void setRadii (float bottom, float top)
void setHeight (float height)
float getBottomRadius () const
float getTopRadius () const
float getHeight () const
void setSlicesCount (uint32_t slices)
void setStacksCount (uint32_t stacks)
uint32_t getSlicesCount () const
uint32_t getStacksCount () const

Static Public Member Functions

static CCylinderPtr Create (const float baseRadius=1, const float topRadius=1, const float height=1, const int slices=10, const int stacks=10)
static CCylinderPtr Create (const float radius=1, const float height=1, const int slices=10, const int stacks=10)

Protected Attributes

float mBaseRadius
float mTopRadius
float mHeight
uint32_t mSlices
uint32_t mStacks
bool mHasTopBase
bool mHasBottomBase

Private Member Functions

 CCylinder ()
 CCylinder (const float baseRadius, const float topRadius, const float height, const int slices, const int stacks)
virtual ~CCylinder ()


Detailed Description

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

See also:
opengl::COpenGLScene

Definition at line 41 of file CCylinder.h.


Constructor & Destructor Documentation

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

Definition at line 100 of file CCylinder.h.

mrpt::opengl::CCylinder::CCylinder ( const float  baseRadius,
const float  topRadius,
const float  height,
const int  slices,
const int  stacks 
) [inline, private]

Definition at line 101 of file CCylinder.h.

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

Definition at line 102 of file CCylinder.h.


Member Function Documentation

static CCylinderPtr mrpt::opengl::CCylinder::Create ( const float  radius = 1,
const float  height = 1,
const int  slices = 10,
const int  stacks = 10 
) [inline, static]

Definition at line 51 of file CCylinder.h.

References mrpt::opengl::CCylinder.

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

Definition at line 48 of file CCylinder.h.

References mrpt::opengl::CCylinder.

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

Definition at line 78 of file CCylinder.h.

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

Definition at line 84 of file CCylinder.h.

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

Definition at line 93 of file CCylinder.h.

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

Definition at line 96 of file CCylinder.h.

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

Definition at line 81 of file CCylinder.h.

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

Definition at line 65 of file CCylinder.h.

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

Definition at line 62 of file CCylinder.h.

void mrpt::opengl::CCylinder::render (  )  const [virtual]

Render.

Implements mrpt::opengl::CRenderizable.

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

Definition at line 58 of file CCylinder.h.

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

Definition at line 75 of file CCylinder.h.

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

Definition at line 71 of file CCylinder.h.

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

Definition at line 68 of file CCylinder.h.

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

Definition at line 87 of file CCylinder.h.

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

Definition at line 90 of file CCylinder.h.

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

Simulation of ray-trace, given a pose.

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

Reimplemented from mrpt::opengl::CRenderizable.


Member Data Documentation

Definition at line 44 of file CCylinder.h.

Definition at line 46 of file CCylinder.h.

Definition at line 46 of file CCylinder.h.

Definition at line 44 of file CCylinder.h.

uint32_t mrpt::opengl::CCylinder::mSlices [protected]

Definition at line 45 of file CCylinder.h.

uint32_t mrpt::opengl::CCylinder::mStacks [protected]

Definition at line 45 of file CCylinder.h.

Definition at line 44 of file CCylinder.h.




Page generated by Doxygen 1.5.8 for MRPT 0.6.5 SVN: at Thu Feb 26 02:14:51 EST 2009