vtkSliderWidget Class Reference

#include <vtkSliderWidget.h>

Inheritance diagram for vtkSliderWidget:

[legend]

Collaboration diagram for vtkSliderWidget:

[legend]

List of all members.

Detailed Description

set a value by manipulating a slider

The vtkSliderWidget is used to set a scalar value in an application. This class assumes that a slider is moved along a 1D parameter space (e.g., a spherical bead that can be moved along a tube). 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.

Event Bindings:

By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):

 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;

Event Bindings:

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkSliderWidget's widget events:

   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

Event Bindings:

In turn, when these widget events are processed, the vtkSliderWidget invokes the following VTK events on itself (which observers can listen for):

   vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select)
   vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect)
   vtkCommand::InteractionEvent (on vtkWidgetEvent::Move)

Events:: vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent

Tests:: vtkSliderWidget (Tests)

Definition at line 79 of file vtkSliderWidget.h.


typedef vtkAbstractWidget	Superclass
static int	IsTypeOf (const char *type)
static vtkSliderWidget *	SafeDownCast (vtkObject *o)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
Public Member Functions
void	CreateDefaultRepresentation ()

void	SetRepresentation (vtkSliderRepresentation *r)

virtual void	SetAnimationMode (int)
virtual int	GetAnimationMode ()
void	SetAnimationModeToOff ()
void	SetAnimationModeToJump ()
void	SetAnimationModeToAnimate ()

virtual void	SetNumberOfAnimationSteps (int)
virtual int	GetNumberOfAnimationSteps ()
Static Public Member Functions
static vtkSliderWidget *	New ()
Protected Types
enum	_WidgetState { Start = 0, Sliding, Animating }
enum	AnimationState { AnimateOff, Jump, Animate }
Protected Member Functions
	vtkSliderWidget ()
	~vtkSliderWidget ()
void	AnimateSlider (int selectionState)
Static Protected Member Functions
static void	SelectAction (vtkAbstractWidget *)
static void	EndSelectAction (vtkAbstractWidget *)
static void	MoveAction (vtkAbstractWidget *)
Protected Attributes
int	WidgetState
int	NumberOfAnimationSteps
int	AnimationMode

Member Typedef Documentation

typedef vtkAbstractWidget vtkSliderWidget::Superclass

Standard macros.

Reimplemented from vtkAbstractWidget.

Definition at line 87 of file vtkSliderWidget.h.

Member Enumeration Documentation

enum vtkSliderWidget::_WidgetState [protected]

Enumerator:

Start
Sliding
Animating

Definition at line 134 of file vtkSliderWidget.h.

enum vtkSliderWidget::AnimationState [protected]

Enumerator:

AnimateOff
Jump
Animate

Definition at line 143 of file vtkSliderWidget.h.

Constructor & Destructor Documentation

vtkSliderWidget::vtkSliderWidget ( ) [protected]

vtkSliderWidget::~vtkSliderWidget ( ) [inline, protected]

Definition at line 124 of file vtkSliderWidget.h.

Member Function Documentation

static vtkSliderWidget* vtkSliderWidget::New ( ) [static]

Instantiate the class.

Reimplemented from vtkObject.

virtual const char* vtkSliderWidget::GetClassName ( ) [virtual]

Standard macros.

Reimplemented from vtkAbstractWidget.

static int vtkSliderWidget::IsTypeOf ( const char * type ) [static]

Standard macros.

Reimplemented from vtkAbstractWidget.

virtual int vtkSliderWidget::IsA ( const char * type ) [virtual]

Standard macros.

Reimplemented from vtkAbstractWidget.

static vtkSliderWidget* vtkSliderWidget::SafeDownCast ( vtkObject * o ) [static]

Standard macros.

Reimplemented from vtkAbstractWidget.

void vtkSliderWidget::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Standard macros.

Reimplemented from vtkAbstractWidget.

void vtkSliderWidget::SetRepresentation ( vtkSliderRepresentation * r ) [inline]

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.

Definition at line 95 of file vtkSliderWidget.h.

virtual void vtkSliderWidget::SetAnimationMode ( int ) [virtual]

Control the behavior of the slider when selecting the tube or caps. If Jump, then selecting the tube, left cap, or right cap causes the slider to jump to the selection point. If the mode is Animate, the slider moves towards the selection point in NumberOfAnimationSteps number of steps. If Off, then the slider does not move.

virtual int vtkSliderWidget::GetAnimationMode ( ) [virtual]

Control the behavior of the slider when selecting the tube or caps. If Jump, then selecting the tube, left cap, or right cap causes the slider to jump to the selection point. If the mode is Animate, the slider moves towards the selection point in NumberOfAnimationSteps number of steps. If Off, then the slider does not move.

void vtkSliderWidget::SetAnimationModeToOff ( ) [inline]

Control the behavior of the slider when selecting the tube or caps. If Jump, then selecting the tube, left cap, or right cap causes the slider to jump to the selection point. If the mode is Animate, the slider moves towards the selection point in NumberOfAnimationSteps number of steps. If Off, then the slider does not move.

Definition at line 107 of file vtkSliderWidget.h.

void vtkSliderWidget::SetAnimationModeToJump ( ) [inline]

Control the behavior of the slider when selecting the tube or caps. If Jump, then selecting the tube, left cap, or right cap causes the slider to jump to the selection point. If the mode is Animate, the slider moves towards the selection point in NumberOfAnimationSteps number of steps. If Off, then the slider does not move.

Definition at line 108 of file vtkSliderWidget.h.

void vtkSliderWidget::SetAnimationModeToAnimate ( ) [inline]

Control the behavior of the slider when selecting the tube or caps. If Jump, then selecting the tube, left cap, or right cap causes the slider to jump to the selection point. If the mode is Animate, the slider moves towards the selection point in NumberOfAnimationSteps number of steps. If Off, then the slider does not move.

Definition at line 109 of file vtkSliderWidget.h.

virtual void vtkSliderWidget::SetNumberOfAnimationSteps ( int ) [virtual]

Specify the number of animation steps to take if the animation mode is set to animate.

virtual int vtkSliderWidget::GetNumberOfAnimationSteps ( ) [virtual]

Specify the number of animation steps to take if the animation mode is set to animate.

void vtkSliderWidget::CreateDefaultRepresentation ( ) [virtual]

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

static void vtkSliderWidget::SelectAction ( vtkAbstractWidget * ) [static, protected]