VTK
9.2.6
Interaction
Widgets
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
97
class
vtkButtonRepresentation
;
98
99
class
VTKINTERACTIONWIDGETS_EXPORT
vtkButtonWidget
:
public
vtkAbstractWidget
100
{
101
public
:
105
static
vtkButtonWidget
*
New
();
106
108
111
vtkTypeMacro(
vtkButtonWidget
,
vtkAbstractWidget
);
112
void
PrintSelf
(ostream& os,
vtkIndent
indent)
override
;
114
120
void
SetRepresentation
(
vtkButtonRepresentation
* r)
121
{
122
this->Superclass::SetWidgetRepresentation(
reinterpret_cast<
vtkWidgetRepresentation
*
>
(r));
123
}
124
128
vtkButtonRepresentation
*
GetSliderRepresentation
()
129
{
130
return
reinterpret_cast<
vtkButtonRepresentation
*
>
(this->
WidgetRep
);
131
}
132
136
void
CreateDefaultRepresentation
()
override
;
137
145
void
SetEnabled
(
int
)
override
;
146
147
protected
:
148
vtkButtonWidget
();
149
~vtkButtonWidget
()
override
=
default
;
150
151
// These are the events that are handled
152
static
void
SelectAction
(
vtkAbstractWidget
*);
153
static
void
MoveAction
(
vtkAbstractWidget
*);
154
static
void
EndSelectAction
(
vtkAbstractWidget
*);
155
156
// Manage the state of the widget
157
int
WidgetState
;
158
enum
WidgetStateType
159
{
160
Start = 0,
161
Hovering
,
162
Selecting
163
};
164
#if !defined(VTK_LEGACY_REMOVE)
165
VTK_DEPRECATED_IN_9_2_0
(
"because leading underscore is reserved"
)
166
typedef
WidgetStateType
_WidgetState
;
167
#endif
168
169
private
:
170
vtkButtonWidget
(
const
vtkButtonWidget
&) =
delete
;
171
void
operator=(
const
vtkButtonWidget
&) =
delete
;
172
};
173
174
#endif
vtkAbstractWidget
define the API for widget / widget representation
Definition:
vtkAbstractWidget.h:66
vtkAbstractWidget::WidgetRep
vtkWidgetRepresentation * WidgetRep
Definition:
vtkAbstractWidget.h:180
vtkButtonRepresentation
abstract class defines the representation for a vtkButtonWidget
Definition:
vtkButtonRepresentation.h:49
vtkButtonWidget
activate an n-state button
Definition:
vtkButtonWidget.h:100
vtkButtonWidget::CreateDefaultRepresentation
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
vtkButtonWidget::~vtkButtonWidget
~vtkButtonWidget() override=default
vtkButtonWidget::vtkButtonWidget
vtkButtonWidget()
vtkButtonWidget::SelectAction
static void SelectAction(vtkAbstractWidget *)
vtkButtonWidget::WidgetState
int WidgetState
Definition:
vtkButtonWidget.h:157
vtkButtonWidget::SetEnabled
void SetEnabled(int) override
The method for activating and deactivating this widget.
vtkButtonWidget::MoveAction
static void MoveAction(vtkAbstractWidget *)
vtkButtonWidget::SetRepresentation
void SetRepresentation(vtkButtonRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Definition:
vtkButtonWidget.h:120
vtkButtonWidget::New
static vtkButtonWidget * New()
Instantiate the class.
vtkButtonWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros.
vtkButtonWidget::GetSliderRepresentation
vtkButtonRepresentation * GetSliderRepresentation()
Return the representation as a vtkButtonRepresentation.
Definition:
vtkButtonWidget.h:128
vtkButtonWidget::EndSelectAction
static void EndSelectAction(vtkAbstractWidget *)
vtkButtonWidget::WidgetStateType
WidgetStateType
Definition:
vtkButtonWidget.h:159
vtkButtonWidget::Hovering
@ Hovering
Definition:
vtkButtonWidget.h:161
vtkIndent
a simple class to control print indentation
Definition:
vtkIndent.h:119
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition:
vtkWidgetRepresentation.h:60
vtkAbstractWidget.h
vtkDeprecation.h
VTK_DEPRECATED_IN_9_2_0
#define VTK_DEPRECATED_IN_9_2_0(reason)
Definition:
vtkDeprecation.h:116
Generated on Tue Feb 14 2023 06:31:43 for VTK by
1.9.1