VTK
9.2.6
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
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
67
#ifndef vtkCompassWidget_h
68
#define vtkCompassWidget_h
69
70
#include "
vtkAbstractWidget.h
"
71
#include "
vtkDeprecation.h
"
// For VTK_DEPRECATED_IN_9_2_0
72
#include "vtkGeovisCoreModule.h"
// For export macro
73
74
class
vtkCompassRepresentation
;
75
76
class
VTKGEOVISCORE_EXPORT
vtkCompassWidget
:
public
vtkAbstractWidget
77
{
78
public
:
82
static
vtkCompassWidget
*
New
();
83
85
88
vtkTypeMacro(
vtkCompassWidget
,
vtkAbstractWidget
);
89
void
PrintSelf
(ostream& os,
vtkIndent
indent)
override
;
91
97
void
SetRepresentation
(
vtkCompassRepresentation
* r)
98
{
99
this->Superclass::SetWidgetRepresentation(
reinterpret_cast<
vtkWidgetRepresentation
*
>
(r));
100
}
101
105
void
CreateDefaultRepresentation
()
override
;
106
108
111
double
GetHeading
();
112
void
SetHeading
(
double
v);
113
double
GetTilt
();
114
void
SetTilt
(
double
value);
115
double
GetDistance
();
116
void
SetDistance
(
double
value);
118
119
protected
:
120
vtkCompassWidget
();
121
~vtkCompassWidget
()
override
=
default
;
122
123
// These are the events that are handled
124
static
void
SelectAction
(
vtkAbstractWidget
*);
125
static
void
EndSelectAction
(
vtkAbstractWidget
*);
126
static
void
MoveAction
(
vtkAbstractWidget
*);
127
static
void
TimerAction
(
vtkAbstractWidget
*);
128
129
int
WidgetState
;
130
enum
WidgetStateType
131
{
132
Start = 0,
133
Highlighting
,
134
Adjusting
,
135
TiltAdjusting
,
136
DistanceAdjusting
137
};
138
#if !defined(VTK_LEGACY_REMOVE)
139
VTK_DEPRECATED_IN_9_2_0
(
"because leading underscore is reserved"
)
140
typedef
WidgetStateType
_WidgetState
;
141
#endif
142
143
int
TimerId
;
144
int
TimerDuration
;
145
double
StartTime
;
146
147
private
:
148
vtkCompassWidget
(
const
vtkCompassWidget
&) =
delete
;
149
void
operator=(
const
vtkCompassWidget
&) =
delete
;
150
};
151
152
#endif
vtkAbstractWidget
define the API for widget / widget representation
Definition
vtkAbstractWidget.h:66
vtkCompassRepresentation
provide a compass
Definition
vtkCompassRepresentation.h:55
vtkCompassWidget
set a value by manipulating something
Definition
vtkCompassWidget.h:77
vtkCompassWidget::WidgetStateType
WidgetStateType
Definition
vtkCompassWidget.h:131
vtkCompassWidget::TiltAdjusting
@ TiltAdjusting
Definition
vtkCompassWidget.h:135
vtkCompassWidget::Highlighting
@ Highlighting
Definition
vtkCompassWidget.h:133
vtkCompassWidget::Adjusting
@ Adjusting
Definition
vtkCompassWidget.h:134
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:97
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::TimerAction
static void TimerAction(vtkAbstractWidget *)
vtkCompassWidget::TimerId
int TimerId
Definition
vtkCompassWidget.h:143
vtkCompassWidget::New
static vtkCompassWidget * New()
Instantiate the class.
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:145
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:129
vtkCompassWidget::TimerDuration
int TimerDuration
Definition
vtkCompassWidget.h:144
vtkCompassWidget::MoveAction
static void MoveAction(vtkAbstractWidget *)
vtkCompassWidget::SelectAction
static void SelectAction(vtkAbstractWidget *)
vtkIndent
a simple class to control print indentation
Definition
vtkIndent.h:40
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition
vtkWidgetRepresentation.h:60
vtkAbstractWidget.h
vtkDeprecation.h
VTK_DEPRECATED_IN_9_2_0
#define VTK_DEPRECATED_IN_9_2_0(reason)
Definition
vtkDeprecation.h:116
Generated on Fri Sep 13 2024 21:27:19 for VTK by
1.9.7