VTK
9.5.2
Main Page
Related Pages
Topics
Namespaces
Classes
Files
Examples
File List
File Members
Interaction
Widgets
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
84
85
#ifndef vtkButtonWidget_h
86
#define vtkButtonWidget_h
87
88
#include "
vtkAbstractWidget.h
"
89
#include "
vtkDeprecation.h
"
// For VTK_DEPRECATED_IN_9_4_0
90
#include "vtkInteractionWidgetsModule.h"
// For export macro
91
#include "
vtkWrappingHints.h
"
// For VTK_MARSHALAUTO
92
93
VTK_ABI_NAMESPACE_BEGIN
94
class
vtkButtonRepresentation
;
95
96
class
VTKINTERACTIONWIDGETS_EXPORT
VTK_MARSHALAUTO
vtkButtonWidget
:
public
vtkAbstractWidget
97
{
98
public
:
102
static
vtkButtonWidget
*
New
();
103
105
108
vtkTypeMacro(
vtkButtonWidget
,
vtkAbstractWidget
);
109
void
PrintSelf
(ostream& os,
vtkIndent
indent)
override
;
111
117
void
SetRepresentation
(
vtkButtonRepresentation
* r)
118
{
119
this->
Superclass::SetWidgetRepresentation
(
reinterpret_cast<
vtkWidgetRepresentation
*
>
(r));
120
}
121
125
vtkButtonRepresentation
*
GetButtonRepresentation
()
126
{
127
return
reinterpret_cast<
vtkButtonRepresentation
*
>
(this->
WidgetRep
);
128
}
129
133
VTK_DEPRECATED_IN_9_4_0
(
"Please use GetButtonRepresentation() instead."
)
134
vtkButtonRepresentation
*
GetSliderRepresentation
() {
return
this->
GetButtonRepresentation
(); }
135
139
void
CreateDefaultRepresentation
()
override
;
140
148
void
SetEnabled
(
int
)
override
;
149
150
protected
:
151
vtkButtonWidget
();
152
~vtkButtonWidget
()
override
=
default
;
153
154
// These are the events that are handled
155
static
void
SelectAction
(
vtkAbstractWidget
*);
156
static
void
MoveAction
(
vtkAbstractWidget
*);
157
static
void
EndSelectAction
(
vtkAbstractWidget
*);
158
159
// Manage the state of the widget
160
int
WidgetState
;
161
enum
WidgetStateType
162
{
163
Start
= 0,
164
Hovering
,
165
Selecting
166
};
167
168
private
:
169
vtkButtonWidget
(
const
vtkButtonWidget
&) =
delete
;
170
void
operator=(
const
vtkButtonWidget
&) =
delete
;
171
};
172
173
VTK_ABI_NAMESPACE_END
174
#endif
vtkAbstractWidget::vtkAbstractWidget
vtkAbstractWidget()
vtkAbstractWidget::SetWidgetRepresentation
void SetWidgetRepresentation(vtkWidgetRepresentation *r)
vtkAbstractWidget::WidgetRep
vtkWidgetRepresentation * WidgetRep
Definition
vtkAbstractWidget.h:197
vtkButtonRepresentation
abstract class defines the representation for a vtkButtonWidget
Definition
vtkButtonRepresentation.h:55
vtkButtonWidget
activate an n-state button
Definition
vtkButtonWidget.h:97
vtkButtonWidget::CreateDefaultRepresentation
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
vtkButtonWidget::~vtkButtonWidget
~vtkButtonWidget() override=default
vtkButtonWidget::vtkButtonWidget
vtkButtonWidget()
vtkButtonWidget::GetButtonRepresentation
vtkButtonRepresentation * GetButtonRepresentation()
Return the representation as a vtkButtonRepresentation.
Definition
vtkButtonWidget.h:125
vtkButtonWidget::SelectAction
static void SelectAction(vtkAbstractWidget *)
vtkButtonWidget::WidgetState
int WidgetState
Definition
vtkButtonWidget.h:160
vtkButtonWidget::GetSliderRepresentation
vtkButtonRepresentation * GetSliderRepresentation()
Incorrect name for GetButtonRepresentation(), for backwards compatibility.
Definition
vtkButtonWidget.h:134
vtkButtonWidget::SetEnabled
void SetEnabled(int) override
The method for activating and deactivating this widget.
vtkButtonWidget::New
static vtkButtonWidget * New()
Instantiate the class.
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:117
vtkButtonWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros.
vtkButtonWidget::EndSelectAction
static void EndSelectAction(vtkAbstractWidget *)
vtkButtonWidget::WidgetStateType
WidgetStateType
Definition
vtkButtonWidget.h:162
vtkButtonWidget::Selecting
@ Selecting
Definition
vtkButtonWidget.h:165
vtkButtonWidget::Start
@ Start
Definition
vtkButtonWidget.h:163
vtkButtonWidget::Hovering
@ Hovering
Definition
vtkButtonWidget.h:164
vtkIndent
a simple class to control print indentation
Definition
vtkIndent.h:108
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition
vtkWidgetRepresentation.h:68
vtkAbstractWidget.h
vtkDeprecation.h
VTK_DEPRECATED_IN_9_4_0
#define VTK_DEPRECATED_IN_9_4_0(reason)
Definition
vtkDeprecation.h:108
vtkWrappingHints.h
VTK_MARSHALAUTO
#define VTK_MARSHALAUTO
Definition
vtkWrappingHints.h:53
Generated on
for VTK by
1.15.0