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

Detailed Description

A camera: if added to a scene, the viewpoint defined by this camera will be used instead of the camera parameters set in COpenGLViewport::m_camera.

A camera can be defined to provide a projective or orthogonal view of the world by setting the member CCamera::m_projectiveModel.

See also:
opengl::COpenGLScene

#include <mrpt/opengl/CCamera.h>

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

List of all members.

Public Member Functions

void setPointingAt (float x, float y, float z)
template<class POSEORPOINT >
void setPointingAt (const POSEORPOINT &p)
void setPointingAt (const mrpt::math::TPoint3D &p)
float getPointingAtX () const
float getPointingAtY () const
float getPointingAtZ () const
void setZoomDistance (float z)
float getZoomDistance () const
float getAzimuthDegrees () const
float getElevationDegrees () const
void setAzimuthDegrees (float ang)
void setElevationDegrees (float ang)
void setProjectiveModel (bool v=true)
 Enable/Disable projective mode (vs. orthogonal)
void setOrthogonal (bool v=true)
 Enable/Disable orthogonal mode (vs. projective)
void set6DOFMode (bool v)
 Set 6DOFMode, if enabled camera is set according to its pose (default=false).
bool isProjective () const
bool isOrthogonal () const
bool is6DOFMode () const
void setProjectiveFOVdeg (float ang)
 Field-of-View in degs, only when projectiveModel=true (default=30 deg).
float getProjectiveFOVdeg () const
 Field-of-View in degs, only when projectiveModel=true (default=30 deg).
void render () const
 Render does nothing here.
CRenderizableclone () const
 Interface for the stlplus smart pointer class.
virtual bool traceRay (const mrpt::poses::CPose3D &o, double &dist) const
 Simulation of ray-trace, given a pose.
mrpt::utils::CObjectPtr duplicateGetSmartPtr () const
 Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).
Changes the appearance of the object to render
void setName (const std::string &n)
 Changes the name of the object.
const std::stringgetName () const
 Returns the name of the object.
bool isVisible () const
 Is the object visible?
void setVisibility (bool visible=true)
 Set object visibility (default=true)
void enableShowName (bool showName=true)
 Enables or disables showing the name of the object as a label when rendering.
bool isShowNameEnabled () const
CRenderizablesetPose (const mrpt::poses::CPose3D &o)
 Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)
CRenderizablesetPose (const mrpt::math::TPose3D &o)
 Set the 3D pose from a mrpt::math::TPose3D object (return a ref to this)
CRenderizablesetPose (const mrpt::poses::CPoint3D &o)
 Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)
CRenderizablesetPose (const mrpt::poses::CPoint2D &o)
 Set the 3D pose from a mrpt::poses::CPose3D object (return a ref to this)
mrpt::math::TPose3D getPose () const
 Returns the 3D pose of the object as TPose3D.
const mrpt::poses::CPose3DgetPoseRef () const
 Returns a const ref to the 3D pose of the object as CPose3D (which explicitly contains the 3x3 rotation matrix)
CRenderizablesetLocation (double x, double y, double z)
 Changes the location of the object, keeping untouched the orientation.
CRenderizablesetLocation (const mrpt::math::TPoint3D &p)
 Changes the location of the object, keeping untouched the orientation.
double getPoseX () const
 Translation relative to parent coordinate origin.
double getPoseY () const
 Translation relative to parent coordinate origin.
double getPoseZ () const
 Translation relative to parent coordinate origin.
double getPoseYaw () const
 Rotation relative to parent coordinate origin, in **DEGREES**.
double getPosePitch () const
 Rotation relative to parent coordinate origin, in **DEGREES**.
double getPoseRoll () const
 Rotation relative to parent coordinate origin, in **DEGREES**.
double getPoseYawRad () const
 Rotation relative to parent coordinate origin, in radians.
double getPosePitchRad () const
 Rotation relative to parent coordinate origin, in radians.
