VTK  9.1.0
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 =========================================================================*/
112 #ifndef vtkBoxWidget2_h
113 #define vtkBoxWidget2_h
114 
115 #include "vtkAbstractWidget.h"
116 #include "vtkInteractionWidgetsModule.h" // For export macro
117 
119 class vtkHandleWidget;
120 
121 class VTKINTERACTIONWIDGETS_EXPORT vtkBoxWidget2 : public vtkAbstractWidget
122 {
123 public:
127  static vtkBoxWidget2* New();
128 
130 
134  void PrintSelf(ostream& os, vtkIndent indent) override;
136 
143  {
144  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
145  }
146 
148 
156  vtkSetMacro(TranslationEnabled, vtkTypeBool);
157  vtkGetMacro(TranslationEnabled, vtkTypeBool);
158  vtkBooleanMacro(TranslationEnabled, vtkTypeBool);
159  vtkSetMacro(ScalingEnabled, vtkTypeBool);
160  vtkGetMacro(ScalingEnabled, vtkTypeBool);
161  vtkBooleanMacro(ScalingEnabled, vtkTypeBool);
162  vtkSetMacro(RotationEnabled, vtkTypeBool);
163  vtkGetMacro(RotationEnabled, vtkTypeBool);
164  vtkBooleanMacro(RotationEnabled, vtkTypeBool);
165  vtkSetMacro(MoveFacesEnabled, vtkTypeBool);
166  vtkGetMacro(MoveFacesEnabled, vtkTypeBool);
167  vtkBooleanMacro(MoveFacesEnabled, vtkTypeBool);
169 
175 
180  void SetEnabled(int enabling) override;
181 
182 protected:
184  ~vtkBoxWidget2() override;
185 
186  // Manage the state of the widget
189  {
190  Start = 0,
191  Active
192  };
193 
194  // These methods handle events
204 
205  // Control whether scaling, rotation, and translation are supported
210 
212  static void ProcessKeyEvents(vtkObject*, unsigned long, void*, void*);
213 
214 private:
215  vtkBoxWidget2(const vtkBoxWidget2&) = delete;
216  void operator=(const vtkBoxWidget2&) = delete;
217 };
218 
219 #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:113
abstract base class for most VTK objects
Definition: vtkObject.h:73
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition: vtkABI.h:69