VTK
vtkAreaPicker.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAreaPicker.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 =========================================================================*/
47 #ifndef vtkAreaPicker_h
48 #define vtkAreaPicker_h
49 
50 #include "vtkRenderingCoreModule.h" // For export macro
51 #include "vtkAbstractPropPicker.h"
52 
53 class vtkRenderer;
54 class vtkPoints;
55 class vtkPlanes;
58 class vtkDataSet;
60 class vtkProp;
61 
62 class VTKRENDERINGCORE_EXPORT vtkAreaPicker : public vtkAbstractPropPicker
63 {
64 public:
65  static vtkAreaPicker *New();
67  void PrintSelf(ostream& os, vtkIndent indent) override;
68 
72  void SetPickCoords(double x0, double y0, double x1, double y1);
73 
77  void SetRenderer(vtkRenderer *);
78 
82  virtual int Pick();
83 
89  virtual int AreaPick(double x0, double y0, double x1, double y1, vtkRenderer *renderer = nullptr);
90 
96  int Pick(double x0, double y0, double vtkNotUsed(z0), vtkRenderer *renderer = nullptr) override
97  { return this->AreaPick(x0, y0, x0+1.0, y0+1.0, renderer); }
98 
100 
103  vtkGetObjectMacro(Mapper, vtkAbstractMapper3D);
105 
107 
111  vtkGetObjectMacro(DataSet, vtkDataSet);
113 
119  { return this->Prop3Ds; }
120 
122 
127  vtkGetObjectMacro(Frustum, vtkPlanes);
129 
131 
134  vtkGetObjectMacro(ClipPoints, vtkPoints);
136 
137 protected:
138  vtkAreaPicker();
139  ~vtkAreaPicker() override;
140 
141  void Initialize() override;
142  void DefineFrustum(double x0, double y0, double x1, double y1, vtkRenderer *);
143  virtual int PickProps(vtkRenderer *renderer);
144  int TypeDecipher(vtkProp *, vtkAbstractMapper3D **);
145 
146  int ABoxFrustumIsect(double bounds[], double &mindist);
147 
150 
151  vtkProp3DCollection *Prop3Ds; //candidate actors (based on bounding box)
152  vtkAbstractMapper3D *Mapper; //selected mapper (if the prop has a mapper)
153  vtkDataSet *DataSet; //selected dataset (if there is one)
154 
155  //used internally to do prop intersection tests
157 
158  double X0;
159  double Y0;
160  double X1;
161  double Y1;
162 
163 private:
164  vtkAreaPicker(const vtkAreaPicker&) = delete;
165  void operator=(const vtkAreaPicker&) = delete;
166 };
167 
168 #endif
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:52
vtkProp3DCollection * GetProp3Ds()
Return a collection of all the prop 3D's that were intersected by the pick ray.
vtkAbstractMapper3D * Mapper
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
vtkProp3DCollection * Prop3Ds
implicit function for convex set of planes
Definition: vtkPlanes.h:55
abstract specification for renderers
Definition: vtkRenderer.h:63
void Initialize() override
vtkPlanes * Frustum
a simple class to control print indentation
Definition: vtkIndent.h:39
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int Pick(double x0, double y0, double vtkNotUsed(z0), vtkRenderer *renderer=nullptr) override
Perform pick operation in volume behind the given screen coordinate.
Definition: vtkAreaPicker.h:96
vtkDataSet * DataSet
abstract class specifies interface to map 3D data
vtkExtractSelectedFrustum * FrustumExtractor
an ordered list of 3D props
Returns the portion of the input dataset that lies within a selection frustum.
vtkPoints * ClipPoints
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.
Picks props behind a selection rectangle on a viewport.
Definition: vtkAreaPicker.h:62
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
represent and manipulate 3D points
Definition: vtkPoints.h:39