VTK  9.3.0
vtkImplicitPlaneWidget2.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
86 #ifndef vtkImplicitPlaneWidget2_h
87 #define vtkImplicitPlaneWidget2_h
88 
89 #include "vtkAbstractWidget.h"
90 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
91 #include "vtkInteractionWidgetsModule.h" // For export macro
92 #include "vtkLegacy.h" // for VTK_LEGACY_REMOVE
93 
94 VTK_ABI_NAMESPACE_BEGIN
96 class vtkImplicitPlaneWidget2InteractionCallback;
97 
98 class VTKINTERACTIONWIDGETS_EXPORT vtkImplicitPlaneWidget2 : public vtkAbstractWidget
99 {
100  friend class vtkImplicitPlaneWidget2InteractionCallback;
101 
102 public:
107 
109 
113  void PrintSelf(ostream& os, vtkIndent indent) override;
115 
122 
123  // Description:
124  // Disable/Enable the widget if needed.
125  // Unobserved the camera if the widget is disabled.
126  void SetEnabled(int enabling) override;
127 
132  void SetLockNormalToCamera(int lock);
133 
138  {
139  return reinterpret_cast<vtkImplicitPlaneRepresentation*>(this->WidgetRep);
140  }
141 
146 
147 protected:
150 
151  // Manage the state of the widget
154  {
155  Start = 0,
156  Active
157  };
158 #if !defined(VTK_LEGACY_REMOVE)
159  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
161 #endif
162 
163  // These methods handle events
175 
180  int UpdateCursorShape(int interactionState);
181 
183 
186  vtkImplicitPlaneWidget2InteractionCallback* InteractionCallback;
189 
190 private:
192  void operator=(const vtkImplicitPlaneWidget2&) = delete;
193 };
194 
195 VTK_ABI_NAMESPACE_END
196 #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 *)
vtkImplicitPlaneWidget2InteractionCallback * InteractionCallback
Handle the interaction callback that may come from the representation.
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
Standard vtkObject methods.
static void SelectAction(vtkAbstractWidget *)
static vtkImplicitPlaneWidget2 * New()
Instantiate the object.
static void MovePlaneAction(vtkAbstractWidget *)
static void EndSelectAction(vtkAbstractWidget *)
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
void InvokeInteractionCallback()
Handle the interaction callback that may come from the representation.
static void ScaleAction(vtkAbstractWidget *)
a simple class to control print indentation
Definition: vtkIndent.h:29
#define VTK_DEPRECATED_IN_9_2_0(reason)