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 =========================================================================*/
92 #ifndef vtkImplicitPlaneWidget2_h
93 #define vtkImplicitPlaneWidget2_h
94 
95 #include "vtkAbstractWidget.h"
96 #include "vtkInteractionWidgetsModule.h" // For export macro
97 
99 class vtkInteractionCallback;
100 
101 class VTKINTERACTIONWIDGETS_EXPORT vtkImplicitPlaneWidget2 : public vtkAbstractWidget
102 {
103  friend class vtkInteractionCallback;
104 
105 public:
110 
112 
116  void PrintSelf(ostream& os, vtkIndent indent) override;
118 
125 
126  // Description:
127  // Disable/Enable the widget if needed.
128  // Unobserved the camera if the widget is disabled.
129  void SetEnabled(int enabling) override;
130 
135  void SetLockNormalToCamera(int lock);
136 
141  {
142  return reinterpret_cast<vtkImplicitPlaneRepresentation*>(this->WidgetRep);
143  }
144 
149 
150 protected:
153 
154  // Manage the state of the widget
157  {
158  Start = 0,
159  Active
160  };
161 
162  // These methods handle events
174 
179  int UpdateCursorShape(int interactionState);
180 
182 
185  vtkInteractionCallback* InteractionCallback;
188 
189 private:
191  void operator=(const vtkImplicitPlaneWidget2&) = delete;
192 };
193 
194 #endif
define the API for widget / widget representation
vtkWidgetRepresentation * WidgetRep
a class defining the representation for a vtkImplicitPlaneWidget2
3D widget for manipulating an infinite plane
int UpdateCursorShape(int interactionState)
Update the cursor shape based on the interaction state.
static void TranslationAxisLock(vtkAbstractWidget *)
void SetEnabled(int enabling) override
Methods for activating this widget.
static void MoveAction3D(vtkAbstractWidget *)
static void TranslationAxisUnLock(vtkAbstractWidget *)
static void TranslateAction(vtkAbstractWidget *)
void SetLockNormalToCamera(int lock)
Observe/Unobserve the camera if the widget is locked/unlocked to update the vtkImplicitePlaneRepresen...
static void MoveAction(vtkAbstractWidget *)
static void EndSelectAction3D(vtkAbstractWidget *)
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
static void SelectAction3D(vtkAbstractWidget *)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static void SelectAction(vtkAbstractWidget *)
static vtkImplicitPlaneWidget2 * New()
Instantiate the object.
static void MovePlaneAction(vtkAbstractWidget *)
static void EndSelectAction(vtkAbstractWidget *)
vtkInteractionCallback * InteractionCallback
Handle the interaction callback that may come from the representation.
void SetRepresentation(vtkImplicitPlaneRepresentation *rep)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
vtkImplicitPlaneRepresentation * GetImplicitPlaneRepresentation()
Return the representation as a vtkImplicitPlaneRepresentation.
~vtkImplicitPlaneWidget2() override
static void ScaleAction(vtkAbstractWidget *)
a simple class to control print indentation
Definition: vtkIndent.h:34