double getPoseRollRad () const
 Rotation relative to parent coordinate origin, in radians.
double getColorR () const
 Color components in the range [0,1].
double getColorG () const
 Color components in the range [0,1].
double getColorB () const
 Color components in the range [0,1].
double getColorA () const
 Color components in the range [0,1].
uint8_t getColorR_u8 () const
 Color components in the range [0,255].
uint8_t getColorG_u8 () const
 Color components in the range [0,255].
uint8_t getColorB_u8 () const
 Color components in the range [0,255].
uint8_t getColorA_u8 () const
 Color components in the range [0,255].
CRenderizablesetColorR (const double r)
 Color components in the range [0,1].
CRenderizablesetColorG (const double g)
 Color components in the range [0,1].
CRenderizablesetColorB (const double b)
 Color components in the range [0,1].
CRenderizablesetColorA (const double a)
 Color components in the range [0,1].
virtual CRenderizablesetColorR_u8 (const uint8_t r)
 Color components in the range [0,255].
virtual CRenderizablesetColorG_u8 (const uint8_t g)
 Color components in the range [0,255].
virtual CRenderizablesetColorB_u8 (const uint8_t b)
 Color components in the range [0,255].
virtual CRenderizablesetColorA_u8 (const uint8_t a)
 Color components in the range [0,255].
CRenderizablesetScale (float s)
 Scale to apply to the object, in all three axes (default=1)
CRenderizablesetScale (float sx, float sy, float sz)
 Scale to apply to the object in each axis (default=1)
float getScaleX () const
 Get the current scaling factor in one axis.
float getScaleY () const
 Get the current scaling factor in one axis.
float getScaleZ () const
 Get the current scaling factor in one axis.
mrpt::utils::TColorf getColor () const
 Returns the object color property as a TColorf.
CRenderizablesetColor (const mrpt::utils::TColorf &c)
CRenderizablesetColor (double R, double G, double B, double A=1)
 Set the color components of this object (R,G,B,Alpha, in the range 0-1)
const mrpt::utils::TColorgetColor_u8 () const
 Returns the object color property as a TColor.
virtual CRenderizablesetColor_u8 (const mrpt::utils::TColor &c)
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)

Static Public Member Functions

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

Static Public Attributes

static const
mrpt::utils::TRuntimeClassId 
classCObject
RTTI stuff
static const
mrpt::utils::TRuntimeClassId 
classCSerializable

Protected Member Functions

void writeToStreamRender (utils::CStream &out) const
void readFromStreamRender (utils::CStream &in)
virtual void writeToStream (mrpt::utils::CStream &out, int *getVersion) const =0
 Introduces a pure virtual method responsible for writing to a CStream.
virtual void readFromStream (mrpt::utils::CStream &in, int version)=0
 Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

Static Protected Member Functions

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

Protected Attributes

float m_pointingX
float m_pointingY
float m_pointingZ
float m_distanceZoom
float m_azimuthDeg
float m_elevationDeg
bool m_projectiveModel
 If set to true (default), camera model is projective, otherwise, it's orthogonal.
float m_projectiveFOVdeg
 Field-of-View in degs, only when projectiveModel=true (default=30 deg).
bool m_6DOFMode
 If set to true, camera pose is used when rendering the viewport.
std::string m_name
bool m_show_name
mrpt::utils::TColor m_color
 Color components in the range [0,255].
mrpt::poses::CPose3D m_pose
 6D pose wrt the parent coordinate reference. This class automatically holds the cached 3x3 rotation matrix for quick load into opengl stack.
float m_scale_x
float m_scale_y
float m_scale_z
 Scale components to apply to the object (default=1)
bool m_visible
 Is the object visible? (default=true)

Private Member Functions

 CCamera ()
 Constructor.
virtual ~CCamera ()
 Private, virtual destructor: only can be deleted from smart pointers.

Friends

class COpenGLViewport
class mrpt::opengl::COpenGLViewport
class mrpt::opengl::CSetOfObjects

RTTI stuff

typedef CCameraPtr SmartPtr
static mrpt::utils::CLASSINIT _init_CCamera
static mrpt::utils::TRuntimeClassId classCCamera
static const
mrpt::utils::TRuntimeClassId
classinfo
static const
mrpt::utils::TRuntimeClassId
_GetBaseClass ()
virtual const
mrpt::utils::TRuntimeClassId
GetRuntimeClass () const
 Returns information about the class of an object in runtime.
virtual mrpt::utils::CObjectduplicate () const
 Returns a copy of the object, indepently of its class.
static mrpt::utils::CObjectCreateObject ()
static CCameraPtr Create ()

RTTI stuff

class mrpt::utils::CStream
static const
mrpt::utils::TRuntimeClassId 
classCRenderizable

Member Typedef Documentation

A typedef for the associated smart pointer

Definition at line 54 of file CCamera.h.


Constructor & Destructor Documentation

mrpt::opengl::CCamera::CCamera ( ) [private]

Constructor.

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

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

Definition at line 120 of file CCamera.h.


Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::opengl::CCamera::_GetBaseClass ( ) [static, protected]

Reimplemented from mrpt::opengl::CRenderizable.

static void mrpt::opengl::CRenderizable::checkOpenGLError ( ) [static, protected, inherited]

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

CRenderizable* mrpt::opengl::CRenderizable::clone ( ) const [inline, inherited]

Interface for the stlplus smart pointer class.

Reimplemented from mrpt::utils::CObject.

Reimplemented in mrpt::opengl::CRenderizableDisplayList.

Definition at line 174 of file CRenderizable.h.

static CCameraPtr mrpt::opengl::CCamera::Create ( ) [static]
static mrpt::utils::CObject* mrpt::opengl::CCamera::CreateObject ( ) [static]
virtual mrpt::utils::CObject* mrpt::opengl::CCamera::duplicate ( ) const [virtual]

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

mrpt::utils::CObjectPtr mrpt::utils::CObject::duplicateGetSmartPtr ( ) const [inline, inherited]

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

Definition at line 151 of file CObject.h.

void mrpt::opengl::CRenderizable::enableShowName ( bool  showName = true) [inline, inherited]

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

Definition at line 95 of file CRenderizable.h.

float mrpt::opengl::CCamera::getAzimuthDegrees ( ) const [inline]

Definition at line 86 of file CCamera.h.

mrpt::utils::TColorf mrpt::opengl::CRenderizable::getColor ( ) const [inline, inherited]

Returns the object color property as a TColorf.

Definition at line 150 of file CRenderizable.h.

const mrpt::utils::TColor& mrpt::opengl::CRenderizable::getColor_u8 ( ) const [inline, inherited]

Returns the object color property as a TColor.

Definition at line 159 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getColorA ( ) const [inline, inherited]

Color components in the range [0,1].

Definition at line 126 of file CRenderizable.h.

uint8_t mrpt::opengl::CRenderizable::getColorA_u8 ( ) const [inline, inherited]

Color components in the range [0,255].

Definition at line 131 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getColorB ( ) const [inline, inherited]

Color components in the range [0,1].

Definition at line 125 of file CRenderizable.h.

uint8_t mrpt::opengl::CRenderizable::getColorB_u8 ( ) const [inline, inherited]

Color components in the range [0,255].

Definition at line 130 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getColorG ( ) const [inline, inherited]

Color components in the range [0,1].

Definition at line 124 of file CRenderizable.h.

uint8_t mrpt::opengl::CRenderizable::getColorG_u8 ( ) const [inline, inherited]

Color components in the range [0,255].

Definition at line 129 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getColorR ( ) const [inline, inherited]

Color components in the range [0,1].

Definition at line 123 of file CRenderizable.h.

