VTK
vtkPicker.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPicker.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 =========================================================================*/
44 #ifndef vtkPicker_h
45 #define vtkPicker_h
46 
47 #include "vtkRenderingCoreModule.h" // For export macro
48 #include "vtkAbstractPropPicker.h"
49 
51 class vtkDataSet;
52 class vtkTransform;
53 class vtkActorCollection;
55 class vtkPoints;
56 
57 class VTKRENDERINGCORE_EXPORT vtkPicker : public vtkAbstractPropPicker
58 {
59 public:
60  static vtkPicker *New();
62  void PrintSelf(ostream& os, vtkIndent indent);
63 
65 
70  vtkSetMacro(Tolerance, double);
71  vtkGetMacro(Tolerance, double);
73 
75 
79  vtkGetVectorMacro(MapperPosition, double, 3);
81 
83 
86  vtkGetObjectMacro(Mapper, vtkAbstractMapper3D);
88 
90 
94  vtkGetObjectMacro(DataSet, vtkDataSet);
96 
102  { return this->Prop3Ds; }
103 
109  vtkActorCollection *GetActors();
110 
117  { return this->PickedPositions; }
118 
125  virtual int Pick(double selectionX, double selectionY, double selectionZ,
126  vtkRenderer *renderer);
127 
133  int Pick(double selectionPt[3], vtkRenderer *ren)
134  { return this->Pick(selectionPt[0], selectionPt[1], selectionPt[2], ren); }
135 
136 protected:
137  vtkPicker();
138  ~vtkPicker();
139 
140  void MarkPicked(vtkAssemblyPath *path, vtkProp3D *p, vtkAbstractMapper3D *m,
141  double tMin, double mapperPos[3]);
142  virtual double IntersectWithLine(double p1[3], double p2[3], double tol,
143  vtkAssemblyPath *path, vtkProp3D *p,
145  virtual void Initialize();
146 
147  double Tolerance; //tolerance for computation (% of window)
148  double MapperPosition[3]; //selection point in untransformed coordinates
149 
150  vtkAbstractMapper3D *Mapper; //selected mapper (if the prop has a mapper)
151  vtkDataSet *DataSet; //selected dataset (if there is one)
152 
153  double GlobalTMin; //parametric coordinate along pick ray where hit occurred
154  vtkTransform *Transform; //use to perform ray transformation
155  vtkActorCollection *Actors; //candidate actors (based on bounding box)
156  vtkProp3DCollection *Prop3Ds; //candidate actors (based on bounding box)
157  vtkPoints *PickedPositions; // candidate positions
158 
159 private:
160  vtkPicker(const vtkPicker&) VTK_DELETE_FUNCTION;
161  void operator=(const vtkPicker&) VTK_DELETE_FUNCTION;
162 };
163 
164 #endif
double Tolerance
Definition: vtkPicker.h:147
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkPoints * PickedPositions
Definition: vtkPicker.h:157
abstract specification for renderers
Definition: vtkRenderer.h:63
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:60
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:46
vtkActorCollection * Actors
Definition: vtkPicker.h:155
superclass for 3D geometric pickers (uses ray cast)
Definition: vtkPicker.h:57
int Pick(double selectionPt[3], vtkRenderer *ren)
Perform pick operation with selection point provided.
Definition: vtkPicker.h:133
vtkTransform * Transform
Definition: vtkPicker.h:154
vtkProp3DCollection * GetProp3Ds()
Return a collection of all the prop 3D's that were intersected by the pick ray.
Definition: vtkPicker.h:101
a list of nodes that form an assembly path
vtkPoints * GetPickedPositions()
Return a list of the points the the actors returned by GetProp3Ds were intersected at...
Definition: vtkPicker.h:116
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkProp3DCollection * Prop3Ds
Definition: vtkPicker.h:156
abstract class specifies interface to map 3D data
a list of 3D props
vtkSetMacro(IgnoreDriverBugs, bool)
When set known driver bugs are ignored during driver feature detection.
a 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.
vtkAbstractMapper3D * Mapper
Definition: vtkPicker.h:150
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
double GlobalTMin
Definition: vtkPicker.h:153
represent and manipulate 3D points
Definition: vtkPoints.h:39
vtkDataSet * DataSet
Definition: vtkPicker.h:151