VTK  9.2.6
vtkInteractorObserver.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkInteractorObserver.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=========================================================================*/
47
48#ifndef vtkInteractorObserver_h
49#define vtkInteractorObserver_h
50
51#include "vtkObject.h"
52#include "vtkRenderingCoreModule.h" // For export macro
53
55class vtkAssemblyPath;
57class vtkRenderer;
61
62class VTKRENDERINGCORE_EXPORT vtkInteractorObserver : public vtkObject
63{
64public:
66 void PrintSelf(ostream& os, vtkIndent indent) override;
67
76 virtual void SetEnabled(int) {}
77 int GetEnabled() { return this->Enabled; }
78 void EnabledOn() { this->SetEnabled(1); }
79 void EnabledOff() { this->SetEnabled(0); }
80 void On() { this->SetEnabled(1); }
81 void Off() { this->SetEnabled(0); }
82
84
95
97
107 vtkSetClampMacro(Priority, float, 0.0f, 1.0f);
108 vtkGetMacro(Priority, float);
110
112
116 vtkBooleanMacro(PickingManaged, bool);
117 virtual void SetPickingManaged(bool managed);
118 vtkGetMacro(PickingManaged, bool);
120
122
132
134
141 vtkSetMacro(KeyPressActivationValue, char);
142 vtkGetMacro(KeyPressActivationValue, char);
144
146
154 vtkGetObjectMacro(DefaultRenderer, vtkRenderer);
157
159
170 vtkGetObjectMacro(CurrentRenderer, vtkRenderer);
173
177 virtual void OnChar();
178
180
185 vtkRenderer* ren, double x, double y, double z, double worldPt[4]);
187 vtkRenderer* ren, double x, double y, double z, double displayPt[3]);
189
191
201 void GrabFocus(vtkCommand* mouseEvents, vtkCommand* keypressEvents = nullptr);
204
205protected:
208
210
215 virtual void StartInteraction();
216 virtual void EndInteraction();
218
222 static void ProcessEvents(
223 vtkObject* object, unsigned long event, void* clientdata, void* calldata);
224
226
229 void ComputeDisplayToWorld(double x, double y, double z, double worldPt[4]);
230 void ComputeWorldToDisplay(double x, double y, double z, double displayPt[3]);
232
233 // The state of the widget, whether on or off (observing events or not)
235
236 // Used to process events
238 vtkCallbackCommand* KeyPressCallbackCommand; // listens to key activation
239
240 // Priority at which events are processed
241 float Priority;
242
243 // This variable controls whether the picking is managed by the Picking
244 // Manager process or not. True by default.
246
252 virtual void RegisterPickers();
253
258
264
269 vtkAssemblyPath* GetAssemblyPath(double X, double Y, double Z, vtkAbstractPropPicker* picker);
270
271 // Keypress activation controls
274
275 // Used to associate observers with the interactor
277
278 // Internal ivars for processing events
281
282 unsigned long CharObserverTag;
283 unsigned long DeleteObserverTag;
284
285 // The mediator used to request resources from the interactor.
287 int RequestCursorShape(int requestedShape);
288
289private:
291 void operator=(const vtkInteractorObserver&) = delete;
292};
293
294#endif
abstract API for pickers that can pick an instance of vtkProp
a list of nodes that form an assembly path
supports function callbacks
superclass for callback/observer methods
Definition vtkCommand.h:395
a simple class to control print indentation
Definition vtkIndent.h:34
virtual void EndInteraction()
Utility routines used to start and end interaction.
void UnRegisterPickers()
Unregister internal pickers from the Picking Manager.
virtual void StartInteraction()
Utility routines used to start and end interaction.
static void ProcessEvents(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
Handles the char widget activation event.
~vtkInteractorObserver() override
vtkCallbackCommand * EventCallbackCommand
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkPickingManager * GetPickingManager()
Return the picking manager associated on the context on which the observer currently belong.
void ComputeWorldToDisplay(double x, double y, double z, double displayPt[3])
Helper method for subclasses.
static void ComputeDisplayToWorld(vtkRenderer *ren, double x, double y, double z, double worldPt[4])
Convenience methods for outside classes.
virtual void RegisterPickers()
Register internal Pickers in the Picking Manager.
vtkCallbackCommand * KeyPressCallbackCommand
void GrabFocus(vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
These methods enable an interactor observer to exclusively grab all events invoked by its associated ...
virtual void OnChar()
Sets up the keypress-i event.
virtual void SetInteractor(vtkRenderWindowInteractor *iren)
This method is used to associate the widget with the render window interactor.
void ComputeDisplayToWorld(double x, double y, double z, double worldPt[4])
Helper method for subclasses.
void ReleaseFocus()
These methods enable an interactor observer to exclusively grab all events invoked by its associated ...
virtual void SetCurrentRenderer(vtkRenderer *)
Set/Get the current renderer.
vtkObserverMediator * ObserverMediator
int RequestCursorShape(int requestedShape)
virtual void SetDefaultRenderer(vtkRenderer *)
Set/Get the default renderer to use when activating the interactor observer.
virtual void SetEnabled(int)
Methods for turning the interactor observer on and off, and determining its state.
static void ComputeWorldToDisplay(vtkRenderer *ren, double x, double y, double z, double displayPt[3])
Convenience methods for outside classes.
virtual void SetPickingManaged(bool managed)
Enable/Disable the use of a manager to process the picking.
vtkRenderWindowInteractor * Interactor
vtkAssemblyPath * GetAssemblyPath(double X, double Y, double Z, vtkAbstractPropPicker *picker)
Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the...
manage contention for cursors and other resources
Class defines API to manage the picking process.
platform-independent render window interaction including picking and frame rate control.
abstract specification for renderers
Definition vtkRenderer.h:67
int vtkTypeBool
Definition vtkABI.h:69