VTK  9.2.6
vtkCompassRepresentation.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkCompassRepresentation.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/*-------------------------------------------------------------------------
17 Copyright 2008 Sandia Corporation.
18 Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
19 the U.S. Government retains certain rights in this software.
20-------------------------------------------------------------------------*/
21
29#ifndef vtkCompassRepresentation_h
30#define vtkCompassRepresentation_h
31
32#include "vtkCenteredSliderRepresentation.h" // to use in a SP
34#include "vtkCoordinate.h" // For vtkViewportCoordinateMacro
35#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
36#include "vtkGeovisCoreModule.h" // For export macro
37#include "vtkSmartPointer.h" // used for SmartPointers
38
39class vtkActor2D;
40class vtkPoints;
41class vtkCellArray;
42class vtkPolyData;
44class vtkCoordinate;
45class vtkProperty2D;
47class vtkWindow;
48class vtkViewport;
49class vtkTransform;
51class vtkTextProperty;
52class vtkTextActor;
53
55{
56public:
61
63
67 void PrintSelf(ostream& os, vtkIndent indent) override;
69
79
89
91
95 vtkGetObjectMacro(RingProperty, vtkProperty2D);
97
99
103 vtkGetObjectMacro(SelectedProperty, vtkProperty2D);
105
107
110 vtkGetObjectMacro(LabelProperty, vtkTextProperty);
112
114
119 void PlaceWidget(double bounds[6]) override;
120 void BuildRepresentation() override;
121 void StartWidgetInteraction(double eventPos[2]) override;
122 void WidgetInteraction(double eventPos[2]) override;
123 virtual void TiltWidgetInteraction(double eventPos[2]);
124 virtual void DistanceWidgetInteraction(double eventPos[2]);
125 int ComputeInteractionState(int X, int Y, int modify = 0) override;
126 void Highlight(int) override;
128
130
138
139 virtual void SetHeading(double value);
140 virtual double GetHeading();
141 virtual void SetTilt(double value);
142 virtual double GetTilt();
143 virtual void UpdateTilt(double time);
144 virtual void EndTilt();
145 virtual void SetDistance(double value);
146 virtual double GetDistance();
147 virtual void UpdateDistance(double time);
148 virtual void EndDistance();
149 void SetRenderer(vtkRenderer* ren) override;
150
151 // Enums are used to describe what is selected
153 {
154 Outside = 0,
162 DistanceAdjusting
163 };
164#if !defined(VTK_LEGACY_REMOVE)
165 VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
167#endif
168
169protected:
172
173 // Positioning the widget
176
177 // radius values
180
181 // tilt and distance rep
182
185
186 // Define the geometry. It is constructed in canaonical position
187 // along the x-axis and then rotated into position.
190
196
199
204
206
207 // build the tube geometry
208 void BuildRing();
210
211 // used for positioning etc
212 void GetCenterAndUnitRadius(int center[2], double& radius);
213
215
216 double Heading;
217 double Tilt;
218 double Distance;
219
220private:
222 void operator=(const vtkCompassRepresentation&) = delete;
223};
224
225#endif
a actor that draws 2D data
Definition: vtkActor2D.h:46
object to represent cell connectivity
Definition: vtkCellArray.h:187
virtual void TiltWidgetInteraction(double eventPos[2])
Methods to interface with the vtkSliderWidget.
virtual void SetTilt(double value)
virtual double GetDistance()
vtkSmartPointer< vtkCenteredSliderRepresentation > TiltRepresentation
virtual void SetHeading(double value)
virtual void UpdateTilt(double time)
virtual double GetHeading()
vtkPolyDataMapper2D * RingMapper
virtual void EndDistance()
virtual void SetDistance(double value)
void GetCenterAndUnitRadius(int center[2], double &radius)
int RenderOverlay(vtkViewport *) override
Methods supporting the rendering process.
void WidgetInteraction(double eventPos[2]) override
Methods to interface with the vtkSliderWidget.
~vtkCompassRepresentation() override
vtkCoordinate * GetPoint1Coordinate()
Position the first end point of the slider.
int ComputeInteractionState(int X, int Y, int modify=0) override
Methods to interface with the vtkSliderWidget.
static vtkCompassRepresentation * New()
Instantiate the class.
virtual void EndTilt()
void Highlight(int) override
Methods to interface with the vtkSliderWidget.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for the class.
void SetRenderer(vtkRenderer *ren) override
Subclasses of vtkWidgetRepresentation must implement these methods.
vtkTransformPolyDataFilter * RingXForm
virtual void DistanceWidgetInteraction(double eventPos[2])
Methods to interface with the vtkSliderWidget.
void BuildRepresentation() override
Methods to interface with the vtkSliderWidget.
virtual double GetTilt()
int RenderOpaqueGeometry(vtkViewport *) override
Methods supporting the rendering process.
void GetActors(vtkPropCollection *) override
Methods supporting the rendering process.
void ReleaseGraphicsResources(vtkWindow *) override
Methods supporting the rendering process.
void StartWidgetInteraction(double eventPos[2]) override
Methods to interface with the vtkSliderWidget.
vtkSmartPointer< vtkCenteredSliderRepresentation > DistanceRepresentation
virtual void UpdateDistance(double time)
vtkCoordinate * GetPoint2Coordinate()
Position the second end point of the slider.
void PlaceWidget(double bounds[6]) override
Methods to interface with the vtkSliderWidget.
vtkPolyDataMapper2D * BackdropMapper
provide the representation for a continuous value
perform coordinate transformation, and represent position, in a variety of vtk coordinate systems
Definition: vtkCoordinate.h:80
a simple class to control print indentation
Definition: vtkIndent.h:40
represent and manipulate 3D points
Definition: vtkPoints.h:40
draw vtkPolyData onto the image plane
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:91
an ordered list of Props
represent surface properties of a 2D image
Definition: vtkProperty2D.h:41
abstract specification for renderers
Definition: vtkRenderer.h:73
Hold a reference to a vtkObjectBase instance.
An actor that displays text.
Definition: vtkTextActor.h:57
represent text properties.
transform points and associated normals and vectors for polygonal dataset
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:61
abstract specification for Viewports
Definition: vtkViewport.h:56
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
#define VTK_DEPRECATED_IN_9_2_0(reason)