VTK
vtkAbstractWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAbstractWidget.h,v
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 =========================================================================*/
52 #ifndef vtkAbstractWidget_h
53 #define vtkAbstractWidget_h
54 
55 #include "vtkInteractionWidgetsModule.h" // For export macro
56 #include "vtkInteractorObserver.h"
57 
61 
62 
63 class VTKINTERACTIONWIDGETS_EXPORT vtkAbstractWidget : public vtkInteractorObserver
64 {
65 public:
67 
71  void PrintSelf(ostream& os, vtkIndent indent) override;
73 
81  void SetEnabled(int) override;
82 
84 
90  vtkSetClampMacro(ProcessEvents, vtkTypeBool, 0, 1);
91  vtkGetMacro(ProcessEvents, vtkTypeBool);
92  vtkBooleanMacro(ProcessEvents, vtkTypeBool);
94 
100  {return this->EventTranslator;}
101 
108  virtual void CreateDefaultRepresentation() = 0;
109 
116  void Render();
117 
124  void SetParent(vtkAbstractWidget *parent) {this->Parent = parent;}
125  vtkGetObjectMacro(Parent,vtkAbstractWidget);
126 
128 
135  {
136  this->CreateDefaultRepresentation();
137  return this->WidgetRep;
138  }
140 
142 
149  vtkSetMacro(ManagesCursor,vtkTypeBool);
150  vtkGetMacro(ManagesCursor,vtkTypeBool);
151  vtkBooleanMacro(ManagesCursor,vtkTypeBool);
153 
159  void SetPriority( float ) override;
160 
161 protected:
163  ~vtkAbstractWidget() override;
164 
165  // Handles the events; centralized here for all widgets.
166  static void ProcessEventsHandler(vtkObject* object, unsigned long event,
167  void* clientdata, void* calldata);
168 
169  // The representation for the widget. This is typically called by the
170  // SetRepresentation() methods particular to each widget (i.e. subclasses
171  // of this class). This method does the actual work; the SetRepresentation()
172  // methods constrain the type that can be set.
175 
176  // helper methods for cursor management
178  virtual void SetCursor(int vtkNotUsed(state)) {}
179 
180  // For translating and invoking events
183 
184  // The parent, if any, for this widget
186 
187  // Call data which can be retrieved by the widget. This data is set
188  // by ProcessEvents() if call data is provided during a callback
189  // sequence.
190  void *CallData;
191 
192  // Flag indicating if the widget should handle interaction events.
193  // On by default.
195 
196 private:
197  vtkAbstractWidget(const vtkAbstractWidget&) = delete;
198  void operator=(const vtkAbstractWidget&) = delete;
199 };
200 
201 #endif
vtkAbstractWidget::SetCursor
virtual void SetCursor(int vtkNotUsed(state))
Definition: vtkAbstractWidget.h:178
vtkAbstractWidget::GetRepresentation
vtkWidgetRepresentation * GetRepresentation()
Return an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Definition: vtkAbstractWidget.h:134
vtkAbstractWidget::GetEventTranslator
vtkWidgetEventTranslator * GetEventTranslator()
Get the event translator.
Definition: vtkAbstractWidget.h:99
vtkAbstractWidget::EventTranslator
vtkWidgetEventTranslator * EventTranslator
Definition: vtkAbstractWidget.h:181
vtkAbstractWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAbstractWidget::ProcessEventsHandler
static void ProcessEventsHandler(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition: vtkWidgetRepresentation.h:61
vtkAbstractWidget::WidgetRep
vtkWidgetRepresentation * WidgetRep
Definition: vtkAbstractWidget.h:174
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkAbstractWidget::CallbackMapper
vtkWidgetCallbackMapper * CallbackMapper
Definition: vtkAbstractWidget.h:182
vtkWidgetCallbackMapper
map widget events into callbacks
Definition: vtkWidgetCallbackMapper.h:42
vtkAbstractWidget::Render
void Render()
This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInter...
vtkInteractorObserver
an abstract superclass for classes observing events invoked by vtkRenderWindowInteractor
Definition: vtkInteractorObserver.h:60
vtkAbstractWidget::ManagesCursor
vtkTypeBool ManagesCursor
Definition: vtkAbstractWidget.h:177
vtkAbstractWidget::~vtkAbstractWidget
~vtkAbstractWidget() override
vtkAbstractWidget
define the API for widget / widget representation
Definition: vtkAbstractWidget.h:64
vtkAbstractWidget::CreateDefaultRepresentation
virtual void CreateDefaultRepresentation()=0
Create the default widget representation if one is not set.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkAbstractWidget::SetPriority
void SetPriority(float) override
Override the superclass method.
vtkAbstractWidget::vtkAbstractWidget
vtkAbstractWidget()
vtkAbstractWidget::CallData
void * CallData
Definition: vtkAbstractWidget.h:190
vtkAbstractWidget::SetEnabled
void SetEnabled(int) override
Methods for activating this widget.
vtkInteractorObserver.h
vtkAbstractWidget::Parent
vtkAbstractWidget * Parent
Definition: vtkAbstractWidget.h:185
vtkWidgetEventTranslator
map VTK events into widget events
Definition: vtkWidgetEventTranslator.h:52
vtkAbstractWidget::ProcessEvents
vtkTypeBool ProcessEvents
Definition: vtkAbstractWidget.h:194
vtkAbstractWidget::SetWidgetRepresentation
void SetWidgetRepresentation(vtkWidgetRepresentation *r)
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkAbstractWidget::SetParent
void SetParent(vtkAbstractWidget *parent)
Specifying a parent to this widget is used when creating composite widgets.
Definition: vtkAbstractWidget.h:124