VTK  9.2.5
vtkWidgetEventTranslator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkWidgetEventTranslator.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 =========================================================================*/
125 #ifndef vtkWidgetEventTranslator_h
126 #define vtkWidgetEventTranslator_h
127 
128 #include "vtkInteractionWidgetsModule.h" // For export macro
129 #include "vtkObject.h"
130 
131 // Support PIMPL encapsulation of internal STL map
132 class vtkEventMap;
134 class vtkCallbackCommand;
135 class vtkEvent;
136 class vtkAbstractWidget;
137 class vtkEventData;
138 
139 // This is a lightweight class that should be used internally by the widgets
140 class VTKINTERACTIONWIDGETS_EXPORT vtkWidgetEventTranslator : public vtkObject
141 {
142 public:
147 
149 
153  void PrintSelf(ostream& os, vtkIndent indent) override;
155 
157 
162  void SetTranslation(unsigned long VTKEvent, unsigned long widgetEvent);
163  void SetTranslation(const char* VTKEvent, const char* widgetEvent);
164  void SetTranslation(unsigned long VTKEvent, int modifier, char keyCode, int repeatCount,
165  const char* keySym, unsigned long widgetEvent);
166  void SetTranslation(vtkEvent* VTKevent, unsigned long widgetEvent);
167  void SetTranslation(unsigned long VTKEvent, vtkEventData* edata, unsigned long widgetEvent);
169 
171 
175  unsigned long GetTranslation(unsigned long VTKEvent);
176  const char* GetTranslation(const char* VTKEvent);
177  unsigned long GetTranslation(
178  unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, const char* keySym);
179  unsigned long GetTranslation(unsigned long VTKEvent, vtkEventData* edata);
180  unsigned long GetTranslation(vtkEvent* VTKEvent);
182 
184 
189  unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, const char* keySym);
192  int RemoveTranslation(unsigned long VTKEvent);
193  int RemoveTranslation(const char* VTKEvent);
195 
200  void ClearEvents();
201 
203 
209 
210 protected:
211  // Constructors/destructors made public for widgets to use
214 
215  // Map VTK events to widget events
216  vtkEventMap* EventMap;
217 
218  // Used for performance reasons to avoid object construction/deletion
220 
221 private:
223  void operator=(const vtkWidgetEventTranslator&) = delete;
224 };
225 
226 #endif /* vtkWidgetEventTranslator_h */
define the API for widget / widget representation
supports function callbacks
a complete specification of a VTK event including all modifiers
Definition: vtkEvent.h:35
a simple class to control print indentation
Definition: vtkIndent.h:119
abstract base class for most VTK objects
Definition: vtkObject.h:82
platform-independent render window interaction including picking and frame rate control.
map VTK events into widget events
void AddEventsToInteractor(vtkRenderWindowInteractor *, vtkCallbackCommand *, float priority)
Add the events in the current translation table to the interactor.
int RemoveTranslation(unsigned long VTKEvent)
Remove translations for a binding.
unsigned long GetTranslation(unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, const char *keySym)
Translate a VTK event into a widget event.
void SetTranslation(const char *VTKEvent, const char *widgetEvent)
Use these methods to create the translation from a VTK event to a widget event.
void SetTranslation(unsigned long VTKEvent, vtkEventData *edata, unsigned long widgetEvent)
Use these methods to create the translation from a VTK event to a widget event.
void ClearEvents()
Clear all events from the translator (i.e., no events will be translated).
void AddEventsToParent(vtkAbstractWidget *, vtkCallbackCommand *, float priority)
Add the events in the current translation table to the interactor.
static vtkWidgetEventTranslator * New()
Instantiate the object.
const char * GetTranslation(const char *VTKEvent)
Translate a VTK event into a widget event.
void SetTranslation(unsigned long VTKEvent, unsigned long widgetEvent)
Use these methods to create the translation from a VTK event to a widget event.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros.
int RemoveTranslation(unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, const char *keySym)
Remove translations for a binding.
int RemoveTranslation(const char *VTKEvent)
Remove translations for a binding.
unsigned long GetTranslation(vtkEvent *VTKEvent)
Translate a VTK event into a widget event.
void SetTranslation(vtkEvent *VTKevent, unsigned long widgetEvent)
Use these methods to create the translation from a VTK event to a widget event.
void SetTranslation(unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, const char *keySym, unsigned long widgetEvent)
Use these methods to create the translation from a VTK event to a widget event.
unsigned long GetTranslation(unsigned long VTKEvent)
Translate a VTK event into a widget event.
int RemoveTranslation(vtkEvent *e)
Remove translations for a binding.
unsigned long GetTranslation(unsigned long VTKEvent, vtkEventData *edata)
Translate a VTK event into a widget event.
~vtkWidgetEventTranslator() override
int RemoveTranslation(vtkEventData *e)
Remove translations for a binding.
@ priority
Definition: vtkX3D.h:456