VTK  9.3.20240319
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 SetRepresentation (vtkSliderRepresentation *r)
 Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
 
vtkSliderRepresentationGetSliderRepresentation ()
 Return the representation as a vtkSliderRepresentation. More...
 
void CreateDefaultRepresentation () override
 Create the default widget representation if one is not set. More...
 
virtual void SetAnimationMode (int)
 Control the behavior of the slider when selecting the tube or caps. More...
 
virtual int GetAnimationMode ()
 Control the behavior of the slider when selecting the tube or caps. More...
 
void SetAnimationModeToOff ()
 Control the behavior of the slider when selecting the tube or caps. More...
 
void SetAnimationModeToJump ()
 Control the behavior of the slider when selecting the tube or caps. More...
 
void SetAnimationModeToAnimate ()
 Control the behavior of the slider when selecting the tube or caps. More...
 
virtual void SetNumberOfAnimationSteps (int)
 Specify the number of animation steps to take if the animation mode is set to animate. More...
 
virtual int GetNumberOfAnimationSteps ()
 Specify the number of animation steps to take if the animation mode is set to animate. More...
 
- Public Member Functions inherited from vtkAbstractWidget
void SetEnabled (int) override
 Methods for activating this widget. More...
 
vtkWidgetEventTranslatorGetEventTranslator ()
 Get the event translator. More...
 
void Render ()
 This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. More...
 
void SetParent (vtkAbstractWidget *parent)
 Specifying a parent to this widget is used when creating composite widgets. More...
 
virtual vtkAbstractWidgetGetParent ()
 
void SetPriority (float) override
 Override the superclass method. More...
 
virtual void SetProcessEvents (vtkTypeBool)
 Methods to change whether the widget responds to interaction. More...
 
virtual vtkTypeBool GetProcessEvents ()
 Methods to change whether the widget responds to interaction. More...
 
virtual void ProcessEventsOn ()
 Methods to change whether the widget responds to interaction. More...
 
virtual void ProcessEventsOff ()
 Methods to change whether the widget responds to interaction. More...
 
vtkWidgetRepresentationGetRepresentation ()
 Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
 
virtual void SetManagesCursor (vtkTypeBool)
 Turn on or off the management of the cursor. More...
 
virtual vtkTypeBool GetManagesCursor ()
 Turn on or off the management of the cursor. More...
 
virtual void ManagesCursorOn ()
 Turn on or off the management of the cursor. More...
 
virtual void ManagesCursorOff ()
 Turn on or off the management of the cursor. More...
 
vtkAbstractWidgetNewInstance () const
 Standard macros implementing standard VTK methods. More...
 
- Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserverNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetEnabled ()
 
void EnabledOn ()
 
void EnabledOff ()
 
void On ()
 
void Off ()
 
virtual void OnChar ()
 Sets up the keypress-i event. More...
 
virtual void SetInteractor (vtkRenderWindowInteractor *iren)
 This method is used to associate the widget with the render window interactor. More...
 
virtual vtkRenderWindowInteractorGetInteractor ()
 This method is used to associate the widget with the render window interactor. More...
 
virtual float GetPriority ()
 Set/Get the priority at which events are processed. More...
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void SetPickingManaged (bool managed)
 Enable/Disable the use of a manager to process the picking. More...
 
virtual bool GetPickingManaged ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void SetKeyPressActivation (vtkTypeBool)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual vtkTypeBool GetKeyPressActivation ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual void KeyPressActivationOn ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual void KeyPressActivationOff ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual void SetKeyPressActivationValue (char)
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
 
virtual char GetKeyPressActivationValue ()
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
 
virtual vtkRendererGetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual void SetDefaultRenderer (vtkRenderer *)
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer. More...
 
virtual void SetCurrentRenderer (vtkRenderer *)
 Set/Get the current renderer. More...
 
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
 
void ReleaseFocus ()
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkSliderWidgetNew ()
 Instantiate the class. More...
 
- Static Public Member Functions inherited from vtkAbstractWidget
static vtkTypeBool IsTypeOf (const char *type)
 Standard macros implementing standard VTK methods. More...
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 Standard macros implementing standard VTK methods. More...
 
- Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInteractorObserverSafeDownCast (vtkObjectBase *o)
 
static void ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
 Convenience methods for outside classes. More...
 
static void ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
 Convenience methods for outside classes. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Types

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

Protected Member Functions

 vtkSliderWidget ()
 
 ~vtkSliderWidget () override=default
 
void AnimateSlider (int selectionState)
 
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 
 ~vtkAbstractWidget () override
 
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
 
virtual void SetCursor (int vtkNotUsed(state))
 
- Protected Member Functions inherited from vtkInteractorObserver
 vtkInteractorObserver ()
 
 ~vtkInteractorObserver () override
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
 
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the observer currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. More...
 
int RequestCursorShape (int requestedShape)
 
