VTK
9.3.0
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
55
#ifndef vtkButtonWidget_h
56
#define vtkButtonWidget_h
57
58
#include "
vtkAbstractWidget.h
"
59
#include "
vtkDeprecation.h
"
// For VTK_DEPRECATED_IN_9_2_0
60
#include "vtkInteractionWidgetsModule.h"
// For export macro
61
#include "vtkLegacy.h"
// for VTK_LEGACY_REMOVE
62
63
VTK_ABI_NAMESPACE_BEGIN
64
class
vtkButtonRepresentation
;
65
66
class
VTKINTERACTIONWIDGETS_EXPORT
vtkButtonWidget
:
public
vtkAbstractWidget
67
{
68
public
:
72
static
vtkButtonWidget
*
New
();
73
75
78
vtkTypeMacro(
vtkButtonWidget
,
vtkAbstractWidget
);
79
void
PrintSelf
(ostream& os,
vtkIndent
indent)
override
;
81
87
void
SetRepresentation
(
vtkButtonRepresentation
* r)
88
{
89
this->Superclass::SetWidgetRepresentation(
reinterpret_cast<
vtkWidgetRepresentation
*
>
(r));
90
}
91
95
vtkButtonRepresentation
*
GetSliderRepresentation
()
96
{
97
return
reinterpret_cast<
vtkButtonRepresentation
*
>
(this->
WidgetRep
);
98
}
99
103
void
CreateDefaultRepresentation
()
override
;
104
112
void
SetEnabled
(
int
)
override
;
113
114
protected
:
115
vtkButtonWidget
();
116
~vtkButtonWidget
()
override
=
default
;
117
118
// These are the events that are handled
119
static
void
SelectAction
(
vtkAbstractWidget
*);
120
static
void
MoveAction
(
vtkAbstractWidget
*);
121
static
void
EndSelectAction
(
vtkAbstractWidget
*);
122
123
// Manage the state of the widget
124
int
WidgetState
;
125
enum
WidgetStateType
126
{
127
Start = 0,
128
Hovering
,
129
Selecting
130
};
131
#if !defined(VTK_LEGACY_REMOVE)
132
VTK_DEPRECATED_IN_9_2_0
(
"because leading underscore is reserved"
)
133
typedef
WidgetStateType
_WidgetState
;
134
#endif
135
136
private
:
137
vtkButtonWidget
(
const
vtkButtonWidget
&) =
delete
;
138
void
operator=(
const
vtkButtonWidget
&) =
delete
;
139
};
140
141
VTK_ABI_NAMESPACE_END
142
#endif
vtkAbstractWidget
define the API for widget / widget representation
Definition
vtkAbstractWidget.h:61
vtkAbstractWidget::WidgetRep
vtkWidgetRepresentation * WidgetRep
Definition
vtkAbstractWidget.h:175
vtkButtonRepresentation
abstract class defines the representation for a vtkButtonWidget
Definition
vtkButtonRepresentation.h:36
vtkButtonWidget
activate an n-state button
Definition
vtkButtonWidget.h:67
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:124
vtkButtonWidget::GetSliderRepresentation
vtkButtonRepresentation * GetSliderRepresentation()
Return the representation as a vtkButtonRepresentation.
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:87
vtkButtonWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros.
vtkButtonWidget::EndSelectAction
static void EndSelectAction(vtkAbstractWidget *)
vtkButtonWidget::WidgetStateType
WidgetStateType
Definition
vtkButtonWidget.h:126
vtkButtonWidget::Hovering
@ Hovering
Definition
vtkButtonWidget.h:128
vtkIndent
a simple class to control print indentation
Definition
vtkIndent.h:38
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 Wed Dec 11 2024 20:34:33 for VTK by
1.9.8