VTK
9.3.1
Main Page
Related Pages
Topics
Namespaces
Classes
Files
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
49
#ifndef vtkButtonWidget_h
50
#define vtkButtonWidget_h
51
52
#include "
vtkAbstractWidget.h
"
53
#include "
vtkDeprecation.h
"
// For VTK_DEPRECATED_IN_9_2_0
54
#include "vtkInteractionWidgetsModule.h"
// For export macro
55
#include "vtkLegacy.h"
// for VTK_LEGACY_REMOVE
56
57
VTK_ABI_NAMESPACE_BEGIN
58
class
vtkButtonRepresentation
;
59
60
class
VTKINTERACTIONWIDGETS_EXPORT
vtkButtonWidget
:
public
vtkAbstractWidget
61
{
62
public
:
66
static
vtkButtonWidget
*
New
();
67
69
72
vtkTypeMacro(
vtkButtonWidget
,
vtkAbstractWidget
);
73
void
PrintSelf
(ostream& os,
vtkIndent
indent)
override
;
75
81
void
SetRepresentation
(
vtkButtonRepresentation
* r)
82
{
83
this->Superclass::SetWidgetRepresentation(
reinterpret_cast<
vtkWidgetRepresentation
*
>
(r));
84
}
85
89
vtkButtonRepresentation
*
GetSliderRepresentation
()
90
{
91
return
reinterpret_cast<
vtkButtonRepresentation
*
>
(this->
WidgetRep
);
92
}
93
97
void
CreateDefaultRepresentation
()
override
;
98
106
void
SetEnabled
(
int
)
override
;
107
108
protected
:
109
vtkButtonWidget
();
110
~vtkButtonWidget
()
override
=
default
;
111
112
// These are the events that are handled
113
static
void
SelectAction
(
vtkAbstractWidget
*);
114
static
void
MoveAction
(
vtkAbstractWidget
*);
115
static
void
EndSelectAction
(
vtkAbstractWidget
*);
116
117
// Manage the state of the widget
118
int
WidgetState
;
119
enum
WidgetStateType
120
{
121
Start = 0,
122
Hovering
,
123
Selecting
124
};
125
#if !defined(VTK_LEGACY_REMOVE)
126
VTK_DEPRECATED_IN_9_2_0
(
"because leading underscore is reserved"
)
127
typedef
WidgetStateType
_WidgetState
;
128
#endif
129
130
private
:
131
vtkButtonWidget
(
const
vtkButtonWidget
&) =
delete
;
132
void
operator=(
const
vtkButtonWidget
&) =
delete
;
133
};
134
135
VTK_ABI_NAMESPACE_END
136
#endif
vtkAbstractWidget
define the API for widget / widget representation
Definition
vtkAbstractWidget.h:55
vtkAbstractWidget::WidgetRep
vtkWidgetRepresentation * WidgetRep
Definition
vtkAbstractWidget.h:169
vtkButtonRepresentation
abstract class defines the representation for a vtkButtonWidget
Definition
vtkButtonRepresentation.h:39
vtkButtonWidget
activate an n-state button
Definition
vtkButtonWidget.h:61
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:118
vtkButtonWidget::GetSliderRepresentation
vtkButtonRepresentation * GetSliderRepresentation()
Return the representation as a vtkButtonRepresentation.
Definition
vtkButtonWidget.h:89
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:81
vtkButtonWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros.
vtkButtonWidget::EndSelectAction
static void EndSelectAction(vtkAbstractWidget *)
vtkButtonWidget::WidgetStateType
WidgetStateType
Definition
vtkButtonWidget.h:120
vtkButtonWidget::Hovering
@ Hovering
Definition
vtkButtonWidget.h:122
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:65
vtkAbstractWidget.h
vtkDeprecation.h
VTK_DEPRECATED_IN_9_2_0
#define VTK_DEPRECATED_IN_9_2_0(reason)
Definition
vtkDeprecation.h:108
Generated on Tue Jul 9 2024 00:00:00 for VTK by
1.11.0