Main MRPT website > C++ reference for MRPT 1.5.6
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
mrpt::opengl::CFBORender Class Reference

Detailed Description

A class for rendering 3D scenes off-screen directly into an image using OpenGL extensions (glext).

To define a background color, set it in the scene's "main" viewport.

You can add overlaid text messages, see base class CTextMessageCapable

See Also
Example "fbo_render_test"

Definition at line 29 of file CFBORender.h.

#include <mrpt/opengl/CFBORender.h>

Inheritance diagram for mrpt::opengl::CFBORender:
Inheritance graph

Public Member Functions

 CFBORender (unsigned int width=800, unsigned int height=600, const bool skip_glut_window=false)
 Constructor. More...
 
virtual ~CFBORender ()
 Destructor. More...
 
void setCamera (const COpenGLScene &scene, const CCamera &camera)
 Change the scene camera. More...
 
CCameragetCamera (const COpenGLScene &scene)
 Get a reference to the scene camera. More...
 
void getFrame (const COpenGLScene &scene, mrpt::utils::CImage &image)
 Render the scene and get the rendered rgb image. More...
 
void getFrame2 (const COpenGLScene &scene, mrpt::utils::CImage &image)
 Render the scene and get the rendered rgb image. More...
 
void resize (unsigned int width, unsigned int height)
 Resize the rendering canvas size. More...
 
const mrpt::utils::TColorfgetBackgroundColor () const
 Get the default background color (unles an COpenGLViewport defines a custom color) More...
 
void setBackgroundColor (const mrpt::utils::TColorf &col)
 Set the default background color (unles an COpenGLViewport defines a custom color) More...
 
void clearTextMessages ()
 
void addTextMessage (const double x_frac, const double y_frac, const std::string &text, const mrpt::utils::TColorf &color=mrpt::utils::TColorf(1.0, 1.0, 1.0), const size_t unique_index=0, const mrpt::opengl::TOpenGLFont font=mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24)
 Add 2D text messages overlapped to the 3D rendered scene. More...
 
void addTextMessage (const double x_frac, const double y_frac, const std::string &text, const mrpt::utils::TColorf &color, const std::string &font_name, const double font_size, const mrpt::opengl::TOpenGLFontStyle font_style=mrpt::opengl::NICE, const size_t unique_index=0, const double font_spacing=1.5, const double font_kerning=0.1, const bool has_shadow=false, const mrpt::utils::TColorf &shadow_color=mrpt::utils::TColorf(0, 0, 0))
 overload with more font parameters - refer to mrpt::opengl::gl_utils::glDrawText() More...
 
bool updateTextMessage (const size_t unique_index, const std::string &text)
 Just updates the text of a given text message, without touching the other parameters. More...
 

Protected Member Functions

int isExtensionSupported (const char *extension)
 Provide information on Framebuffer object extension. More...
 
void render_text_messages (const int w, const int h) const
 Renders the messages to the current opengl rendering context (to be called OUT of MRPT mrpt::opengl render() methods ). More...
 

Protected Attributes

int m_win
 
int m_width
 
int m_height
 
unsigned int m_fbo
 
unsigned int m_tex
 
bool m_win_used
 
mrpt::utils::TColorf m_default_bk_color
 
std::map< size_t,
mrpt::opengl::T2DTextData
m_2D_texts
 

Constructor & Destructor Documentation

CFBORender::CFBORender ( unsigned int  width = 800,
unsigned int  height = 600,
const bool  skip_glut_window = false 
)

Constructor.

Parameters
[in]skip_glut_windowShould be set to true only if another GUI windows already exist with an associated OpenGL context. If left to false, a hidden GLUT window will be created.

Definition at line 23 of file CFBORender.cpp.

References ASSERT_, GL_COLOR_ATTACHMENT0_EXT, GL_FRAMEBUFFER_EXT, GL_RGB, GL_TEXTURE_RECTANGLE_ARB, GL_TEXTURE_RECTANGLE_EXT, GL_TEXTURE_RECTANGLE_NV, GL_UNSIGNED_BYTE, glBindFramebufferEXT, glBindTexture(), glDeleteFramebuffersEXT, glFramebufferTexture2DEXT, glGenFramebuffersEXT, glGenTextures(), glTexImage2D(), glViewport(), isExtensionSupported(), m_fbo, m_height, m_tex, m_width, m_win, m_win_used, MRPT_END, MRPT_START, and THROW_EXCEPTION.

CFBORender::~CFBORender ( )
virtual

Destructor.

Definition at line 108 of file CFBORender.cpp.

References glDeleteFramebuffersEXT, glDeleteTextures(), m_fbo, m_tex, m_win, and m_win_used.

Member Function Documentation

void CTextMessageCapable::addTextMessage ( const double  x_frac,
const double  y_frac,
const std::string text,
const mrpt::utils::TColorf color = mrpt::utils::TColorf(1.0,1.0,1.0),
const size_t  unique_index = 0,
const mrpt::opengl::TOpenGLFont  font = mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24 
)
inherited

Add 2D text messages overlapped to the 3D rendered scene.

The string will remain displayed in the 3D window until it's changed with subsequent calls to this same method, or all the texts are cleared with clearTextMessages().

Parameters
xThe X position, interpreted as absolute pixels from the left if X>=1, absolute pixels from the left if X<0 or as a width factor if in the range [0,1[.
yThe Y position, interpreted as absolute pixels from the bottom if Y>=1, absolute pixels from the top if Y<0 or as a height factor if in the range [0,1[.
textThe text string to display.
colorThe text color. For example: TColorf(1.0,1.0,1.0)
unique_indexAn "index" for this text message, so that subsequent calls with the same index will overwrite this text message instead of creating new ones.

You'll need to refresh the display manually with forceRepaint().

See Also
clearTextMessages

Definition at line 120 of file CTextMessageCapable.cpp.

References mrpt::opengl::TFontParams::color, mrpt::opengl::TFontParams::font, mrpt::opengl::T2DTextData::text, mrpt::opengl::T2DTextData::x, and mrpt::opengl::T2DTextData::y.

void CTextMessageCapable::addTextMessage ( const double  x_frac,
const double  y_frac,
const std::string text,
const mrpt::utils::TColorf color,
const std::string font_name,
const double  font_size,
const mrpt::opengl::TOpenGLFontStyle  font_style = mrpt::opengl::NICE,
const size_t  unique_index = 0,
const double  font_spacing = 1.5,
const double  font_kerning = 0.1,
const bool  has_shadow = false,
const mrpt::utils::TColorf shadow_color = mrpt::utils::TColorf(0,0,0) 
)
inherited
void CTextMessageCapable::clearTextMessages ( )
inherited

Definition at line 114 of file CTextMessageCapable.cpp.

const mrpt::utils::TColorf& mrpt::opengl::CFBORender::getBackgroundColor ( ) const
inline

Get the default background color (unles an COpenGLViewport defines a custom color)

Definition at line 62 of file CFBORender.h.

CCamera & CFBORender::getCamera ( const COpenGLScene scene)

Get a reference to the scene camera.

Definition at line 133 of file CFBORender.cpp.

References mrpt::opengl::COpenGLScene::getViewport(), MRPT_END, and MRPT_START.

void CFBORender::getFrame ( const COpenGLScene scene,
mrpt::utils::CImage image 
)
void CFBORender::getFrame2 ( const COpenGLScene scene,
mrpt::utils::CImage image 
)
int CFBORender::isExtensionSupported ( const char *  extension)
protected

Provide information on Framebuffer object extension.

Definition at line 261 of file CFBORender.cpp.

References GL_EXTENSIONS, glGetString(), MRPT_END, MRPT_START, and MRPT_UNUSED_PARAM.

Referenced by CFBORender().

void CTextMessageCapable::render_text_messages ( const int  w,
const int  h 
) const
protectedinherited
void CFBORender::resize ( unsigned int  width,
unsigned int  height 
)
void mrpt::opengl::CFBORender::setBackgroundColor ( const mrpt::utils::TColorf col)
inline

Set the default background color (unles an COpenGLViewport defines a custom color)

Definition at line 65 of file CFBORender.h.

void CFBORender::setCamera ( const COpenGLScene scene,
const CCamera camera 
)

Change the scene camera.

Definition at line 121 of file CFBORender.cpp.

References mrpt::opengl::COpenGLScene::getViewport(), MRPT_END, and MRPT_START.

bool CTextMessageCapable::updateTextMessage ( const size_t  unique_index,
const std::string text 
)
inherited

Just updates the text of a given text message, without touching the other parameters.

Returns
false if given ID doesn't exist.

Definition at line 142 of file CTextMessageCapable.cpp.

Member Data Documentation

std::map<size_t,mrpt::opengl::T2DTextData> mrpt::opengl::CTextMessageCapable::m_2D_texts
protectedinherited

Definition at line 27 of file CTextMessageCapable.h.

mrpt::utils::TColorf mrpt::opengl::CFBORender::m_default_bk_color
protected

Definition at line 71 of file CFBORender.h.

Referenced by getFrame2().

unsigned int mrpt::opengl::CFBORender::m_fbo
protected

Definition at line 69 of file CFBORender.h.

Referenced by CFBORender(), getFrame2(), resize(), and ~CFBORender().

int mrpt::opengl::CFBORender::m_height
protected

Definition at line 68 of file CFBORender.h.

Referenced by CFBORender(), getFrame(), getFrame2(), and resize().

unsigned int mrpt::opengl::CFBORender::m_tex
protected

Definition at line 69 of file CFBORender.h.

Referenced by CFBORender(), resize(), and ~CFBORender().

int mrpt::opengl::CFBORender::m_width
protected

Definition at line 68 of file CFBORender.h.

Referenced by CFBORender(), getFrame(), getFrame2(), and resize().

int mrpt::opengl::CFBORender::m_win
protected

Definition at line 68 of file CFBORender.h.

Referenced by CFBORender(), and ~CFBORender().

bool mrpt::opengl::CFBORender::m_win_used
protected

Definition at line 70 of file CFBORender.h.

Referenced by CFBORender(), and ~CFBORender().




Page generated by Doxygen 1.8.6 for MRPT 1.5.6 Git: 4c65e84 Tue Apr 24 08:18:17 2018 +0200 at mar abr 24 08:26:17 CEST 2018