lib/maracasVisuLib/src/interface/wxWindows/widgets/wxVTKRenderWindowInteractor.h

   1 /*=========================================================================
   2
   3   Program:   Visualization Toolkit
   4   Module:    $RCSfile: wxVTKRenderWindowInteractor.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008/10/31 16:32:44 $
   7   Version:   $Revision: 1.1 $
   8
   9   Copyright (c) 1993-2002 Ken Martin, Will Schroeder, Bill Lorensen
  10   All rights reserved.
  11   See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notice for more information.
  16
  17 =========================================================================*/
  18
  19 // .NAME  wxVTKRenderWindowInteractor - class to enable VTK to render to
  20 // and interact with wxWindow.
  21 // .SECTION Description
  22 //  wxVTKRenderWindowInteractor provide a VTK widget for wxWindow. This class
  23 // was completely rewrote to have the 'Look & Feel' of the python version:
  24 // wxVTKRenderWindowInteractor.py
  25 // .SECTION Caveats
  26 //  - There is a know bug that prevent this class to works for more info see
  27 // WX_USE_X_CAPTURE. This bug only affect wxGTK from 2.3.2 to wxGTK 2.4.0.
  28 //  - Furthermore this class is tempated over either wxWindows or wxGLCanvas,
  29 // in wxWindows 2.3.1 and earlier, the wxGLCanvas had scroll bars, you can avoid
  30 // this effect by playing with WX_BASE_CLASS at your risk (you might end up with
  31 // lot of flickering.)
  32 //  - This class might not be easily readable as it tried to work with VTK 3.2
  33 //  and 4.x. This class doesn't support reparenting with VTK 4.2 and earlier.
  34 // .SECTION see also
  35 // wxVTKRenderWindowInteractor.py wxVTKRenderWindow.py
  36
  37 #ifndef _wxVTKRenderWindowInteractor_h_
  38 #define _wxVTKRenderWindowInteractor_h_
  39
  40 // For compilers that support precompilation, includes "wx/wx.h".
  41 #include "wx/wxprec.h"
  42
  43 #ifdef __BORLANDC__
  44 #  pragma hdrstop
  45 #endif
  46
  47 #ifndef WX_PRECOMP
  48 #include <wx/wx.h>
  49 #endif
  50
  51 #include <wx/timer.h>
  52 #include <wx/dcclient.h>
  53
  54 // vtk includes
  55 #include "vtkRenderWindowInteractor.h"
  56 #include "vtkRenderWindow.h"
  57
  58 // Apparently since wxGTK 2.8.0 one can finally use wxWindow (just as in any
  59 // other port):
  60 #if (!wxCHECK_VERSION(2, 8, 0))
  61 #define USE_WXGLCANVAS
  62 #endif
  63
  64
  65 #if defined(__WXGTK__) && defined(USE_WXGLCANVAS)
  66 # if wxUSE_GLCANVAS
  67 #    include <wx/glcanvas.h>
  68 # else
  69 #    error "problem of wxGLCanvas, you need to build wxWidgets with opengl"
  70 # endif //wxUSE_GLCANVAS
  71 #endif //__WXGTK__
  72
  73 // Motif version (renamed into wxX11 for wxWindow 2.4 and newer)
  74 #if defined(__WXMOTIF__)
  75 # error This GUI is not supported by wxVTKRenderWindowInteractor for now
  76 #endif
  77
  78 // wx forward declarations
  79 class wxPaintEvent;
  80 class wxMouseEvent;
  81 class wxTimerEvent;
  82 class wxKeyEvent;
  83 class wxSizeEvent;
  84
  85 #if defined(__WXGTK__) && defined(USE_WXGLCANVAS)
  86 class VTK_RENDERING_EXPORT wxVTKRenderWindowInteractor : public wxGLCanvas, virtual public vtkRenderWindowInteractor
  87 #else
  88 class /*VTK_RENDERING_EXPORT*/ wxVTKRenderWindowInteractor : public wxWindow, virtual public vtkRenderWindowInteractor
  89 #endif //__WXGTK__
  90 {
  91   DECLARE_DYNAMIC_CLASS(wxVTKRenderWindowInteractor)
  92
  93   public:
  94     //constructors
  95     wxVTKRenderWindowInteractor();
  96
  97     wxVTKRenderWindowInteractor(wxWindow *parent,
  98                                 wxWindowID id,
  99                                 const wxPoint &pos = wxDefaultPosition,
 100                                 const wxSize &size = wxDefaultSize,
 101                                 long style = wxWANTS_CHARS | wxNO_FULL_REPAINT_ON_RESIZE,
 102                                 const wxString &name = wxPanelNameStr);
 103         //vtk ::New()
 104     static wxVTKRenderWindowInteractor * New();
 105     void PrintSelf(ostream& os, vtkIndent indent);
 106
 107           //destructor
 108     ~wxVTKRenderWindowInteractor();
 109
 110 #if defined(_WIN32)
 111     const char * wxVTKRenderWindowInteractor::GetClassName() const;
 112 #endif //_WIN32
 113
 114
 115     // vtkRenderWindowInteractor overrides
 116     void Initialize();
 117     void Enable();
 118     bool Enable(bool enable);
 119     void Disable();
 120     void Start();
 121     void UpdateSize(int x, int y);
 122     int CreateTimer(int timertype);
 123     int DestroyTimer();
 124     void TerminateApp() {};
 125
 126     // event handlers
 127     void OnPaint(wxPaintEvent &event);
 128     void OnEraseBackground (wxEraseEvent& event);
 129     void OnMotion(wxMouseEvent &event);
 130
 131     void OnButtonDown(wxMouseEvent &event);
 132     void OnButtonUp(wxMouseEvent &event);
 133 #if !(VTK_MAJOR_VERSION == 3 && VTK_MINOR_VERSION == 1)
 134     void OnEnter(wxMouseEvent &event);
 135     void OnLeave(wxMouseEvent &event);
 136     void OnKeyDown(wxKeyEvent &event);
 137     void OnKeyUp(wxKeyEvent &event);
 138 #endif
 139     void OnTimer(wxTimerEvent &event);
 140     void OnSize(wxSizeEvent &event);
 141     void OnMouseWheel(wxMouseEvent& event);
 142
 143     void Render();
 144     void SetRenderWhenDisabled(int newValue);
 145
 146     // Description:
 147     // Prescribe that the window be created in a stereo-capable mode. This
 148     // method must be called before the window is realized. Default if off.
 149     vtkGetMacro(Stereo,int);
 150     vtkBooleanMacro(Stereo,int);
 151     virtual void SetStereo(int capable);
 152
 153     // Description:
 154     // As CaptureMouse could be a problem sometimes on a window box
 155     // This method allow to set or not the CaptureMouse.
 156     // This method actually will works only if WX_USE_X_CAPTURE was set to 1
 157     vtkSetMacro(UseCaptureMouse,int);
 158     vtkBooleanMacro(UseCaptureMouse,int);
 159
 160   protected:
 161     wxTimer timer;
 162     int ActiveButton;
 163     int RenderAllowed;
 164     long GetHandleHack();
 165     int Stereo;
 166
 167   private:
 168     long Handle;
 169     bool Created;
 170     int RenderWhenDisabled;
 171     int UseCaptureMouse;
 172
 173     DECLARE_EVENT_TABLE()
 174 };
 175
 176 #endif //_wxVTKRenderWindowInteractor_h_