VTK
vtkPolygonalSurfacePointPlacer.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPolygonalSurfacePointPlacer.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 =========================================================================*/
35 #ifndef vtkPolygonalSurfacePointPlacer_h
36 #define vtkPolygonalSurfacePointPlacer_h
37 
38 #include "vtkInteractionWidgetsModule.h" // For export macro
39 #include "vtkPolyDataPointPlacer.h"
40 
42 class vtkCellPicker;
43 class vtkPolygonalSurfacePointPlacerInternals;
44 class vtkPolyData;
45 
46 // The Node stores information about the point. This information is used by
47 // the interpolator. Reusing this information avoids the need for a second
48 // pick operation to regenerate it. (Cellpickers are slow).
50 {
51  double WorldPosition[3];
55  double ParametricCoords[3]; // parametric coords within cell
57 };
58 
59 class VTKINTERACTIONWIDGETS_EXPORT vtkPolygonalSurfacePointPlacer
60  : public vtkPolyDataPointPlacer
61 {
62 public:
67 
69 
73  void PrintSelf(ostream& os, vtkIndent indent) override;
75 
76  // Descuription:
77  // Add /remove a prop, to place points on
78  void AddProp( vtkProp * ) override;
79  void RemoveViewProp(vtkProp *prop) override;
80  void RemoveAllProps() override;
81 
91  double displayPos[2],
92  double worldPos[3],
93  double worldOrient[9] ) override;
94 
102  double displayPos[2],
103  double refWorldPos[3],
104  double worldPos[3],
105  double worldOrient[9] ) override;
106 
111  int ValidateWorldPosition( double worldPos[3] ) override;
112 
116  int UpdateNodeWorldPosition( double worldPos[3],
117  vtkIdType nodePointId ) override;
118 
122  int ValidateDisplayPosition( vtkRenderer *, double displayPos[2] ) override;
123 
128  int ValidateWorldPosition( double worldPos[3],
129  double worldOrient[9] ) override;
130 
132 
135  vtkGetObjectMacro( CellPicker, vtkCellPicker );
137 
139 
143  vtkGetObjectMacro( Polys, vtkPolyDataCollection );
145 
147 
152  vtkSetMacro( DistanceOffset, double );
153  vtkGetMacro( DistanceOffset, double );
155 
157 
163  vtkSetMacro( SnapToClosestPoint, vtkTypeBool );
164  vtkGetMacro( SnapToClosestPoint, vtkTypeBool );
165  vtkBooleanMacro( SnapToClosestPoint, vtkTypeBool );
167 
169 
173  Node *GetNodeAtWorldPosition( double worldPos[3] );
175 
176 protected:
178  ~vtkPolygonalSurfacePointPlacer() override;
179 
180  // The props that represents the terrain data (one or more) in a rendered
181  // scene
184  vtkPolygonalSurfacePointPlacerInternals *Internals;
187 
188 private:
190  void operator=(const vtkPolygonalSurfacePointPlacer&) = delete;
191 };
192 
193 #endif
vtkPolyDataCollection
maintain a list of polygonal data objects
Definition: vtkPolyDataCollection.h:34
vtkPolygonalSurfacePointPlacer::CellPicker
vtkCellPicker * CellPicker
Definition: vtkPolygonalSurfacePointPlacer.h:182
vtkPolyDataPointPlacer::New
static vtkPolyDataPointPlacer * New()
Instantiate this class.
vtkPolygonalSurfacePointPlacerNode::ParametricCoords
double ParametricCoords[3]
Definition: vtkPolygonalSurfacePointPlacer.h:55
vtkPolyDataPointPlacer::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkPolyDataPointPlacer::AddProp
virtual void AddProp(vtkProp *)
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkPolyDataPointPlacer::ValidateDisplayPosition
int ValidateDisplayPosition(vtkRenderer *, double displayPos[2]) override
Given a display position, check the validity of this position.
vtkPolygonalSurfacePointPlacer::Polys
vtkPolyDataCollection * Polys
Definition: vtkPolygonalSurfacePointPlacer.h:183
vtkPolygonalSurfacePointPlacerNode
Definition: vtkPolygonalSurfacePointPlacer.h:49
vtkPolyDataPointPlacer::ValidateWorldPosition
int ValidateWorldPosition(double worldPos[3]) override
Given a world position check the validity of this position according to the constraints of the placer...
vtkPolygonalSurfacePointPlacerNode::PolyData
vtkPolyData * PolyData
Definition: vtkPolygonalSurfacePointPlacer.h:56
vtkPolyDataPointPlacer::RemoveViewProp
virtual void RemoveViewProp(vtkProp *prop)
vtkPolygonalSurfacePointPlacer::SnapToClosestPoint
vtkTypeBool SnapToClosestPoint
Definition: vtkPolygonalSurfacePointPlacer.h:186
vtkPolyDataPointPlacer.h
vtkPolygonalSurfacePointPlacer::Node
vtkPolygonalSurfacePointPlacerNode Node
Internally used by the interpolator.
Definition: vtkPolygonalSurfacePointPlacer.h:165
vtkPolyDataPointPlacer::ComputeWorldPosition
int ComputeWorldPosition(vtkRenderer *ren, double displayPos[2], double worldPos[3], double worldOrient[9]) override
Given a renderer and a display position in pixel coordinates, compute the world position and orientat...
vtkPolygonalSurfacePointPlacerNode::SurfaceWorldPosition
double SurfaceWorldPosition[3]
Definition: vtkPolygonalSurfacePointPlacer.h:52
vtkPolyDataPointPlacer
Base class to place points given constraints on polygonal data.
Definition: vtkPolyDataPointPlacer.h:45
vtkPolygonalSurfacePointPlacerNode::CellId
vtkIdType CellId
Definition: vtkPolygonalSurfacePointPlacer.h:53
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkPolyDataPointPlacer::RemoveAllProps
virtual void RemoveAllProps()
vtkPolygonalSurfacePointPlacerNode::PointId
vtkIdType PointId
Definition: vtkPolygonalSurfacePointPlacer.h:54
vtkPolygonalSurfacePointPlacerNode::WorldPosition
double WorldPosition[3]
Definition: vtkPolygonalSurfacePointPlacer.h:51
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:52
vtkPolygonalSurfacePointPlacer::DistanceOffset
double DistanceOffset
Definition: vtkPolygonalSurfacePointPlacer.h:185
vtkRenderer
abstract specification for renderers
Definition: vtkRenderer.h:63
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:85
vtkCellPicker
ray-cast cell picker for all kinds of Prop3Ds
Definition: vtkCellPicker.h:69
vtkPointPlacer::UpdateNodeWorldPosition
virtual int UpdateNodeWorldPosition(double worldPos[3], vtkIdType nodePointId)
Give the placer a chance to update the node information, if any.
vtkPolygonalSurfacePointPlacer
Place points on the surface of polygonal data.
Definition: vtkPolygonalSurfacePointPlacer.h:59
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkPolygonalSurfacePointPlacer::Internals
vtkPolygonalSurfacePointPlacerInternals * Internals
Definition: vtkPolygonalSurfacePointPlacer.h:184