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
vtkCenteredSliderWidget Class Reference

set a value by manipulating a slider More...

#include <vtkCenteredSliderWidget.h>

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

Public Member Functions

void CreateDefaultRepresentation ()
 
double GetValue ()
 
void SetRepresentation (vtkSliderRepresentation *r)
 
vtkSliderRepresentationGetSliderRepresentation ()
 
- 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 vtkCenteredSliderWidgetNew ()
 
- Static Public Member Functions inherited from vtkAbstractWidget
static int IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 

Protected Types

enum  _WidgetState { Start =0, Sliding }
 

Protected Member Functions

 vtkCenteredSliderWidget ()
 
 ~vtkCenteredSliderWidget ()
 
- 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 void TimerAction (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 TimerId
 
int TimerDuration
 
double StartTime
 
double Value
 
- 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 vtkCenteredSliderWidgetSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkCenteredSliderWidgetNewInstance () 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::StartInteractionEvent vtkCommand::InteractionEvent vtkCommand::EndInteractionEvent
Tests:
vtkCenteredSliderWidget (Tests)

Definition at line 85 of file vtkCenteredSliderWidget.h.

Member Typedef Documentation

Standard macros.

Definition at line 93 of file vtkCenteredSliderWidget.h.

Member Enumeration Documentation

Enumerator
Start 
Sliding 

Definition at line 129 of file vtkCenteredSliderWidget.h.

Constructor & Destructor Documentation

vtkCenteredSliderWidget::vtkCenteredSliderWidget ( )
protected
vtkCenteredSliderWidget::~vtkCenteredSliderWidget ( )
inlineprotected

Definition at line 119 of file vtkCenteredSliderWidget.h.

Member Function Documentation

static vtkCenteredSliderWidget* vtkCenteredSliderWidget::New ( )
static

Instantiate the class.

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

Standard macros.

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

Standard macros.

Reimplemented from vtkAbstractWidget.

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

Standard macros.

virtual vtkObjectBase* vtkCenteredSliderWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard macros.

Reimplemented from vtkAbstractWidget.

vtkCenteredSliderWidget* vtkCenteredSliderWidget::NewInstance ( ) const

Standard macros.

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

Standard macros.

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 )
staticprotected
static void vtkCenteredSliderWidget::EndSelectAction ( vtkAbstractWidget )
staticprotected
static void vtkCenteredSliderWidget::MoveAction ( vtkAbstractWidget )
staticprotected
static void vtkCenteredSliderWidget::TimerAction ( vtkAbstractWidget )
staticprotected

Member Data Documentation

int vtkCenteredSliderWidget::WidgetState
protected

Definition at line 128 of file vtkCenteredSliderWidget.h.

int vtkCenteredSliderWidget::TimerId
protected

Definition at line 136 of file vtkCenteredSliderWidget.h.

int vtkCenteredSliderWidget::TimerDuration
protected

Definition at line 137 of file vtkCenteredSliderWidget.h.

double vtkCenteredSliderWidget::StartTime
protected

Definition at line 138 of file vtkCenteredSliderWidget.h.

double vtkCenteredSliderWidget::Value
protected

Definition at line 139 of file vtkCenteredSliderWidget.h.


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