set a value by manipulating a slider More...

#include <vtkCenteredSliderWidget.h>

Inheritance diagram for vtkCenteredSliderWidget:

Collaboration diagram for vtkCenteredSliderWidget:

Public Types
typedef vtkAbstractWidget	Superclass

Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver	Superclass

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkCenteredSliderWidget *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	SetRepresentation (vtkSliderRepresentation *r)

vtkSliderRepresentation *	GetSliderRepresentation ()

void	CreateDefaultRepresentation ()

double	GetValue ()

Public Member Functions inherited from vtkAbstractWidget
vtkAbstractWidget *	NewInstance () const

virtual void	SetEnabled (int)

virtual void	SetProcessEvents (int)

virtual int	GetProcessEvents ()

virtual void	ProcessEventsOn ()

virtual void	ProcessEventsOff ()

vtkWidgetEventTranslator *	GetEventTranslator ()

void	Render ()

void	SetParent (vtkAbstractWidget *parent)

virtual vtkAbstractWidget *	GetParent ()

vtkWidgetRepresentation *	GetRepresentation ()

virtual void	SetManagesCursor (int)

virtual int	GetManagesCursor ()

virtual void	ManagesCursorOn ()

virtual void	ManagesCursorOff ()

virtual void	SetPriority (float)

Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual void	SetInteractor (vtkRenderWindowInteractor *iren)

virtual vtkRenderWindowInteractor *	GetInteractor ()

virtual float	GetPriority ()

virtual void	PickingManagedOn ()

virtual void	PickingManagedOff ()

virtual void	SetPickingManaged (bool)

virtual bool	GetPickingManaged ()

virtual void	SetKeyPressActivation (int)

virtual int	GetKeyPressActivation ()

virtual void	KeyPressActivationOn ()

virtual void	KeyPressActivationOff ()

virtual void	SetKeyPressActivationValue (char)

virtual char	GetKeyPressActivationValue ()

virtual vtkRenderer *	GetDefaultRenderer ()

virtual void	SetDefaultRenderer (vtkRenderer *)

virtual vtkRenderer *	GetCurrentRenderer ()

virtual void	SetCurrentRenderer (vtkRenderer *)

virtual void	OnChar ()

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	ReleaseFocus ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

int	GetReferenceCount ()

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkCenteredSliderWidget *	New ()

static int	IsTypeOf (const char *type)

static vtkCenteredSliderWidget *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractWidget
static int	IsTypeOf (const char *type)

static vtkAbstractWidget *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorObserver
static int	IsTypeOf (const char *type)

static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)

static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])

static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Types
enum	_WidgetState { Start =0, Sliding }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCenteredSliderWidget ()

	~vtkCenteredSliderWidget ()

Protected Member Functions inherited from vtkAbstractWidget
	vtkAbstractWidget ()

	~vtkAbstractWidget ()

void	SetWidgetRepresentation (vtkWidgetRepresentation *r)

virtual void	SetCursor (int vtkNotUsed(state))

Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()

	~vtkInteractorObserver ()

virtual void	StartInteraction ()

virtual void	EndInteraction ()

void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])

void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])

virtual void	RegisterPickers ()

void	UnRegisterPickers ()

virtual void	PickersModified ()

vtkPickingManager *	GetPickingManager ()

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)

