Find file
Fetching contributors…
Cannot retrieve contributors at this time
131 lines (111 sloc) 4.66 KB
Program: Visualization Toolkit
Module: vtkCenteredSliderWidget.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or for details.
This software is distributed WITHOUT ANY WARRANTY; without even
PURPOSE. See the above copyright notice for more information.
// .NAME vtkCenteredSliderWidget - set a value by manipulating a slider
// .SECTION Description
// The vtkCenteredSliderWidget is used to adjust a scalar value in an application.
// This class measures deviations form the center point on the slider.
// Moving the slider
// modifies the value of the widget, which can be used to set parameters on
// other objects. Note that the actual appearance of the widget depends on
// the specific representation for the widget.
// To use this widget, set the widget representation. The representation is
// assumed to consist of a tube, two end caps, and a slider (the details may
// vary depending on the particulars of the representation). Then in the
// representation you will typically set minimum and maximum value, as well
// as the current value. The position of the slider must also be set, as well
// as various properties.
// Note that the value should be obtain from the widget, not from the
// representation. Also note that Minimum and Maximum values are in terms of
// value per second. The value you get from this widget's GetValue method is
// multiplied by time.
// .SECTION Event Bindings
// By default, the widget responds to the following VTK events (i.e., it
// watches the vtkRenderWindowInteractor for these events):
// <pre>
// If the slider bead is selected:
// LeftButtonPressEvent - select slider (if on slider)
// LeftButtonReleaseEvent - release slider (if selected)
// MouseMoveEvent - move slider
// If the end caps or slider tube are selected:
// LeftButtonPressEvent - move (or animate) to cap or point on tube;
// </pre>
// Note that the event bindings described above can be changed using this
// class's vtkWidgetEventTranslator. This class translates VTK events
// into the vtkCenteredSliderWidget's widget events:
// <pre>
// vtkWidgetEvent::Select -- some part of the widget has been selected
// vtkWidgetEvent::EndSelect -- the selection process has completed
// vtkWidgetEvent::Move -- a request for slider motion has been invoked
// </pre>
// In turn, when these widget events are processed, the vtkCenteredSliderWidget
// invokes the following VTK events on itself (which observers can listen for):
// <pre>
// vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select)
// vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect)
// vtkCommand::InteractionEvent (on vtkWidgetEvent::Move)
// </pre>
#ifndef __vtkCenteredSliderWidget_h
#define __vtkCenteredSliderWidget_h
#include "vtkAbstractWidget.h"
class vtkSliderRepresentation;
class VTK_WIDGETS_EXPORT vtkCenteredSliderWidget : public vtkAbstractWidget
// Description:
// Instantiate the class.
static vtkCenteredSliderWidget *New();
// Description:
// Standard macros.
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Specify an instance of vtkWidgetRepresentation used to represent this
// widget in the scene. Note that the representation is a subclass of vtkProp
// so it can be added to the renderer independent of the widget.
void SetRepresentation(vtkSliderRepresentation *r)
// Description:
// Create the default widget representation if one is not set.
void CreateDefaultRepresentation();
// Description:
// Get the value fo this widget.
double GetValue() { return this->Value; };
~vtkCenteredSliderWidget() {}
// These are the events that are handled
static void SelectAction(vtkAbstractWidget*);
static void EndSelectAction(vtkAbstractWidget*);
static void MoveAction(vtkAbstractWidget*);
static void TimerAction(vtkAbstractWidget*);
//BTX - manage the state of the widget
int WidgetState;
enum _WidgetState
int TimerId;
int TimerDuration;
double StartTime;
double Value;
vtkCenteredSliderWidget(const vtkCenteredSliderWidget&); //Not implemented
void operator=(const vtkCenteredSliderWidget&); //Not implemented