uint8_t mrpt::opengl::CRenderizable::getColorR_u8 ( ) const [inline, inherited]

Color components in the range [0,255].

Definition at line 128 of file CRenderizable.h.

float mrpt::opengl::CCamera::getElevationDegrees ( ) const [inline]

Definition at line 87 of file CCamera.h.

const std::string& mrpt::opengl::CRenderizable::getName ( ) const [inline, inherited]

Returns the name of the object.

Definition at line 90 of file CRenderizable.h.

static unsigned int mrpt::opengl::CRenderizable::getNewTextureNumber ( ) [static, protected, inherited]

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

float mrpt::opengl::CCamera::getPointingAtX ( ) const [inline]

Definition at line 79 of file CCamera.h.

float mrpt::opengl::CCamera::getPointingAtY ( ) const [inline]

Definition at line 80 of file CCamera.h.

float mrpt::opengl::CCamera::getPointingAtZ ( ) const [inline]

Definition at line 81 of file CCamera.h.

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

Returns the 3D pose of the object as TPose3D.

double mrpt::opengl::CRenderizable::getPosePitch ( ) const [inline, inherited]

Rotation relative to parent coordinate origin, in **DEGREES**.

Definition at line 117 of file CRenderizable.h.

References mrpt::utils::RAD2DEG().

double mrpt::opengl::CRenderizable::getPosePitchRad ( ) const [inline, inherited]

Rotation relative to parent coordinate origin, in radians.

Definition at line 120 of file CRenderizable.h.

const mrpt::poses::CPose3D& mrpt::opengl::CRenderizable::getPoseRef ( ) const [inline, inherited]

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

Definition at line 105 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getPoseRoll ( ) const [inline, inherited]

Rotation relative to parent coordinate origin, in **DEGREES**.

Definition at line 118 of file CRenderizable.h.

References mrpt::utils::RAD2DEG().

double mrpt::opengl::CRenderizable::getPoseRollRad ( ) const [inline, inherited]

Rotation relative to parent coordinate origin, in radians.

Definition at line 121 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getPoseX ( ) const [inline, inherited]

Translation relative to parent coordinate origin.

Definition at line 113 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getPoseY ( ) const [inline, inherited]

Translation relative to parent coordinate origin.

Definition at line 114 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getPoseYaw ( ) const [inline, inherited]

Rotation relative to parent coordinate origin, in **DEGREES**.

Definition at line 116 of file CRenderizable.h.

References mrpt::utils::RAD2DEG().

double mrpt::opengl::CRenderizable::getPoseYawRad ( ) const [inline, inherited]

Rotation relative to parent coordinate origin, in radians.

Definition at line 119 of file CRenderizable.h.

double mrpt::opengl::CRenderizable::getPoseZ ( ) const [inline, inherited]

Translation relative to parent coordinate origin.

Definition at line 115 of file CRenderizable.h.

float mrpt::opengl::CCamera::getProjectiveFOVdeg ( ) const [inline]

Field-of-View in degs, only when projectiveModel=true (default=30 deg).

Definition at line 107 of file CCamera.h.

virtual const mrpt::utils::TRuntimeClassId* mrpt::opengl::CCamera::GetRuntimeClass ( ) const [virtual]

Returns information about the class of an object in runtime.

Reimplemented from mrpt::opengl::CRenderizable.

float mrpt::opengl::CRenderizable::getScaleX ( ) const [inline, inherited]

Get the current scaling factor in one axis.

Definition at line 145 of file CRenderizable.h.

float mrpt::opengl::CRenderizable::getScaleY ( ) const [inline, inherited]

Get the current scaling factor in one axis.

Definition at line 146 of file CRenderizable.h.

float mrpt::opengl::CRenderizable::getScaleZ ( ) const [inline, inherited]

Get the current scaling factor in one axis.

Definition at line 147 of file CRenderizable.h.

float mrpt::opengl::CCamera::getZoomDistance ( ) const [inline]

