VTK  9.0.2
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 "vtkGeovisCoreModule.h" // For export macro
36 #include "vtkSmartPointer.h" // used for SmartPointers
37 
38 class vtkActor2D;
39 class vtkPoints;
40 class vtkCellArray;
41 class vtkPolyData;
43 class vtkCoordinate;
44 class vtkProperty2D;
45 class vtkPropCollection;
46 class vtkWindow;
47 class vtkViewport;
48 class vtkTransform;
50 class vtkTextProperty;
51 class vtkTextActor;
52 
54 {
55 public:
60 
62 
66  void PrintSelf(ostream& os, vtkIndent indent) override;
68 
78 
88 
90 
94  vtkGetObjectMacro(RingProperty, vtkProperty2D);
96 
98 
102  vtkGetObjectMacro(SelectedProperty, vtkProperty2D);
104 
106 
109  vtkGetObjectMacro(LabelProperty, vtkTextProperty);
111 
113 
118  void PlaceWidget(double bounds[6]) override;
119  void BuildRepresentation() override;
120  void StartWidgetInteraction(double eventPos[2]) override;
121  void WidgetInteraction(double eventPos[2]) override;
122  virtual void TiltWidgetInteraction(double eventPos[2]);
123  virtual void DistanceWidgetInteraction(double eventPos[2]);
124  int ComputeInteractionState(int X, int Y, int modify = 0) override;
125  void Highlight(int) override;
127 
129 
132  void GetActors(vtkPropCollection*) override;
134  int RenderOverlay(vtkViewport*) override;
137 
138  virtual void SetHeading(double value);
139  virtual double GetHeading();
140  virtual void SetTilt(double value);
141  virtual double GetTilt();
142  virtual void UpdateTilt(double time);
143  virtual void EndTilt();
144  virtual void SetDistance(double value);
145  virtual double GetDistance();
146  virtual void UpdateDistance(double time);
147  virtual void EndDistance();
148  void SetRenderer(vtkRenderer* ren) override;
149 
150  // Enums are used to describe what is selected
152  {
153  Outside = 0,
161  DistanceAdjusting
162  };
163 
164 protected:
167 
168  // Positioning the widget
171 
172  // radius values
173  double InnerRadius;
174  double OuterRadius;
175 
176  // tilt and distance rep
177 
180 
181  // Define the geometry. It is constructed in canaonical position
182  // along the x-axis and then rotated into position.
185 
191 
194 
199 
201 
202  // build the tube geometry
203  void BuildRing();
205 
206  // used for positioning etc
207  void GetCenterAndUnitRadius(int center[2], double& radius);
208 
210 
211  double Heading;
212  double Tilt;
213  double Distance;
214 
215 private:
217  void operator=(const vtkCompassRepresentation&) = delete;
218 };
219 
220 #endif
a actor that draws 2D data
Definition: vtkActor2D.h:40
object to represent cell connectivity
Definition: vtkCellArray.h:180
virtual void TiltWidgetInteraction(double eventPos[2])
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
void WidgetInteraction(double eventPos[2]) override
~vtkCompassRepresentation() override
int ComputeInteractionState(int X, int Y, int modify=0) override
virtual void EndTilt()
void Highlight(int) override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetRenderer(vtkRenderer *ren) override
Subclasses of vtkWidgetRepresentation must implement these methods.
vtkTransformPolyDataFilter * RingXForm
virtual void DistanceWidgetInteraction(double eventPos[2])
void BuildRepresentation() override
virtual double GetTilt()
int RenderOpaqueGeometry(vtkViewport *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
void GetActors(vtkPropCollection *) override
Methods supporting the rendering process.
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
void StartWidgetInteraction(double eventPos[2]) override
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
Definition: vtkCoordinate.h:77
a simple class to control print indentation
Definition: vtkIndent.h:34
represent and manipulate 3D points
Definition: vtkPoints.h:34
draw vtkPolyData onto the image plane
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:85
an ordered list of Props
represent surface properties of a 2D image
Definition: vtkProperty2D.h:38
abstract specification for renderers
Definition: vtkRenderer.h:68
An actor that displays text.
Definition: vtkTextActor.h:51
represent text properties.
transform points and associated normals and vectors for polygonal dataset
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:55
abstract specification for Viewports
Definition: vtkViewport.h:45
window superclass for vtkRenderWindow
Definition: vtkWindow.h:38
@ value
Definition: vtkX3D.h:226
@ time
Definition: vtkX3D.h:503
@ center
Definition: vtkX3D.h:236
@ radius
Definition: vtkX3D.h:258