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

vtkBalloonWidget - popup text balloons above instance of vtkProp when hovering occurs More...

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

List of all members.

Public Member Functions

 vtkBalloonWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkBalloonWidget ()
 Instantiate this class.
void AddBalloon (vtkProp prop, string str, vtkImageData img)
 Add and remove text and/or an image to be associated with a vtkProp. You may add one or both of them.
void AddBalloon (vtkProp prop, string str)
 Add and remove text and/or an image to be associated with a vtkProp. You may add one or both of them.
override void CreateDefaultRepresentation ()
 Create the default widget representation if one is not set.
vtkImageData GetBalloonImage (vtkProp prop)
 Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up each balloon). A NULL will be returned if the vtkProp does not exist, or if a string or image have not been associated with the specified vtkProp.
vtkBalloonRepresentation GetBalloonRepresentation ()
 Return the representation as a vtkBalloonRepresentation.
string GetBalloonString (vtkProp prop)
 Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up each balloon). A NULL will be returned if the vtkProp does not exist, or if a string or image have not been associated with the specified vtkProp.
virtual vtkProp GetCurrentProp ()
 Return the current vtkProp that is being hovered over. Note that the value may be NULL (if hovering over nothing or the mouse is moving).
virtual vtkAbstractPropPicker GetPicker ()
 Set/Get the object used to perform pick operations. Since the vtkBalloonWidget operates on vtkProps, the picker must be a subclass of vtkAbstractPropPicker. (Note: if not specified, an instance of vtkPropPicker is used.)
override int IsA (string type)
 Standard methods for a VTK class.
new vtkBalloonWidget NewInstance ()
 Standard methods for a VTK class.
void RemoveBalloon (vtkProp prop)
 Add and remove text and/or an image to be associated with a vtkProp. You may add one or both of them.
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.
void SetPicker (vtkAbstractPropPicker arg0)
 Set/Get the object used to perform pick operations. Since the vtkBalloonWidget operates on vtkProps, the picker must be a subclass of vtkAbstractPropPicker. (Note: if not specified, an instance of vtkPropPicker is used.)
void SetRepresentation (vtkBalloonRepresentation 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.
void UpdateBalloonImage (vtkProp prop, vtkImageData image)
 Update the balloon string or image. If the specified prop does not exist, then nothing is added not changed.
void UpdateBalloonString (vtkProp prop, string str)
 Update the balloon string or image. If the specified prop does not exist, then nothing is added not changed.

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "16vtkBalloonWidget"
 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 vtkBalloonWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkBalloonWidget_AddBalloon_01 (HandleRef pThis, HandleRef prop, string str, HandleRef img)
static internal void vtkBalloonWidget_AddBalloon_02 (HandleRef pThis, HandleRef prop, string str)
static internal void vtkBalloonWidget_CreateDefaultRepresentation_03 (HandleRef pThis)
static internal IntPtr vtkBalloonWidget_GetBalloonImage_04 (HandleRef pThis, HandleRef prop, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkBalloonWidget_GetBalloonRepresentation_05 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkBalloonWidget_GetBalloonString_06 (HandleRef pThis, HandleRef prop)
static internal IntPtr vtkBalloonWidget_GetCurrentProp_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkBalloonWidget_GetPicker_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkBalloonWidget_IsA_09 (HandleRef pThis, string type)
static internal int vtkBalloonWidget_IsTypeOf_10 (string type)
static internal IntPtr vtkBalloonWidget_NewInstance_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkBalloonWidget_RemoveBalloon_13 (HandleRef pThis, HandleRef prop)
static internal IntPtr vtkBalloonWidget_SafeDownCast_14 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkBalloonWidget_SetEnabled_15 (HandleRef pThis, int arg0)
static internal void vtkBalloonWidget_SetPicker_16 (HandleRef pThis, HandleRef arg0)
static internal void vtkBalloonWidget_SetRepresentation_17 (HandleRef pThis, HandleRef r)
static internal void vtkBalloonWidget_UpdateBalloonImage_18 (HandleRef pThis, HandleRef prop, HandleRef image)
static internal void vtkBalloonWidget_UpdateBalloonString_19 (HandleRef pThis, HandleRef prop, string str)

Static Private Member Functions

static vtkBalloonWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkBalloonWidget - popup text balloons above instance of vtkProp when hovering occurs

Description The vtkBalloonWidget is used to popup text and/or an image when the mouse hovers over an instance of vtkProp. The widget keeps track of (vtkProp,vtkBalloon) pairs (where the internal vtkBalloon class is defined by a pair of vtkStdString and vtkImageData), and when the mouse stops moving for a user-specified period of time over the vtkProp, then the vtkBalloon is drawn nearby the vtkProp. Note that an instance of vtkBalloonRepresentation is used to draw the balloon.

To use this widget, specify an instance of vtkBalloonWidget and a representation (e.g., vtkBalloonRepresentation). Then list all instances of vtkProp, a text string, and/or an instance of vtkImageData to be associated with each vtkProp. (Note that you can specify both text and an image, or just one or the other.) You may also wish to specify the hover delay (i.e., set in the superclass vtkHoverWidget).

Event Bindings By default, the widget observes the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events): <pre> MouseMoveEvent - occurs when mouse is moved in render window. TimerEvent - occurs when the time between events (e.g., mouse move) is greater than TimerDuration. 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 vtkBalloonWidget's widget events: <pre> vtkWidgetEvent::Move -- start the timer vtkWidgetEvent::TimedOut -- when hovering occurs, vtkWidgetEvent::SelectAction -- activate any callbacks associated with the balloon. </pre>

This widget invokes the following VTK events on itself (which observers can listen for): <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.vtkBalloonWidget.vtkBalloonWidget ( ) [static, private]

Automatically generated type registration mechanics.

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

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

Instantiate this class.


Member Function Documentation

void Kitware.VTK.vtkBalloonWidget.AddBalloon ( vtkProp  prop,
string  str,
vtkImageData  img 
)

Add and remove text and/or an image to be associated with a vtkProp. You may add one or both of them.

void Kitware.VTK.vtkBalloonWidget.AddBalloon ( vtkProp  prop,
string  str 
)

Add and remove text and/or an image to be associated with a vtkProp. You may add one or both of them.

Create the default widget representation if one is not set.

Reimplemented from Kitware.VTK.vtkHoverWidget.

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

Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up each balloon). A NULL will be returned if the vtkProp does not exist, or if a string or image have not been associated with the specified vtkProp.

