VTK  9.3.0
vtkBoxWidget2.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
96 #ifndef vtkBoxWidget2_h
97 #define vtkBoxWidget2_h
98 
99 #include "vtkAbstractWidget.h"
100 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
101 #include "vtkInteractionWidgetsModule.h" // For export macro
102 #include "vtkLegacy.h" // for VTK_LEGACY_REMOVE
103 
104 VTK_ABI_NAMESPACE_BEGIN
106 class vtkHandleWidget;
107 
108 class VTKINTERACTIONWIDGETS_EXPORT vtkBoxWidget2 : public vtkAbstractWidget
109 {
110 public:
114  static vtkBoxWidget2* New();
115 
117 
121  void PrintSelf(ostream& os, vtkIndent indent) override;
123 
130  {
131  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
132  }
133 
135 
143  vtkSetMacro(TranslationEnabled, vtkTypeBool);
144  vtkGetMacro(TranslationEnabled, vtkTypeBool);
145  vtkBooleanMacro(TranslationEnabled, vtkTypeBool);
146  vtkSetMacro(ScalingEnabled, vtkTypeBool);
147  vtkGetMacro(ScalingEnabled, vtkTypeBool);
148  vtkBooleanMacro(ScalingEnabled, vtkTypeBool);
149  vtkSetMacro(RotationEnabled, vtkTypeBool);
150  vtkGetMacro(RotationEnabled, vtkTypeBool);
151  vtkBooleanMacro(RotationEnabled, vtkTypeBool);
152  vtkSetMacro(MoveFacesEnabled, vtkTypeBool);
153  vtkGetMacro(MoveFacesEnabled, vtkTypeBool);
154  vtkBooleanMacro(MoveFacesEnabled, vtkTypeBool);
156 
162 
167  void SetEnabled(int enabling) override;
168 
169 protected:
171  ~vtkBoxWidget2() override;
172 
173  // Manage the state of the widget
176  {
177  Start = 0,
178  Active
179  };
180 #if !defined(VTK_LEGACY_REMOVE)
181  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
183 #endif
184 
185  // These methods handle events
195 
196  // Control whether scaling, rotation, and translation are supported
201 
203  static void ProcessKeyEvents(vtkObject*, unsigned long, void*, void*);
204 
205 private:
206  vtkBoxWidget2(const vtkBoxWidget2&) = delete;
207  void operator=(const vtkBoxWidget2&) = delete;
208 };
209 
210 VTK_ABI_NAMESPACE_END
211 #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:38
abstract base class for most VTK objects
Definition: vtkObject.h:61
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition: vtkABI.h:64
#define VTK_DEPRECATED_IN_9_2_0(reason)