CWxGLCanvasBase.h

Go to the documentation of this file.

/* +------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)            |
   |                          http://www.mrpt.org/                          |
   |                                                                        |
   | Copyright (c) 2005-2017, Individual contributors, see AUTHORS file     |
   | See: http://www.mrpt.org/Authors - All rights reserved.                |
   | Released under BSD License. See details in http://www.mrpt.org/License |
   +------------------------------------------------------------------------+ */

#ifndef CMyGLCanvas_H
#define CMyGLCanvas_H

#include <mrpt/gui/CGlCanvasBase.h>

#include <mrpt/opengl/opengl_fonts.h>
#include <mrpt/opengl/CTextMessageCapable.h>
#include <mrpt/opengl/COpenGLScene.h>

namespace mrpt
{
namespace gui
{
}
}  // At least declare the existence of the namespace mrpt::gui even if we don't
// have wxWidgets libs

#if MRPT_HAS_WXWIDGETS

#include <wx/string.h>
#include <wx/intl.h>
#include <wx/bitmap.h>
#include <wx/icon.h>
#include <wx/image.h>
#include <wx/artprov.h>

#include <wx/msgdlg.h>
#include <wx/filedlg.h>
#include <wx/progdlg.h>
#include <wx/imaglist.h>
#include <wx/busyinfo.h>
#include <wx/log.h>
#include <wx/textdlg.h>
#include <wx/dirdlg.h>
#include <wx/colordlg.h>
#include <wx/dcmemory.h>

#if wxUSE_GLCANVAS && MRPT_HAS_OPENGL_GLUT

#include <wx/glcanvas.h>
#include <wx/dcclient.h>

// To avoid conflicts between Eigen & X11 headers
#ifdef Success
#undef Success
#endif

namespace mrpt
{
namespace gui
{
/** This class implements a OpenGL canvas, and it's used in
 * gui::CDisplayWindow3D and a number of standalone applications in the MRPT
 * project.
  *  There is a filter to control the user capability of moving the camera with
 * the mouse. See OnUserManuallyMovesCamera
  * \ingroup mrpt_gui_grp
  */
class CWxGLCanvasBase : public CGlCanvasBase,
                                                public wxGLCanvas,
                                                public mrpt::opengl::CTextMessageCapable
{
   public:
        CWxGLCanvasBase(
                wxWindow* parent, wxWindowID id = wxID_ANY,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize, long style = 0,
                const wxString& name = _T("CWxGLCanvasBase"));

        virtual ~CWxGLCanvasBase();

        void OnPaint(wxPaintEvent& event);
        void OnSize(wxSizeEvent& event);
        void OnEraseBackground(wxEraseEvent& event);
        void OnEnterWindow(wxMouseEvent& event);

        void OnChar(wxKeyEvent& event);

        void OnMouseDown(wxMouseEvent& event);
        void OnMouseMove(wxMouseEvent& event);
        void OnMouseUp(wxMouseEvent&);
        void OnMouseWheel(wxMouseEvent& event);

        void Render();
        void InitGL();

        /** Set the camera from a CPose3D, which defines the +X,+Y axis as image
         * place RIGHT and UP dirctions, and -Z as towards the pointing direction.
          */
        void setCameraPose(const mrpt::poses::CPose3D& camPose);

        /**  Methods that can be implemented in custom derived classes  */
        virtual void OnCharCustom(wxKeyEvent& event) { MRPT_UNUSED_PARAM(event); }
        virtual void OnPreRender() {}
        virtual void OnPostRender() {}
        virtual void OnPostRenderSwapBuffers(double At, wxPaintDC& dc)
        {
                MRPT_UNUSED_PARAM(At);
                MRPT_UNUSED_PARAM(dc);
        }

        virtual void OnRenderError(const wxString& str) { MRPT_UNUSED_PARAM(str); }
   protected:
        wxGLContext* m_gl_context = nullptr;
        bool m_init = false;

        long m_Key = 0;
        unsigned long m_StartTime = 0;
        unsigned long m_LastTime = 0;
        unsigned long m_LastRedraw = 0;

        // Used to create the gl context at startup.
        void OnWindowCreation(wxWindowCreateEvent& ev);
        virtual void swapBuffers() override;
        virtual void preRender() override;
        virtual void postRender() override;
        virtual void renderError(const std::string& err_msg) override;

};  // end of class

}  // end namespace
}  // end namespace

#endif  // wxUSE_GLCANVAS
#endif  // MRPT_HAS_WXWIDGETS
#endif  // CMyGLCanvas_H