vtkInteractorStyleManipulator.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 vtkInteractorStyleManipulator_h
#define vtkInteractorStyleManipulator_h

#include "vtkInteractorStyle.h"

#include "vtkInteractionStyleModule.h" // needed for export macro

VTK_ABI_NAMESPACE_BEGIN
class vtkCollection;
class vtkCameraManipulator;
class VTKINTERACTIONSTYLE_EXPORT vtkInteractorStyleManipulator : public vtkInteractorStyle
{
public:
  static vtkInteractorStyleManipulator* New();
  vtkTypeMacro(vtkInteractorStyleManipulator, vtkInteractorStyle);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void OnMouseMove() override;
  void OnLeftButtonDown() override;
  void OnLeftButtonUp() override;
  void OnMiddleButtonDown() override;
  void OnMiddleButtonUp() override;
  void OnRightButtonDown() override;
  void OnRightButtonUp() override;
  void OnMouseWheelForward() override;
  void OnMouseWheelBackward() override;


  void OnKeyDown() override;
  void OnKeyUp() override;

  void AddManipulator(vtkCameraManipulator* m);

  void RemoveAllManipulators();


  vtkGetObjectMacro(CameraManipulators, vtkCollection);


  vtkSetMacro(MouseWheelZoomsToCursor, bool);
  vtkGetMacro(MouseWheelZoomsToCursor, bool);


  vtkSetMacro(MouseMotionFactor, double);
  vtkGetMacro(MouseMotionFactor, double);

  void Dolly() override;

  vtkCameraManipulator* FindManipulator(int button, bool alt, bool control, bool shift);

protected:
  vtkInteractorStyleManipulator();
  ~vtkInteractorStyleManipulator() override;

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

  bool MouseWheelZoomsToCursor = false;
  double MouseMotionFactor = 1.0;

  // The CameraInteractors also store there button and modifier.
  vtkCollection* CameraManipulators;

  class vtkInternals;
  std::unique_ptr<vtkInternals> Internals;
  friend class vtkInternals;
};
VTK_ABI_NAMESPACE_END
#endif