Definition at line 84 of file CCamera.h.

bool mrpt::opengl::CCamera::is6DOFMode ( ) const [inline]

Definition at line 104 of file CCamera.h.

bool mrpt::opengl::CCamera::isOrthogonal ( ) const [inline]

Definition at line 103 of file CCamera.h.

bool mrpt::opengl::CCamera::isProjective ( ) const [inline]

Definition at line 102 of file CCamera.h.

bool mrpt::opengl::CRenderizable::isShowNameEnabled ( ) const [inline, inherited]
See also:
enableShowName

Definition at line 96 of file CRenderizable.h.

bool mrpt::opengl::CRenderizable::isVisible ( ) const [inline, inherited]

Is the object visible?

See also:
setVisibility

Definition at line 92 of file CRenderizable.h.

virtual void mrpt::utils::CSerializable::readFromStream ( mrpt::utils::CStream in,
int  version 
) [protected, pure virtual, inherited]

Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

Parameters:
inThe input binary stream where the object data must read from.
versionThe version of the object stored in the stream: use this version number in your code to know how to read the incoming data.
Exceptions:
std::exceptionOn any error, see CStream::ReadBuffer
See also:
CStream

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

void mrpt::opengl::CRenderizable::readFromStreamRender ( utils::CStream in) [protected, inherited]
static void mrpt::opengl::CRenderizable::releaseTextureName ( unsigned int  i) [static, protected, inherited]
void mrpt::opengl::CCamera::render ( ) const [inline, virtual]

Render does nothing here.

Implements mrpt::opengl::CRenderizable.

Definition at line 112 of file CCamera.h.

static void mrpt::opengl::CRenderizable::renderTextBitmap ( const char *  str,
void *  fontStyle 
) [static, inherited]

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

See also:
renderTextBitmap, mrpt::opengl::gl_utils
static void mrpt::opengl::CRenderizable::renderTextBitmap ( int  screen_x,
int  screen_y,
const std::string str,
float  color_r = 1,
float  color_g = 1,
float  color_b = 1,
mrpt::opengl::TOpenGLFont  font = mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24 
) [static, inherited]

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

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

Set 6DOFMode, if enabled camera is set according to its pose (default=false).

Conventionally, eye is set looking towards the positive direction of Z axis. Up is set as the Y axis. In this mode azimuth/elevation are ignored.

Definition at line 100 of file CCamera.h.

void mrpt::opengl::CCamera::setAzimuthDegrees ( float  ang) [inline]

Definition at line 89 of file CCamera.h.

CRenderizable& mrpt::opengl::CRenderizable::setColor ( const mrpt::utils::TColorf c) [inline, inherited]
Parameters:
cChanges the default object color
Returns:
a ref to this

Definition at line 151 of file CRenderizable.h.

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

CRenderizable& mrpt::opengl::CRenderizable::setColor ( double  R,
double  G,
double  B,
double  A = 1 
) [inline, inherited]

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

Returns:
a ref to this

Definition at line 157 of file CRenderizable.h.

virtual CRenderizable& mrpt::opengl::CRenderizable::setColor_u8 ( const mrpt::utils::TColor c) [virtual, inherited]
CRenderizable& mrpt::opengl::CRenderizable::setColor_u8 ( uint8_t  R,
uint8_t  G,
uint8_t  B,
uint8_t  A = 255 
) [inline, inherited]

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

Returns:
a ref to this

Definition at line 164 of file CRenderizable.h.

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

Referenced by mrpt::opengl::CRenderizable::setColor_u8().

CRenderizable& mrpt::opengl::CRenderizable::setColorA ( const double  a) [inline, inherited]

Color components in the range [0,1].

Returns:
a ref to this

Definition at line 136 of file CRenderizable.h.

virtual CRenderizable& mrpt::opengl::CRenderizable::setColorA_u8 ( const uint8_t  a) [inline, virtual, inherited]

