VTK  9.2.6
vtkHoverWidget.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkHoverWidget.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
73#ifndef vtkHoverWidget_h
74#define vtkHoverWidget_h
75
76#include "vtkAbstractWidget.h"
77#include "vtkInteractionWidgetsModule.h" // For export macro
78
79class VTKINTERACTIONWIDGETS_EXPORT vtkHoverWidget : public vtkAbstractWidget
80{
81public:
86
88
92 void PrintSelf(ostream& os, vtkIndent indent) override;
94
96
101 vtkSetClampMacro(TimerDuration, int, 1, 100000);
102 vtkGetMacro(TimerDuration, int);
104
109 void SetEnabled(int) override;
110
116 void CreateDefaultRepresentation() override { this->WidgetRep = nullptr; }
117
118protected:
120 ~vtkHoverWidget() override;
121
122 // The state of the widget
123
124 enum
125 {
126 Start = 0,
128 TimedOut
129 };
130
132
133 // Callback interface to execute events
137
138 // Subclasses of this class invoke these methods. If a non-zero
139 // value is returned, a subclass is handling the event.
140 virtual int SubclassHoverAction() { return 0; }
141 virtual int SubclassEndHoverAction() { return 0; }
142 virtual int SubclassSelectAction() { return 0; }
143
145
151
152private:
153 vtkHoverWidget(const vtkHoverWidget&) = delete;
154 void operator=(const vtkHoverWidget&) = delete;
155};
156
157#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:34