virtual void StartInteraction ()
 Utility routines used to start and end interaction. More...
 
virtual void EndInteraction ()
 Utility routines used to start and end interaction. More...
 
void ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
 Helper method for subclasses. More...
 
void ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
 Helper method for subclasses. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
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 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)
 Handles the char widget activation event. More...
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Protected Attributes

int WidgetState
 
int NumberOfAnimationSteps
 
int AnimationMode
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
vtkTypeBool ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
vtkTypeBool ProcessEvents
 
int LastDevice
 
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
 
vtkCallbackCommandEventCallbackCommand
 
vtkCallbackCommandKeyPressCallbackCommand
 
float Priority
 
bool PickingManaged
 
vtkTypeBool KeyPressActivation
 
char KeyPressActivationValue
 
vtkRenderWindowInteractorInteractor
 
vtkRendererCurrentRenderer
 
vtkRendererDefaultRenderer
 
unsigned long CharObserverTag
 
unsigned long DeleteObserverTag
 
vtkObserverMediatorObserverMediator
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkAbstractWidget Superclass
 Standard macros. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard macros. More...
 
static vtkSliderWidgetSafeDownCast (vtkObjectBase *o)
 Standard macros. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard macros. More...
 
vtkSliderWidgetNewInstance () const
 Standard macros. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard macros. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard macros. More...
 

Additional Inherited Members

- Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver Superclass
 Standard macros implementing standard VTK methods. More...
 
- Public Types inherited from vtkInteractorObserver
typedef vtkObject Superclass
 

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::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent
Online Examples:

Tests:
vtkSliderWidget (Tests)

Definition at line 178 of file vtkSliderWidget.h.

Member Typedef Documentation

◆ Superclass

Standard macros.

Definition at line 190 of file vtkSliderWidget.h.

Member Enumeration Documentation

◆ WidgetStateType

Enumerator
Start 
Sliding 
Animating 

Definition at line 253 of file vtkSliderWidget.h.

◆ AnimationState

Enumerator
AnimateOff 
Jump 
Animate 

Definition at line 262 of file vtkSliderWidget.h.

Constructor & Destructor Documentation

◆ vtkSliderWidget()

vtkSliderWidget::vtkSliderWidget ( )
protected

◆ ~vtkSliderWidget()

vtkSliderWidget::~vtkSliderWidget ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkSliderWidget* vtkSliderWidget::New ( )
static

Instantiate the class.

◆ IsTypeOf()

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

Standard macros.

◆ IsA()

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

Standard macros.

Reimplemented from vtkAbstractWidget.

◆ SafeDownCast()

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

Standard macros.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSliderWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard macros.

Reimplemented from vtkAbstractWidget.

◆ NewInstance()

vtkSliderWidget* vtkSliderWidget::NewInstance ( ) const

Standard macros.

◆ PrintSelf()

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

Standard macros.

Reimplemented from vtkAbstractWidget.

◆ SetRepresentation()

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

◆ GetSliderRepresentation()

vtkSliderRepresentation* vtkSliderWidget::GetSliderRepresentation ( )
inline

Return the representation as a vtkSliderRepresentation.

Definition at line 207 of file vtkSliderWidget.h.

◆ SetAnimationMode()

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.

◆ GetAnimationMode()

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.

◆ SetAnimationModeToOff()

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

◆ SetAnimationModeToJump()

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

◆ SetAnimationModeToAnimate()

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

◆ SetNumberOfAnimationSteps()

virtual void vtkSliderWidget::SetNumberOfAnimationSteps ( int  )
virtual

Specify the number of animation steps to take if the animation mode is set to animate.

◆ GetNumberOfAnimationSteps()

virtual int vtkSliderWidget::GetNumberOfAnimationSteps ( )
virtual

Specify the number of animation steps to take if the animation mode is set to animate.

◆ CreateDefaultRepresentation()

void vtkSliderWidget::CreateDefaultRepresentation ( )
overridevirtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

◆ SelectAction()

static void vtkSliderWidget::SelectAction ( vtkAbstractWidget )
staticprotected

◆ EndSelectAction()

static void vtkSliderWidget::EndSelectAction ( vtkAbstractWidget )
staticprotected

◆ MoveAction()

static void vtkSliderWidget::MoveAction ( vtkAbstractWidget )
staticprotected

◆ AnimateSlider()

void vtkSliderWidget::AnimateSlider ( int  selectionState)
protected

Member Data Documentation

◆ WidgetState

int vtkSliderWidget::WidgetState
protected

Definition at line 252 of file vtkSliderWidget.h.

◆ NumberOfAnimationSteps

int vtkSliderWidget::NumberOfAnimationSteps
protected

Definition at line 260 of file vtkSliderWidget.h.

◆ AnimationMode

int vtkSliderWidget::AnimationMode
protected

Definition at line 261 of file vtkSliderWidget.h.


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