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 
67 #ifndef vtkCompassWidget_h
68 #define vtkCompassWidget_h
69 
70 #include "vtkAbstractWidget.h"
71 #include "vtkGeovisCoreModule.h" // For export macro
72 
74 
75 class VTKGEOVISCORE_EXPORT vtkCompassWidget : public vtkAbstractWidget
76 {
77 public:
81  static vtkCompassWidget* New();
82 
84 
88  void PrintSelf(ostream& os, vtkIndent indent) override;
90 
97  {
98  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
99  }
100 
105 
107 
110  double GetHeading();
111  void SetHeading(double v);
112  double GetTilt();
113  void SetTilt(double value);
114  double GetDistance();
115  void SetDistance(double value);
117 
118 protected:
120  ~vtkCompassWidget() override = default;
121 
122  // These are the events that are handled
127 
130  {
131  Start = 0,
135  DistanceAdjusting
136  };
137 
138  int TimerId;
140  double StartTime;
141 
142 private:
143  vtkCompassWidget(const vtkCompassWidget&) = delete;
144  void operator=(const vtkCompassWidget&) = delete;
145 };
146 
147 #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:34
abstract class defines interface between the widget and widget representation classes
@ value
Definition: vtkX3D.h:226