vtkPickingManager.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause AND Apache-2.0
 
#ifndef vtkPickingManager_h
#define vtkPickingManager_h
 
#include "vtkObject.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractPicker;
class vtkAbstractPropPicker;
class vtkAssemblyPath;
class vtkRenderer;
class vtkRenderWindowInteractor;
 
class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkPickingManager : public vtkObject
{
public:
  static vtkPickingManager* New();
  vtkTypeMacro(vtkPickingManager, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkBooleanMacro(Enabled, bool);
  vtkSetMacro(Enabled, bool);
  vtkGetMacro(Enabled, bool);


  void SetOptimizeOnInteractorEvents(bool optimize);
  vtkGetMacro(OptimizeOnInteractorEvents, bool);


  void SetInteractor(vtkRenderWindowInteractor* iren);
  vtkGetMacro(Interactor, vtkRenderWindowInteractor*);

  void AddPicker(vtkAbstractPicker* picker, vtkObject* object = nullptr);

  void RemovePicker(vtkAbstractPicker* picker, vtkObject* object = nullptr);

  void RemoveObject(vtkObject* object);

  bool Pick(vtkAbstractPicker* picker, vtkObject* object);

  bool Pick(vtkObject* object);

  bool Pick(vtkAbstractPicker* picker);

  vtkAssemblyPath* GetAssemblyPath(double X, double Y, double Z, vtkAbstractPropPicker* picker,
    vtkRenderer* renderer, vtkObject* obj);

  int GetNumberOfPickers();

  int GetNumberOfObjectsLinked(vtkAbstractPicker* picker);
 
protected:
  vtkPickingManager();
  ~vtkPickingManager() override;
 
  // Used to associate the manager with the interactor
  vtkRenderWindowInteractor* Interactor;
  bool Enabled;
  bool OptimizeOnInteractorEvents;
 
private:
  vtkPickingManager(const vtkPickingManager&) = delete;
  void operator=(const vtkPickingManager&) = delete;
 
  class vtkInternal;
  vtkInternal* Internal;
};
 
VTK_ABI_NAMESPACE_END
#endif