VTK  9.1.0
vtkCompassWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCompassWidget.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 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2008 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
20 
83 #ifndef vtkCompassWidget_h
84 #define vtkCompassWidget_h
85 
86 #include "vtkAbstractWidget.h"
87 #include "vtkGeovisCoreModule.h" // For export macro
88 
90 
91 class VTKGEOVISCORE_EXPORT vtkCompassWidget : public vtkAbstractWidget
92 {
93 public:
97  static vtkCompassWidget* New();
98 
100 
104  void PrintSelf(ostream& os, vtkIndent indent) override;
106 
113  {
114  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
115  }
116 
121 
123 
126  double GetHeading();
127  void SetHeading(double v);
128  double GetTilt();
129  void SetTilt(double value);
130  double GetDistance();
131  void SetDistance(double value);
133 
134 protected:
136  ~vtkCompassWidget() override = default;
137 
138  // These are the events that are handled
143 
146  {
147  Start = 0,
151  DistanceAdjusting
152  };
153 
154  int TimerId;
156  double StartTime;
157 
158 private:
159  vtkCompassWidget(const vtkCompassWidget&) = delete;
160  void operator=(const vtkCompassWidget&) = delete;
161 };
162 
163 #endif
define the API for widget / widget representation
set a value by manipulating something
void SetTilt(double value)
Get the value for this widget.
~vtkCompassWidget() override=default
void SetRepresentation(vtkCompassRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
void SetHeading(double v)
Get the value for this widget.
double GetHeading()
Get the value for this widget.
static void EndSelectAction(vtkAbstractWidget *)
static vtkCompassWidget * New()
Instantiate the class.
static void TimerAction(vtkAbstractWidget *)
void SetDistance(double value)
Get the value for this widget.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros.
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
double GetDistance()
Get the value for this widget.
double GetTilt()
Get the value for this widget.
static void MoveAction(vtkAbstractWidget *)
static void SelectAction(vtkAbstractWidget *)
a simple class to control print indentation
Definition: vtkIndent.h:113
abstract class defines interface between the widget and widget representation classes
@ value
Definition: vtkX3D.h:226