VTK  9.1.0
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=========================================================================*/
117#ifndef vtkImplicitPlaneWidget2_h
118#define vtkImplicitPlaneWidget2_h
119
120#include "vtkAbstractWidget.h"
121#include "vtkInteractionWidgetsModule.h" // For export macro
122
124class vtkInteractionCallback;
125
126class VTKINTERACTIONWIDGETS_EXPORT vtkImplicitPlaneWidget2 : public vtkAbstractWidget
127{
128 friend class vtkInteractionCallback;
129
130public:
135
137
141 void PrintSelf(ostream& os, vtkIndent indent) override;
143
150
151 // Description:
152 // Disable/Enable the widget if needed.
153 // Unobserved the camera if the widget is disabled.
154 void SetEnabled(int enabling) override;
155
160 void SetLockNormalToCamera(int lock);
161
166 {
167 return reinterpret_cast<vtkImplicitPlaneRepresentation*>(this->WidgetRep);
168 }
169
174
175protected:
178
179 // Manage the state of the widget
182 {
183 Start = 0,
184 Active
185 };
186
187 // These methods handle events
199
204 int UpdateCursorShape(int interactionState);
205
207
210 vtkInteractionCallback* InteractionCallback;
213
214private:
216 void operator=(const vtkImplicitPlaneWidget2&) = delete;
217};
218
219#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
Standard vtkObject methods.
vtkImplicitPlaneRepresentation * GetImplicitPlaneRepresentation()
Return the representation as a vtkImplicitPlaneRepresentation.
static void SelectAction(vtkAbstractWidget *)
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.
~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:113