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
83#ifndef vtkImplicitPlaneWidget2_h
84#define vtkImplicitPlaneWidget2_h
85
86#include "vtkAbstractWidget.h"
87#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
88#include "vtkInteractionWidgetsModule.h" // For export macro
89#include "vtkLegacy.h" // for VTK_LEGACY_REMOVE
90
91VTK_ABI_NAMESPACE_BEGIN
93class vtkImplicitPlaneWidget2InteractionCallback;
94
95class VTKINTERACTIONWIDGETS_EXPORT vtkImplicitPlaneWidget2 : public vtkAbstractWidget
96{
97 friend class vtkImplicitPlaneWidget2InteractionCallback;
98
99public:
104
106
110 void PrintSelf(ostream& os, vtkIndent indent) override;
112
119
120 // Description:
121 // Disable/Enable the widget if needed.
122 // Unobserved the camera if the widget is disabled.
123 void SetEnabled(int enabling) override;
124
129 void SetLockNormalToCamera(int lock);
130
135 {
136 return reinterpret_cast<vtkImplicitPlaneRepresentation*>(this->WidgetRep);
137 }
138
143
144protected:
147
148 // Manage the state of the widget
151 {
152 Start = 0,
153 Active
154 };
155#if !defined(VTK_LEGACY_REMOVE)
156 VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
158#endif
159
160 // These methods handle events
172
177 int UpdateCursorShape(int interactionState);
178
180
183 vtkImplicitPlaneWidget2InteractionCallback* InteractionCallback;
186
187private:
189 void operator=(const vtkImplicitPlaneWidget2&) = delete;
190};
191
192VTK_ABI_NAMESPACE_END
193#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.
vtkImplicitPlaneRepresentation * GetImplicitPlaneRepresentation()
Return the representation as a vtkImplicitPlaneRepresentation.
static void SelectAction(vtkAbstractWidget *)
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.
~vtkImplicitPlaneWidget2() override
void InvokeInteractionCallback()
Handle the interaction callback that may come from the representation.
static vtkImplicitPlaneWidget2 * New()
Instantiate the object.
static void ScaleAction(vtkAbstractWidget *)
a simple class to control print indentation
Definition vtkIndent.h:29
#define VTK_DEPRECATED_IN_9_2_0(reason)