vtkPicker.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPicker_h
#define vtkPicker_h

#include "vtkAbstractPropPicker.h"
#include "vtkDeprecation.h"         // For VTK_DEPRECATED_9_7_0
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractMapper3D;
class vtkCompositeDataSet;
class vtkDataSet;
class vtkTransform;
class vtkActorCollection;
class vtkProp3DCollection;
class vtkPoints;

class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkPicker : public vtkAbstractPropPicker
{
public:
  static vtkPicker* New();
  vtkTypeMacro(vtkPicker, vtkAbstractPropPicker);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetMacro(Tolerance, double);
  vtkGetMacro(Tolerance, double);


  vtkGetVectorMacro(MapperPosition, double, 3);


  vtkGetObjectMacro(Mapper, vtkAbstractMapper3D);


  vtkGetObjectMacro(DataSet, vtkDataSet);


  vtkGetObjectMacro(CompositeDataSet, vtkCompositeDataSet);


  vtkGetMacro(FlatBlockIndex, vtkIdType);

  vtkProp3DCollection* GetProp3Ds() { return this->Prop3Ds; }

  VTK_DEPRECATED_IN_9_7_0("Use GetProp3Ds instead.")
  vtkActorCollection* GetActors();

  vtkPoints* GetPickedPositions() { return this->PickedPositions; }

  int Pick(double selectionX, double selectionY, double selectionZ, vtkRenderer* renderer) override;

  int Pick(VTK_FUTURE_CONST double selectionPt[3], vtkRenderer* ren)
  {
    return this->Pick(selectionPt[0], selectionPt[1], selectionPt[2], ren);
  }

  int Pick3DPoint(VTK_FUTURE_CONST double selectionPt[3], vtkRenderer* ren) override;

  /*
   * Pick a point in the scene with the selection point and focal point
   * provided. The two points are in world coordinates.
   *
   * Returns non-zero if something was successfully picked.
   */
  virtual int Pick3DPoint(
    VTK_FUTURE_CONST double p1World[3], VTK_FUTURE_CONST double p2World[3], vtkRenderer* ren);
  int Pick3DRay(VTK_FUTURE_CONST double selectionPt[3], VTK_FUTURE_CONST double orient[4],
    vtkRenderer* ren) override;

protected:
  vtkPicker();
  ~vtkPicker() override;

  // shared code for picking
  virtual int Pick3DInternal(
    vtkRenderer* ren, VTK_FUTURE_CONST double p1World[4], VTK_FUTURE_CONST double p2World[4]);

  void MarkPicked(vtkAssemblyPath* path, vtkProp3D* p, vtkAbstractMapper3D* m, double tMin,
    VTK_FUTURE_CONST double mapperPos[3]);
  void MarkPickedData(vtkAssemblyPath* path, double tMin, VTK_FUTURE_CONST double mapperPos[3],
    vtkAbstractMapper3D* mapper, vtkDataSet* input, vtkIdType flatBlockIndex = -1);
  virtual double IntersectWithLine(const double p1[3], const double p2[3], double tol,
    vtkAssemblyPath* path, vtkProp3D* p, vtkAbstractMapper3D* m);
  void Initialize() override;
  static bool CalculateRay(
    const double p1[3], const double p2[3], double ray[3], double& rayFactor);

  double Tolerance;         // tolerance for computation (% of window)
  double MapperPosition[3]; // selection point in untransformed coordinates

  vtkAbstractMapper3D* Mapper; // selected mapper (if the prop has a mapper)
  vtkDataSet* DataSet;         // selected dataset (if there is one)
  vtkCompositeDataSet* CompositeDataSet;
  vtkIdType FlatBlockIndex; // flat block index, for a composite data set

  double GlobalTMin;            // parametric coordinate along pick ray where hit occurred
  vtkTransform* Transform;      // use to perform ray transformation
  vtkActorCollection* Actors;   // candidate actors (based on bounding box)
  vtkProp3DCollection* Prop3Ds; // candidate actors (based on bounding box)
  vtkPoints* PickedPositions;   // candidate positions

private:
  vtkPicker(const vtkPicker&) = delete;
  void operator=(const vtkPicker&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif