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 =========================================================================*/
61 #ifndef vtkButtonWidget_h
62 #define vtkButtonWidget_h
63 
64 #include "vtkAbstractWidget.h"
65 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
66 #include "vtkInteractionWidgetsModule.h" // For export macro
67 
69 
70 class VTKINTERACTIONWIDGETS_EXPORT vtkButtonWidget : public vtkAbstractWidget
71 {
72 public:
76  static vtkButtonWidget* New();
77 
79 
83  void PrintSelf(ostream& os, vtkIndent indent) override;
85 
92  {
93  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
94  }
95 
100  {
101  return reinterpret_cast<vtkButtonRepresentation*>(this->WidgetRep);
102  }
103 
107  void CreateDefaultRepresentation() override;
108 
116  void SetEnabled(int) override;
117 
118 protected:
119  vtkButtonWidget();
120  ~vtkButtonWidget() override = default;
121 
122  // These are the events that are handled
123  static void SelectAction(vtkAbstractWidget*);
124  static void MoveAction(vtkAbstractWidget*);
125  static void EndSelectAction(vtkAbstractWidget*);
126 
127  // Manage the state of the widget
130  {
131  Start = 0,
133  Selecting
134  };
135 #if !defined(VTK_LEGACY_REMOVE)
136  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
138 #endif
139 
140 private:
141  vtkButtonWidget(const vtkButtonWidget&) = delete;
142  void operator=(const vtkButtonWidget&) = delete;
143 };
144 
145 #endif
vtkButtonRepresentation * GetSliderRepresentation()
Return the representation as a vtkButtonRepresentation.
#define VTK_DEPRECATED_IN_9_2_0(reason)
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros implementing standard VTK methods.
activate an n-state button
virtual void CreateDefaultRepresentation()=0
Create the default widget representation if one is not set.
vtkWidgetRepresentation * WidgetRep
a simple class to control print indentation
Definition: vtkIndent.h:39
abstract class defines the representation for a vtkButtonWidget
define the API for widget / widget representation
void SetEnabled(int) override
Methods for activating this widget.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
void SetRepresentation(vtkButtonRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene...