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

vtkHoverWidget - invoke a vtkTimerEvent when hovering More...

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

List of all members.

Public Member Functions

 vtkHoverWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkHoverWidget ()
 Instantiate this class.
override void CreateDefaultRepresentation ()
 A default representation, of which there is none, is created. Note that the superclasses vtkAbstractWidget::GetRepresentation() method returns NULL.
virtual int GetTimerDuration ()
 Specify the hovering interval (in milliseconds). If after moving the mouse the pointer stays over a vtkProp for this duration, then a vtkTimerEvent::TimerEvent is invoked.
virtual int GetTimerDurationMaxValue ()
 Specify the hovering interval (in milliseconds). If after moving the mouse the pointer stays over a vtkProp for this duration, then a vtkTimerEvent::TimerEvent is invoked.
virtual int GetTimerDurationMinValue ()
 Specify the hovering interval (in milliseconds). If after moving the mouse the pointer stays over a vtkProp for this duration, then a vtkTimerEvent::TimerEvent is invoked.
override int IsA (string type)
 Standard methods for a VTK class.
new vtkHoverWidget NewInstance ()
 Standard methods for a VTK class.
override void SetEnabled (int arg0)
 The method for activiating and deactiviating this widget. This method must be overridden because it performs special timer-related operations.
virtual void SetTimerDuration (int _arg)
 Specify the hovering interval (in milliseconds). If after moving the mouse the pointer stays over a vtkProp for this duration, then a vtkTimerEvent::TimerEvent is invoked.

Static Public Member Functions

static new vtkHoverWidget New ()
 Instantiate this class.
static new int IsTypeOf (string type)
 Standard methods for a VTK class.
static new vtkHoverWidget SafeDownCast (vtkObjectBase o)
 Standard methods for a VTK class.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "14vtkHoverWidget"
 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 vtkHoverWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkHoverWidget_CreateDefaultRepresentation_01 (HandleRef pThis)
static internal int vtkHoverWidget_GetTimerDuration_02 (HandleRef pThis)
static internal int vtkHoverWidget_GetTimerDurationMaxValue_03 (HandleRef pThis)
static internal int vtkHoverWidget_GetTimerDurationMinValue_04 (HandleRef pThis)
static internal int vtkHoverWidget_IsA_05 (HandleRef pThis, string type)
static internal int vtkHoverWidget_IsTypeOf_06 (string type)
static internal IntPtr vtkHoverWidget_NewInstance_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkHoverWidget_SafeDownCast_09 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkHoverWidget_SetEnabled_10 (HandleRef pThis, int arg0)
static internal void vtkHoverWidget_SetTimerDuration_11 (HandleRef pThis, int _arg)

Static Private Member Functions

static vtkHoverWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkHoverWidget - invoke a vtkTimerEvent when hovering

Description The vtkHoverWidget is used to invoke an event when hovering in a render window. Hovering occurs when mouse motion (in the render window) does not occur for a specified amount of time (i.e., TimerDuration). This class can be used as is (by observing TimerEvents) or for class derivation for those classes wishing to do more with the hover event.

To use this widget, specify an instance of vtkHoverWidget and specify the time (in milliseconds) defining the hover period. Unlike most widgets, this widget does not require a representation (although subclasses like vtkBalloonWidget do require a representation).

Event Bindings By default, the widget observes the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events): <pre> MouseMoveEvent - manages a timer used to determine whether the mouse is hovering. TimerEvent - when the time between events (e.g., mouse move), then a timer event is invoked. KeyPressEvent - when the "Enter" key is pressed after the balloon appears, a callback is activited (e.g., WidgetActivateEvent). </pre>

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkHoverWidget's widget events: <pre> vtkWidgetEvent::Move -- start (or reset) the timer vtkWidgetEvent::TimedOut -- when enough time is elapsed between defined VTK events the hover event is invoked. vtkWidgetEvent::SelectAction -- activate any callbacks associated with the balloon. </pre>

This widget invokes the following VTK events on itself when the widget determines that it is hovering. Note that observers of this widget can listen for these events and take appropriate action. <pre> vtkCommand::TimerEvent (when hovering is determined to occur) vtkCommand::EndInteractionEvent (after a hover has occured and the mouse begins moving again). vtkCommand::WidgetActivateEvent (when the balloon is selected with a keypress). </pre>


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Instantiate this class.


Member Function Documentation

A default representation, of which there is none, is created. Note that the superclasses vtkAbstractWidget::GetRepresentation() method returns NULL.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Reimplemented in Kitware.VTK.vtkBalloonWidget.

override void Kitware.VTK.vtkHoverWidget.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.

Reimplemented in Kitware.VTK.vtkBalloonWidget.

Specify the hovering interval (in milliseconds). If after moving the mouse the pointer stays over a vtkProp for this duration, then a vtkTimerEvent::TimerEvent is invoked.

Specify the hovering interval (in milliseconds). If after moving the mouse the pointer stays over a vtkProp for this duration, then a vtkTimerEvent::TimerEvent is invoked.

Specify the hovering interval (in milliseconds). If after moving the mouse the pointer stays over a vtkProp for this duration, then a vtkTimerEvent::TimerEvent is invoked.

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

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Reimplemented in Kitware.VTK.vtkBalloonWidget.

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

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Reimplemented in Kitware.VTK.vtkBalloonWidget.

Instantiate this class.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkBalloonWidget.

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Reimplemented in Kitware.VTK.vtkBalloonWidget.

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Reimplemented in Kitware.VTK.vtkBalloonWidget.

Here is the call graph for this function:

override void Kitware.VTK.vtkHoverWidget.SetEnabled ( int  arg0) [virtual]

The method for activiating and deactiviating this widget. This method must be overridden because it performs special timer-related operations.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Reimplemented in Kitware.VTK.vtkBalloonWidget.

virtual void Kitware.VTK.vtkHoverWidget.SetTimerDuration ( int  _arg) [virtual]

Specify the hovering interval (in milliseconds). If after moving the mouse the pointer stays over a vtkProp for this duration, then a vtkTimerEvent::TimerEvent is invoked.

static internal void Kitware.VTK.vtkHoverWidget.vtkHoverWidget_CreateDefaultRepresentation_01 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHoverWidget.vtkHoverWidget_GetTimerDuration_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHoverWidget.vtkHoverWidget_GetTimerDurationMaxValue_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHoverWidget.vtkHoverWidget_GetTimerDurationMinValue_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHoverWidget.vtkHoverWidget_IsA_05 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkHoverWidget.vtkHoverWidget_IsTypeOf_06 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkHoverWidget.vtkHoverWidget_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHoverWidget.vtkHoverWidget_NewInstance_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHoverWidget.vtkHoverWidget_SafeDownCast_09 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkHoverWidget.vtkHoverWidget_SetEnabled_10 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkHoverWidget.vtkHoverWidget_SetTimerDuration_11 ( HandleRef  pThis,
int  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkHoverWidget.MRClassNameKey = "14vtkHoverWidget" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Reimplemented in Kitware.VTK.vtkBalloonWidget.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Reimplemented in Kitware.VTK.vtkBalloonWidget.


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