vtkCenteredSliderWidget Class Reference

#include <vtkCenteredSliderWidget.h>

Inheritance diagram for vtkCenteredSliderWidget:

Inheritance graph
Collaboration diagram for vtkCenteredSliderWidget:

Collaboration graph

List of all members.

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)
vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent
vtkCenteredSliderWidget (Tests)

Definition at line 84 of file vtkCenteredSliderWidget.h.

typedef vtkAbstractWidget Superclass
static int IsTypeOf (const char *type)
static vtkCenteredSliderWidgetSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Public Member Functions

void CreateDefaultRepresentation ()
double GetValue ()
void SetRepresentation (vtkSliderRepresentation *r)

Static Public Member Functions

static vtkCenteredSliderWidgetNew ()

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

Member Typedef Documentation

Standard macros.

Reimplemented from vtkAbstractWidget.

Definition at line 92 of file vtkCenteredSliderWidget.h.

Member Enumeration Documentation


Definition at line 122 of file vtkCenteredSliderWidget.h.

Constructor & Destructor Documentation

vtkCenteredSliderWidget::vtkCenteredSliderWidget (  )  [protected]

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

Definition at line 112 of file vtkCenteredSliderWidget.h.

Member Function Documentation

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

Instantiate the class.

Reimplemented from vtkObject.

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

Standard macros.

Reimplemented from vtkAbstractWidget.

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 ( vtkObject o  )  [static]

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 100 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 108 of file vtkCenteredSliderWidget.h.

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

static void vtkCenteredSliderWidget::EndSelectAction ( vtkAbstractWidget  )  [static, protected]

static void vtkCenteredSliderWidget::MoveAction ( vtkAbstractWidget  )  [static, protected]

static void vtkCenteredSliderWidget::TimerAction ( vtkAbstractWidget  )  [static, protected]

Member Data Documentation

Definition at line 121 of file vtkCenteredSliderWidget.h.

Definition at line 129 of file vtkCenteredSliderWidget.h.

Definition at line 130 of file vtkCenteredSliderWidget.h.

Definition at line 131 of file vtkCenteredSliderWidget.h.

double vtkCenteredSliderWidget::Value [protected]

Definition at line 132 of file vtkCenteredSliderWidget.h.

The documentation for this class was generated from the following file:

Generated on Wed Jun 3 18:56:26 2009 for VTK by  doxygen 1.5.6