VTK  9.0.1
vtkImplicitPlaneWidget2.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImplicitPlaneWidget2.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 =========================================================================*/
95 #ifndef vtkImplicitPlaneWidget2_h
96 #define vtkImplicitPlaneWidget2_h
97 
98 #include "vtkAbstractWidget.h"
99 #include "vtkInteractionWidgetsModule.h" // For export macro
100 
102 class vtkInteractionCallback;
103 
104 class VTKINTERACTIONWIDGETS_EXPORT vtkImplicitPlaneWidget2 : public vtkAbstractWidget
105 {
106  friend class vtkInteractionCallback;
107 
108 public:
112  static vtkImplicitPlaneWidget2* New();
113 
115 
119  void PrintSelf(ostream& os, vtkIndent indent) override;
121 
127  void SetRepresentation(vtkImplicitPlaneRepresentation* rep);
128 
129  // Description:
130  // Disable/Enable the widget if needed.
131  // Unobserved the camera if the widget is disabled.
132  void SetEnabled(int enabling) override;
133 
138  void SetLockNormalToCamera(int lock);
139 
144  {
145  return reinterpret_cast<vtkImplicitPlaneRepresentation*>(this->WidgetRep);
146  }
147 
151  void CreateDefaultRepresentation() override;
152 
153 protected:
155  ~vtkImplicitPlaneWidget2() override;
156 
157  // Manage the state of the widget
160  {
161  Start = 0,
162  Active
163  };
164 
165  // These methods handle events
166  static void SelectAction(vtkAbstractWidget*);
167  static void TranslateAction(vtkAbstractWidget*);
168  static void ScaleAction(vtkAbstractWidget*);
169  static void EndSelectAction(vtkAbstractWidget*);
170  static void MoveAction(vtkAbstractWidget*);
171  static void MovePlaneAction(vtkAbstractWidget*);
172  static void SelectAction3D(vtkAbstractWidget*);
173  static void EndSelectAction3D(vtkAbstractWidget*);
174  static void MoveAction3D(vtkAbstractWidget*);
175  static void TranslationAxisLock(vtkAbstractWidget*);
176  static void TranslationAxisUnLock(vtkAbstractWidget*);
177 
182  int UpdateCursorShape(int interactionState);
183 
185 
188  vtkInteractionCallback* InteractionCallback;
189  void InvokeInteractionCallback();
191 
192 private:
194  void operator=(const vtkImplicitPlaneWidget2&) = delete;
195 };
196 
197 #endif
3D widget for manipulating an infinite plane
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros implementing standard VTK methods.
virtual void CreateDefaultRepresentation()=0
Create the default widget representation if one is not set.
vtkWidgetRepresentation * WidgetRep
vtkImplicitPlaneRepresentation * GetImplicitPlaneRepresentation()
Return the representation as a vtkImplicitPlaneRepresentation.
a simple class to control print indentation
Definition: vtkIndent.h:33
a class defining the representation for a vtkImplicitPlaneWidget2
vtkInteractionCallback * InteractionCallback
Handle the interaction callback that may come from the representation.
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...