VTK
9.2.6
Geovis
Core
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 "
vtkDeprecation.h
"
// For VTK_DEPRECATED_IN_9_2_0
91
#include "vtkGeovisCoreModule.h"
// For export macro
92
93
class
vtkCompassRepresentation
;
94
95
class
VTKGEOVISCORE_EXPORT
vtkCompassWidget
:
public
vtkAbstractWidget
96
{
97
public
:
101
static
vtkCompassWidget
*
New
();
102
104
107
vtkTypeMacro(
vtkCompassWidget
,
vtkAbstractWidget
);
108
void
PrintSelf
(ostream& os,
vtkIndent
indent)
override
;
110
116
void
SetRepresentation
(
vtkCompassRepresentation
* r)
117
{
118
this->Superclass::SetWidgetRepresentation(
reinterpret_cast<
vtkWidgetRepresentation
*
>
(r));
119
}
120
124
void
CreateDefaultRepresentation
()
override
;
125
127
130
double
GetHeading
();
131
void
SetHeading
(
double
v);
132
double
GetTilt
();
133
void
SetTilt
(
double
value
);
134
double
GetDistance
();
135
void
SetDistance
(
double
value
);
137
138
protected
:
139
vtkCompassWidget
();
140
~vtkCompassWidget
()
override
=
default
;
141
142
// These are the events that are handled
143
static
void
SelectAction
(
vtkAbstractWidget
*);
144
static
void
EndSelectAction
(
vtkAbstractWidget
*);
145
static
void
MoveAction
(
vtkAbstractWidget
*);
146
static
void
TimerAction
(
vtkAbstractWidget
*);
147
148
int
WidgetState
;
149
enum
WidgetStateType
150
{
151
Start = 0,
152
Highlighting
,
153
Adjusting
,
154
TiltAdjusting
,
155
DistanceAdjusting
156
};
157
#if !defined(VTK_LEGACY_REMOVE)
158
VTK_DEPRECATED_IN_9_2_0
(
"because leading underscore is reserved"
)
159
typedef
WidgetStateType
_WidgetState
;
160
#endif
161
162
int
TimerId
;
163
int
TimerDuration
;
164
double
StartTime
;
165
166
private
:
167
vtkCompassWidget
(
const
vtkCompassWidget
&) =
delete
;
168
void
operator=(
const
vtkCompassWidget
&) =
delete
;
169
};
170
171
#endif
vtkAbstractWidget
define the API for widget / widget representation
Definition:
vtkAbstractWidget.h:66
vtkCompassRepresentation
provide a compass
Definition:
vtkCompassRepresentation.h:74
vtkCompassWidget
set a value by manipulating something
Definition:
vtkCompassWidget.h:96
vtkCompassWidget::WidgetStateType
WidgetStateType
Definition:
vtkCompassWidget.h:150
vtkCompassWidget::TiltAdjusting
@ TiltAdjusting
Definition:
vtkCompassWidget.h:154
vtkCompassWidget::Highlighting
@ Highlighting
Definition:
vtkCompassWidget.h:152
vtkCompassWidget::Adjusting
@ Adjusting
Definition:
vtkCompassWidget.h:153
vtkCompassWidget::SetTilt
void SetTilt(double value)
Get the value for this widget.
vtkCompassWidget::~vtkCompassWidget
~vtkCompassWidget() override=default
vtkCompassWidget::SetRepresentation
void SetRepresentation(vtkCompassRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Definition:
vtkCompassWidget.h:116
vtkCompassWidget::SetHeading
void SetHeading(double v)
Get the value for this widget.
vtkCompassWidget::GetHeading
double GetHeading()
Get the value for this widget.
vtkCompassWidget::EndSelectAction
static void EndSelectAction(vtkAbstractWidget *)
vtkCompassWidget::New
static vtkCompassWidget * New()
Instantiate the class.
vtkCompassWidget::TimerAction
static void TimerAction(vtkAbstractWidget *)
vtkCompassWidget::TimerId
int TimerId
Definition:
vtkCompassWidget.h:162
vtkCompassWidget::SetDistance
void SetDistance(double value)
Get the value for this widget.
vtkCompassWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros.
vtkCompassWidget::vtkCompassWidget
vtkCompassWidget()
vtkCompassWidget::StartTime
double StartTime
Definition:
vtkCompassWidget.h:164
vtkCompassWidget::CreateDefaultRepresentation
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
vtkCompassWidget::GetDistance
double GetDistance()
Get the value for this widget.
vtkCompassWidget::GetTilt
double GetTilt()
Get the value for this widget.
vtkCompassWidget::WidgetState
int WidgetState
Definition:
vtkCompassWidget.h:148
vtkCompassWidget::TimerDuration
int TimerDuration
Definition:
vtkCompassWidget.h:163
vtkCompassWidget::MoveAction
static void MoveAction(vtkAbstractWidget *)
vtkCompassWidget::SelectAction
static void SelectAction(vtkAbstractWidget *)
vtkIndent
a simple class to control print indentation
Definition:
vtkIndent.h:119
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition:
vtkWidgetRepresentation.h:60
vtkX3D::value
@ value
Definition:
vtkX3D.h:226
vtkAbstractWidget.h
vtkDeprecation.h
VTK_DEPRECATED_IN_9_2_0
#define VTK_DEPRECATED_IN_9_2_0(reason)
Definition:
vtkDeprecation.h:116
Generated on Tue Feb 14 2023 06:31:43 for VTK by
1.9.1