VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkSliderWidget Class Reference

set a value by manipulating a slider More...

#include <vtkSliderWidget.h>

Inheritance diagram for vtkSliderWidget:
[legend]
Collaboration diagram for vtkSliderWidget:
[legend]

Public Member Functions

void CreateDefaultRepresentation ()
 
void SetRepresentation (vtkSliderRepresentation *r)
 
vtkSliderRepresentationGetSliderRepresentation ()
 
virtual void SetAnimationMode (int)
 
virtual int GetAnimationMode ()
 
void SetAnimationModeToOff ()
 
void SetAnimationModeToJump ()
 
void SetAnimationModeToAnimate ()
 
virtual void SetNumberOfAnimationSteps (int)
 
virtual int GetNumberOfAnimationSteps ()
 
- Public Member Functions inherited from vtkAbstractWidget
virtual void SetEnabled (int)
 
void Render ()
 
virtual void SetPriority (float)
 
virtual void SetProcessEvents (int)
 
virtual int GetProcessEvents ()
 
virtual void ProcessEventsOn ()
 
virtual void ProcessEventsOff ()
 
vtkWidgetEventTranslatorGetEventTranslator ()
 
void SetParent (vtkAbstractWidget *parent)
 
virtual vtkAbstractWidgetGetParent ()
 
vtkWidgetRepresentationGetRepresentation ()
 
virtual void SetManagesCursor (int)
 
virtual int GetManagesCursor ()
 
virtual void ManagesCursorOn ()
 
virtual void ManagesCursorOff ()
 
vtkAbstractWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSliderWidgetNew ()
 
- Static Public Member Functions inherited from vtkAbstractWidget
static int IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 

Protected Types

enum  _WidgetState { Start =0, Sliding, Animating }
 
enum  AnimationState { AnimateOff, Jump, Animate }
 

Protected Member Functions

 vtkSliderWidget ()
 
 ~vtkSliderWidget ()
 
void AnimateSlider (int selectionState)
 
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 
 ~vtkAbstractWidget ()
 
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
 
virtual void SetCursor (int vtkNotUsed(state))
 

Static Protected Member Functions

static void SelectAction (vtkAbstractWidget *)
 
static void EndSelectAction (vtkAbstractWidget *)
 
static void MoveAction (vtkAbstractWidget *)
 
- Static Protected Member Functions inherited from vtkAbstractWidget
static void ProcessEventsHandler (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 

Protected Attributes

int WidgetState
 
int NumberOfAnimationSteps
 
int AnimationMode
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
int ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
int ProcessEvents
 
typedef vtkAbstractWidget Superclass
 
static int IsTypeOf (const char *type)
 
static vtkSliderWidgetSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkSliderWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBase * NewInstanceInternal () const
 

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

Definition at line 83 of file vtkSliderWidget.h.

Member Typedef Documentation

Standard macros.

Definition at line 91 of file vtkSliderWidget.h.

Member Enumeration Documentation

Enumerator
Start 
Sliding 
Animating 

Definition at line 144 of file vtkSliderWidget.h.

Enumerator
AnimateOff 
Jump 
Animate 

Definition at line 153 of file vtkSliderWidget.h.

Constructor & Destructor Documentation

vtkSliderWidget::vtkSliderWidget ( )
protected
vtkSliderWidget::~vtkSliderWidget ( )
inlineprotected

Definition at line 134 of file vtkSliderWidget.h.

Member Function Documentation

static vtkSliderWidget* vtkSliderWidget::New ( )
static

Instantiate the class.

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

Standard macros.

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

Standard macros.

Reimplemented from vtkAbstractWidget.

static vtkSliderWidget* vtkSliderWidget::SafeDownCast ( vtkObjectBase *  o)
static

Standard macros.

virtual vtkObjectBase* vtkSliderWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard macros.

Reimplemented from vtkAbstractWidget.

vtkSliderWidget* vtkSliderWidget::NewInstance ( ) const

Standard macros.

void vtkSliderWidget::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

Standard macros.

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 99 of file vtkSliderWidget.h.

vtkSliderRepresentation* vtkSliderWidget::GetSliderRepresentation ( )
inline

Return the representation as a vtkSliderRepresentation.

Definition at line 105 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 117 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 118 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 119 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 )
staticprotected
static void vtkSliderWidget::EndSelectAction ( vtkAbstractWidget )
staticprotected
static void vtkSliderWidget::MoveAction ( vtkAbstractWidget )
staticprotected
void vtkSliderWidget::AnimateSlider ( int  selectionState)
protected

Member Data Documentation

int vtkSliderWidget::WidgetState
protected

Definition at line 143 of file vtkSliderWidget.h.

int vtkSliderWidget::NumberOfAnimationSteps
protected

Definition at line 151 of file vtkSliderWidget.h.

int vtkSliderWidget::AnimationMode
protected

Definition at line 152 of file vtkSliderWidget.h.


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