VTK  9.2.6
vtkButtonWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkButtonWidget.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 =========================================================================*/
90 #ifndef vtkButtonWidget_h
91 #define vtkButtonWidget_h
92 
93 #include "vtkAbstractWidget.h"
94 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
95 #include "vtkInteractionWidgetsModule.h" // For export macro
96 
98 
99 class VTKINTERACTIONWIDGETS_EXPORT vtkButtonWidget : public vtkAbstractWidget
100 {
101 public:
105  static vtkButtonWidget* New();
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 
137 
145  void SetEnabled(int) override;
146 
147 protected:
149  ~vtkButtonWidget() override = default;
150 
151  // These are the events that are handled
155 
156  // Manage the state of the widget
159  {
160  Start = 0,
162  Selecting
163  };
164 #if !defined(VTK_LEGACY_REMOVE)
165  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
167 #endif
168 
169 private:
170  vtkButtonWidget(const vtkButtonWidget&) = delete;
171  void operator=(const vtkButtonWidget&) = delete;
172 };
173 
174 #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:119
abstract class defines interface between the widget and widget representation classes
#define VTK_DEPRECATED_IN_9_2_0(reason)