VTK  9.1.0
vtkSliderWidget.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkSliderWidget.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
72#ifndef vtkSliderWidget_h
73#define vtkSliderWidget_h
74
75#include "vtkAbstractWidget.h"
76#include "vtkInteractionWidgetsModule.h" // For export macro
77
79
80class VTKINTERACTIONWIDGETS_EXPORT vtkSliderWidget : public vtkAbstractWidget
81{
82public:
87
89
93 void PrintSelf(ostream& os, vtkIndent indent) override;
95
102 {
103 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
104 }
105
110 {
111 return reinterpret_cast<vtkSliderRepresentation*>(this->WidgetRep);
112 }
113
115
122 vtkSetClampMacro(AnimationMode, int, AnimateOff, Animate);
123 vtkGetMacro(AnimationMode, int);
124 void SetAnimationModeToOff() { this->SetAnimationMode(AnimateOff); }
125 void SetAnimationModeToJump() { this->SetAnimationMode(Jump); }
126 void SetAnimationModeToAnimate() { this->SetAnimationMode(Animate); }
128
130
134 vtkSetClampMacro(NumberOfAnimationSteps, int, 1, VTK_INT_MAX);
135 vtkGetMacro(NumberOfAnimationSteps, int);
137
142
143protected:
145 ~vtkSliderWidget() override = default;
146
147 // These are the events that are handled
151 void AnimateSlider(int selectionState);
152
153 // Manage the state of the widget
156 {
157 Start = 0,
159 Animating
160 };
161
165 {
168 Animate
169 };
170
171private:
172 vtkSliderWidget(const vtkSliderWidget&) = delete;
173 void operator=(const vtkSliderWidget&) = delete;
174};
175
176#endif
define the API for widget / widget representation
vtkWidgetRepresentation * WidgetRep
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract class defines the representation for a vtkSliderWidget
set a value by manipulating a slider
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
void SetAnimationModeToOff()
Control the behavior of the slider when selecting the tube or caps.
void SetAnimationModeToJump()
Control the behavior of the slider when selecting the tube or caps.
void AnimateSlider(int selectionState)
void SetAnimationModeToAnimate()
Control the behavior of the slider when selecting the tube or caps.
vtkSliderRepresentation * GetSliderRepresentation()
Return the representation as a vtkSliderRepresentation.
~vtkSliderWidget() override=default
static void SelectAction(vtkAbstractWidget *)
static void EndSelectAction(vtkAbstractWidget *)
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros.
static vtkSliderWidget * New()
Instantiate the class.
void SetRepresentation(vtkSliderRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
static void MoveAction(vtkAbstractWidget *)
abstract class defines interface between the widget and widget representation classes
#define VTK_INT_MAX
Definition: vtkType.h:155