ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkSliderWidget Class Reference

vtkSliderWidget - set a value by manipulating a slider More...

Inheritance diagram for Kitware.VTK.vtkSliderWidget:
[legend]
Collaboration diagram for Kitware.VTK.vtkSliderWidget:
[legend]

List of all members.

Public Member Functions

 vtkSliderWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkSliderWidget ()
 Instantiate the class.
override void CreateDefaultRepresentation ()
 Create the default widget representation if one is not set.
virtual int GetAnimationMode ()
 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 GetAnimationModeMaxValue ()
 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 GetAnimationModeMinValue ()
 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 GetNumberOfAnimationSteps ()
 Specify the number of animation steps to take if the animation mode is set to animate.
virtual int GetNumberOfAnimationStepsMaxValue ()
 Specify the number of animation steps to take if the animation mode is set to animate.
virtual int GetNumberOfAnimationStepsMinValue ()
 Specify the number of animation steps to take if the animation mode is set to animate.
vtkSliderRepresentation GetSliderRepresentation ()
 Return the representation as a vtkSliderRepresentation.
override int IsA (string type)
 Standard macros.
new vtkSliderWidget NewInstance ()
 Standard macros.
virtual void SetAnimationMode (int _arg)
 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 SetAnimationModeToAnimate ()
 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 SetAnimationModeToJump ()
 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 SetAnimationModeToOff ()
 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 void SetNumberOfAnimationSteps (int _arg)
 Specify the number of animation steps to take if the animation mode is set to animate.
void SetRepresentation (vtkSliderRepresentation r)
 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.

Static Public Member Functions

static new vtkSliderWidget New ()
 Instantiate the class.
static new int IsTypeOf (string type)
 Standard macros.
static new vtkSliderWidget SafeDownCast (vtkObjectBase o)
 Standard macros.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkSliderWidget"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "15vtkSliderWidget"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkSliderWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSliderWidget_CreateDefaultRepresentation_01 (HandleRef pThis)
static internal int vtkSliderWidget_GetAnimationMode_02 (HandleRef pThis)
static internal int vtkSliderWidget_GetAnimationModeMaxValue_03 (HandleRef pThis)
static internal int vtkSliderWidget_GetAnimationModeMinValue_04 (HandleRef pThis)
static internal int vtkSliderWidget_GetNumberOfAnimationSteps_05 (HandleRef pThis)
static internal int vtkSliderWidget_GetNumberOfAnimationStepsMaxValue_06 (HandleRef pThis)
static internal int vtkSliderWidget_GetNumberOfAnimationStepsMinValue_07 (HandleRef pThis)
static internal IntPtr vtkSliderWidget_GetSliderRepresentation_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkSliderWidget_IsA_09 (HandleRef pThis, string type)
static internal int vtkSliderWidget_IsTypeOf_10 (string type)
static internal IntPtr vtkSliderWidget_NewInstance_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkSliderWidget_SafeDownCast_13 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSliderWidget_SetAnimationMode_14 (HandleRef pThis, int _arg)
static internal void vtkSliderWidget_SetAnimationModeToAnimate_15 (HandleRef pThis)
static internal void vtkSliderWidget_SetAnimationModeToJump_16 (HandleRef pThis)
static internal void vtkSliderWidget_SetAnimationModeToOff_17 (HandleRef pThis)
static internal void vtkSliderWidget_SetNumberOfAnimationSteps_18 (HandleRef pThis, int _arg)
static internal void vtkSliderWidget_SetRepresentation_19 (HandleRef pThis, HandleRef r)

Static Private Member Functions

static vtkSliderWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkSliderWidget - set a value by manipulating a slider

Description 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): <pre> 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; </pre>

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: <pre> 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 </pre>

In turn, when these widget events are processed, the vtkSliderWidget invokes the following VTK events on itself (which observers can listen for): <pre> vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select) vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect) vtkCommand::InteractionEvent (on vtkWidgetEvent::Move) </pre>


Constructor & Destructor Documentation

static Kitware.VTK.vtkSliderWidget.vtkSliderWidget ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkSliderWidget.vtkSliderWidget ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Instantiate the class.


Member Function Documentation

Create the default widget representation if one is not set.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

override void Kitware.VTK.vtkSliderWidget.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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.

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.

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.

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

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

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

Return the representation as a vtkSliderRepresentation.

Here is the call graph for this function:

override int Kitware.VTK.vtkSliderWidget.IsA ( string  type) [virtual]

Standard macros.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

static new int Kitware.VTK.vtkSliderWidget.IsTypeOf ( string  type) [static]

Standard macros.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Instantiate the class.

Reimplemented from Kitware.VTK.vtkObject.

Standard macros.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Standard macros.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkSliderWidget.SetAnimationMode ( int  _arg) [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.

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.

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.

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 void Kitware.VTK.vtkSliderWidget.SetNumberOfAnimationSteps ( int  _arg) [virtual]

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

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.

static internal void Kitware.VTK.vtkSliderWidget.vtkSliderWidget_CreateDefaultRepresentation_01 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSliderWidget.vtkSliderWidget_GetAnimationMode_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSliderWidget.vtkSliderWidget_GetAnimationModeMaxValue_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSliderWidget.vtkSliderWidget_GetAnimationModeMinValue_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSliderWidget.vtkSliderWidget_GetNumberOfAnimationSteps_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSliderWidget.vtkSliderWidget_GetSliderRepresentation_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkSliderWidget.vtkSliderWidget_IsA_09 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkSliderWidget.vtkSliderWidget_IsTypeOf_10 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkSliderWidget.vtkSliderWidget_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSliderWidget.vtkSliderWidget_NewInstance_12 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSliderWidget.vtkSliderWidget_SafeDownCast_13 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkSliderWidget.vtkSliderWidget_SetAnimationMode_14 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSliderWidget.vtkSliderWidget_SetAnimationModeToAnimate_15 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSliderWidget.vtkSliderWidget_SetAnimationModeToJump_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSliderWidget.vtkSliderWidget_SetAnimationModeToOff_17 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSliderWidget.vtkSliderWidget_SetNumberOfAnimationSteps_18 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSliderWidget.vtkSliderWidget_SetRepresentation_19 ( HandleRef  pThis,
HandleRef  r 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkSliderWidget.MRClassNameKey = "15vtkSliderWidget" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

new const string Kitware.VTK.vtkSliderWidget.MRFullTypeName = "Kitware.VTK.vtkSliderWidget"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.


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