Here is the call graph for this function:

Return the representation as a vtkBalloonRepresentation.

Here is the call graph for this function:

Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up each balloon). A NULL will be returned if the vtkProp does not exist, or if a string or image have not been associated with the specified vtkProp.

Return the current vtkProp that is being hovered over. Note that the value may be NULL (if hovering over nothing or the mouse is moving).

Here is the call graph for this function:

Set/Get the object used to perform pick operations. Since the vtkBalloonWidget operates on vtkProps, the picker must be a subclass of vtkAbstractPropPicker. (Note: if not specified, an instance of vtkPropPicker is used.)

Here is the call graph for this function:

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

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkHoverWidget.

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

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkHoverWidget.

Instantiate this class.

Reimplemented from Kitware.VTK.vtkHoverWidget.

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkHoverWidget.

Add and remove text and/or an image to be associated with a vtkProp. You may add one or both of them.

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkHoverWidget.

Here is the call graph for this function:

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

Set/Get the object used to perform pick operations. Since the vtkBalloonWidget operates on vtkProps, the picker must be a subclass of vtkAbstractPropPicker. (Note: if not specified, an instance of vtkPropPicker is used.)

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.

Update the balloon string or image. If the specified prop does not exist, then nothing is added not changed.

Update the balloon string or image. If the specified prop does not exist, then nothing is added not changed.

static internal void Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_AddBalloon_01 ( HandleRef  pThis,
HandleRef  prop,
string  str,
HandleRef  img 
) [private]
static internal void Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_AddBalloon_02 ( HandleRef  pThis,
HandleRef  prop,
string  str 
) [private]
static internal void Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_CreateDefaultRepresentation_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_GetBalloonImage_04 ( HandleRef  pThis,
HandleRef  prop,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_GetBalloonRepresentation_05 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_GetBalloonString_06 ( HandleRef  pThis,
HandleRef  prop 
) [private]
static internal IntPtr Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_GetCurrentProp_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_GetPicker_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_IsA_09 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_IsTypeOf_10 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_NewInstance_12 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_RemoveBalloon_13 ( HandleRef  pThis,
HandleRef  prop 
) [private]
static internal IntPtr Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_SafeDownCast_14 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_SetEnabled_15 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_SetPicker_16 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_SetRepresentation_17 ( HandleRef  pThis,
HandleRef  r 
) [private]
static internal void Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_UpdateBalloonImage_18 ( HandleRef  pThis,
HandleRef  prop,
HandleRef  image 
) [private]
static internal void Kitware.VTK.vtkBalloonWidget.vtkBalloonWidget_UpdateBalloonString_19 ( HandleRef  pThis,
HandleRef  prop,
string  str 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkBalloonWidget.MRClassNameKey = "16vtkBalloonWidget" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkHoverWidget.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkHoverWidget.


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