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 
86 #ifndef vtkCompassWidget_h
87 #define vtkCompassWidget_h
88 
89 #include "vtkAbstractWidget.h"
90 #include "vtkGeovisCoreModule.h" // For export macro
91 
93 
94 class VTKGEOVISCORE_EXPORT vtkCompassWidget : public vtkAbstractWidget
95 {
96 public:
101 
103 
107  void PrintSelf(ostream& os, vtkIndent indent) override;
109 
116  {
117  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
118  }
119 
124 
126 
129  double GetHeading();
130  void SetHeading(double v);
131  double GetTilt();
132  void SetTilt(double value);
133  double GetDistance();
134  void SetDistance(double value);
136 
137 protected:
139  ~vtkCompassWidget() override = default;
140 
141  // These are the events that are handled
146 
149  {
150  Start = 0,
154  DistanceAdjusting
155  };
156 
157  int TimerId;
159  double StartTime;
160 
161 private:
162  vtkCompassWidget(const vtkCompassWidget&) = delete;
163  void operator=(const vtkCompassWidget&) = delete;
164 };
165 
166 #endif
vtkCompassWidget::New
static vtkCompassWidget * New()
Instantiate the class.
vtkCompassWidget::SelectAction
static void SelectAction(vtkAbstractWidget *)
vtkCompassWidget::vtkCompassWidget
vtkCompassWidget()
vtkX3D::value
@ value
Definition: vtkX3D.h:226
vtkCompassWidget::EndSelectAction
static void EndSelectAction(vtkAbstractWidget *)
vtkAbstractWidget.h
vtkCompassWidget::WidgetState
int WidgetState
Definition: vtkCompassWidget.h:147
vtkCompassWidget::~vtkCompassWidget
~vtkCompassWidget() override=default
vtkCompassWidget::Adjusting
@ Adjusting
Definition: vtkCompassWidget.h:152
vtkCompassWidget::StartTime
double StartTime
Definition: vtkCompassWidget.h:159
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition: vtkWidgetRepresentation.h:60
vtkCompassWidget::GetDistance
double GetDistance()
Get the value for this widget.
vtkCompassWidget::SetDistance
void SetDistance(double value)
Get the value for this widget.
vtkCompassWidget::TimerAction
static void TimerAction(vtkAbstractWidget *)
vtkCompassWidget::MoveAction
static void MoveAction(vtkAbstractWidget *)
vtkCompassWidget::TimerId
int TimerId
Definition: vtkCompassWidget.h:157
vtkCompassWidget
set a value by manipulating something
Definition: vtkCompassWidget.h:95
vtkAbstractWidget
define the API for widget / widget representation
Definition: vtkAbstractWidget.h:66
vtkCompassWidget::GetHeading
double GetHeading()
Get the value for this widget.
vtkCompassWidget::SetHeading
void SetHeading(double v)
Get the value for this widget.
vtkCompassWidget::_WidgetState
_WidgetState
Definition: vtkCompassWidget.h:149
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:113
vtkCompassWidget::SetRepresentation
void SetRepresentation(vtkCompassRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Definition: vtkCompassWidget.h:115
vtkCompassWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros.
vtkCompassWidget::TiltAdjusting
@ TiltAdjusting
Definition: vtkCompassWidget.h:153
vtkCompassWidget::CreateDefaultRepresentation
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
vtkCompassWidget::Highlighting
@ Highlighting
Definition: vtkCompassWidget.h:151
vtkCompassWidget::TimerDuration
int TimerDuration
Definition: vtkCompassWidget.h:158
vtkCompassRepresentation
provide a compass
Definition: vtkCompassRepresentation.h:73
vtkCompassWidget::GetTilt
double GetTilt()
Get the value for this widget.
vtkCompassWidget::SetTilt
void SetTilt(double value)
Get the value for this widget.