vtkCameraOrientationWidget.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 vtkCameraOrientationWidget_h
#define vtkCameraOrientationWidget_h

#include "vtkAbstractWidget.h"
#include "vtkInteractionWidgetsModule.h" // needed for export macro
#include "vtkWeakPointer.h"              // for weak pointer ivar
#include "vtkWrappingHints.h"            // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkCameraInterpolator;
class vtkCameraOrientationRepresentation;
class vtkRenderer;

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


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


  vtkSetClampMacro(AnimatorTotalFrames, int, 2, VTK_INT_MAX);
  vtkGetMacro(AnimatorTotalFrames, int);

  void SetRepresentation(vtkCameraOrientationRepresentation* r);

  void CreateDefaultRepresentation() override;

  void SquareResize();

  void SetDefaultRenderer(vtkRenderer* renderer) override;


  void SetParentRenderer(vtkRenderer* renderer);
  vtkRenderer* GetParentRenderer();


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


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

protected:
  vtkCameraOrientationWidget();
  ~vtkCameraOrientationWidget() override;

  // These methods handle events
  void ComputeWidgetState(int X, int Y, int modify = 0);
  static void SelectAction(vtkAbstractWidget*);
  static void EndSelectAction(vtkAbstractWidget*);
  static void MoveAction(vtkAbstractWidget*);

  // These control the representation and parent renderer's camera.
  void OrientParentCamera(double back[3], double up[3]);
  void OrientWidgetRepresentation();
  void InterpolateCamera(int t);

  void StartAnimation();
  void PlayAnimationSingleFrame(vtkObject* caller, unsigned long event, void* callData);
  void StopAnimation();

  // Manage the state of the widget
  enum class WidgetStateType : int
  {
    Inactive, // mouse is not over the widget, none of the handles are selected.
    Hot,      // mouse is over the widget but none of the handles are selected
    Active    // any one handle is selected, representation could be rotating.
  };
  WidgetStateType WidgetState = WidgetStateType::Inactive;

  vtkWeakPointer<vtkRenderer> ParentRenderer;

  // Store camera interpolations.
  vtkNew<vtkCameraInterpolator> CameraInterpolator;

  bool Animate = true;
  bool ShouldResetCamera = true;
  bool UseCenterOfRotation = false;
  int AnimatorTotalFrames = 20;
  int AnimatorCurrentFrame = 0;
  int AnimationTimerId = -1;

  int ResizeObserverTag = -1;
  int ReorientObserverTag = -1;
  int AnimationTimerObserverTag = -1;

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

VTK_ABI_NAMESPACE_END
#endif