VTK  9.5.2
vtkButtonWidget.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
88#ifndef vtkButtonWidget_h
89#define vtkButtonWidget_h
90
91#include "vtkAbstractWidget.h"
92#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_4_0
93#include "vtkInteractionWidgetsModule.h" // For export macro
94#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
95
96VTK_ABI_NAMESPACE_BEGIN
98
99class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkButtonWidget : public vtkAbstractWidget
100{
101public:
106
108
112 void PrintSelf(ostream& os, vtkIndent indent) override;
114
121 {
122 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
123 }
124
129 {
130 return reinterpret_cast<vtkButtonRepresentation*>(this->WidgetRep);
131 }
132
136 VTK_DEPRECATED_IN_9_4_0("Please use GetButtonRepresentation() instead.")
137 vtkButtonRepresentation* GetSliderRepresentation() { return this->GetButtonRepresentation(); }
138
143
151 void SetEnabled(int) override;
152
153protected:
155 ~vtkButtonWidget() override = default;
156
157 // These are the events that are handled
161
162 // Manage the state of the widget
165 {
166 Start = 0,
168 Selecting
169 };
170
171private:
172 vtkButtonWidget(const vtkButtonWidget&) = delete;
173 void operator=(const vtkButtonWidget&) = delete;
174};
175
176VTK_ABI_NAMESPACE_END
177#endif
define the API for widget / widget representation
vtkWidgetRepresentation * WidgetRep
abstract class defines the representation for a vtkButtonWidget
activate an n-state button
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
~vtkButtonWidget() override=default
vtkButtonRepresentation * GetButtonRepresentation()
Return the representation as a vtkButtonRepresentation.
static void SelectAction(vtkAbstractWidget *)
void SetEnabled(int) override
The method for activating and deactivating this widget.
static vtkButtonWidget * New()
Instantiate the class.
static void MoveAction(vtkAbstractWidget *)
void SetRepresentation(vtkButtonRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros.
static void EndSelectAction(vtkAbstractWidget *)
a simple class to control print indentation
Definition vtkIndent.h:108
abstract class defines interface between the widget and widget representation classes
#define VTK_DEPRECATED_IN_9_4_0(reason)
#define VTK_MARSHALAUTO