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

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

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

List of all members.

Public Member Functions

 vtkCenteredSliderWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkCenteredSliderWidget ()
 Instantiate the class.
override void CreateDefaultRepresentation ()
 Create the default widget representation if one is not set.
vtkSliderRepresentation GetSliderRepresentation ()
 Return the representation as a vtkSliderRepresentation.
double GetValue ()
 Get the value fo this widget.
override int IsA (string type)
 Standard macros.
new vtkCenteredSliderWidget NewInstance ()
 Standard macros.
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 vtkCenteredSliderWidget New ()
 Instantiate the class.
static new int IsTypeOf (string type)
 Standard macros.
static new vtkCenteredSliderWidget SafeDownCast (vtkObjectBase o)
 Standard macros.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "23vtkCenteredSliderWidget"
 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 vtkCenteredSliderWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCenteredSliderWidget_CreateDefaultRepresentation_01 (HandleRef pThis)
static internal IntPtr vtkCenteredSliderWidget_GetSliderRepresentation_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal double vtkCenteredSliderWidget_GetValue_03 (HandleRef pThis)
static internal int vtkCenteredSliderWidget_IsA_04 (HandleRef pThis, string type)
static internal int vtkCenteredSliderWidget_IsTypeOf_05 (string type)
static internal IntPtr vtkCenteredSliderWidget_NewInstance_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkCenteredSliderWidget_SafeDownCast_08 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCenteredSliderWidget_SetRepresentation_09 (HandleRef pThis, HandleRef r)

Static Private Member Functions

static vtkCenteredSliderWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkCenteredSliderWidget - set a value by manipulating a slider

Description 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): <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 vtkCenteredSliderWidget'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 vtkCenteredSliderWidget 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

Automatically generated type registration mechanics.

Kitware.VTK.vtkCenteredSliderWidget.vtkCenteredSliderWidget ( 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.vtkCenteredSliderWidget.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.

Return the representation as a vtkSliderRepresentation.

Here is the call graph for this function:

Get the value fo this widget.

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

Standard macros.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

static new int Kitware.VTK.vtkCenteredSliderWidget.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:

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 IntPtr Kitware.VTK.vtkCenteredSliderWidget.vtkCenteredSliderWidget_GetSliderRepresentation_02 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal double Kitware.VTK.vtkCenteredSliderWidget.vtkCenteredSliderWidget_GetValue_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkCenteredSliderWidget.vtkCenteredSliderWidget_IsA_04 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkCenteredSliderWidget.vtkCenteredSliderWidget_IsTypeOf_05 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkCenteredSliderWidget.vtkCenteredSliderWidget_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCenteredSliderWidget.vtkCenteredSliderWidget_NewInstance_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCenteredSliderWidget.vtkCenteredSliderWidget_SafeDownCast_08 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkCenteredSliderWidget.vtkCenteredSliderWidget_SetRepresentation_09 ( HandleRef  pThis,
HandleRef  r 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkCenteredSliderWidget.MRClassNameKey = "23vtkCenteredSliderWidget" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.


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