vtk3DCursorRepresentation.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 vtk3DCursorRepresentation_h
#define vtk3DCursorRepresentation_h

#include "vtkActor.h"                    // For vtkActor
#include "vtkHardwarePicker.h"           // For vtkHardwarePicker
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkNew.h"                      // For vtkNew
#include "vtkSmartPointer.h"             // For vtkSmartPointer
#include "vtkWidgetRepresentation.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

#include <memory> // for unique_ptr

VTK_ABI_NAMESPACE_BEGIN

class vtkViewport;

class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtk3DCursorRepresentation
  : public vtkWidgetRepresentation
{
public:
  static vtk3DCursorRepresentation* New();
  vtkTypeMacro(vtk3DCursorRepresentation, vtkWidgetRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void BuildRepresentation() override;

  void WidgetInteraction(double newEventPos[2]) override;


  void ReleaseGraphicsResources(vtkWindow*) override;
  int RenderOpaqueGeometry(vtkViewport* viewport) override;

  enum CursorShape
  {
    CROSS_SHAPE = 0,
    SPHERE_SHAPE = 1,
    CUSTOM_SHAPE = 2
  };


  void SetCursorShape(int shape);
  vtkGetMacro(Shape, int);


  void SetCustomCursor(vtkActor* customCursor);
  vtkGetSmartPointerMacro(CustomCursor, vtkActor);

protected:
  vtk3DCursorRepresentation();
  ~vtk3DCursorRepresentation() override;

private:
  vtk3DCursorRepresentation(const vtk3DCursorRepresentation&) = delete;
  void operator=(const vtk3DCursorRepresentation&) = delete;

  struct vtkInternals;
  std::unique_ptr<vtkInternals> Internals;

  vtkSmartPointer<vtkActor> CustomCursor;
  int Shape = CROSS_SHAPE;
};

VTK_ABI_NAMESPACE_END
#endif