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 =========================================================================*/
76 #ifndef vtkHoverWidget_h
77 #define vtkHoverWidget_h
78 
79 #include "vtkAbstractWidget.h"
80 #include "vtkInteractionWidgetsModule.h" // For export macro
81 
82 class VTKINTERACTIONWIDGETS_EXPORT vtkHoverWidget : public vtkAbstractWidget
83 {
84 public:
88  static vtkHoverWidget* New();
89 
91 
95  void PrintSelf(ostream& os, vtkIndent indent) override;
97 
99 
104  vtkSetClampMacro(TimerDuration, int, 1, 100000);
105  vtkGetMacro(TimerDuration, int);
107 
112  void SetEnabled(int) override;
113 
119  void CreateDefaultRepresentation() override { this->WidgetRep = nullptr; }
120 
121 protected:
123  ~vtkHoverWidget() override;
124 
125  // The state of the widget
126 
127  enum
128  {
129  Start = 0,
131  TimedOut
132  };
133 
135 
136  // Callback interface to execute events
140 
141  // Subclasses of this class invoke these methods. If a non-zero
142  // value is returned, a subclass is handling the event.
143  virtual int SubclassHoverAction() { return 0; }
144  virtual int SubclassEndHoverAction() { return 0; }
145  virtual int SubclassSelectAction() { return 0; }
146 
148 
151  int TimerId;
154 
155 private:
156  vtkHoverWidget(const vtkHoverWidget&) = delete;
157  void operator=(const vtkHoverWidget&) = delete;
158 };
159 
160 #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.
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()
static vtkHoverWidget * New()
Instantiate this class.
a simple class to control print indentation
Definition: vtkIndent.h:34