vtkSliderRepresentation.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 vtkSliderRepresentation_h
#define vtkSliderRepresentation_h
 
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkWidgetRepresentation.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkSliderRepresentation
  : public vtkWidgetRepresentation
{
public:

  vtkTypeMacro(vtkSliderRepresentation, vtkWidgetRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetValue(double value);
  vtkGetMacro(Value, double);


  void SetMinimumValue(double value);
  vtkGetMacro(MinimumValue, double);


  void SetMaximumValue(double value);
  vtkGetMacro(MaximumValue, double);


  vtkSetClampMacro(SliderLength, double, 0.01, 0.5);
  vtkGetMacro(SliderLength, double);


  vtkSetClampMacro(SliderWidth, double, 0.0, 1.0);
  vtkGetMacro(SliderWidth, double);


  vtkSetClampMacro(TubeWidth, double, 0.0, 1.0);
  vtkGetMacro(TubeWidth, double);


  vtkSetClampMacro(EndCapLength, double, 0.0, 0.25);
  vtkGetMacro(EndCapLength, double);


  vtkSetClampMacro(EndCapWidth, double, 0.0, 0.25);
  vtkGetMacro(EndCapWidth, double);

  virtual void SetTitleText(const char*) {}
  virtual const char* GetTitleText() { return nullptr; }


  void SetLabelFormat(const char* format);
  vtkGetStringMacro(LabelFormat);


  vtkSetClampMacro(LabelHeight, double, 0.0, 2.0);
  vtkGetMacro(LabelHeight, double);


  vtkSetClampMacro(TitleHeight, double, 0.0, 2.0);
  vtkGetMacro(TitleHeight, double);


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

  virtual double GetCurrentT() { return this->CurrentT; }
  virtual double GetPickedT() { return this->PickedT; }
 
  // Enums are used to describe what is selected
  enum InteractionStateType
  {
    Outside = 0,
    Tube,
    LeftCap,
    RightCap,
    Slider
  };
 
protected:
  vtkSliderRepresentation();
  ~vtkSliderRepresentation() override;
 
  // Values
  double Value;
  double MinimumValue;
  double MaximumValue;
 
  // More ivars controlling the appearance of the widget
  double SliderLength;
  double SliderWidth;
  double EndCapLength;
  double EndCapWidth;
  double TubeWidth;
 
  // The current parametric coordinate
  double CurrentT;
  double PickedT;
 
  // both the title and label
  vtkTypeBool ShowSliderLabel;
  char* LabelFormat;
  double LabelHeight;
  double TitleHeight;
 
private:
  vtkSliderRepresentation(const vtkSliderRepresentation&) = delete;
  void operator=(const vtkSliderRepresentation&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif