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
Definition at line 29 of file CFBORender.h.
#include <mrpt/opengl/CFBORender.h>
Public Member Functions | |
CFBORender (unsigned int width=800, unsigned int height=600, const bool skip_glut_window=false) | |
Constructor. | |
virtual | ~CFBORender () |
Destructor. | |
void | setCamera (const COpenGLScene &scene, const CCamera &camera) |
Change the scene camera. | |
CCamera & | getCamera (const COpenGLScene &scene) |
Get a reference to the scene camera. | |
void | getFrame (const COpenGLScene &scene, mrpt::utils::CImage &image) |
Render the scene and get the rendered rgb image. | |
void | getFrame2 (const COpenGLScene &scene, mrpt::utils::CImage &image) |
Render the scene and get the rendered rgb image. | |
void | resize (unsigned int width, unsigned int height) |
Resize the rendering canvas size. | |
const mrpt::utils::TColorf & | getBackgroundColor () const |
Get the default background color (unles an COpenGLViewport defines a custom color) | |
void | setBackgroundColor (const mrpt::utils::TColorf &col) |
Set the default background color (unles an COpenGLViewport defines a custom color) | |
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. | |
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)) |
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. | |
Protected Member Functions | |
int | isExtensionSupported (const char *extension) |
Provide information on Framebuffer object extension. | |
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 ). | |
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 |
mrpt::opengl::CFBORender::CFBORender | ( | unsigned int | width = 800 , |
unsigned int | height = 600 , |
||
const bool | skip_glut_window = false |
||
) |
Constructor.
[in] | skip_glut_window | Should 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. |
|
virtual |
Destructor.
|
inherited |
|
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().
x | The 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[. |
y | The 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[. |
text | The text string to display. |
color | The text color. For example: TColorf(1.0,1.0,1.0) |
unique_index | An "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().
|
inherited |
|
inline |
Get the default background color (unles an COpenGLViewport defines a custom color)
Definition at line 62 of file CFBORender.h.
CCamera & mrpt::opengl::CFBORender::getCamera | ( | const COpenGLScene & | scene | ) |
Get a reference to the scene camera.
void mrpt::opengl::CFBORender::getFrame | ( | const COpenGLScene & | scene, |
mrpt::utils::CImage & | image | ||
) |
Render the scene and get the rendered rgb image.
Resizes the image buffer if it is necessary.
void mrpt::opengl::CFBORender::getFrame2 | ( | const COpenGLScene & | scene, |
mrpt::utils::CImage & | image | ||
) |
Render the scene and get the rendered rgb image.
Does not resize the image buffer. MANDATORY: The image origin must be bottom left.
|
protected |
Provide information on Framebuffer object extension.
|
protectedinherited |
Renders the messages to the current opengl rendering context (to be called OUT of MRPT mrpt::opengl render() methods ).
(w,h) are the dimensions of the rendering area in pixels.
void mrpt::opengl::CFBORender::resize | ( | unsigned int | width, |
unsigned int | height | ||
) |
Resize the rendering canvas size.
|
inline |
Set the default background color (unles an COpenGLViewport defines a custom color)
Definition at line 65 of file CFBORender.h.
void mrpt::opengl::CFBORender::setCamera | ( | const COpenGLScene & | scene, |
const CCamera & | camera | ||
) |
Change the scene camera.
|
inherited |
Just updates the text of a given text message, without touching the other parameters.
|
protectedinherited |
Definition at line 27 of file CTextMessageCapable.h.
|
protected |
Definition at line 71 of file CFBORender.h.
|
protected |
Definition at line 69 of file CFBORender.h.
|
protected |
Definition at line 68 of file CFBORender.h.
|
protected |
Definition at line 69 of file CFBORender.h.
|
protected |
Definition at line 68 of file CFBORender.h.
|
protected |
Definition at line 68 of file CFBORender.h.
|
protected |
Definition at line 70 of file CFBORender.h.
Page generated by Doxygen 1.9.7 for MRPT 1.4.0 SVN: at Tue Jun 13 13:56:43 UTC 2023 |