vtkAbstractPicker.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkAbstractPicker.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkAbstractPicker_h
#define vtkAbstractPicker_h

#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkObject.h"

class vtkRenderer;
class vtkProp;
class vtkPropCollection;

class VTKRENDERINGCORE_EXPORT vtkAbstractPicker : public vtkObject
{
public:
  vtkTypeMacro(vtkAbstractPicker,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkGetObjectMacro(Renderer,vtkRenderer);


  vtkGetVectorMacro(SelectionPoint,double,3);


  vtkGetVectorMacro(PickPosition,double,3);

  virtual int Pick(double selectionX, double selectionY, double selectionZ,
                   vtkRenderer *renderer) = 0;

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

  virtual int Pick3DPoint(double /* selectionPt */[3], vtkRenderer * /*ren*/)
    { vtkErrorMacro("Pick3DPoint called without implementation"); return 0;};

  virtual int Pick3DRay(double /* selectionPt */[3], double /* orient */ [4], vtkRenderer * /*ren*/)
    { vtkErrorMacro("Pick3DRay called without implementation"); return 0;};


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

  void InitializePickList();

  void AddPickList(vtkProp *);

  void DeletePickList(vtkProp *);

  vtkPropCollection *GetPickList() {return this->PickList;}

protected:
  vtkAbstractPicker();
  ~vtkAbstractPicker() override;

  virtual void Initialize();

  vtkRenderer *Renderer; //pick occurred in this renderer's viewport
  double SelectionPoint[3]; //selection point in window (pixel) coordinates
  double PickPosition[3]; //selection point in world coordinates

  // use the following to control picking from a list
  vtkTypeBool PickFromList;
  vtkPropCollection *PickList;
private:
  vtkAbstractPicker(const vtkAbstractPicker&) = delete;
  void operator=(const vtkAbstractPicker&) = delete;
};

#endif