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
45
46
#ifndef vtkButtonWidget_h
47
#define vtkButtonWidget_h
48
49
#include "
vtkAbstractWidget.h
"
50
#include "
vtkDeprecation.h
"
// For VTK_DEPRECATED_IN_9_4_0
51
#include "vtkInteractionWidgetsModule.h"
// For export macro
52
#include "
vtkWrappingHints.h
"
// For VTK_MARSHALAUTO
53
54
VTK_ABI_NAMESPACE_BEGIN
55
class
vtkButtonRepresentation
;
56
57
class
VTKINTERACTIONWIDGETS_EXPORT
VTK_MARSHALAUTO
vtkButtonWidget
:
public
vtkAbstractWidget
58
{
59
public
:
63
static
vtkButtonWidget
*
New
();
64
66
69
vtkTypeMacro(
vtkButtonWidget
,
vtkAbstractWidget
);
70
void
PrintSelf
(ostream& os,
vtkIndent
indent)
override
;
72
78
void
SetRepresentation
(
vtkButtonRepresentation
* r)
79
{
80
this->
Superclass::SetWidgetRepresentation
(
reinterpret_cast<
vtkWidgetRepresentation
*
>
(r));
81
}
82
86
vtkButtonRepresentation
*
GetButtonRepresentation
()
87
{
88
return
reinterpret_cast<
vtkButtonRepresentation
*
>
(this->
WidgetRep
);
89
}
90
94
VTK_DEPRECATED_IN_9_4_0
(
"Please use GetButtonRepresentation() instead."
)
95
vtkButtonRepresentation
*
GetSliderRepresentation
() {
return
this->
GetButtonRepresentation
(); }
96
100
void
CreateDefaultRepresentation
()
override
;
101
109
void
SetEnabled
(
int
)
override
;
110
111
protected
:
112
vtkButtonWidget
();
113
~vtkButtonWidget
()
override
=
default
;
114
115
// These are the events that are handled
116
static
void
SelectAction
(
vtkAbstractWidget
*);
117
static
void
MoveAction
(
vtkAbstractWidget
*);
118
static
void
EndSelectAction
(
vtkAbstractWidget
*);
119
120
// Manage the state of the widget
121
int
WidgetState
;
122
enum
WidgetStateType
123
{
124
Start
= 0,
125
Hovering
,
126
Selecting
127
};
128
129
private
:
130
vtkButtonWidget
(
const
vtkButtonWidget
&) =
delete
;
131
void
operator=(
const
vtkButtonWidget
&) =
delete
;
132
};
133
134
VTK_ABI_NAMESPACE_END
135
#endif
vtkAbstractWidget::vtkAbstractWidget
vtkAbstractWidget()
vtkAbstractWidget::SetWidgetRepresentation
void SetWidgetRepresentation(vtkWidgetRepresentation *r)
vtkAbstractWidget::WidgetRep
vtkWidgetRepresentation * WidgetRep
Definition
vtkAbstractWidget.h:168
vtkButtonRepresentation
abstract class defines the representation for a vtkButtonWidget
Definition
vtkButtonRepresentation.h:36
vtkButtonWidget
activate an n-state button
Definition
vtkButtonWidget.h:58
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:86
vtkButtonWidget::SelectAction
static void SelectAction(vtkAbstractWidget *)
vtkButtonWidget::WidgetState
int WidgetState
Definition
vtkButtonWidget.h:121
vtkButtonWidget::GetSliderRepresentation
vtkButtonRepresentation * GetSliderRepresentation()
Incorrect name for GetButtonRepresentation(), for backwards compatibility.
Definition
vtkButtonWidget.h:95
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:78
vtkButtonWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros.
vtkButtonWidget::EndSelectAction
static void EndSelectAction(vtkAbstractWidget *)
vtkButtonWidget::WidgetStateType
WidgetStateType
Definition
vtkButtonWidget.h:123
vtkButtonWidget::Selecting
@ Selecting
Definition
vtkButtonWidget.h:126
vtkButtonWidget::Start
@ Start
Definition
vtkButtonWidget.h:124
vtkButtonWidget::Hovering
@ Hovering
Definition
vtkButtonWidget.h:125
vtkIndent
a simple class to control print indentation
Definition
vtkIndent.h:29
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