vtkCellPicker.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 vtkCellPicker_h
#define vtkCellPicker_h
 
#include "vtkPicker.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkMapper;
class vtkTexture;
class vtkAbstractHyperTreeGridMapper;
class vtkAbstractVolumeMapper;
class vtkImageMapper3D;
class vtkPlaneCollection;
class vtkPiecewiseFunction;
class vtkDataArray;
class vtkDoubleArray;
class vtkIdList;
class vtkCell;
class vtkGenericCell;
class vtkImageData;
class vtkAbstractCellLocator;
class vtkCollection;
class vtkMatrix4x4;
class vtkBitArray;
class vtkHyperTreeGridNonOrientedGeometryCursor;
 
class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkCellPicker : public vtkPicker
{
public:
  static vtkCellPicker* New();
  vtkTypeMacro(vtkCellPicker, vtkPicker);
  void PrintSelf(ostream& os, vtkIndent indent) override;

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

  int Pick3DRay(double selectionPt[3], double orient[4], vtkRenderer* ren) override;

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void AddLocator(vtkAbstractCellLocator* locator);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void RemoveLocator(vtkAbstractCellLocator* locator);

  void RemoveAllLocators();


  vtkSetMacro(VolumeOpacityIsovalue, double);
  vtkGetMacro(VolumeOpacityIsovalue, double);


  vtkSetMacro(UseVolumeGradientOpacity, vtkTypeBool);
  vtkBooleanMacro(UseVolumeGradientOpacity, vtkTypeBool);
  vtkGetMacro(UseVolumeGradientOpacity, vtkTypeBool);


  vtkSetMacro(PickClippingPlanes, vtkTypeBool);
  vtkBooleanMacro(PickClippingPlanes, vtkTypeBool);
  vtkGetMacro(PickClippingPlanes, vtkTypeBool);


  vtkGetMacro(ClippingPlaneId, int);


  vtkGetVectorMacro(PickNormal, double, 3);


  vtkGetVector3Macro(MapperNormal, double);


  vtkGetVector3Macro(PointIJK, int);


  vtkGetVector3Macro(CellIJK, int);


  vtkGetMacro(PointId, vtkIdType);


  vtkGetMacro(CellId, vtkIdType);


  vtkGetMacro(SubId, int);


  vtkGetVector3Macro(PCoords, double);

  vtkTexture* GetTexture() { return this->Texture; }


  vtkSetMacro(PickTextureData, vtkTypeBool);
  vtkBooleanMacro(PickTextureData, vtkTypeBool);
  vtkGetMacro(PickTextureData, vtkTypeBool);
 
protected:
  vtkCellPicker();
  ~vtkCellPicker() override;
 
  void Initialize() override;
 
  virtual void ResetPickInfo();
 
  double IntersectWithLine(const double p1[3], const double p2[3], double tol,
    vtkAssemblyPath* path, vtkProp3D* p, vtkAbstractMapper3D* m) override;
 
  virtual double IntersectActorWithLine(const double p1[3], const double p2[3], double t1,
    double t2, double tol, vtkProp3D* prop, vtkMapper* mapper);
 
  virtual bool IntersectDataSetWithLine(vtkDataSet* dataSet, const double p1[3], const double p2[3],
    double t1, double t2, double tol, vtkAbstractCellLocator*& locator, vtkIdType& cellId,
    int& subId, double& tMin, double& pDistMin, double xyz[3], double minPCoords[3]);


  virtual double IntersectHyperTreeGridWithLine(
    const double[3], const double[3], double, double, vtkAbstractHyperTreeGridMapper*);
  virtual bool RecursivelyProcessTree(vtkHyperTreeGridNonOrientedGeometryCursor*, int);
 
  virtual double IntersectVolumeWithLine(const double p1[3], const double p2[3], double t1,
    double t2, vtkProp3D* prop, vtkAbstractVolumeMapper* mapper);
 
  virtual double IntersectImageWithLine(const double p1[3], const double p2[3], double t1,
    double t2, vtkProp3D* prop, vtkImageMapper3D* mapper);
 
  virtual double IntersectProp3DWithLine(const double p1[3], const double p2[3], double t1,
    double t2, double tol, vtkProp3D* prop, vtkAbstractMapper3D* mapper);
 
  static int ClipLineWithPlanes(vtkAbstractMapper3D* mapper, vtkMatrix4x4* propMatrix,
    const double p1[3], const double p2[3], double& t1, double& t2, int& planeId);
 
  static int ClipLineWithExtent(const int extent[6], const double x1[3], const double x2[3],
    double& t1, double& t2, int& planeId);
 
  static int ComputeSurfaceNormal(
    vtkDataSet* data, vtkCell* cell, const double* weights, double normal[3]);
 
  static int ComputeSurfaceTCoord(
    vtkDataSet* data, vtkCell* cell, const double* weights, double tcoord[3]);
 
  static vtkTypeBool HasSubCells(int cellType);
 
  static int GetNumberOfSubCells(vtkIdList* pointIds, int cellType);
 
  static void GetSubCell(
    vtkDataSet* data, vtkIdList* pointIds, int subId, int cellType, vtkGenericCell* cell);
 
  static void SubCellFromCell(vtkGenericCell* cell, int subId);
 
  void SetImageDataPickInfo(const double x[3], const int extent[6]);
 
  double ComputeVolumeOpacity(const int xi[3], const double pcoords[3], vtkImageData* data,
    vtkDataArray* scalars, vtkPiecewiseFunction* scalarOpacity,
    vtkPiecewiseFunction* gradientOpacity);
 
  vtkCollection* Locators;
 
  double VolumeOpacityIsovalue;
  vtkTypeBool UseVolumeGradientOpacity;
  vtkTypeBool PickClippingPlanes;
  int ClippingPlaneId;
 
  vtkIdType PointId;
  vtkIdType CellId;
  int SubId;
  double PCoords[3];
 
  int PointIJK[3];
  int CellIJK[3];
 
  double PickNormal[3];
  double MapperNormal[3];
 
  vtkTexture* Texture;
  vtkTypeBool PickTextureData;
 
  vtkBitArray* InMask;
  double WordlPoint[3];
 
private:
  void ResetCellPickerInfo();
 
  vtkGenericCell* Cell;      // used to accelerate picking
  vtkIdList* PointIds;       // used to accelerate picking
  vtkDoubleArray* Gradients; // used in volume picking
 
  vtkCellPicker(const vtkCellPicker&) = delete;
  void operator=(const vtkCellPicker&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif