VTK  9.4.20250114
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
108#ifndef vtkImplicitPlaneWidget2_h
109#define vtkImplicitPlaneWidget2_h
110
111#include "vtkAbstractWidget.h"
112#include "vtkInteractionWidgetsModule.h" // For export macro
113#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
114
115VTK_ABI_NAMESPACE_BEGIN
117class vtkImplicitPlaneWidget2InteractionCallback;
118
119class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkImplicitPlaneWidget2
120 : public vtkAbstractWidget
121{
122 friend class vtkImplicitPlaneWidget2InteractionCallback;
123
124public:
129
131
135 void PrintSelf(ostream& os, vtkIndent indent) override;
137
144
145 // Description:
146 // Disable/Enable the widget if needed.
147 // Unobserved the camera if the widget is disabled.
148 void SetEnabled(int enabling) override;
149
154 void SetLockNormalToCamera(int lock);
155
160 {
161 return reinterpret_cast<vtkImplicitPlaneRepresentation*>(this->WidgetRep);
162 }
163
168
169protected:
172
173 // Manage the state of the widget
176 {
177 Start = 0,
178 Active
179 };
180
181 // These methods handle events
193
198 int UpdateCursorShape(int interactionState);
199
201
204 vtkImplicitPlaneWidget2InteractionCallback* InteractionCallback;
207
208private:
210 void operator=(const vtkImplicitPlaneWidget2&) = delete;
211};
212
213VTK_ABI_NAMESPACE_END
214#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:108
#define VTK_MARSHALAUTO