Color components in the range [0,255].

Returns:
a ref to this

Reimplemented in mrpt::opengl::CSetOfObjects, mrpt::opengl::CSetOfTriangles, and mrpt::opengl::CRenderizableDisplayList.

Definition at line 141 of file CRenderizable.h.

CRenderizable& mrpt::opengl::CRenderizable::setColorB ( const double  b) [inline, inherited]

Color components in the range [0,1].

Returns:
a ref to this

Definition at line 135 of file CRenderizable.h.

virtual CRenderizable& mrpt::opengl::CRenderizable::setColorB_u8 ( const uint8_t  b) [inline, virtual, inherited]

Color components in the range [0,255].

Returns:
a ref to this

Reimplemented in mrpt::opengl::CSetOfObjects, mrpt::opengl::CSetOfTriangles, and mrpt::opengl::CRenderizableDisplayList.

Definition at line 140 of file CRenderizable.h.

CRenderizable& mrpt::opengl::CRenderizable::setColorG ( const double  g) [inline, inherited]

Color components in the range [0,1].

Returns:
a ref to this

Definition at line 134 of file CRenderizable.h.

virtual CRenderizable& mrpt::opengl::CRenderizable::setColorG_u8 ( const uint8_t  g) [inline, virtual, inherited]

Color components in the range [0,255].

Returns:
a ref to this

Reimplemented in mrpt::opengl::CSetOfObjects, mrpt::opengl::CSetOfTriangles, and mrpt::opengl::CRenderizableDisplayList.

Definition at line 139 of file CRenderizable.h.

CRenderizable& mrpt::opengl::CRenderizable::setColorR ( const double  r) [inline, inherited]

Color components in the range [0,1].

Returns:
a ref to this

Definition at line 133 of file CRenderizable.h.

virtual CRenderizable& mrpt::opengl::CRenderizable::setColorR_u8 ( const uint8_t  r) [inline, virtual, inherited]

Color components in the range [0,255].

Returns:
a ref to this

Reimplemented in mrpt::opengl::CSetOfObjects, mrpt::opengl::CSetOfTriangles, and mrpt::opengl::CRenderizableDisplayList.

Definition at line 138 of file CRenderizable.h.

void mrpt::opengl::CCamera::setElevationDegrees ( float  ang) [inline]

Definition at line 90 of file CCamera.h.

CRenderizable& mrpt::opengl::CRenderizable::setLocation ( double  x,
double  y,
double  z 
) [inline, inherited]

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

Returns:
a ref to this

Definition at line 108 of file CRenderizable.h.

CRenderizable& mrpt::opengl::CRenderizable::setLocation ( const mrpt::math::TPoint3D p) [inline, inherited]

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

Returns:
a ref to this

Definition at line 111 of file CRenderizable.h.

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

void mrpt::opengl::CRenderizable::setName ( const std::string n) [inline, inherited]

Changes the name of the object.

Definition at line 89 of file CRenderizable.h.

void mrpt::opengl::CCamera::setOrthogonal ( bool  v = true) [inline]

Enable/Disable orthogonal mode (vs. projective)

Definition at line 93 of file CCamera.h.

void mrpt::opengl::CCamera::setPointingAt ( float  x,
float  y,
float  z 
) [inline]

Definition at line 67 of file CCamera.h.

References Eigen::internal::y.

template<class POSEORPOINT >
void mrpt::opengl::CCamera::setPointingAt ( const POSEORPOINT &  p) [inline]

Definition at line 70 of file CCamera.h.

void mrpt::opengl::CCamera::setPointingAt ( const mrpt::math::TPoint3D p) [inline]
CRenderizable& mrpt::opengl::CRenderizable::setPose ( const mrpt::poses::CPose3D o) [inherited]

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

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

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

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

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

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

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

void mrpt::opengl::CCamera::setProjectiveFOVdeg ( float  ang) [inline]

