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=========================================================================*/
70#ifndef vtkButtonWidget_h
71#define vtkButtonWidget_h
72
73#include "vtkAbstractWidget.h"
74#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
75#include "vtkInteractionWidgetsModule.h" // For export macro
76
78
79class VTKINTERACTIONWIDGETS_EXPORT vtkButtonWidget : public vtkAbstractWidget
80{
81public:
86
88
92 void PrintSelf(ostream& os, vtkIndent indent) override;
94
101 {
102 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
103 }
104
109 {
110 return reinterpret_cast<vtkButtonRepresentation*>(this->WidgetRep);
111 }
112
117
125 void SetEnabled(int) override;
126
127protected:
129 ~vtkButtonWidget() override = default;
130
131 // These are the events that are handled
135
136 // Manage the state of the widget
139 {
140 Start = 0,
142 Selecting
143 };
144#if !defined(VTK_LEGACY_REMOVE)
145 VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
147#endif
148
149private:
150 vtkButtonWidget(const vtkButtonWidget&) = delete;
151 void operator=(const vtkButtonWidget&) = delete;
152};
153
154#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 *)
vtkButtonRepresentation * GetSliderRepresentation()
Return the representation as a vtkButtonRepresentation.
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:49
abstract class defines interface between the widget and widget representation classes
#define VTK_DEPRECATED_IN_9_2_0(reason)