VTK  9.2.6
vtkLineRepresentation.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkLineRepresentation.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=========================================================================*/
37
38#ifndef vtkLineRepresentation_h
39#define vtkLineRepresentation_h
40
41#include "vtkInteractionWidgetsModule.h" // For export macro
43
44class vtkActor;
45class vtkConeSource;
47class vtkLineSource;
48class vtkProperty;
49class vtkPolyData;
52class vtkBox;
53class vtkFollower;
54class vtkVectorText;
56class vtkCellPicker;
57
58class VTKINTERACTIONWIDGETS_EXPORT vtkLineRepresentation : public vtkWidgetRepresentation
59{
60public:
65
67
71 void PrintSelf(ostream& os, vtkIndent indent) override;
73
75
80 void GetPoint1WorldPosition(double pos[3]);
82 void GetPoint1DisplayPosition(double pos[3]);
84 void SetPoint1WorldPosition(double pos[3]);
85 void SetPoint1DisplayPosition(double pos[3]);
86 void GetPoint2DisplayPosition(double pos[3]);
88 void GetPoint2WorldPosition(double pos[3]);
90 void SetPoint2WorldPosition(double pos[3]);
91 void SetPoint2DisplayPosition(double pos[3]);
93
95
108
110
117
119
123 vtkGetObjectMacro(EndPointProperty, vtkProperty);
126
128
132 vtkGetObjectMacro(EndPoint2Property, vtkProperty);
135
137
141 vtkGetObjectMacro(LineProperty, vtkProperty);
144
146
151 vtkSetClampMacro(Tolerance, int, 1, 100);
152 vtkGetMacro(Tolerance, int);
154
156
161 void SetResolution(int res);
164
174
176
179 void PlaceWidget(double bounds[6]) override;
180 void BuildRepresentation() override;
181 int ComputeInteractionState(int X, int Y, int modify = 0) override;
182 void StartWidgetInteraction(double e[2]) override;
183 void WidgetInteraction(double e[2]) override;
184 double* GetBounds() VTK_SIZEHINT(6) override;
186
188
191 void GetActors(vtkPropCollection* pc) override;
197
198 // Manage the state of the widget
199 enum
200 {
208 };
209
211
220 vtkSetClampMacro(InteractionState, int, Outside, Scaling);
222
224
228 virtual void SetRepresentationState(int);
229 vtkGetMacro(RepresentationState, int);
231
233
237 void SetDirectionalLine(bool val);
238 vtkGetMacro(DirectionalLine, bool);
239 vtkBooleanMacro(DirectionalLine, bool);
241
247
251 void SetRenderer(vtkRenderer* ren) override;
252
254
261
263
268 vtkSetStringMacro(DistanceAnnotationFormat);
269 vtkGetStringMacro(DistanceAnnotationFormat);
271
273
276 void SetDistanceAnnotationScale(double x, double y, double z)
277 {
278 double scale[3];
279 scale[0] = x;
280 scale[1] = y;
281 scale[2] = z;
282 this->SetDistanceAnnotationScale(scale);
283 }
284 virtual void SetDistanceAnnotationScale(double scale[3]);
287
291 double GetDistance();
292
297 void SetLineColor(double r, double g, double b);
298
303
305
308 vtkGetObjectMacro(TextActor, vtkFollower);
310
311 enum
312 {
317 };
318
319protected:
322
323 // The handle and the rep used to close the handles
328
329 // Manage how the representation appears
332
333 // the line
337
338 // glyphs representing hot spots (e.g., handles)
342
343 // Properties used to control the appearance of selected objects and
344 // the manipulator in general.
352
353 // Selection tolerance for the handles and the line
355
356 // Helper members
358 void ClampPosition(double x[3]);
359 void HighlightPoint(int ptId, int highlight);
360 void HighlightLine(int highlight);
361 int InBounds(double x[3]);
363
364 // Ivars used during widget interaction to hold initial positions
365 double StartP1[3];
366 double StartP2[3];
368 double Length;
370
371 // Support GetBounds() method
373
374 // Need to keep track if we have successfully initialized the display position.
375 // The widget tends to do stuff in world coordinates, put if the renderer has
376 // not been assigned, then certain operations do not properly update the display
377 // position.
379
380 // Format for the label
383
387 double Distance;
389
391
392private:
394 void operator=(const vtkLineRepresentation&) = delete;
395};
396
397#endif
represents an object (geometry & properties) in a rendered scene
Definition vtkActor.h:46
implicit function for a bounding box
Definition vtkBox.h:39
ray-cast cell picker for all kinds of Prop3Ds
generate polygonal cone
a subclass of actor that always faces the camera
Definition vtkFollower.h:41
a simple class to control print indentation
Definition vtkIndent.h:34
void SetDirectionalLine(bool val)
Sets the representation to be a directional line with point 1 represented as a cone.
void InstantiateHandleRepresentation()
This method is used to specify the type of handle representation to use for the three internal vtkHan...
double * GetBounds() override
These are methods that satisfy vtkWidgetRepresentation's API.
void WidgetInteraction(double e[2]) override
These are methods that satisfy vtkWidgetRepresentation's API.
vtkTypeBool HasTranslucentPolygonalGeometry() override
Methods supporting the rendering process.
vtkPolyDataMapper * TextMapper
void ReleaseGraphicsResources(vtkWindow *) override
Methods supporting the rendering process.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for the class.
static vtkLineRepresentation * New()
Instantiate the class.
virtual void SetDistanceAnnotationScale(double scale[3])
Scale text (font size along each dimension).
void PlaceWidget(double bounds[6]) override
These are methods that satisfy vtkWidgetRepresentation's API.
void GetPoint2DisplayPosition(double pos[3])
Methods to Set/Get the coordinates of the two points defining this representation.
void SetDistanceAnnotationScale(double x, double y, double z)
Scale text (font size along each dimension).
vtkPointHandleRepresentation3D * Point1Representation
void ClampPosition(double x[3])
virtual void SetRepresentationState(int)
Sets the visual appearance of the representation based on the state it is in.
void GetPoint2WorldPosition(double pos[3])
Methods to Set/Get the coordinates of the two points defining this representation.
void SetPoint1DisplayPosition(double pos[3])
Methods to Set/Get the coordinates of the two points defining this representation.
void SetResolution(int res)
Set/Get the resolution (number of subdivisions) of the line.
vtkPolyDataMapper * LineMapper
vtkPointHandleRepresentation3D * LineHandleRepresentation
void SetPoint1WorldPosition(double pos[3])
Methods to Set/Get the coordinates of the two points defining this representation.
int RenderOpaqueGeometry(vtkViewport *) override
Methods supporting the rendering process.
double * GetPoint1WorldPosition()
Methods to Set/Get the coordinates of the two points defining this representation.
void GetPoint1DisplayPosition(double pos[3])
Methods to Set/Get the coordinates of the two points defining this representation.
int ComputeInteractionState(int X, int Y, int modify=0) override
These are methods that satisfy vtkWidgetRepresentation's API.
void SetRenderer(vtkRenderer *ren) override
Overridden to set the rendererer on the internal representations.
void GetActors(vtkPropCollection *pc) override
Methods supporting the rendering process.
void SetHandleRepresentation(vtkPointHandleRepresentation3D *handle)
This method is used to specify the type of handle representation to use for the three internal vtkHan...
void SetLineColor(double r, double g, double b)
Convenience method to set the line color.
vtkPolyDataAlgorithm ** HandleGeometry
virtual double * GetDistanceAnnotationScale()
Scale text (font size along each dimension).
virtual vtkProperty * GetDistanceAnnotationProperty()
Get the distance annotation property.
void HighlightLine(int highlight)
void HighlightPoint(int ptId, int highlight)
void GetPolyData(vtkPolyData *pd)
Retrieve the polydata (including points) that defines the line.
double GetDistance()
Get the distance between the points.
vtkPointHandleRepresentation3D * Point2Representation
vtkPointHandleRepresentation3D * HandleRepresentation
void StartWidgetInteraction(double e[2]) override
These are methods that satisfy vtkWidgetRepresentation's API.
vtkPolyDataMapper ** HandleMapper
int GetResolution()
Set/Get the resolution (number of subdivisions) of the line.
void SetPoint2DisplayPosition(double pos[3])
Methods to Set/Get the coordinates of the two points defining this representation.
void SetPoint2WorldPosition(double pos[3])
Methods to Set/Get the coordinates of the two points defining this representation.
vtkProperty * SelectedEndPoint2Property
~vtkLineRepresentation() override
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
Methods supporting the rendering process.
void GetPoint1WorldPosition(double pos[3])
Methods to Set/Get the coordinates of the two points defining this representation.
void BuildRepresentation() override
These are methods that satisfy vtkWidgetRepresentation's API.
vtkMTimeType GetMTime() override
Overload the superclasses' GetMTime() because internal classes are used to keep the state of the repr...
int InBounds(double x[3])
create a line defined by two end points
represent the position of a point in 3D space
Superclass for algorithms that produce only polydata as output.
map vtkPolyData to graphics primitives
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition vtkPolyData.h:85
an ordered list of Props
represent surface properties of a geometric object
Definition vtkProperty.h:62
abstract specification for renderers
Definition vtkRenderer.h:67
create polygonal text
abstract specification for Viewports
Definition vtkViewport.h:50
window superclass for vtkRenderWindow
Definition vtkWindow.h:39
int vtkTypeBool
Definition vtkABI.h:69
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287
#define VTK_SIZEHINT(...)