VTK  9.2.20220807
vtkBoxWidget2.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkBoxWidget2.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 =========================================================================*/
118 #ifndef vtkBoxWidget2_h
119 #define vtkBoxWidget2_h
120 
121 #include "vtkAbstractWidget.h"
122 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
123 #include "vtkInteractionWidgetsModule.h" // For export macro
124 
126 class vtkHandleWidget;
127 
128 class VTKINTERACTIONWIDGETS_EXPORT vtkBoxWidget2 : public vtkAbstractWidget
129 {
130 public:
134  static vtkBoxWidget2* New();
135 
137 
141  void PrintSelf(ostream& os, vtkIndent indent) override;
143 
150  {
151  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
152  }
153 
155 
163  vtkSetMacro(TranslationEnabled, vtkTypeBool);
164  vtkGetMacro(TranslationEnabled, vtkTypeBool);
165  vtkBooleanMacro(TranslationEnabled, vtkTypeBool);
166  vtkSetMacro(ScalingEnabled, vtkTypeBool);
167  vtkGetMacro(ScalingEnabled, vtkTypeBool);
168  vtkBooleanMacro(ScalingEnabled, vtkTypeBool);
169  vtkSetMacro(RotationEnabled, vtkTypeBool);
170  vtkGetMacro(RotationEnabled, vtkTypeBool);
171  vtkBooleanMacro(RotationEnabled, vtkTypeBool);
172  vtkSetMacro(MoveFacesEnabled, vtkTypeBool);
173  vtkGetMacro(MoveFacesEnabled, vtkTypeBool);
174  vtkBooleanMacro(MoveFacesEnabled, vtkTypeBool);
176 
182 
187  void SetEnabled(int enabling) override;
188 
189 protected:
191  ~vtkBoxWidget2() override;
192 
193  // Manage the state of the widget
196  {
197  Start = 0,
198  Active
199  };
200 #if !defined(VTK_LEGACY_REMOVE)
201  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
203 #endif
204 
205  // These methods handle events
215 
216  // Control whether scaling, rotation, and translation are supported
221 
223  static void ProcessKeyEvents(vtkObject*, unsigned long, void*, void*);
224 
225 private:
226  vtkBoxWidget2(const vtkBoxWidget2&) = delete;
227  void operator=(const vtkBoxWidget2&) = delete;
228 };
229 
230 #endif
define the API for widget / widget representation
a class defining the representation for the vtkBoxWidget2
3D widget for manipulating a box
static vtkBoxWidget2 * New()
Instantiate the object.
vtkTypeBool MoveFacesEnabled
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
void SetRepresentation(vtkBoxRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
static void SelectAction3D(vtkAbstractWidget *)
void SetEnabled(int enabling) override
Override superclasses' SetEnabled() method because the line widget must enable its internal handle wi...
static void ScaleAction(vtkAbstractWidget *)
static void ProcessKeyEvents(vtkObject *, unsigned long, void *, void *)
~vtkBoxWidget2() override
static void SelectAction(vtkAbstractWidget *)
static void EndSelectAction(vtkAbstractWidget *)
static void EndSelectAction3D(vtkAbstractWidget *)
static void TranslateAction(vtkAbstractWidget *)
vtkTypeBool TranslationEnabled
vtkTypeBool RotationEnabled
static void MoveAction3D(vtkAbstractWidget *)
static void MoveAction(vtkAbstractWidget *)
vtkTypeBool ScalingEnabled
void PrintSelf(ostream &os, vtkIndent indent) override
Standard class methods for type information and printing.
vtkCallbackCommand * KeyEventCallbackCommand
static void StepAction3D(vtkAbstractWidget *)
supports function callbacks
a general widget for moving handles
a simple class to control print indentation
Definition: vtkIndent.h:119
abstract base class for most VTK objects
Definition: vtkObject.h:82
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_DEPRECATED_IN_9_2_0(reason)