Field-of-View in degs, only when projectiveModel=true (default=30 deg).

Definition at line 106 of file CCamera.h.

void mrpt::opengl::CCamera::setProjectiveModel ( bool  v = true) [inline]

Enable/Disable projective mode (vs. orthogonal)

Definition at line 92 of file CCamera.h.

CRenderizable& mrpt::opengl::CRenderizable::setScale ( float  s) [inline, inherited]

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

Returns:
a ref to this

Definition at line 143 of file CRenderizable.h.

CRenderizable& mrpt::opengl::CRenderizable::setScale ( float  sx,
float  sy,
float  sz 
) [inline, inherited]

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

Returns:
a ref to this

Definition at line 144 of file CRenderizable.h.

void mrpt::opengl::CRenderizable::setVisibility ( bool  visible = true) [inline, inherited]

Set object visibility (default=true)

See also:
isVisible

Definition at line 93 of file CRenderizable.h.

void mrpt::opengl::CCamera::setZoomDistance ( float  z) [inline]

Definition at line 83 of file CCamera.h.

static int mrpt::opengl::CRenderizable::textBitmapWidth ( const std::string str,
mrpt::opengl::TOpenGLFont  font = mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24 
) [static, inherited]

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

See also:
renderTextBitmap, mrpt::opengl::gl_utils
virtual bool mrpt::opengl::CRenderizable::traceRay ( const mrpt::poses::CPose3D o,
double &  dist 
) const [virtual, inherited]

Simulation of ray-trace, given a pose.

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

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

virtual void mrpt::utils::CSerializable::writeToStream ( mrpt::utils::CStream out,
int *  getVersion 
) const [protected, pure virtual, inherited]

Introduces a pure virtual method responsible for writing to a CStream.

This can not be used directly be users, instead use "stream << object;" for writing it to a stream.

Parameters:
outThe output binary stream where object must be dumped.
getVersionIf NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data.
Exceptions:
std::exceptionOn any error, see CStream::WriteBuffer
See also:
CStream

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

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

Friends And Related Function Documentation

friend class COpenGLViewport [friend]

Definition at line 52 of file CCamera.h.

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

Definition at line 74 of file CRenderizable.h.

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

Definition at line 75 of file CRenderizable.h.

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

Reimplemented from mrpt::utils::CSerializable.

Reimplemented in mrpt::opengl::CRenderizableDisplayList, and mrpt::opengl::CTexturedObject.

Definition at line 72 of file CRenderizable.h.


Member Data Documentation

Definition at line 54 of file CCamera.h.

Definition at line 54 of file CCamera.h.

Definition at line 139 of file CObject.h.

Definition at line 72 of file CRenderizable.h.

Definition at line 56 of file CSerializable.h.

Definition at line 54 of file CCamera.h.

If set to true, camera pose is used when rendering the viewport.

Definition at line 63 of file CCamera.h.

Definition at line 59 of file CCamera.h.

Color components in the range [0,255].

Definition at line 80 of file CRenderizable.h.

Definition at line 58 of file CCamera.h.

Definition at line 59 of file CCamera.h.

Definition at line 78 of file CRenderizable.h.

Definition at line 57 of file CCamera.h.

Definition at line 57 of file CCamera.h.

Definition at line 57 of file CCamera.h.

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

Definition at line 81 of file CRenderizable.h.

Field-of-View in degs, only when projectiveModel=true (default=30 deg).

Definition at line 62 of file CCamera.h.

If set to true (default), camera model is projective, otherwise, it's orthogonal.

Definition at line 61 of file CCamera.h.

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

Definition at line 82 of file CRenderizable.h.

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

Definition at line 82 of file CRenderizable.h.

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

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

Definition at line 82 of file CRenderizable.h.

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

Definition at line 79 of file CRenderizable.h.

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

Is the object visible? (default=true)

Definition at line 83 of file CRenderizable.h.




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