vtkCameraManipulator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkCameraManipulator_h
#define vtkCameraManipulator_h

#include "vtkObject.h"

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

VTK_ABI_NAMESPACE_BEGIN
class vtkRenderer;
class vtkRenderWindowInteractor;

class VTKINTERACTIONSTYLE_EXPORT vtkCameraManipulator : public vtkObject
{
public:
  vtkTypeMacro(vtkCameraManipulator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual void StartInteraction() = 0;
  virtual void EndInteraction() = 0;

  virtual void OnMouseMove(int x, int y, vtkRenderer* ren, vtkRenderWindowInteractor* iren) = 0;
  virtual void OnButtonDown(int x, int y, vtkRenderer* ren, vtkRenderWindowInteractor* iren) = 0;
  virtual void OnButtonUp(int x, int y, vtkRenderer* ren, vtkRenderWindowInteractor* iren) = 0;


  virtual void OnKeyUp(vtkRenderWindowInteractor* iren) = 0;
  virtual void OnKeyDown(vtkRenderWindowInteractor* iren) = 0;

  enum class MouseButtonType
  {
    Left = 1,
    Middle = 2,
    Right = 3
  };


  vtkSetEnumMacro(MouseButton, MouseButtonType);
  vtkGetEnumMacro(MouseButton, MouseButtonType);


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


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


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


  vtkSetVector3Macro(CenterOfRotation, double);
  vtkGetVector3Macro(CenterOfRotation, double);


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


  vtkSetStringMacro(ManipulatorName);
  vtkGetStringMacro(ManipulatorName);

protected:
  vtkCameraManipulator();
  ~vtkCameraManipulator() override;

  void ComputeCenterOfRotationInDisplayCoordinates(vtkRenderer* ren);

  // protected so subclasses can use it in their mouse move events.
  double CenterOfRotationInDisplayCoordinates[2] = { 0.0, 0.0 };

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

  char* ManipulatorName = nullptr;

  MouseButtonType MouseButton = MouseButtonType::Left;

  bool Alt = false;
  bool Control = false;
  bool Shift = false;

  double CenterOfRotation[3] = { 0.0, 0.0, 0.0 };
  double MouseMotionFactor = 1.0;
};
VTK_ABI_NAMESPACE_END
#endif