VTK  9.3.0
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
58 #ifndef vtkButtonWidget_h
59 #define vtkButtonWidget_h
60 
61 #include "vtkAbstractWidget.h"
62 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
63 #include "vtkInteractionWidgetsModule.h" // For export macro
64 #include "vtkLegacy.h" // for VTK_LEGACY_REMOVE
65 
66 VTK_ABI_NAMESPACE_BEGIN
68 
69 class VTKINTERACTIONWIDGETS_EXPORT vtkButtonWidget : public vtkAbstractWidget
70 {
71 public:
75  static vtkButtonWidget* New();
76 
78 
82  void PrintSelf(ostream& os, vtkIndent indent) override;
84 
91  {
92  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
93  }
94 
99  {
100  return reinterpret_cast<vtkButtonRepresentation*>(this->WidgetRep);
101  }
102 
107 
115  void SetEnabled(int) override;
116 
117 protected:
119  ~vtkButtonWidget() override = default;
120 
121  // These are the events that are handled
125 
126  // Manage the state of the widget
129  {
130  Start = 0,
132  Selecting
133  };
134 #if !defined(VTK_LEGACY_REMOVE)
135  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
137 #endif
138 
139 private:
140  vtkButtonWidget(const vtkButtonWidget&) = delete;
141  void operator=(const vtkButtonWidget&) = delete;
142 };
143 
144 VTK_ABI_NAMESPACE_END
145 #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
static void SelectAction(vtkAbstractWidget *)
void SetEnabled(int) override
The method for activating and deactivating this widget.
static void MoveAction(vtkAbstractWidget *)
void SetRepresentation(vtkButtonRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
static vtkButtonWidget * New()
Instantiate the class.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros.
vtkButtonRepresentation * GetSliderRepresentation()
Return the representation as a vtkButtonRepresentation.
static void EndSelectAction(vtkAbstractWidget *)
a simple class to control print indentation
Definition: vtkIndent.h:38
abstract class defines interface between the widget and widget representation classes
#define VTK_DEPRECATED_IN_9_2_0(reason)