VTK
vtkContextInteractorStyle.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkContextInteractorStyle.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 =========================================================================*/
25 #ifndef vtkContextInteractorStyle_h
26 #define vtkContextInteractorStyle_h
27 
28 #include "vtkViewsContext2DModule.h" // For export macro
29 #include "vtkInteractorStyle.h"
30 #include "vtkNew.h" // For ivars
31 #include "vtkWeakPointer.h" // For ivars
32 
34 class vtkContextScene;
35 
36 class VTKVIEWSCONTEXT2D_EXPORT vtkContextInteractorStyle : public vtkInteractorStyle
37 {
38 public:
41  void PrintSelf(ostream& os, vtkIndent indent) override;
42 
50  void SetScene(vtkContextScene* scene);
51 
55  vtkContextScene* GetScene();
56 
60  virtual void OnSceneModified();
61 
66  void OnMouseMove() override;
67 
72  void OnLeftButtonDown() override;
73 
78  void OnLeftButtonUp() override;
79 
84  void OnMiddleButtonDown() override;
85 
90  void OnMiddleButtonUp() override;
91 
96  void OnRightButtonDown() override;
97 
102  void OnRightButtonUp() override;
103 
108  void OnMouseWheelForward() override;
109 
114  void OnMouseWheelBackward() override;
115 
120  virtual void OnSelection(unsigned int rect[5]);
121 
125  void OnChar() override;
126 
130  void OnKeyPress() override;
131 
135  void OnKeyRelease() override;
136 
137 protected:
139  ~vtkContextInteractorStyle() override;
140 
141  static void ProcessSceneEvents(vtkObject* object, unsigned long event,
142  void* clientdata, void* calldata);
143 
144  static void ProcessInteractorEvents(vtkObject* object, unsigned long event,
145  void* clientdata, void* calldata);
146 
147  virtual void RenderNow();
148 
154  void BeginProcessingEvent();
155 
161  void EndProcessingEvent();
162 
168 
171 
172 private:
174  void operator=(const vtkContextInteractorStyle&) = delete;
175 
176  void ConstructMouseEvent(vtkContextMouseEvent &event, int button);
177  bool ProcessMousePress(const vtkContextMouseEvent &event);
178 };
179 
180 #endif
vtkContextMouseEvent
data structure to represent mouse events.
Definition: vtkContextMouseEvent.h:34
vtkInteractorStyle.h
vtkInteractorStyle::OnKeyRelease
virtual void OnKeyRelease()
Definition: vtkInteractorStyle.h:268
vtkInteractorStyle::OnKeyPress
virtual void OnKeyPress()
Definition: vtkInteractorStyle.h:263
vtkContextInteractorStyle::LastSceneRepaintMTime
vtkMTimeType LastSceneRepaintMTime
Definition: vtkContextInteractorStyle.h:167
vtkContextInteractorStyle::SceneTimerId
int SceneTimerId
Definition: vtkContextInteractorStyle.h:169
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:53
vtkContextInteractorStyle::Scene
vtkWeakPointer< vtkContextScene > Scene
Definition: vtkContextInteractorStyle.h:163
vtkContextInteractorStyle::InteractorCallbackCommand
vtkNew< vtkCallbackCommand > InteractorCallbackCommand
Definition: vtkContextInteractorStyle.h:165
vtkContextInteractorStyle::ProcessingEvents
int ProcessingEvents
Definition: vtkContextInteractorStyle.h:166
vtkInteractorStyle::OnChar
void OnChar() override
OnChar is triggered when an ASCII key is pressed.
vtkInteractorStyle::OnMiddleButtonUp
virtual void OnMiddleButtonUp()
Definition: vtkInteractorStyle.h:227
vtkInteractorStyle::OnMouseMove
virtual void OnMouseMove()
Generic event bindings can be overridden in subclasses.
Definition: vtkInteractorStyle.h:223
vtkContextScene
Provides a 2D scene for vtkContextItem objects.
Definition: vtkContextScene.h:47
vtkInteractorStyle::OnMiddleButtonDown
virtual void OnMiddleButtonDown()
Definition: vtkInteractorStyle.h:226
vtkInteractorStyle::OnRightButtonDown
virtual void OnRightButtonDown()
Definition: vtkInteractorStyle.h:228
vtkInteractorStyle::OnMouseWheelForward
virtual void OnMouseWheelForward()
Definition: vtkInteractorStyle.h:230
vtkInteractorStyle::OnLeftButtonDown
virtual void OnLeftButtonDown()
Definition: vtkInteractorStyle.h:224
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkNew< vtkCallbackCommand >
vtkWeakPointer.h
vtkInteractorStyle
provide event-driven interface to the rendering window (defines trackball mode)
Definition: vtkInteractorStyle.h:135
vtkInteractorStyle::OnMouseWheelBackward
virtual void OnMouseWheelBackward()
Definition: vtkInteractorStyle.h:231
vtkInteractorStyle::OnLeftButtonUp
virtual void OnLeftButtonUp()
Definition: vtkInteractorStyle.h:225
vtkNew.h
vtkInteractorStyle::New
static vtkInteractorStyle * New()
This class must be supplied with a vtkRenderWindowInteractor wrapper or parent.
vtkContextInteractorStyle
An interactor for chart views.
Definition: vtkContextInteractorStyle.h:36
vtkContextInteractorStyle::SceneCallbackCommand
vtkNew< vtkCallbackCommand > SceneCallbackCommand
Definition: vtkContextInteractorStyle.h:164
vtkContextInteractorStyle::TimerCallbackInitialized
bool TimerCallbackInitialized
Definition: vtkContextInteractorStyle.h:170
vtkInteractorStyle::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInteractorStyle::OnRightButtonUp
virtual void OnRightButtonUp()
Definition: vtkInteractorStyle.h:229
vtkWeakPointer< vtkContextScene >
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:302