VTK  9.3.1
vtkHoverWidget.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
64#ifndef vtkHoverWidget_h
65#define vtkHoverWidget_h
66
67#include "vtkAbstractWidget.h"
68#include "vtkInteractionWidgetsModule.h" // For export macro
69
70VTK_ABI_NAMESPACE_BEGIN
71class VTKINTERACTIONWIDGETS_EXPORT vtkHoverWidget : public vtkAbstractWidget
72{
73public:
78
80
84 void PrintSelf(ostream& os, vtkIndent indent) override;
86
88
93 vtkSetClampMacro(TimerDuration, int, 1, 100000);
94 vtkGetMacro(TimerDuration, int);
96
101 void SetEnabled(int) override;
102
108 void CreateDefaultRepresentation() override { this->WidgetRep = nullptr; }
109
110protected:
112 ~vtkHoverWidget() override;
113
114 // The state of the widget
115
116 enum
117 {
118 Start = 0,
120 TimedOut
121 };
122
124
125 // Callback interface to execute events
129
130 // Subclasses of this class invoke these methods. If a non-zero
131 // value is returned, a subclass is handling the event.
132 virtual int SubclassHoverAction() { return 0; }
133 virtual int SubclassEndHoverAction() { return 0; }
134 virtual int SubclassSelectAction() { return 0; }
135
137
143
144private:
145 vtkHoverWidget(const vtkHoverWidget&) = delete;
146 void operator=(const vtkHoverWidget&) = delete;
147};
148
149VTK_ABI_NAMESPACE_END
150#endif
define the API for widget / widget representation
invoke a vtkTimerEvent when hovering
virtual int SubclassSelectAction()
int TimerId
Helper methods for creating and destroying timers.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for a VTK class.
static vtkHoverWidget * New()
Instantiate this class.
void CreateDefaultRepresentation() override
A default representation, of which there is none, is created.
static void HoverAction(vtkAbstractWidget *)
int TimerDuration
Helper methods for creating and destroying timers.
~vtkHoverWidget() override
static void MoveAction(vtkAbstractWidget *)
static void SelectAction(vtkAbstractWidget *)
void SetEnabled(int) override
The method for activating and deactivating this widget.
virtual int SubclassEndHoverAction()
virtual int SubclassHoverAction()
a simple class to control print indentation
Definition vtkIndent.h:29