vtkInteractorStyleFlight.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 vtkInteractorStyleFlight_h
#define vtkInteractorStyleFlight_h

#include "vtkInteractionStyleModule.h" // For export macro
#include "vtkInteractorStyle.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
VTK_ABI_NAMESPACE_BEGIN
class vtkCamera;
class vtkPerspectiveTransform;

class CPIDControl;

class VTKINTERACTIONSTYLE_EXPORT VTK_MARSHALAUTO vtkInteractorStyleFlight
  : public vtkInteractorStyle
{
public:
  static vtkInteractorStyleFlight* New();
  vtkTypeMacro(vtkInteractorStyleFlight, vtkInteractorStyle);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void JumpTo(double campos[3], double focpos[3]);


  vtkSetMacro(MotionStepSize, double);
  vtkGetMacro(MotionStepSize, double);


  vtkSetMacro(MotionAccelerationFactor, double);
  vtkGetMacro(MotionAccelerationFactor, double);


  vtkSetMacro(AngleStepSize, double);
  vtkGetMacro(AngleStepSize, double);


  vtkSetMacro(AngleAccelerationFactor, double);
  vtkGetMacro(AngleAccelerationFactor, double);


  vtkSetMacro(DisableMotion, vtkTypeBool);
  vtkGetMacro(DisableMotion, vtkTypeBool);
  vtkBooleanMacro(DisableMotion, vtkTypeBool);


  vtkSetMacro(RestoreUpVector, vtkTypeBool);
  vtkGetMacro(RestoreUpVector, vtkTypeBool);
  vtkBooleanMacro(RestoreUpVector, vtkTypeBool);

  // Specify "up" (by default {0,0,1} but can be changed)
  vtkGetVectorMacro(DefaultUpVector, double, 3);
  vtkSetVectorMacro(DefaultUpVector, double, 3);


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


  void OnChar() override;
  void OnKeyDown() override;
  void OnKeyUp() override;
  void OnTimer() override;
  //
  virtual void ForwardFly();
  virtual void ReverseFly();
  //
  virtual void StartForwardFly();
  virtual void EndForwardFly();
  virtual void StartReverseFly();
  virtual void EndReverseFly();

protected:
  vtkInteractorStyleFlight();
  ~vtkInteractorStyleFlight() override;


  void UpdateSteering(vtkCamera* cam);
  void UpdateMouseSteering(vtkCamera* cam);
  void FlyByMouse(vtkCamera* cam);
  void FlyByKey(vtkCamera* cam);
  void GetLRVector(double vector[3], vtkCamera* cam);
  void MotionAlongVector(double vector[3], double amount, vtkCamera* cam);
  void SetupMotionVars(vtkCamera* cam);
  void FinishCamera(vtkCamera* cam);
  //
  //
  unsigned char KeysDown;
  vtkTypeBool DisableMotion;
  vtkTypeBool RestoreUpVector;
  double DiagonalLength;
  double MotionStepSize;
  double MotionUserScale;
  double MotionAccelerationFactor;
  double AngleStepSize;
  double AngleAccelerationFactor;
  double DefaultUpVector[3];
  double AzimuthStepSize;
  double IdealFocalPoint[3];
  vtkPerspectiveTransform* Transform;
  double DeltaYaw;
  double lYaw;
  double DeltaPitch;
  double lPitch;

  CPIDControl* PID_Yaw;
  CPIDControl* PID_Pitch;

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

VTK_ABI_NAMESPACE_END
#endif