vtkCompassWidget.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov

#ifndef vtkCompassWidget_h
#define vtkCompassWidget_h

#include "vtkAbstractWidget.h"
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkWrappingHints.h"            // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkCompassRepresentation;

class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkCompassWidget : public vtkAbstractWidget
{
public:
  static vtkCompassWidget* New();


  vtkTypeMacro(vtkCompassWidget, vtkAbstractWidget);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetRepresentation(vtkCompassRepresentation* r)
  {
    this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
  }

  void CreateDefaultRepresentation() override;


  double GetHeading();
  void SetHeading(double v);
  double GetTilt();
  void SetTilt(double tilt);
  double GetDistance();
  void SetDistance(double distance);


  vtkGetMacro(TimerDuration, int);
  vtkSetMacro(TimerDuration, int);


  vtkGetMacro(TiltSpeed, double);
  vtkSetMacro(TiltSpeed, double);


  vtkGetMacro(DistanceSpeed, double);
  vtkSetMacro(DistanceSpeed, double);

protected:
  vtkCompassWidget();
  ~vtkCompassWidget() override = default;

  // These are the events that are handled
  static void SelectAction(vtkAbstractWidget* widget);
  static void EndSelectAction(vtkAbstractWidget* widget);
  static void MoveAction(vtkAbstractWidget* widget);
  static void TimerAction(vtkAbstractWidget* widget);

  int WidgetState;
  enum WidgetStateType
  {
    Start = 0,
    Highlighting,
    Adjusting,
    TiltAdjusting,
    DistanceAdjusting,
    TiltTimerAdjustingDown,
    TiltTimerAdjustingUp,
    DistanceTimerAdjustingIn,
    DistanceTimerAdjustingOut
  };

  int TimerId = -1;
  int TimerDuration = 50;
  double StartTime;

  double TiltSpeed = 30.0;
  double DistanceSpeed = 1.0;

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

VTK_ABI_NAMESPACE_END
#endif