VTK  9.2.6
vtkSphereWidget2.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSphereWidget2.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 =========================================================================*/
93 #ifndef vtkSphereWidget2_h
94 #define vtkSphereWidget2_h
95 
96 #include "vtkAbstractWidget.h"
97 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
98 #include "vtkInteractionWidgetsModule.h" // For export macro
99 
101 class vtkHandleWidget;
102 
103 class VTKINTERACTIONWIDGETS_EXPORT vtkSphereWidget2 : public vtkAbstractWidget
104 {
105 public:
109  static vtkSphereWidget2* New();
110 
112 
116  void PrintSelf(ostream& os, vtkIndent indent) override;
118 
125  {
126  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
127  }
128 
130 
134  vtkSetMacro(TranslationEnabled, vtkTypeBool);
135  vtkGetMacro(TranslationEnabled, vtkTypeBool);
136  vtkBooleanMacro(TranslationEnabled, vtkTypeBool);
137  vtkSetMacro(ScalingEnabled, vtkTypeBool);
138  vtkGetMacro(ScalingEnabled, vtkTypeBool);
139  vtkBooleanMacro(ScalingEnabled, vtkTypeBool);
141 
146  void CreateDefaultRepresentation() override;
147 
152  void SetEnabled(int enabling) override;
153 
154 protected:
156  ~vtkSphereWidget2() override;
157 
158  // Manage the state of the widget
161  {
162  Start = 0,
163  Active
164  };
165 #if !defined(VTK_LEGACY_REMOVE)
166  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
168 #endif
169 
170  // These methods handle events
171  static void SelectAction(vtkAbstractWidget*);
172  static void EndSelectAction(vtkAbstractWidget*);
173  static void TranslateAction(vtkAbstractWidget*);
174  static void ScaleAction(vtkAbstractWidget*);
175  static void MoveAction(vtkAbstractWidget*);
176 
177  // Control whether scaling and translation are supported
180 
182  static void ProcessKeyEvents(vtkObject*, unsigned long, void*, void*);
183 
184 private:
185  vtkSphereWidget2(const vtkSphereWidget2&) = delete;
186  void operator=(const vtkSphereWidget2&) = delete;
187 };
188 
189 #endif
3D widget for manipulating a point on a sphere
vtkTypeBool TranslationEnabled
abstract base class for most VTK objects
Definition: vtkObject.h:62
vtkCallbackCommand * KeyEventCallbackCommand
#define VTK_DEPRECATED_IN_9_2_0(reason)
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros implementing standard VTK methods.
a general widget for moving handles
void SetRepresentation(vtkSphereRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene...
virtual void CreateDefaultRepresentation()=0
Create the default widget representation if one is not set.
int vtkTypeBool
Definition: vtkABI.h:69
supports function callbacks
a simple class to control print indentation
Definition: vtkIndent.h:39
define the API for widget / widget representation
void SetEnabled(int) override
Methods for activating this widget.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
a class defining the representation for the vtkSphereWidget2
vtkTypeBool ScalingEnabled