VTK  9.2.5
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 
48 #ifndef vtkCompassRepresentation_h
49 #define vtkCompassRepresentation_h
50 
51 #include "vtkCenteredSliderRepresentation.h" // to use in a SP
53 #include "vtkCoordinate.h" // For vtkViewportCoordinateMacro
54 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
55 #include "vtkGeovisCoreModule.h" // For export macro
56 #include "vtkSmartPointer.h" // used for SmartPointers
57 
58 class vtkActor2D;
59 class vtkPoints;
60 class vtkCellArray;
61 class vtkPolyData;
63 class vtkCoordinate;
64 class vtkProperty2D;
65 class vtkPropCollection;
66 class vtkWindow;
67 class vtkViewport;
68 class vtkTransform;
70 class vtkTextProperty;
71 class vtkTextActor;
72 
74 {
75 public:
80 
82 
86  void PrintSelf(ostream& os, vtkIndent indent) override;
88 
98 
108 
110 
114  vtkGetObjectMacro(RingProperty, vtkProperty2D);
116 
118 
122  vtkGetObjectMacro(SelectedProperty, vtkProperty2D);
124 
126 
129  vtkGetObjectMacro(LabelProperty, vtkTextProperty);
131 
133 
138  void PlaceWidget(double bounds[6]) override;
139  void BuildRepresentation() override;
140  void StartWidgetInteraction(double eventPos[2]) override;
141  void WidgetInteraction(double eventPos[2]) override;
142  virtual void TiltWidgetInteraction(double eventPos[2]);
143  virtual void DistanceWidgetInteraction(double eventPos[2]);
144  int ComputeInteractionState(int X, int Y, int modify = 0) override;
145  void Highlight(int) override;
147 
149 
152  void GetActors(vtkPropCollection*) override;
154  int RenderOverlay(vtkViewport*) override;
157 
158  virtual void SetHeading(double value);
159  virtual double GetHeading();
160  virtual void SetTilt(double value);
161  virtual double GetTilt();
162  virtual void UpdateTilt(double time);
163  virtual void EndTilt();
164  virtual void SetDistance(double value);
165  virtual double GetDistance();
166  virtual void UpdateDistance(double time);
167  virtual void EndDistance();
168  void SetRenderer(vtkRenderer* ren) override;
169 
170  // Enums are used to describe what is selected
172  {
173  Outside = 0,
181  DistanceAdjusting
182  };
183 #if !defined(VTK_LEGACY_REMOVE)
184  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
186 #endif
187 
188 protected:
191 
192  // Positioning the widget
195 
196  // radius values
197  double InnerRadius;
198  double OuterRadius;
199 
200  // tilt and distance rep
201 
204 
205  // Define the geometry. It is constructed in canaonical position
206  // along the x-axis and then rotated into position.
209 
215 
218 
223 
225 
226  // build the tube geometry
227  void BuildRing();
229 
230  // used for positioning etc
231  void GetCenterAndUnitRadius(int center[2], double& radius);
232 
234 
235  double Heading;
236  double Tilt;
237  double Distance;
238 
239 private:
241  void operator=(const vtkCompassRepresentation&) = delete;
242 };
243 
244 #endif
a actor that draws 2D data
Definition: vtkActor2D.h:155
object to represent cell connectivity
Definition: vtkCellArray.h:296
virtual void TiltWidgetInteraction(double eventPos[2])
Methods to interface with the vtkSliderWidget.
virtual void SetTilt(double value)
static vtkCompassRepresentation * New()
Instantiate the class.
virtual double GetDistance()
vtkSmartPointer< vtkCenteredSliderRepresentation > TiltRepresentation
virtual void SetHeading(double value)
virtual void UpdateTilt(double time)
virtual double GetHeading()
vtkCoordinate * GetPoint2Coordinate()
Position the second end point of the slider.
vtkPolyDataMapper2D * RingMapper
vtkCoordinate * GetPoint1Coordinate()
Position the first end point of the slider.
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
int ComputeInteractionState(int X, int Y, int modify=0) override
Methods to interface with the vtkSliderWidget.
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)
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
a simple class to control print indentation
Definition: vtkIndent.h:119
represent and manipulate 3D points
Definition: vtkPoints.h:149
draw vtkPolyData onto the image plane
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:200
an ordered list of Props
represent surface properties of a 2D image
abstract specification for renderers
Definition: vtkRenderer.h:182
An actor that displays text.
Definition: vtkTextActor.h:166
represent text properties.
transform points and associated normals and vectors for polygonal dataset
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:170
abstract specification for Viewports
Definition: vtkViewport.h:56
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
@ value
Definition: vtkX3D.h:226
@ time
Definition: vtkX3D.h:503
@ center
Definition: vtkX3D.h:236
@ radius
Definition: vtkX3D.h:258
#define VTK_DEPRECATED_IN_9_2_0(reason)