vtkContextTransform.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 vtkContextTransform_h
#define vtkContextTransform_h

#include "vtkAbstractContextItem.h"
#include "vtkRenderingContext2DModule.h" // For export macro
#include "vtkSmartPointer.h"             // Needed for SP ivars.
#include "vtkVector.h"                   // Needed for ivars.
#include "vtkWrappingHints.h"            // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkTransform2D;

class VTKRENDERINGCONTEXT2D_EXPORT VTK_MARSHALAUTO vtkContextTransform
  : public vtkAbstractContextItem
{
public:
  vtkTypeMacro(vtkContextTransform, vtkAbstractContextItem);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkContextTransform* New();

  vtkIdType AddItem(vtkAbstractContextItem* item) override
  {
    return this->Superclass::AddItem(item);
  }

  vtkAbstractContextItem* GetItem(vtkIdType index) override
  {
    return this->Superclass::GetItem(index);
  }

  void RemoveAllItems() { this->ClearItems(); }

  void Update() override;

  bool Paint(vtkContext2D* painter) override;

  virtual void Identity();

  virtual void Translate(float dx, float dy);

  virtual void Scale(float dx, float dy);

  virtual void Rotate(float angle);

  virtual vtkTransform2D* GetTransform();

  vtkVector2f MapToParent(const vtkVector2f& point) override;

  vtkVector2f MapFromParent(const vtkVector2f& point) override;


  vtkSetMacro(PanMouseButton, int);
  vtkGetMacro(PanMouseButton, int);


  vtkSetMacro(PanModifier, int);
  vtkGetMacro(PanModifier, int);


  vtkSetMacro(SecondaryPanMouseButton, int);
  vtkGetMacro(SecondaryPanMouseButton, int);


  vtkSetMacro(SecondaryPanModifier, int);
  vtkGetMacro(SecondaryPanModifier, int);


  vtkSetMacro(ZoomMouseButton, int);
  vtkGetMacro(ZoomMouseButton, int);


  vtkSetMacro(ZoomModifier, int);
  vtkGetMacro(ZoomModifier, int);


  vtkSetMacro(SecondaryZoomMouseButton, int);
  vtkGetMacro(SecondaryZoomMouseButton, int);


  vtkSetMacro(SecondaryZoomModifier, int);
  vtkGetMacro(SecondaryZoomModifier, int);


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


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

  bool Hit(const vtkContextMouseEvent& mouse) override;

  bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;

  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;

  bool MouseWheelEvent(const vtkContextMouseEvent& mouse, int delta) override;

protected:
  vtkContextTransform();
  ~vtkContextTransform() override;

  vtkNew<vtkTransform2D> Transform;

  int PanMouseButton;
  int PanModifier;
  int ZoomMouseButton;
  int ZoomModifier;
  int SecondaryPanMouseButton;
  int SecondaryPanModifier;
  int SecondaryZoomMouseButton;
  int SecondaryZoomModifier;

  bool ZoomOnMouseWheel;
  bool PanYOnMouseWheel;

  vtkVector2f ZoomAnchor;

private:
  vtkContextTransform(const vtkContextTransform&) = delete;
  void operator=(const vtkContextTransform&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif // vtkContextTransform_h