VTK
vtkWin32RenderWindowInteractor.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkWin32RenderWindowInteractor.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
30 #ifndef vtkWin32RenderWindowInteractor_h
31 #define vtkWin32RenderWindowInteractor_h
32 
33 #include "vtkRenderingOpenGL2Module.h" // For export macro
35 #include "vtkWindows.h" // For windows API.
36 
37 #include "vtkTDxConfigure.h" // defines VTK_USE_TDX
38 #ifdef VTK_USE_TDX
39 class vtkTDxWinDevice;
40 #endif
41 
42 class VTKRENDERINGOPENGL2_EXPORT vtkWin32RenderWindowInteractor : public vtkRenderWindowInteractor
43 {
44 public:
49 
51  void PrintSelf(ostream& os, vtkIndent indent) override;
52 
56  virtual void Initialize() override;
57 
59 
68  virtual void Enable() override;
69  virtual void Disable() override;
71 
73 
79  vtkSetMacro(InstallMessageProc,int);
80  vtkGetMacro(InstallMessageProc,int);
81  vtkBooleanMacro(InstallMessageProc,int);
83 
89  void TerminateApp(void) override;
90 
91  friend VTKRENDERINGOPENGL2_EXPORT LRESULT CALLBACK vtkHandleMessage(HWND hwnd,UINT uMsg, WPARAM w, LPARAM l);
92  friend VTKRENDERINGOPENGL2_EXPORT LRESULT CALLBACK vtkHandleMessage2(HWND hwnd,UINT uMsg, WPARAM w, LPARAM l, vtkWin32RenderWindowInteractor *me);
93 
95 
99  virtual int OnMouseMove(HWND wnd, UINT nFlags, int X, int Y);
100  virtual int OnNCMouseMove(HWND wnd, UINT nFlags, int X, int Y);
101  virtual int OnRButtonDown(HWND wnd, UINT nFlags, int X, int Y, int repeat = 0);
102  virtual int OnRButtonUp(HWND wnd, UINT nFlags, int X, int Y);
103  virtual int OnMButtonDown(HWND wnd, UINT nFlags, int X, int Y, int repeat = 0);
104  virtual int OnMButtonUp(HWND wnd, UINT nFlags, int X, int Y);
105  virtual int OnLButtonDown(HWND wnd, UINT nFlags, int X, int Y, int repeat = 0);
106  virtual int OnLButtonUp(HWND wnd, UINT nFlags, int X, int Y);
107  virtual int OnSize(HWND wnd, UINT nType, int X, int Y);
108  virtual int OnTimer(HWND wnd, UINT nIDEvent);
109  virtual int OnKeyDown(HWND wnd, UINT nChar, UINT nRepCnt, UINT nFlags);
110  virtual int OnKeyUp(HWND wnd, UINT nChar, UINT nRepCnt, UINT nFlags);
111  virtual int OnChar(HWND wnd, UINT nChar, UINT nRepCnt, UINT nFlags);
112  virtual int OnMouseWheelForward(HWND wnd, UINT nFlags, int X, int Y);
113  virtual int OnMouseWheelBackward(HWND wnd, UINT nFlags, int X, int Y);
114  virtual int OnFocus(HWND wnd, UINT nFlags);
115  virtual int OnKillFocus(HWND wnd, UINT nFlags);
116  virtual int OnTouch(HWND wnd, UINT wParam, UINT lParam);
118 
120 
126  static void SetClassExitMethod(void (*f)(void *), void *arg);
127  static void SetClassExitMethodArgDelete(void (*f)(void *));
129 
134  void ExitCallback() override;
135 
136 protected:
139 
140  HWND WindowId;
141  WNDPROC OldProc;
145 
147 
152  static void (*ClassExitMethod)(void *);
153  static void (*ClassExitMethodArgDelete)(void *);
154  static void *ClassExitMethodArg;
156 
158 
162  int InternalCreateTimer(int timerId, int timerType, unsigned long duration) override;
163  int InternalDestroyTimer(int platformTimerId) override;
165 
171  void StartEventLoop() override;
172 
173 #ifdef VTK_USE_TDX
174  vtkTDxWinDevice *Device;
175 #endif
176 
177 private:
179  void operator=(const vtkWin32RenderWindowInteractor&) = delete;
180 };
181 
182 #endif
vtkRenderWindowInteractor::New
static vtkRenderWindowInteractor * New()
vtkRenderWindowInteractor::InternalCreateTimer
virtual int InternalCreateTimer(int timerId, int timerType, unsigned long duration)
Internal methods for creating and destroying timers that must be implemented by subclasses.
vtkRenderWindowInteractor::StartEventLoop
virtual void StartEventLoop()
Run the event loop (does not return until TerminateApp is called).
Definition: vtkRenderWindowInteractor.h:889
vtkRenderWindowInteractor::InternalDestroyTimer
virtual int InternalDestroyTimer(int platformTimerId)
vtkWin32RenderWindowInteractor::StartedMessageLoop
int StartedMessageLoop
Definition: vtkWin32RenderWindowInteractor.h:144
vtkWin32RenderWindowInteractor
implements Win32 specific functions required by vtkRenderWindowInteractor.
Definition: vtkWin32RenderWindowInteractor.h:42
vtkRenderWindowInteractor::Disable
virtual void Disable()
Definition: vtkRenderWindowInteractor.h:118
vtkWin32RenderWindowInteractor::OldProc
WNDPROC OldProc
Definition: vtkWin32RenderWindowInteractor.h:141
vtkRenderWindowInteractor::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkWin32RenderWindowInteractor::MouseInWindow
int MouseInWindow
Definition: vtkWin32RenderWindowInteractor.h:143
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkRenderWindowInteractor
platform-independent render window interaction including picking and frame rate control.
Definition: vtkRenderWindowInteractor.h:72
vtkRenderWindowInteractor::ExitCallback
virtual void ExitCallback()
These methods correspond to the Exit, User and Pick callbacks.
vtkRenderWindowInteractor::TerminateApp
virtual void TerminateApp(void)
This function is called on 'q','e' keypress if exitmethod is not specified and should be overridden b...
Definition: vtkRenderWindowInteractor.h:249
vtkRenderWindowInteractor::Enable
virtual void Enable()
Enable/Disable interactions.
Definition: vtkRenderWindowInteractor.h:117
vtkWin32RenderWindowInteractor::InstallMessageProc
int InstallMessageProc
Definition: vtkWin32RenderWindowInteractor.h:142
vtkRenderWindowInteractor.h
vtkRenderWindowInteractor::Initialize
virtual void Initialize()
Prepare for handling events and set the Enabled flag to true.
vtkWin32RenderWindowInteractor::ClassExitMethodArg
static void * ClassExitMethodArg
Definition: vtkWin32RenderWindowInteractor.h:154
vtkWin32RenderWindowInteractor::WindowId
HWND WindowId
Definition: vtkWin32RenderWindowInteractor.h:140