VTK: Interaction/Widgets/vtkFinitePlaneWidget.h Source File

| VTK 9.3.1

vtkFinitePlaneWidget.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
63 #ifndef vtkFinitePlaneWidget_h
64 #define vtkFinitePlaneWidget_h
65
66 #include "vtkAbstractWidget.h"
67 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
68 #include "vtkInteractionWidgetsModule.h" // For export macro
69 #include "vtkLegacy.h" // for VTK_LEGACY_REMOVE
70
71 VTK_ABI_NAMESPACE_BEGIN
72 class vtkFinitePlaneRepresentation;
73 class vtkHandleWidget;
74
75 class VTKINTERACTIONWIDGETS_EXPORT vtkFinitePlaneWidget : public vtkAbstractWidget
76 {
77 public:
81 static vtkFinitePlaneWidget* New();
82
84
87 vtkTypeMacro(vtkFinitePlaneWidget, vtkAbstractWidget);
88 void PrintSelf(ostream& os, vtkIndent indent) override;
90
96 void SetRepresentation(vtkFinitePlaneRepresentation* r);
97
102 void CreateDefaultRepresentation() override;
103
104 protected:
105 vtkFinitePlaneWidget();
106 ~vtkFinitePlaneWidget() override;
107
108 int WidgetState;
109 enum WidgetStateType
110 {
111 Start = 0,
112 Active
113 };
114 #if !defined(VTK_LEGACY_REMOVE)
115 VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
116 typedef WidgetStateType _WidgetState;
117 #endif
118
119 // These methods handle events
120 static void SelectAction(vtkAbstractWidget*);
121 static void EndSelectAction(vtkAbstractWidget*);
122 static void MoveAction(vtkAbstractWidget*);
123
128 int UpdateCursorShape(int interactionState);
129
130 private:
131 vtkFinitePlaneWidget(const vtkFinitePlaneWidget&) = delete;
132 void operator=(const vtkFinitePlaneWidget&) = delete;
133 };
134
135 VTK_ABI_NAMESPACE_END
136 #endif
vtkAbstractWidget
define the API for widget / widget representation
Definition: vtkAbstractWidget.h:64
vtkFinitePlaneRepresentation
represent the vtkFinitePlaneWidget.
Definition: vtkFinitePlaneRepresentation.h:45
vtkFinitePlaneWidget
3D widget for manipulating a finite plane
Definition: vtkFinitePlaneWidget.h:76
vtkFinitePlaneWidget::New
static vtkFinitePlaneWidget * New()
Instantiate the object.
vtkFinitePlaneWidget::SelectAction
static void SelectAction(vtkAbstractWidget *)
vtkFinitePlaneWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Standard vtkObject methods.
vtkFinitePlaneWidget::SetRepresentation
void SetRepresentation(vtkFinitePlaneRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
vtkFinitePlaneWidget::CreateDefaultRepresentation
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
vtkFinitePlaneWidget::WidgetState
int WidgetState
Definition: vtkFinitePlaneWidget.h:108
vtkFinitePlaneWidget::WidgetStateType
WidgetStateType
Definition: vtkFinitePlaneWidget.h:110
vtkFinitePlaneWidget::MoveAction
static void MoveAction(vtkAbstractWidget *)
vtkFinitePlaneWidget::vtkFinitePlaneWidget
vtkFinitePlaneWidget()
vtkFinitePlaneWidget::~vtkFinitePlaneWidget
~vtkFinitePlaneWidget() override
vtkFinitePlaneWidget::UpdateCursorShape
int UpdateCursorShape(int interactionState)
Update the cursor shape based on the interaction state.
vtkFinitePlaneWidget::EndSelectAction
static void EndSelectAction(vtkAbstractWidget *)
vtkHandleWidget
a general widget for moving handles
Definition: vtkHandleWidget.h:70
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:38
vtkAbstractWidget.h
vtkDeprecation.h
VTK_DEPRECATED_IN_9_2_0
#define VTK_DEPRECATED_IN_9_2_0(reason)
Definition: vtkDeprecation.h:108