int	RequestCursorShape (int requestedShape)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

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)

Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (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
vtkWidgetRepresentation *	WidgetRep

int	ManagesCursor

vtkWidgetEventTranslator *	EventTranslator

vtkWidgetCallbackMapper *	CallbackMapper

vtkAbstractWidget *	Parent

void *	CallData

int	ProcessEvents

Protected Attributes inherited from vtkInteractorObserver
int	Enabled

vtkCallbackCommand *	EventCallbackCommand

vtkCallbackCommand *	KeyPressCallbackCommand

float	Priority

bool	PickingManaged

int	KeyPressActivation

char	KeyPressActivationValue

vtkRenderWindowInteractor *	Interactor

vtkRenderer *	CurrentRenderer

vtkRenderer *	DefaultRenderer

unsigned long	CharObserverTag

unsigned long	DeleteObserverTag

vtkObserverMediator *	ObserverMediator

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

◆ Superclass

typedef vtkAbstractWidget vtkCenteredSliderWidget::Superclass

Standard macros.

Definition at line 93 of file vtkCenteredSliderWidget.h.

Member Enumeration Documentation

◆ _WidgetState

enum vtkCenteredSliderWidget::_WidgetState

protected

Enumerator
Start
Sliding

Definition at line 129 of file vtkCenteredSliderWidget.h.

Constructor & Destructor Documentation

◆ vtkCenteredSliderWidget()

vtkCenteredSliderWidget::vtkCenteredSliderWidget ( )

protected

◆ ~vtkCenteredSliderWidget()

vtkCenteredSliderWidget::~vtkCenteredSliderWidget ( )

inlineprotected

Definition at line 119 of file vtkCenteredSliderWidget.h.

Member Function Documentation

◆ New()

static vtkCenteredSliderWidget* vtkCenteredSliderWidget::New ( )

static

Instantiate the class.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAbstractWidget.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCenteredSliderWidget::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractWidget.

◆ NewInstance()

vtkCenteredSliderWidget* vtkCenteredSliderWidget::NewInstance ( ) const

◆ PrintSelf()

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

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAbstractWidget.

◆ SetRepresentation()

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.

◆ GetSliderRepresentation()

vtkSliderRepresentation* vtkCenteredSliderWidget::GetSliderRepresentation ( )

inline

Return the representation as a vtkSliderRepresentation.

Definition at line 107 of file vtkCenteredSliderWidget.h.

◆ CreateDefaultRepresentation()

void vtkCenteredSliderWidget::CreateDefaultRepresentation ( )

virtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

◆ GetValue()

double vtkCenteredSliderWidget::GetValue ( )

inline

Get the value fo this widget.

Definition at line 115 of file vtkCenteredSliderWidget.h.

◆ SelectAction()

static void vtkCenteredSliderWidget::SelectAction ( vtkAbstractWidget * )

staticprotected

◆ EndSelectAction()

static void vtkCenteredSliderWidget::EndSelectAction ( vtkAbstractWidget * )

staticprotected

◆ MoveAction()

static void vtkCenteredSliderWidget::MoveAction ( vtkAbstractWidget * )

staticprotected

◆ TimerAction()

static void vtkCenteredSliderWidget::TimerAction ( vtkAbstractWidget * )

staticprotected

Member Data Documentation

◆ WidgetState

int vtkCenteredSliderWidget::WidgetState

protected

Definition at line 128 of file vtkCenteredSliderWidget.h.

◆ TimerId

int vtkCenteredSliderWidget::TimerId

protected

Definition at line 136 of file vtkCenteredSliderWidget.h.

◆ TimerDuration

int vtkCenteredSliderWidget::TimerDuration

protected

Definition at line 137 of file vtkCenteredSliderWidget.h.

◆ StartTime

double vtkCenteredSliderWidget::StartTime

protected

Definition at line 138 of file vtkCenteredSliderWidget.h.

◆ Value

double vtkCenteredSliderWidget::Value

protected

Definition at line 139 of file vtkCenteredSliderWidget.h.

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

dox/opt/build/vtk6-6.3.0+dfsg2/Interaction/Widgets/vtkCenteredSliderWidget.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ _WidgetState

Constructor & Destructor Documentation

◆ vtkCenteredSliderWidget()

◆ ~vtkCenteredSliderWidget()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetRepresentation()

◆ GetSliderRepresentation()

◆ CreateDefaultRepresentation()

◆ GetValue()

◆ SelectAction()

◆ EndSelectAction()

◆ MoveAction()

◆ TimerAction()

Member Data Documentation

◆ WidgetState

◆ TimerId

◆ TimerDuration

◆ StartTime

◆ Value