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 =========================================================================*/
28 #ifndef vtkContextInteractorStyle_h
29 #define vtkContextInteractorStyle_h
30 
31 #include "vtkViewsContext2DModule.h" // For export macro
32 #include "vtkInteractorStyle.h"
33 #include "vtkNew.h" // For ivars
34 #include "vtkWeakPointer.h" // For ivars
35 
37 class vtkContextScene;
38 
39 class VTKVIEWSCONTEXT2D_EXPORT vtkContextInteractorStyle : public vtkInteractorStyle
40 {
41 public:
44  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
53  void SetScene(vtkContextScene* scene);
54 
59 
63  virtual void OnSceneModified();
64 
69  void OnMouseMove() override;
70 
75  void OnLeftButtonDown() override;
76 
81  void OnLeftButtonUp() override;
82 
87  void OnMiddleButtonDown() override;
88 
93  void OnMiddleButtonUp() override;
94 
99  void OnRightButtonDown() override;
100 
105  void OnRightButtonUp() override;
106 
111  void OnMouseWheelForward() override;
112 
117  void OnMouseWheelBackward() override;
118 
123  virtual void OnSelection(unsigned int rect[5]);
124 
128  void OnChar() override;
129 
133  void OnKeyPress() override;
134 
138  void OnKeyRelease() override;
139 
140 protected:
143 
144  static void ProcessSceneEvents(vtkObject* object, unsigned long event,
145  void* clientdata, void* calldata);
146 
147  static void ProcessInteractorEvents(vtkObject* object, unsigned long event,
148  void* clientdata, void* calldata);
149 
150  virtual void RenderNow();
151 
158 
165 
171 
174 
175 private:
177  void operator=(const vtkContextInteractorStyle&) = delete;
178 
179  void ConstructMouseEvent(vtkContextMouseEvent &event, int button);
180  bool ProcessMousePress(const vtkContextMouseEvent &event);
181 };
182 
183 #endif
vtkContextMouseEvent
data structure to represent mouse events.
Definition: vtkContextMouseEvent.h:41
vtkContextInteractorStyle::OnLeftButtonUp
void OnLeftButtonUp() override
Called when the user releases the mouse left button.
vtkContextInteractorStyle::SetScene
void SetScene(vtkContextScene *scene)
Set the scene to forward user events to.
vtkInteractorStyle.h
vtkContextInteractorStyle::New
static vtkContextInteractorStyle * New()
vtkContextInteractorStyle::GetScene
vtkContextScene * GetScene()
Return the observed scene.
vtkContextInteractorStyle::OnSelection
virtual void OnSelection(unsigned int rect[5])
Place holder for future implementation.
vtkContextInteractorStyle::LastSceneRepaintMTime
vtkMTimeType LastSceneRepaintMTime
Definition: vtkContextInteractorStyle.h:170
vtkContextInteractorStyle::SceneTimerId
int SceneTimerId
Definition: vtkContextInteractorStyle.h:172
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkContextInteractorStyle::Scene
vtkWeakPointer< vtkContextScene > Scene
Definition: vtkContextInteractorStyle.h:166
vtkContextInteractorStyle::OnChar
void OnChar() override
Handle key presses.
vtkContextInteractorStyle::RenderNow
virtual void RenderNow()
vtkContextInteractorStyle::OnKeyPress
void OnKeyPress() override
Called when the user presses a key.
vtkContextInteractorStyle::InteractorCallbackCommand
vtkNew< vtkCallbackCommand > InteractorCallbackCommand
Definition: vtkContextInteractorStyle.h:168
vtkContextInteractorStyle::EndProcessingEvent
void EndProcessingEvent()
Inform the interactor style that an event is finished to be processed.
vtkContextInteractorStyle::ProcessingEvents
int ProcessingEvents
Definition: vtkContextInteractorStyle.h:169
vtkContextInteractorStyle::OnMouseWheelForward
void OnMouseWheelForward() override
Called when the user moves the mouse wheel forward.
vtkContextInteractorStyle::OnMouseMove
void OnMouseMove() override
Called when the user moves the mouse Default behavior forwards the event to the observed scene.
vtkContextScene
Provides a 2D scene for vtkContextItem objects.
Definition: vtkContextScene.h:51
vtkContextInteractorStyle::BeginProcessingEvent
void BeginProcessingEvent()
Inform the interactor style that an event is being processed.
vtkContextInteractorStyle::OnMouseWheelBackward
void OnMouseWheelBackward() override
Called when the user moves the mouse wheel backward.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkContextInteractorStyle::ProcessSceneEvents
static void ProcessSceneEvents(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
vtkContextInteractorStyle::OnRightButtonUp
void OnRightButtonUp() override
Called when the user releases the mouse right button.
vtkContextInteractorStyle::~vtkContextInteractorStyle
~vtkContextInteractorStyle() override
vtkContextInteractorStyle::ProcessInteractorEvents
static void ProcessInteractorEvents(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
vtkNew< vtkCallbackCommand >
vtkContextInteractorStyle::OnRightButtonDown
void OnRightButtonDown() override
Called when the user clicks the mouse right button.
vtkContextInteractorStyle::OnKeyRelease
void OnKeyRelease() override
Called when the user releases a key.
vtkWeakPointer.h
vtkInteractorStyle
provide event-driven interface to the rendering window (defines trackball mode)
Definition: vtkInteractorStyle.h:142
vtkContextInteractorStyle::vtkContextInteractorStyle
vtkContextInteractorStyle()
vtkContextInteractorStyle::OnSceneModified
virtual void OnSceneModified()
Called when the scene is modified.
vtkContextInteractorStyle::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkContextInteractorStyle::OnLeftButtonDown
void OnLeftButtonDown() override
Called when the user clicks the mouse left button.
vtkContextInteractorStyle::OnMiddleButtonUp
void OnMiddleButtonUp() override
Called when the user releases the mouse middle button.
vtkNew.h
vtkContextInteractorStyle
An interactor for chart views.
Definition: vtkContextInteractorStyle.h:40
vtkContextInteractorStyle::SceneCallbackCommand
vtkNew< vtkCallbackCommand > SceneCallbackCommand
Definition: vtkContextInteractorStyle.h:167
vtkContextInteractorStyle::TimerCallbackInitialized
bool TimerCallbackInitialized
Definition: vtkContextInteractorStyle.h:173
vtkContextInteractorStyle::OnMiddleButtonDown
void OnMiddleButtonDown() override
Called when the user clicks the mouse middle button.
vtkWeakPointer< vtkContextScene >
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:302