VTK  9.3.1
vtkPicker.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
35 #ifndef vtkPicker_h
36 #define vtkPicker_h
37 
38 #include "vtkAbstractPropPicker.h"
39 #include "vtkRenderingCoreModule.h" // For export macro
40 
41 VTK_ABI_NAMESPACE_BEGIN
44 class vtkDataSet;
45 class vtkTransform;
46 class vtkActorCollection;
48 class vtkPoints;
49 
50 class VTKRENDERINGCORE_EXPORT vtkPicker : public vtkAbstractPropPicker
51 {
52 public:
53  static vtkPicker* New();
55  void PrintSelf(ostream& os, vtkIndent indent) override;
56 
58 
63  vtkSetMacro(Tolerance, double);
64  vtkGetMacro(Tolerance, double);
66 
68 
72  vtkGetVectorMacro(MapperPosition, double, 3);
74 
76 
79  vtkGetObjectMacro(Mapper, vtkAbstractMapper3D);
81 
83 
87  vtkGetObjectMacro(DataSet, vtkDataSet);
89 
91 
95  vtkGetObjectMacro(CompositeDataSet, vtkCompositeDataSet);
97 
99 
104  vtkGetMacro(FlatBlockIndex, vtkIdType);
106 
111  vtkProp3DCollection* GetProp3Ds() { return this->Prop3Ds; }
112 
118  vtkActorCollection* GetActors();
119 
125  vtkPoints* GetPickedPositions() { return this->PickedPositions; }
126 
133  int Pick(double selectionX, double selectionY, double selectionZ, vtkRenderer* renderer) override;
134 
140  int Pick(double selectionPt[3], vtkRenderer* ren)
141  {
142  return this->Pick(selectionPt[0], selectionPt[1], selectionPt[2], ren);
143  }
144 
150  int Pick3DPoint(double selectionPt[3], vtkRenderer* ren) override;
151 
152  /*
153  * Pick a point in the scene with the selection point and focal point
154  * provided. The two points are in world coordinates.
155  *
156  * Returns non-zero if something was successfully picked.
157  */
158  virtual int Pick3DPoint(double p1World[3], double p2World[3], vtkRenderer* ren);
164  int Pick3DRay(double selectionPt[3], double orient[4], vtkRenderer* ren) override;
165 
166 protected:
167  vtkPicker();
168  ~vtkPicker() override;
169 
170  // shared code for picking
171  virtual int Pick3DInternal(vtkRenderer* ren, double p1World[4], double p2World[4]);
172 
173  void MarkPicked(
174  vtkAssemblyPath* path, vtkProp3D* p, vtkAbstractMapper3D* m, double tMin, double mapperPos[3]);
175  void MarkPickedData(vtkAssemblyPath* path, double tMin, double mapperPos[3],
176  vtkAbstractMapper3D* mapper, vtkDataSet* input, vtkIdType flatBlockIndex = -1);
177  virtual double IntersectWithLine(const double p1[3], const double p2[3], double tol,
179  void Initialize() override;
180  static bool CalculateRay(
181  const double p1[3], const double p2[3], double ray[3], double& rayFactor);
182 
183  double Tolerance; // tolerance for computation (% of window)
184  double MapperPosition[3]; // selection point in untransformed coordinates
185 
186  vtkAbstractMapper3D* Mapper; // selected mapper (if the prop has a mapper)
187  vtkDataSet* DataSet; // selected dataset (if there is one)
189  vtkIdType FlatBlockIndex; // flat block index, for a composite data set
190 
191  double GlobalTMin; // parametric coordinate along pick ray where hit occurred
192  vtkTransform* Transform; // use to perform ray transformation
193  vtkActorCollection* Actors; // candidate actors (based on bounding box)
194  vtkProp3DCollection* Prop3Ds; // candidate actors (based on bounding box)
195  vtkPoints* PickedPositions; // candidate positions
196 
197 private:
198  vtkPicker(const vtkPicker&) = delete;
199  void operator=(const vtkPicker&) = delete;
200 };
201 
202 VTK_ABI_NAMESPACE_END
203 #endif
vtkIdType FlatBlockIndex
Definition: vtkPicker.h:189
double Tolerance
Definition: vtkPicker.h:183
abstract class to specify dataset behavior
Definition: vtkDataSet.h:52
vtkPoints * PickedPositions
Definition: vtkPicker.h:195
abstract specification for renderers
Definition: vtkRenderer.h:61
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:49
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:38
vtkActorCollection * Actors
Definition: vtkPicker.h:193
int vtkIdType
Definition: vtkType.h:315
virtual int Pick3DPoint(double[3], vtkRenderer *)
Perform pick operation with selection point provided.
superclass for 3D geometric pickers (uses ray cast)
Definition: vtkPicker.h:50
void Initialize() override
int Pick(double selectionPt[3], vtkRenderer *ren)
Perform pick operation with selection point provided.
Definition: vtkPicker.h:140
vtkTransform * Transform
Definition: vtkPicker.h:192
vtkProp3DCollection * GetProp3Ds()
Return a collection of all the prop 3D's that were intersected by the pick ray.
Definition: vtkPicker.h:111
abstract superclass for composite (multi-block or AMR) datasets
a list of nodes that form an assembly path
vtkPoints * GetPickedPositions()
Return a list of the points the actors returned by GetProp3Ds were intersected at.
Definition: vtkPicker.h:125
a simple class to control print indentation
Definition: vtkIndent.h:28
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
std::map< std::string, DataArray > DataSet
key: variable name, value: DataArray
Definition: VTXTypes.h:28
vtkProp3DCollection * Prop3Ds
Definition: vtkPicker.h:194
abstract class specifies interface to map 3D data
an ordered list of 3D props
vtkCompositeDataSet * CompositeDataSet
Definition: vtkPicker.h:188
an ordered list of actors
abstract API for pickers that can pick an instance of vtkProp
virtual int Pick(double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer)=0
Perform pick operation with selection point provided.
virtual int Pick3DRay(double[3], double[4], vtkRenderer *)
Perform pick operation with selection point and orientation provided.
vtkAbstractMapper3D * Mapper
Definition: vtkPicker.h:186
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
double GlobalTMin
Definition: vtkPicker.h:191
represent and manipulate 3D points
Definition: vtkPoints.h:28
vtkDataSet * DataSet
Definition: vtkPicker.h:187