src/creawxVTKRenderWindowInteractor.h

   1 /*
   2  # ---------------------------------------------------------------------
   3  #
   4  # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   5  #                        pour la SantÈ)
   6  # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   7  # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   8  # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   9  #
  10  #  This software is governed by the CeCILL-B license under French law and
  11  #  abiding by the rules of distribution of free software. You can  use,
  12  #  modify and/ or redistribute the software under the terms of the CeCILL-B
  13  #  license as circulated by CEA, CNRS and INRIA at the following URL
  14  #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  15  #  or in the file LICENSE.txt.
  16  #
  17  #  As a counterpart to the access to the source code and  rights to copy,
  18  #  modify and redistribute granted by the license, users are provided only
  19  #  with a limited warranty  and the software's author,  the holder of the
  20  #  economic rights,  and the successive licensors  have only  limited
  21  #  liability.
  22  #
  23  #  The fact that you are presently reading this means that you have had
  24  #  knowledge of the CeCILL-B license and that you accept its terms.
  25  # ------------------------------------------------------------------------ */
  26
  27
  28 /*=========================================================================
  29
  30   Program:   Visualization Toolkit
  31   Module:    $RCSfile$
  32   Language:  C++
  33   Date:      $Date$
  34   Version:   $Revision$
  35
  36   Copyright (c) 1993-2002 Ken Martin, Will Schroeder, Bill Lorensen
  37   All rights reserved.
  38   See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
  39
  40      This software is distributed WITHOUT ANY WARRANTY; without even
  41      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  42      PURPOSE.  See the above copyright notice for more information.
  43
  44 =========================================================================*/
  45
  46 // .NAME  wxVTKRenderWindowInteractor - class to enable VTK to render to
  47 // and interact with wxWindow.
  48 // .SECTION Description
  49 //  wxVTKRenderWindowInteractor provide a VTK widget for wxWindow. This class
  50 // was completely rewrote to have the 'Look & Feel' of the python version:
  51 // wxVTKRenderWindowInteractor.py
  52 // .SECTION Caveats
  53 //  - There is a know bug that prevent this class to works for more info see
  54 // WX_USE_X_CAPTURE. This bug only affect wxGTK from 2.3.2 to wxGTK 2.4.0.
  55 //  - Furthermore this class is tempated over either wxWindows or wxGLCanvas,
  56 // in wxWindows 2.3.1 and earlier, the wxGLCanvas had scroll bars, you can avoid
  57 // this effect by playing with WX_BASE_CLASS at your risk (you might end up with
  58 // lot of flickering.)
  59 //  - This class might not be easily readable as it tried to work with VTK 3.2
  60 //  and 4.x. This class doesn't support reparenting with VTK 4.2 and earlier.
  61 // .SECTION see also
  62 // wxVTKRenderWindowInteractor.py wxVTKRenderWindow.py
  63
  64 #ifndef _wxVTKRenderWindowInteractor_h_
  65 #define _wxVTKRenderWindowInteractor_h_
  66
  67 // For compilers that support precompilation, includes "wx/wx.h".
  68 #include "wx/wxprec.h"
  69
  70 #ifdef __BORLANDC__
  71 #  pragma hdrstop
  72 #endif
  73
  74 #ifndef WX_PRECOMP
  75 #include <wx/wx.h>
  76 #endif
  77
  78 #include <wx/timer.h>
  79 #include <wx/dcclient.h>
  80
  81 // vtk includes
  82 #include "vtkRenderWindowInteractor.h"
  83 #include "vtkRenderWindow.h"
  84
  85 #define USE_WXGLCANVAS
  86
  87 #if defined(__WXGTK__) && defined(USE_WXGLCANVAS)
  88 #  if wxUSE_GLCANVAS
  89 #    include <wx/glcanvas.h>
  90 #  else
  91 #    error "problem of wxGLCanvas, you need to build wxWidgets with opengl"
  92 #  endif //wxUSE_GLCANVAS
  93 #endif //__WXGTK__
  94
  95 // Motif version (renamed into wxX11 for wxWindow 2.4 and newer)
  96 #if defined(__WXMOTIF__)
  97 # error This GUI is not supported by wxVTKRenderWindowInteractor for now
  98 #endif
  99
 100 #include "creaSystem.h"
 101
 102 #include "vtkTDxConfigure.h" // defines VTK_USE_TDX
 103 #ifdef VTK_USE_TDX
 104 class vtkTDxMacDevice;
 105 #endif
 106
 107
 108
 109 // wx forward declarations
 110 class wxPaintEvent;
 111 class wxMouseEvent;
 112 class wxTimerEvent;
 113 class wxKeyEvent;
 114 class wxSizeEvent;
 115
 116 //=======================================================================
 117 // LG : NAMESPACE IS NECESSARY TO AVOID CONFLICTING SYMBOLS IN DYN LIBS
 118 namespace crea
 119 {
 120
 121
 122 #if defined(__WXGTK__) && defined(USE_WXGLCANVAS)
 123 class wxVTKRenderWindowInteractor : public wxGLCanvas, public vtkRenderWindowInteractor
 124 #else
 125 class CREA_EXPORT wxVTKRenderWindowInteractor : public wxWindow, public vtkRenderWindowInteractor
 126 #endif //__WXGTK__
 127 {
 128 //EED 2017-09-16 Migration wxWidgets 2.8 to 3.0
 129 #if wxMAJOR_VERSION <= 2
 130   DECLARE_DYNAMIC_CLASS(wxVTKRenderWindowInteractor)
 131 #else
 132   wxDECLARE_DYNAMIC_CLASS(wxVTKRenderWindowInteractor);
 133 #endif
 134
 135   public:
 136     //constructors
 137     wxVTKRenderWindowInteractor();
 138
 139     wxVTKRenderWindowInteractor(wxWindow *parent,
 140                                 wxWindowID id,
 141                                 const wxPoint &pos = wxDefaultPosition,
 142                                 const wxSize &size = wxDefaultSize,
 143                                 long style = wxWANTS_CHARS | wxNO_FULL_REPAINT_ON_RESIZE,
 144                                 const wxString &name = wxPanelNameStr);
 145   //EED win Compilation why ??:    vtkTypeRevisionMacro(wxVTKRenderWindowInteractor,vtkRenderWindowInteractor);
 146     static wxVTKRenderWindowInteractor * New();
 147     void PrintSelf(ostream& os, vtkIndent indent);
 148
 149           //destructor
 150     ~wxVTKRenderWindowInteractor();
 151
 152     // vtkRenderWindowInteractor overrides
 153     void Initialize();
 154     void Enable();
 155     bool Enable(bool enable);
 156     void Disable();
 157     void Start();
 158     void UpdateSize(int x, int y);
 159     int CreateTimer(int timertype);
 160     int DestroyTimer();
 161     void TerminateApp() {};
 162
 163     // event handlers
 164     void OnPaint(wxPaintEvent &event);
 165     void OnEraseBackground (wxEraseEvent& event);
 166     void OnMotion(wxMouseEvent &event);
 167
 168     void OnButtonDown(wxMouseEvent &event);
 169     void OnButtonUp(wxMouseEvent &event);
 170 #if !(VTK_MAJOR_VERSION == 3 && VTK_MINOR_VERSION == 1)
 171     void OnEnter(wxMouseEvent &event);
 172     void OnLeave(wxMouseEvent &event);
 173     void OnMouseWheel(wxMouseEvent& event);
 174 #if wxCHECK_VERSION(2, 8, 0)
 175     void OnMouseCaptureLost(wxMouseCaptureLostEvent& event);
 176 #endif
 177     void OnKeyDown(wxKeyEvent &event);
 178     void OnKeyUp(wxKeyEvent &event);
 179     void OnChar(wxKeyEvent &event);
 180 #endif
 181     void OnTimer(wxTimerEvent &event);
 182     void OnSize(wxSizeEvent &event);
 183
 184     void Render();
 185     void SetRenderWhenDisabled(int newValue);
 186
 187     // Description:
 188     // Prescribe that the window be created in a stereo-capable mode. This
 189     // method must be called before the window is realized. Default if off.
 190     vtkGetMacro(Stereo,int);
 191     vtkBooleanMacro(Stereo,int);
 192     virtual void SetStereo(int capable);
 193
 194     // Description:
 195     // As CaptureMouse could be a problem sometimes on a window box
 196     // This method allow to set or not the CaptureMouse.
 197     // This method actually will works only if WX_USE_X_CAPTURE was set to 1
 198     vtkSetMacro(UseCaptureMouse,int);
 199     vtkBooleanMacro(UseCaptureMouse,int);
 200
 201 #if VTK_MAJOR_VERSION > 5 || (VTK_MAJOR_VERSION == 5 && VTK_MINOR_VERSION >= 2)
 202   protected:
 203     virtual int InternalCreateTimer(int timerId, int timerType, unsigned long duration);
 204     virtual int InternalDestroyTimer(int platformTimerId);
 205 #endif
 206
 207   protected:
 208 #if defined(__WXGTK__) && defined(USE_WXGLCANVAS)
 209     wxGLContext *context;
 210 #endif
 211     wxTimer timer;
 212     int ActiveButton;
 213     long GetHandleHack();
 214     int Stereo;
 215
 216 #ifdef VTK_USE_TDX
 217   vtkTDxMacDevice *Device;
 218 #endif
 219
 220
 221   private:
 222     long Handle;
 223     bool Created;
 224     int RenderWhenDisabled;
 225     int UseCaptureMouse;
 226
 227     DECLARE_EVENT_TABLE()
 228 };
 229
 230 }
 231 // LG : EO namespace bbwxvtk
 232 //======================================================================
 233
 234 #endif //_wxVTKRenderWindowInteractor_h_