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);
45 
53  void SetScene(vtkContextScene* scene);
54 
59 
63  virtual void OnSceneModified();
64 
69  virtual void OnMouseMove();
70 
75  virtual void OnLeftButtonDown();
76 
81  virtual void OnLeftButtonUp();
82 
87  virtual void OnMiddleButtonDown();
88 
93  virtual void OnMiddleButtonUp();
94 
99  virtual void OnRightButtonDown();
100 
105  virtual void OnRightButtonUp();
106 
111  virtual void OnMouseWheelForward();
112 
117  virtual void OnMouseWheelBackward();
118 
123  virtual void OnSelection(unsigned int rect[5]);
124 
128  virtual void OnChar();
129 
133  virtual void OnKeyPress();
134 
138  virtual void OnKeyRelease();
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 
172  int TimerId;
174 
175 private:
176  vtkContextInteractorStyle(const vtkContextInteractorStyle&) VTK_DELETE_FUNCTION;
177  void operator=(const vtkContextInteractorStyle&) VTK_DELETE_FUNCTION;
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::OnKeyRelease
virtual void OnKeyRelease()
Called when the user releases a key.
vtkContextInteractorStyle::~vtkContextInteractorStyle
~vtkContextInteractorStyle()
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::OnMiddleButtonDown
virtual void OnMiddleButtonDown()
Called when the user clicks the mouse middle button.
vtkContextInteractorStyle::OnMouseMove
virtual void OnMouseMove()
Called when the user moves the mouse Default behavior forwards the event to the observed scene.
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkContextInteractorStyle::Scene
vtkWeakPointer< vtkContextScene > Scene
Definition: vtkContextInteractorStyle.h:166
vtkContextInteractorStyle::RenderNow
virtual void RenderNow()
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::OnMiddleButtonUp
virtual void OnMiddleButtonUp()
Called when the user releases the mouse middle button.
vtkContextInteractorStyle::ProcessingEvents
int ProcessingEvents
Definition: vtkContextInteractorStyle.h:169
vtkContextInteractorStyle::OnRightButtonUp
virtual void OnRightButtonUp()
Called when the user releases the mouse right button.
vtkContextInteractorStyle::TimerId
int TimerId
Definition: vtkContextInteractorStyle.h:172
vtkMTimeType
vtkTypeUInt64 vtkMTimeType
Definition: vtkType.h:248
vtkContextInteractorStyle::OnMouseWheelForward
virtual void OnMouseWheelForward()
Called when the user moves the mouse wheel forward.
vtkContextInteractorStyle::OnMouseWheelBackward
virtual void OnMouseWheelBackward()
Called when the user moves the mouse wheel backward.
vtkContextScene
Provides a 2D scene for vtkContextItem objects.
Definition: vtkContextScene.h:51
vtkContextInteractorStyle::OnChar
virtual void OnChar()
Handle key presses.
vtkContextInteractorStyle::BeginProcessingEvent
void BeginProcessingEvent()
Inform the interactor style that an event is being processed.
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::ProcessInteractorEvents
static void ProcessInteractorEvents(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
vtkNew< vtkCallbackCommand >
vtkWeakPointer.h
vtkInteractorStyle
provide event-driven interface to the rendering window (defines trackball mode)
Definition: vtkInteractorStyle.h:134
vtkContextInteractorStyle::vtkContextInteractorStyle
vtkContextInteractorStyle()
vtkContextInteractorStyle::OnSceneModified
virtual void OnSceneModified()
Called when the scene is modified.
vtkContextInteractorStyle::OnLeftButtonUp
virtual void OnLeftButtonUp()
Called when the user releases the mouse left button.
vtkContextInteractorStyle::OnLeftButtonDown
virtual void OnLeftButtonDown()
Called when the user clicks the mouse left 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::OnRightButtonDown
virtual void OnRightButtonDown()
Called when the user clicks the mouse right button.
vtkContextInteractorStyle::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkWeakPointer< vtkContextScene >
vtkContextInteractorStyle::OnKeyPress
virtual void OnKeyPress()
Called when the user presses a key.