vtkScenePicker.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 vtkScenePicker_h
#define vtkScenePicker_h
 
#include "vtkObject.h"
#include "vtkRenderingCoreModule.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class vtkRenderer;
class vtkProp;
class vtkHardwareSelector;
class vtkRenderWindowInteractor;
class vtkScenePickerSelectionRenderCommand;
 
class VTKRENDERINGCORE_EXPORT vtkScenePicker : public vtkObject
{
 
  friend class vtkRenderer;
  friend class vtkScenePickerSelectionRenderCommand;
 
public:
  static vtkScenePicker* New();
  vtkTypeMacro(vtkScenePicker, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  virtual void SetRenderer(vtkRenderer*);
  vtkGetObjectMacro(Renderer, vtkRenderer);
 
  vtkIdType GetCellId(int displayPos[2]);
 
  vtkIdType GetVertexId(int displayPos[2]);
 
  vtkProp* GetViewProp(int displayPos[2]);
 
 
  vtkSetMacro(EnableVertexPicking, vtkTypeBool);
  vtkGetMacro(EnableVertexPicking, vtkTypeBool);
  vtkBooleanMacro(EnableVertexPicking, vtkTypeBool);
 
protected:
  vtkScenePicker();
  ~vtkScenePicker() override;
 
  // Pick render entire viewport
  // Automatically invoked from vtkRenderer at the end of a still render.
  void PickRender();
 
  // Pick render a region of the renderwindow
  void PickRender(int x0, int y0, int x1, int y1);
 
  // Internal update method retrieves info from the Selector
  void Update(int displayPos[2]);
 
  // The RenderWindowInteractor must be set, so that avoid scene picks (which
  // involve extra renders) during interaction. This is done by observing the
  // RenderWindowInteractor for start and end interaction events.
  void SetInteractor(vtkRenderWindowInteractor*);
 
  vtkTypeBool EnableVertexPicking;
  vtkHardwareSelector* Selector;
  vtkRenderer* Renderer;
  vtkRenderWindowInteractor* Interactor;
  vtkIdType VertId;
  vtkIdType CellId;
  vtkProp* Prop;
  bool NeedToUpdate;
  int LastQueriedDisplayPos[2];
  vtkScenePickerSelectionRenderCommand* SelectionRenderCommand;
 
  vtkTimeStamp PickRenderTime;
 
private:
  vtkScenePicker(const vtkScenePicker&) = delete;
  void operator=(const vtkScenePicker&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif