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

vtkAbstractWidget - define the API for widget / widget representation More...

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

List of all members.

Public Member Functions

 vtkAbstractWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual void CreateDefaultRepresentation ()
 Create the default widget representation if one is not set. The representation defines the geometry of the widget (i.e., how it appears) as well as providing special methods for manipulting the state and appearance of the widget.
vtkWidgetEventTranslator GetEventTranslator ()
 Get the event translator. Careful manipulation of this class enables the user to override the default event bindings.
virtual int GetManagesCursor ()
 Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.
virtual vtkAbstractWidget GetParent ()
 Specifying a parent to this widget is used when creating composite widgets. It is an internal method not meant to be used by the public. When a widget has a parent, it defers the rendering to the parent. It may also defer managing the cursor (see ManagesCursor ivar).
virtual int GetProcessEvents ()
 Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.
virtual int GetProcessEventsMaxValue ()
 Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.
virtual int GetProcessEventsMinValue ()
 Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.
vtkWidgetRepresentation GetRepresentation ()
 Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. Note that the representation is a subclass of vtkProp (typically a subclass of vtkWidgetRepresenation) so it can be added to the renderer independent of the widget.
override int IsA (string type)
 Standard macros implementing standard VTK methods.
virtual void ManagesCursorOff ()
 Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.
virtual void ManagesCursorOn ()
 Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.
new vtkAbstractWidget NewInstance ()
 Standard macros implementing standard VTK methods.
virtual void ProcessEventsOff ()
 Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.
virtual void ProcessEventsOn ()
 Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.
void Render ()
 This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. This method should be called (instead of vtkRenderWindow::Render() because it has built into it optimizations for minimizing renders and/or speeding renders.
override void SetEnabled (int arg0)
 Methods for activating this widget. Note that the widget representation must be specified or the widget will not appear. ProcessEvents (On by default) must be On for Enabled widget to respond to interaction. If ProcessEvents is Off, enabling/disabling a widget merely affects the visibility of the representation.
virtual void SetManagesCursor (int _arg)
 Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.
void SetParent (vtkAbstractWidget parent)
 Specifying a parent to this widget is used when creating composite widgets. It is an internal method not meant to be used by the public. When a widget has a parent, it defers the rendering to the parent. It may also defer managing the cursor (see ManagesCursor ivar).
override void SetPriority (float arg0)
 Override the superclass method. This will automatically change the priority of the widget. Unlike the superclass documentation, no methods such as SetInteractor to null and reset it etc. are necessary.
virtual void SetProcessEvents (int _arg)
 Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.

Static Public Member Functions

static new int IsTypeOf (string type)
 Standard macros implementing standard VTK methods.
static new vtkAbstractWidget SafeDownCast (vtkObjectBase o)
 Standard macros implementing standard VTK methods.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkAbstractWidget"
 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 void vtkAbstractWidget_CreateDefaultRepresentation_01 (HandleRef pThis)
static internal IntPtr vtkAbstractWidget_GetEventTranslator_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkAbstractWidget_GetManagesCursor_03 (HandleRef pThis)
static internal IntPtr vtkAbstractWidget_GetParent_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkAbstractWidget_GetProcessEvents_05 (HandleRef pThis)
static internal int vtkAbstractWidget_GetProcessEventsMaxValue_06 (HandleRef pThis)
static internal int vtkAbstractWidget_GetProcessEventsMinValue_07 (HandleRef pThis)
static internal IntPtr vtkAbstractWidget_GetRepresentation_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkAbstractWidget_IsA_09 (HandleRef pThis, string type)
static internal int vtkAbstractWidget_IsTypeOf_10 (string type)
static internal void vtkAbstractWidget_ManagesCursorOff_11 (HandleRef pThis)
static internal void vtkAbstractWidget_ManagesCursorOn_12 (HandleRef pThis)
static internal IntPtr vtkAbstractWidget_NewInstance_13 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkAbstractWidget_ProcessEventsOff_14 (HandleRef pThis)
static internal void vtkAbstractWidget_ProcessEventsOn_15 (HandleRef pThis)
static internal void vtkAbstractWidget_Render_16 (HandleRef pThis)
static internal IntPtr vtkAbstractWidget_SafeDownCast_17 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkAbstractWidget_SetEnabled_18 (HandleRef pThis, int arg0)
static internal void vtkAbstractWidget_SetManagesCursor_19 (HandleRef pThis, int _arg)
static internal void vtkAbstractWidget_SetParent_20 (HandleRef pThis, HandleRef parent)
static internal void vtkAbstractWidget_SetPriority_21 (HandleRef pThis, float arg0)
static internal void vtkAbstractWidget_SetProcessEvents_22 (HandleRef pThis, int _arg)

Static Private Member Functions

static vtkAbstractWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkAbstractWidget - define the API for widget / widget representation

Description The vtkAbstractWidget defines an API and implements methods common to all widgets using the interaction/representation design. In this design, the term interaction means that part of the widget that performs event handling, while the representation corresponds to a vtkProp (or the subclass vtkWidgetRepresentation) used to represent the widget. vtkAbstractWidget also implements some methods common to all subclasses.

Note that vtkAbstractWidget provides access to the vtkWidgetEventTranslator. This class is responsible for translating VTK events (defined in vtkCommand.h) into widget events (defined in vtkWidgetEvent.h). This class can be manipulated so that different VTK events can be mapped into widget events, thereby allowing the modification of event bindings. Each subclass of vtkAbstractWidget defines the events to which it responds.

Caveats Note that the pair (vtkAbstractWidget/vtkWidgetRepresentation) are an implementation of the second generation VTK Widgets design. In the first generation design, widgets were implemented in a single monotonic class. This design was problematic because in client-server applications it was difficult to manage widgets properly. Also, new "representations" or look-and-feel, for a widget required a whole new class, with a lot of redundant code. The separation of the widget event handling and representation enables users and developers to create new appearances for the widget. It also facilitates parallel processing, where the client application handles events, and remote representations of the widget are slaves to the client (and do not handle events).


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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


Member Function Documentation

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

Get the event translator. Careful manipulation of this class enables the user to override the default event bindings.

Here is the call graph for this function:

Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.

Specifying a parent to this widget is used when creating composite widgets. It is an internal method not meant to be used by the public. When a widget has a parent, it defers the rendering to the parent. It may also defer managing the cursor (see ManagesCursor ivar).

Here is the call graph for this function:

Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.

Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.

Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.

Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. Note that the representation is a subclass of vtkProp (typically a subclass of vtkWidgetRepresenation) so it can be added to the renderer independent of the widget.

Here is the call graph for this function:

override int Kitware.VTK.vtkAbstractWidget.IsA ( string  type) [virtual]
static new int Kitware.VTK.vtkAbstractWidget.IsTypeOf ( string  type) [static]

Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.

Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.

Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.

Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.

This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. This method should be called (instead of vtkRenderWindow::Render() because it has built into it optimizations for minimizing renders and/or speeding renders.

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

Methods for activating this widget. Note that the widget representation must be specified or the widget will not appear. ProcessEvents (On by default) must be On for Enabled widget to respond to interaction. If ProcessEvents is Off, enabling/disabling a widget merely affects the visibility of the representation.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

Reimplemented in Kitware.VTK.vtkContourWidget, Kitware.VTK.vtkBalloonWidget, Kitware.VTK.vtkSeedWidget, Kitware.VTK.vtkBiDimensionalWidget, Kitware.VTK.vtkAngleWidget, Kitware.VTK.vtkParallelopipedWidget, Kitware.VTK.vtkDistanceWidget, Kitware.VTK.vtkHoverWidget, Kitware.VTK.vtkLineWidget2, Kitware.VTK.vtkAxesTransformWidget, Kitware.VTK.vtkAffineWidget, Kitware.VTK.vtkCaptionWidget, and Kitware.VTK.vtkCheckerboardWidget.

virtual void Kitware.VTK.vtkAbstractWidget.SetManagesCursor ( int  _arg) [virtual]

Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.

Specifying a parent to this widget is used when creating composite widgets. It is an internal method not meant to be used by the public. When a widget has a parent, it defers the rendering to the parent. It may also defer managing the cursor (see ManagesCursor ivar).

override void Kitware.VTK.vtkAbstractWidget.SetPriority ( float  arg0) [virtual]

Override the superclass method. This will automatically change the priority of the widget. Unlike the superclass documentation, no methods such as SetInteractor to null and reset it etc. are necessary.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

virtual void Kitware.VTK.vtkAbstractWidget.SetProcessEvents ( int  _arg) [virtual]

Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.

Reimplemented in Kitware.VTK.vtkSeedWidget, Kitware.VTK.vtkBiDimensionalWidget, Kitware.VTK.vtkAngleWidget, Kitware.VTK.vtkParallelopipedWidget, Kitware.VTK.vtkDistanceWidget, Kitware.VTK.vtkLineWidget2, and Kitware.VTK.vtkAxesTransformWidget.

static internal void Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_CreateDefaultRepresentation_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_GetEventTranslator_02 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_GetManagesCursor_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_GetParent_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_GetProcessEvents_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_GetProcessEventsMaxValue_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_GetProcessEventsMinValue_07 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_GetRepresentation_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_IsA_09 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_IsTypeOf_10 ( string  type) [private]
static internal void Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_ManagesCursorOff_11 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_ManagesCursorOn_12 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_NewInstance_13 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_ProcessEventsOff_14 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_ProcessEventsOn_15 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_Render_16 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_SafeDownCast_17 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_SetEnabled_18 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_SetManagesCursor_19 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_SetParent_20 ( HandleRef  pThis,
HandleRef  parent 
) [private]
static internal void Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_SetPriority_21 ( HandleRef  pThis,
float  arg0 
) [private]
static internal void Kitware.VTK.vtkAbstractWidget.vtkAbstractWidget_SetProcessEvents_22 ( HandleRef  pThis,
int  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkAbstractWidget.MRClassNameKey = "17vtkAbstractWidget" [static]
new const string Kitware.VTK.vtkAbstractWidget.MRFullTypeName = "Kitware.VTK.vtkAbstractWidget"

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