VTK  9.3.20240416
vtkAreaPicker.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
77 #ifndef vtkAreaPicker_h
78 #define vtkAreaPicker_h
79 
80 #include "vtkAbstractPropPicker.h"
81 #include "vtkRenderingCoreModule.h" // For export macro
82 
83 VTK_ABI_NAMESPACE_BEGIN
84 class vtkRenderer;
85 class vtkPoints;
86 class vtkPlanes;
89 class vtkDataSet;
91 class vtkProp;
92 
93 class VTKRENDERINGCORE_EXPORT vtkAreaPicker : public vtkAbstractPropPicker
94 {
95 public:
96  static vtkAreaPicker* New();
98  void PrintSelf(ostream& os, vtkIndent indent) override;
99 
103  void SetPickCoords(double x0, double y0, double x1, double y1);
104 
109 
113  virtual int Pick();
114 
120  virtual int AreaPick(double x0, double y0, double x1, double y1, vtkRenderer* renderer = nullptr);
121 
127  int Pick(double x0, double y0, double vtkNotUsed(z0), vtkRenderer* renderer = nullptr) override
128  {
129  return this->AreaPick(x0, y0, x0 + 1.0, y0 + 1.0, renderer);
130  }
131 
133 
136  vtkGetObjectMacro(Mapper, vtkAbstractMapper3D);
138 
140 
144  vtkGetObjectMacro(DataSet, vtkDataSet);
146 
151  vtkProp3DCollection* GetProp3Ds() { return this->Prop3Ds; }
152 
154 
159  vtkGetObjectMacro(Frustum, vtkPlanes);
161 
163 
166  vtkGetObjectMacro(ClipPoints, vtkPoints);
168 
169 protected:
171  ~vtkAreaPicker() override;
172 
173  void Initialize() override;
174  void DefineFrustum(double x0, double y0, double x1, double y1, vtkRenderer*);
175  virtual int PickProps(vtkRenderer* renderer);
177 
178  int ABoxFrustumIsect(double bounds[], double& mindist);
179 
182 
183  vtkProp3DCollection* Prop3Ds; // candidate actors (based on bounding box)
184  vtkAbstractMapper3D* Mapper; // selected mapper (if the prop has a mapper)
185  vtkDataSet* DataSet; // selected dataset (if there is one)
186 
187  // used internally to do prop intersection tests
189 
190  double X0;
191  double Y0;
192  double X1;
193  double Y1;
194 
195 private:
196  vtkAreaPicker(const vtkAreaPicker&) = delete;
197  void operator=(const vtkAreaPicker&) = delete;
198 };
199 
200 VTK_ABI_NAMESPACE_END
201 #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:94
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.
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:166
Returns the portion of the input dataset that lies within a selection frustum.
a simple class to control print indentation
Definition: vtkIndent.h:108
implicit function for convex set of planes
Definition: vtkPlanes.h:151
represent and manipulate 3D points
Definition: vtkPoints.h:139
an ordered list of 3D props
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:66
abstract specification for renderers
Definition: vtkRenderer.h:172
std::map< std::string, DataArray > DataSet
key: variable name, value: DataArray
Definition: VTXTypes.h:28