vtkAbstractPropPicker.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 vtkAbstractPropPicker_h
#define vtkAbstractPropPicker_h

#include "vtkAbstractPicker.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkProp;
class vtkPropAssembly;
class vtkAssembly;
class vtkActor;
class vtkVolume;
class vtkProp3D;
class vtkAssemblyPath;
class vtkActor2D;

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


  virtual void SetPath(vtkAssemblyPath*);
  vtkGetObjectMacro(Path, vtkAssemblyPath);

  // The following are convenience methods to maintain API with older
  // versions of VTK, and to allow query for the return type of a pick. Note:
  // the functionality of these methods can also be obtained by using the
  // returned vtkAssemblyPath and using the IsA() to determine type.

  virtual vtkProp* GetViewProp();

  virtual vtkProp3D* GetProp3D();

  virtual vtkActor* GetActor();

  virtual vtkActor2D* GetActor2D();

  virtual vtkVolume* GetVolume();

  virtual vtkAssembly* GetAssembly();

  virtual vtkPropAssembly* GetPropAssembly();

protected:
  vtkAbstractPropPicker();
  ~vtkAbstractPropPicker() override;

  void Initialize() override;

  vtkAssemblyPath* Path; // this is what is picked, and includes the prop
private:
  vtkAbstractPropPicker(const vtkAbstractPropPicker&) = delete;
  void operator=(const vtkAbstractPropPicker&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif