VTK  9.0.1
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 =========================================================================*/
44 #ifndef vtkAreaPicker_h
45 #define vtkAreaPicker_h
46 
47 #include "vtkAbstractPropPicker.h"
48 #include "vtkRenderingCoreModule.h" // For export macro
49 
50 class vtkRenderer;
51 class vtkPoints;
52 class vtkPlanes;
55 class vtkDataSet;
57 class vtkProp;
58 
59 class VTKRENDERINGCORE_EXPORT vtkAreaPicker : public vtkAbstractPropPicker
60 {
61 public:
62  static vtkAreaPicker* New();
64  void PrintSelf(ostream& os, vtkIndent indent) override;
65 
69  void SetPickCoords(double x0, double y0, double x1, double y1);
70 
75 
79  virtual int Pick();
80 
86  virtual int AreaPick(double x0, double y0, double x1, double y1, vtkRenderer* renderer = nullptr);
87 
93  int Pick(double x0, double y0, double vtkNotUsed(z0), vtkRenderer* renderer = nullptr) override
94  {
95  return this->AreaPick(x0, y0, x0 + 1.0, y0 + 1.0, renderer);
96  }
97 
99 
102  vtkGetObjectMacro(Mapper, vtkAbstractMapper3D);
104 
106 
110  vtkGetObjectMacro(DataSet, vtkDataSet);
112 
117  vtkProp3DCollection* GetProp3Ds() { return this->Prop3Ds; }
118 
120 
125  vtkGetObjectMacro(Frustum, vtkPlanes);
127 
129 
132  vtkGetObjectMacro(ClipPoints, vtkPoints);
134 
135 protected:
137  ~vtkAreaPicker() override;
138 
139  void Initialize() override;
140  void DefineFrustum(double x0, double y0, double x1, double y1, vtkRenderer*);
141  virtual int PickProps(vtkRenderer* renderer);
143 
144  int ABoxFrustumIsect(double bounds[], double& mindist);
145 
148 
149  vtkProp3DCollection* Prop3Ds; // candidate actors (based on bounding box)
150  vtkAbstractMapper3D* Mapper; // selected mapper (if the prop has a mapper)
151  vtkDataSet* DataSet; // selected dataset (if there is one)
152 
153  // used internally to do prop intersection tests
155 
156  double X0;
157  double Y0;
158  double X1;
159  double Y1;
160 
161 private:
162  vtkAreaPicker(const vtkAreaPicker&) = delete;
163  void operator=(const vtkAreaPicker&) = delete;
164 };
165 
166 #endif
abstract class specifies interface to map 3D data
abstract API for pickers that can pick an instance of vtkProp
Picks props behind a selection rectangle on a viewport.
Definition: vtkAreaPicker.h:60
int ABoxFrustumIsect(double bounds[], double &mindist)
void SetRenderer(vtkRenderer *)
Set the default renderer to pick on.
vtkAbstractMapper3D * Mapper
vtkPlanes * Frustum
virtual int Pick()
Perform an AreaPick within the default screen rectangle and renderer.
vtkDataSet * DataSet
static vtkAreaPicker * New()
void Initialize() override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual int PickProps(vtkRenderer *renderer)
vtkProp3DCollection * GetProp3Ds()
Return a collection of all the prop 3D's that were intersected by the pick ray.
void DefineFrustum(double x0, double y0, double x1, double y1, vtkRenderer *)
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:93
int TypeDecipher(vtkProp *, vtkAbstractMapper3D **)
virtual int AreaPick(double x0, double y0, double x1, double y1, vtkRenderer *renderer=nullptr)
Perform pick operation in volume behind the given screen coordinates.
void SetPickCoords(double x0, double y0, double x1, double y1)
Set the default screen rectangle to pick in.
vtkExtractSelectedFrustum * FrustumExtractor
vtkPoints * ClipPoints
~vtkAreaPicker() override
vtkProp3DCollection * Prop3Ds
abstract class to specify dataset behavior
Definition: vtkDataSet.h:57
Returns the portion of the input dataset that lies within a selection frustum.
a simple class to control print indentation
Definition: vtkIndent.h:34
implicit function for convex set of planes
Definition: vtkPlanes.h:50
represent and manipulate 3D points
Definition: vtkPoints.h:34
an ordered list of 3D props
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:48
abstract specification for renderers
Definition: vtkRenderer.h:59
std::map< std::string, DataArray > DataSet
key: variable name, value: DataArray
Definition: VTXTypes.h:39