set a value by manipulating a slider More...

#include <vtkCenteredSliderWidget.h>

Inheritance diagram for vtkCenteredSliderWidget:

Collaboration diagram for vtkCenteredSliderWidget:

Public Member Functions
void	CreateDefaultRepresentation ()
double	GetValue ()

void	SetRepresentation (vtkSliderRepresentation *r)

vtkSliderRepresentation *	GetSliderRepresentation ()
Static Public Member Functions
static vtkCenteredSliderWidget *	New ()
Protected Types
enum	_WidgetState { Start = 0, Sliding }
Protected Member Functions
	vtkCenteredSliderWidget ()
	~vtkCenteredSliderWidget ()
Static Protected Member Functions
static void	SelectAction (vtkAbstractWidget *)
static void	EndSelectAction (vtkAbstractWidget *)
static void	MoveAction (vtkAbstractWidget *)
static void	TimerAction (vtkAbstractWidget *)
Protected Attributes
int	WidgetState
int	TimerId
int	TimerDuration
double	StartTime
double	Value
typedef vtkAbstractWidget	Superclass
static int	IsTypeOf (const char *type)
static vtkCenteredSliderWidget *	SafeDownCast (vtkObjectBase *o)
virtual int	IsA (const char *type)
vtkCenteredSliderWidget *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBase *	NewInstanceInternal () const

Detailed Description

set a value by manipulating a slider

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.

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 vtkCenteredSliderWidget'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 vtkCenteredSliderWidget 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:: vtkCenteredSliderWidget (Tests)

Definition at line 85 of file vtkCenteredSliderWidget.h.

Member Typedef Documentation

typedef vtkAbstractWidget vtkCenteredSliderWidget::Superclass

Standard macros.

Reimplemented from vtkAbstractWidget.

Definition at line 93 of file vtkCenteredSliderWidget.h.

Member Enumeration Documentation

enum vtkCenteredSliderWidget::_WidgetState [protected]

Enumerator:

Start
Sliding

Definition at line 129 of file vtkCenteredSliderWidget.h.

Constructor & Destructor Documentation

vtkCenteredSliderWidget::vtkCenteredSliderWidget ( ) [protected]

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

Definition at line 119 of file vtkCenteredSliderWidget.h.

Member Function Documentation

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

Instantiate the class.

Reimplemented from vtkObject.

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

Standard macros.

Reimplemented from vtkAbstractWidget.

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

Standard macros.

Reimplemented from vtkAbstractWidget.

static vtkCenteredSliderWidget* vtkCenteredSliderWidget::SafeDownCast ( vtkObjectBase * o ) [static]

Standard macros.

Reimplemented from vtkAbstractWidget.

virtual vtkObjectBase* vtkCenteredSliderWidget::NewInstanceInternal ( ) const [protected, virtual]

Standard macros.

Reimplemented from vtkAbstractWidget.

vtkCenteredSliderWidget* vtkCenteredSliderWidget::NewInstance ( ) const

Standard macros.

Reimplemented from vtkAbstractWidget.

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

Standard macros.

Reimplemented from vtkAbstractWidget.

void vtkCenteredSliderWidget::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 101 of file vtkCenteredSliderWidget.h.

vtkSliderRepresentation* vtkCenteredSliderWidget::GetSliderRepresentation ( ) [inline]

Return the representation as a vtkSliderRepresentation.

Definition at line 107 of file vtkCenteredSliderWidget.h.

void vtkCenteredSliderWidget::CreateDefaultRepresentation ( ) [virtual]

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

double vtkCenteredSliderWidget::GetValue ( ) [inline]

Get the value fo this widget.

Definition at line 115 of file vtkCenteredSliderWidget.h.

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