VTK  9.4.20250204
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
78#ifndef vtkButtonWidget_h
79#define vtkButtonWidget_h
80
81#include "vtkAbstractWidget.h"
82#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_4_0
83#include "vtkInteractionWidgetsModule.h" // For export macro
84#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
85
86VTK_ABI_NAMESPACE_BEGIN
88
89class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkButtonWidget : public vtkAbstractWidget
90{
91public:
96
98
102 void PrintSelf(ostream& os, vtkIndent indent) override;
104
111 {
112 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
113 }
114
119 {
120 return reinterpret_cast<vtkButtonRepresentation*>(this->WidgetRep);
121 }
122
126 VTK_DEPRECATED_IN_9_4_0("Please use GetButtonRepresentation() instead.")
127 vtkButtonRepresentation* GetSliderRepresentation() { return this->GetButtonRepresentation(); }
128
133
141 void SetEnabled(int) override;
142
143protected:
145 ~vtkButtonWidget() override = default;
146
147 // These are the events that are handled
151
152 // Manage the state of the widget
155 {
156 Start = 0,
158 Selecting
159 };
160
161private:
162 vtkButtonWidget(const vtkButtonWidget&) = delete;
163 void operator=(const vtkButtonWidget&) = delete;
164};
165
166VTK_ABI_NAMESPACE_END
167#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