vtkSliderWidget.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 vtkSliderWidget_h
#define vtkSliderWidget_h
 
#include "vtkAbstractWidget.h"
#include "vtkDeprecation.h"              // For VTK_DEPRECATED_IN_9_2_0
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkLegacy.h"                   // for VTK_LEGACY_REMOVE
 
VTK_ABI_NAMESPACE_BEGIN
class vtkSliderRepresentation;
 
class VTKINTERACTIONWIDGETS_EXPORT vtkSliderWidget : public vtkAbstractWidget
{
public:
  static vtkSliderWidget* New();
 
 
  vtkTypeMacro(vtkSliderWidget, vtkAbstractWidget);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void SetRepresentation(vtkSliderRepresentation* r)
  {
    this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
  }
 
  vtkSliderRepresentation* GetSliderRepresentation()
  {
    return reinterpret_cast<vtkSliderRepresentation*>(this->WidgetRep);
  }
 
 
  vtkSetClampMacro(AnimationMode, int, AnimateOff, Animate);
  vtkGetMacro(AnimationMode, int);
  void SetAnimationModeToOff() { this->SetAnimationMode(AnimateOff); }
  void SetAnimationModeToJump() { this->SetAnimationMode(Jump); }
  void SetAnimationModeToAnimate() { this->SetAnimationMode(Animate); }
 
 
  vtkSetClampMacro(NumberOfAnimationSteps, int, 1, VTK_INT_MAX);
  vtkGetMacro(NumberOfAnimationSteps, int);
 
  void CreateDefaultRepresentation() override;
 
protected:
  vtkSliderWidget();
  ~vtkSliderWidget() override = default;
 
  // These are the events that are handled
  static void SelectAction(vtkAbstractWidget*);
  static void EndSelectAction(vtkAbstractWidget*);
  static void MoveAction(vtkAbstractWidget*);
  void AnimateSlider(int selectionState);
 
  // Manage the state of the widget
  int WidgetState;
  enum WidgetStateType
  {
    Start = 0,
    Sliding,
    Animating
  };
#if !defined(VTK_LEGACY_REMOVE)
  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
  typedef WidgetStateType _WidgetState;
#endif
 
  int NumberOfAnimationSteps;
  int AnimationMode;
  enum AnimationState
  {
    AnimateOff,
    Jump,
    Animate
  };
 
private:
  vtkSliderWidget(const vtkSliderWidget&) = delete;
  void operator=(const vtkSliderWidget&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif