VTK
vtkDistanceRepresentation3D.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkDistanceRepresentation3D.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 =========================================================================*/
29 #ifndef vtkDistanceRepresentation3D_h
30 #define vtkDistanceRepresentation3D_h
31 
32 #include "vtkInteractionWidgetsModule.h" // For export macro
34 
35 class vtkPoints;
36 class vtkPolyData;
37 class vtkPolyDataMapper;
38 class vtkActor;
39 class vtkVectorText;
40 class vtkFollower;
41 class vtkBox;
42 class vtkCylinderSource;
43 class vtkGlyph3D;
44 class vtkDoubleArray;
46 class vtkProperty;
47 
48 
49 class VTKINTERACTIONWIDGETS_EXPORT vtkDistanceRepresentation3D : public vtkDistanceRepresentation
50 {
51 public:
56 
58 
62  void PrintSelf(ostream& os, vtkIndent indent) override;
64 
68  double GetDistance() override
69  {return this->Distance;}
70 
72 
76  void SetGlyphScale(double scale);
77  vtkGetMacro(GlyphScale, double);
79 
83  virtual vtkProperty *GetLineProperty();
84 
86 
90  void SetLabelPosition(double labelPosition);
91  vtkGetMacro(LabelPosition, double);
93 
95 
98  vtkSetClampMacro(MaximumNumberOfRulerTicks, int, 1, VTK_INT_MAX);
99  vtkGetMacro(MaximumNumberOfRulerTicks, int);
101 
103 
107  vtkGetObjectMacro(GlyphActor, vtkActor);
109 
111 
115  vtkGetObjectMacro(LabelActor, vtkFollower);
116  virtual void SetLabelActor(vtkFollower *);
118 
120 
125  double* GetPoint1WorldPosition() override;
126  double* GetPoint2WorldPosition() override;
127  void GetPoint1WorldPosition(double pos[3]) override;
128  void GetPoint2WorldPosition(double pos[3]) override;
129  void SetPoint1WorldPosition(double pos[3]) override;
130  void SetPoint2WorldPosition(double pos[3]) override;
132 
133  void SetPoint1DisplayPosition(double pos[3]) override;
134  void SetPoint2DisplayPosition(double pos[3]) override;
135  void GetPoint1DisplayPosition(double pos[3]) override;
136  void GetPoint2DisplayPosition(double pos[3]) override;
137 
139 
142  void BuildRepresentation() override;
143  double *GetBounds() override;
145 
147 
150  void ReleaseGraphicsResources(vtkWindow *w) override;
151  int RenderOpaqueGeometry(vtkViewport *viewport) override;
152  int RenderTranslucentPolygonalGeometry(vtkViewport *viewport) override;
154 
156 
160  void SetLabelScale(double x, double y, double z)
161  {
162  double scale[3];
163  scale[0] = x;
164  scale[1] = y;
165  scale[2] = z;
166  this->SetLabelScale(scale);
167  }
168  virtual void SetLabelScale( double scale[3] );
169  virtual double * GetLabelScale();
171 
175  virtual vtkProperty *GetLabelProperty();
176 
177 protected:
179  ~vtkDistanceRepresentation3D() override;
180 
181  // The line
186 
187  // The distance label
191 
192  // Support internal operations
194 
195  // The 3D disk tick marks
204 
205  // Glyph3D scale
206  double GlyphScale;
208 
209  // The distance between the two points
210  double Distance;
211 
212  // Support GetBounds() method
214 
215  // Maximum number of ticks on the 3d ruler
217 
218  // Label title position
220 
221 private:
223  void operator=(const vtkDistanceRepresentation3D&) = delete;
224 
225  // Internal method to update the position of the label.
226  void UpdateLabelPosition();
227 };
228 
229 #endif
vtkPolyDataMapper
map vtkPolyData to graphics primitives
Definition: vtkPolyDataMapper.h:36
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
vtkDistanceRepresentation3D::LinePolyData
vtkPolyData * LinePolyData
Definition: vtkDistanceRepresentation3D.h:183
vtkDistanceRepresentation3D::LabelPosition
double LabelPosition
Definition: vtkDistanceRepresentation3D.h:219
vtkDistanceRepresentation3D::GlyphPolyData
vtkPolyData * GlyphPolyData
Definition: vtkDistanceRepresentation3D.h:198
vtkFollower
a subclass of actor that always faces the camera
Definition: vtkFollower.h:40
VTK_INT_MAX
#define VTK_INT_MAX
Definition: vtkType.h:159
vtkDistanceRepresentation3D::MaximumNumberOfRulerTicks
int MaximumNumberOfRulerTicks
Definition: vtkDistanceRepresentation3D.h:216
vtkDistanceRepresentation3D::LabelText
vtkVectorText * LabelText
Definition: vtkDistanceRepresentation3D.h:188
vtkX3D::scale
Definition: vtkX3D.h:229
vtkDistanceRepresentation3D::BoundingBox
vtkBox * BoundingBox
Definition: vtkDistanceRepresentation3D.h:213
vtkDistanceRepresentation::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkDistanceRepresentation::GetPoint1DisplayPosition
virtual void GetPoint1DisplayPosition(double pos[3])=0
vtkDistanceRepresentation.h
vtkDistanceRepresentation3D::Distance
double Distance
Definition: vtkDistanceRepresentation3D.h:210
vtkVectorText
create polygonal text
Definition: vtkVectorText.h:41
vtkDistanceRepresentation3D::LinePoints
vtkPoints * LinePoints
Definition: vtkDistanceRepresentation3D.h:182
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:34
vtkDistanceRepresentation3D::LabelActor
vtkFollower * LabelActor
Definition: vtkDistanceRepresentation3D.h:190
vtkWidgetRepresentation::RenderTranslucentPolygonalGeometry
int RenderTranslucentPolygonalGeometry(vtkViewport *vtkNotUsed(viewport)) override
Definition: vtkWidgetRepresentation.h:223
vtkWidgetRepresentation::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
Definition: vtkWidgetRepresentation.h:220
vtkWidgetRepresentation::GetBounds
double * GetBounds() override
Methods to make this class behave as a vtkProp.
Definition: vtkWidgetRepresentation.h:215
vtkDistanceRepresentation
represent the vtkDistanceWidget
Definition: vtkDistanceRepresentation.h:36
vtkDistanceRepresentation3D::Glyph3D
vtkGlyph3D * Glyph3D
Definition: vtkDistanceRepresentation3D.h:201
vtkDistanceRepresentation3D::LabelScaleSpecified
bool LabelScaleSpecified
Definition: vtkDistanceRepresentation3D.h:193
vtkDistanceRepresentation3D
represent the vtkDistanceWidget
Definition: vtkDistanceRepresentation3D.h:49
vtkDistanceRepresentation3D::LineActor
vtkActor * LineActor
Definition: vtkDistanceRepresentation3D.h:185
vtkDistanceRepresentation::BuildRepresentation
void BuildRepresentation() override
These are methods that satisfy vtkWidgetRepresentation's API.
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:45
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkDistanceRepresentation::SetPoint1WorldPosition
virtual void SetPoint1WorldPosition(double pos[3])=0
vtkDistanceRepresentation3D::GlyphPoints
vtkPoints * GlyphPoints
Definition: vtkDistanceRepresentation3D.h:196
vtkCylinderSource
generate a cylinder centered at origin
Definition: vtkCylinderSource.h:36
vtkTransformPolyDataFilter
transform points and associated normals and vectors for polygonal dataset
Definition: vtkTransformPolyDataFilter.h:45
vtkDistanceRepresentation3D::GlyphCylinder
vtkCylinderSource * GlyphCylinder
Definition: vtkDistanceRepresentation3D.h:199
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:44
vtkDistanceRepresentation3D::LabelMapper
vtkPolyDataMapper * LabelMapper
Definition: vtkDistanceRepresentation3D.h:189
vtkDistanceRepresentation3D::GlyphActor
vtkActor * GlyphActor
Definition: vtkDistanceRepresentation3D.h:203
vtkGlyph3D
copy oriented and scaled glyph geometry to every input point
Definition: vtkGlyph3D.h:105
vtkDistanceRepresentation3D::GlyphScale
double GlyphScale
Definition: vtkDistanceRepresentation3D.h:206
vtkDistanceRepresentation3D::GlyphVectors
vtkDoubleArray * GlyphVectors
Definition: vtkDistanceRepresentation3D.h:197
vtkBox
implicit function for a bounding box
Definition: vtkBox.h:38
vtkDistanceRepresentation3D::GlyphMapper
vtkPolyDataMapper * GlyphMapper
Definition: vtkDistanceRepresentation3D.h:202
vtkWidgetRepresentation::RenderOpaqueGeometry
int RenderOpaqueGeometry(vtkViewport *vtkNotUsed(viewport)) override
Definition: vtkWidgetRepresentation.h:222
vtkDistanceRepresentation3D::GlyphXForm
vtkTransformPolyDataFilter * GlyphXForm
Definition: vtkDistanceRepresentation3D.h:200
vtkDistanceRepresentation3D::GlyphScaleSpecified
bool GlyphScaleSpecified
Definition: vtkDistanceRepresentation3D.h:207
vtkDistanceRepresentation::GetPoint2WorldPosition
virtual double * GetPoint2WorldPosition()=0
vtkDistanceRepresentation::GetPoint1WorldPosition
virtual double * GetPoint1WorldPosition()=0
vtkDistanceRepresentation::SetPoint2WorldPosition
virtual void SetPoint2WorldPosition(double pos[3])=0
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:79
vtkDoubleArray
dynamic, self-adjusting array of double
Definition: vtkDoubleArray.h:35
vtkDistanceRepresentation::GetPoint2DisplayPosition
virtual void GetPoint2DisplayPosition(double pos[3])=0
vtkProperty
represent surface properties of a geometric object
Definition: vtkProperty.h:60
vtkDistanceRepresentation::SetPoint2DisplayPosition
virtual void SetPoint2DisplayPosition(double pos[3])=0
vtkDistanceRepresentation3D::GetDistance
double GetDistance() override
Satisfy the superclasses API.
Definition: vtkDistanceRepresentation3D.h:68
vtkDistanceRepresentation3D::LineMapper
vtkPolyDataMapper * LineMapper
Definition: vtkDistanceRepresentation3D.h:184
vtkDistanceRepresentation3D::SetLabelScale
void SetLabelScale(double x, double y, double z)
Scale text (font size along each dimension).
Definition: vtkDistanceRepresentation3D.h:160
vtkDistanceRepresentation::SetPoint1DisplayPosition
virtual void SetPoint1DisplayPosition(double pos[3])=0