VTK  9.3.0
vtkAbstractPicker.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
55 #ifndef vtkAbstractPicker_h
56 #define vtkAbstractPicker_h
57 
58 #include "vtkObject.h"
59 #include "vtkRenderingCoreModule.h" // For export macro
60 
61 VTK_ABI_NAMESPACE_BEGIN
62 class vtkRenderer;
63 class vtkProp;
64 class vtkPropCollection;
65 
66 class VTKRENDERINGCORE_EXPORT vtkAbstractPicker : public vtkObject
67 {
68 public:
69  vtkTypeMacro(vtkAbstractPicker, vtkObject);
70  void PrintSelf(ostream& os, vtkIndent indent) override;
71 
73 
76  vtkGetObjectMacro(Renderer, vtkRenderer);
78 
80 
84  vtkGetVectorMacro(SelectionPoint, double, 3);
86 
88 
91  vtkGetVectorMacro(PickPosition, double, 3);
93 
100  virtual int Pick(
101  double selectionX, double selectionY, double selectionZ, vtkRenderer* renderer) = 0;
102 
108  int Pick(double selectionPt[3], vtkRenderer* ren)
109  {
110  return this->Pick(selectionPt[0], selectionPt[1], selectionPt[2], ren);
111  }
112 
118  virtual int Pick3DPoint(double /* selectionPt */[3], vtkRenderer* /*ren*/)
119  {
120  vtkErrorMacro("Pick3DPoint called without implementation");
121  return 0;
122  }
123 
129  virtual int Pick3DRay(double /* selectionPt */[3], double /* orient */[4], vtkRenderer* /*ren*/)
130  {
131  vtkErrorMacro("Pick3DRay called without implementation");
132  return 0;
133  }
134 
136 
141  vtkSetMacro(PickFromList, vtkTypeBool);
142  vtkGetMacro(PickFromList, vtkTypeBool);
143  vtkBooleanMacro(PickFromList, vtkTypeBool);
145 
150 
155 
160 
164  vtkPropCollection* GetPickList() { return this->PickList; }
165 
166 protected:
168  ~vtkAbstractPicker() override;
169 
170  virtual void Initialize();
171 
172  vtkRenderer* Renderer; // pick occurred in this renderer's viewport
173  double SelectionPoint[3]; // selection point in window (pixel) coordinates
174  double PickPosition[3]; // selection point in world coordinates
175 
176  // use the following to control picking from a list
179 
180 private:
181  vtkAbstractPicker(const vtkAbstractPicker&) = delete;
182  void operator=(const vtkAbstractPicker&) = delete;
183 };
184 
185 VTK_ABI_NAMESPACE_END
186 #endif
define API for picking subclasses
vtkRenderer * Renderer
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkTypeBool PickFromList
virtual int Pick(double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer)=0
Perform pick operation with selection point provided.
virtual void Initialize()
virtual int Pick3DRay(double[3], double[4], vtkRenderer *)
Perform pick operation with selection point and orientation provided.
void DeletePickList(vtkProp *)
Delete an actor from the pick list.
~vtkAbstractPicker() override
void AddPickList(vtkProp *)
Add an actor to the pick list.
void InitializePickList()
Initialize list of actors in pick list.
vtkPropCollection * GetPickList()
Return the list of actors in the PickList.
virtual int Pick3DPoint(double[3], vtkRenderer *)
Perform pick operation with selection point provided.
int Pick(double selectionPt[3], vtkRenderer *ren)
provided.
vtkPropCollection * PickList
a simple class to control print indentation
Definition: vtkIndent.h:38
abstract base class for most VTK objects
Definition: vtkObject.h:61
an ordered list of Props
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:55
abstract specification for renderers
Definition: vtkRenderer.h:71
int vtkTypeBool
Definition: vtkABI.h:64