VTK  9.1.0
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=========================================================================*/
95#ifndef vtkHoverWidget_h
96#define vtkHoverWidget_h
97
98#include "vtkAbstractWidget.h"
99#include "vtkInteractionWidgetsModule.h" // For export macro
100
101class VTKINTERACTIONWIDGETS_EXPORT vtkHoverWidget : public vtkAbstractWidget
102{
103public:
108
110
114 void PrintSelf(ostream& os, vtkIndent indent) override;
116
118
123 vtkSetClampMacro(TimerDuration, int, 1, 100000);
124 vtkGetMacro(TimerDuration, int);
126
131 void SetEnabled(int) override;
132
138 void CreateDefaultRepresentation() override { this->WidgetRep = nullptr; }
139
140protected:
142 ~vtkHoverWidget() override;
143
144 // The state of the widget
145
146 enum
147 {
148 Start = 0,
150 TimedOut
151 };
152
154
155 // Callback interface to execute events
159
160 // Subclasses of this class invoke these methods. If a non-zero
161 // value is returned, a subclass is handling the event.
162 virtual int SubclassHoverAction() { return 0; }
163 virtual int SubclassEndHoverAction() { return 0; }
164 virtual int SubclassSelectAction() { return 0; }
165
167
173
174private:
175 vtkHoverWidget(const vtkHoverWidget&) = delete;
176 void operator=(const vtkHoverWidget&) = delete;
177};
178
179#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:113