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

vtkBorderWidget - place a border around a 2D rectangular region More...

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

List of all members.

Public Member Functions

 vtkBorderWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkBorderWidget ()
 Method to instantiate class.
override void CreateDefaultRepresentation ()
 Create the default widget representation if one is not set.
vtkBorderRepresentation GetBorderRepresentation ()
 Return the representation as a vtkBorderRepresentation.
virtual int GetResizable ()
 Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.
virtual int GetSelectable ()
 Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.
override int IsA (string type)
 Description; Standard methods for class.
new vtkBorderWidget NewInstance ()
 Description; Standard methods for class.
virtual void ResizableOff ()
 Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.
virtual void ResizableOn ()
 Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.
virtual void SelectableOff ()
 Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.
virtual void SelectableOn ()
 Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.
void SetRepresentation (vtkBorderRepresentation 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.
virtual void SetResizable (int _arg)
 Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.
virtual void SetSelectable (int _arg)
 Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.

Static Public Member Functions

static new vtkBorderWidget New ()
 Method to instantiate class.
static new int IsTypeOf (string type)
 Description; Standard methods for class.
static new vtkBorderWidget SafeDownCast (vtkObjectBase o)
 Description; Standard methods for class.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "15vtkBorderWidget"
 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 vtkBorderWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkBorderWidget_CreateDefaultRepresentation_01 (HandleRef pThis)
static internal IntPtr vtkBorderWidget_GetBorderRepresentation_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkBorderWidget_GetResizable_03 (HandleRef pThis)
static internal int vtkBorderWidget_GetSelectable_04 (HandleRef pThis)
static internal int vtkBorderWidget_IsA_05 (HandleRef pThis, string type)
static internal int vtkBorderWidget_IsTypeOf_06 (string type)
static internal IntPtr vtkBorderWidget_NewInstance_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkBorderWidget_ResizableOff_09 (HandleRef pThis)
static internal void vtkBorderWidget_ResizableOn_10 (HandleRef pThis)
static internal IntPtr vtkBorderWidget_SafeDownCast_11 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkBorderWidget_SelectableOff_12 (HandleRef pThis)
static internal void vtkBorderWidget_SelectableOn_13 (HandleRef pThis)
static internal void vtkBorderWidget_SetRepresentation_14 (HandleRef pThis, HandleRef r)
static internal void vtkBorderWidget_SetResizable_15 (HandleRef pThis, int _arg)
static internal void vtkBorderWidget_SetSelectable_16 (HandleRef pThis, int _arg)

Static Private Member Functions

static vtkBorderWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkBorderWidget - place a border around a 2D rectangular region

Description This class is a superclass for 2D widgets that may require a rectangular border. Besides drawing a border, the widget provides methods for resizing and moving the rectangular region (and associated border). The widget provides methods and internal data members so that subclasses can take advantage of this widgets capabilities, requiring only that the subclass defines a "representation", i.e., some combination of props or actors that can be managed in the 2D rectangular region.

The class defines basic positioning functionality, including the ability to size the widget with locked x/y proportions. The area within the border may be made "selectable" as well, meaning that a selection event interior to the widget invokes a virtual SelectRegion() method, which can be used to pick objects or otherwise manipulate data interior to the widget.

Event Bindings By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events): <pre> On the boundary of the widget: LeftButtonPressEvent - select boundary LeftButtonReleaseEvent - deselect boundary MouseMoveEvent - move/resize widget depending on which portion of the boundary was selected. On the interior of the widget: LeftButtonPressEvent - invoke SelectButton() callback (if the ivar Selectable is on) Anywhere on the widget: MiddleButtonPressEvent - move the widget </pre>

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkBorderWidget's widget events: <pre> vtkWidgetEvent::Select -- some part of the widget has been selected vtkWidgetEvent::EndSelect -- the selection process has completed vtkWidgetEvent::Translate -- the widget is to be translated vtkWidgetEvent::Move -- a request for slider motion has been invoked </pre>

In turn, when these widget events are processed, this widget 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.vtkBorderWidget.vtkBorderWidget ( ) [static, private]

Automatically generated type registration mechanics.

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

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

Method to instantiate class.


Member Function Documentation

override void Kitware.VTK.vtkBorderWidget.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.vtkCaptionWidget, Kitware.VTK.vtkScalarBarWidget, Kitware.VTK.vtkCameraWidget, Kitware.VTK.vtkTextWidget, Kitware.VTK.vtkLogoWidget, and Kitware.VTK.vtkPlaybackWidget.

Return the representation as a vtkBorderRepresentation.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkBorderWidget.GetResizable ( ) [virtual]

Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.

virtual int Kitware.VTK.vtkBorderWidget.GetSelectable ( ) [virtual]

Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.

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

Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.

virtual void Kitware.VTK.vtkBorderWidget.ResizableOn ( ) [virtual]

Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.

Description; Standard methods for class.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Reimplemented in Kitware.VTK.vtkScalarBarWidget, Kitware.VTK.vtkCaptionWidget, Kitware.VTK.vtkTextWidget, Kitware.VTK.vtkCameraWidget, Kitware.VTK.vtkLogoWidget, and Kitware.VTK.vtkPlaybackWidget.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkBorderWidget.SelectableOff ( ) [virtual]

Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.

virtual void Kitware.VTK.vtkBorderWidget.SelectableOn ( ) [virtual]

Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.

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.

virtual void Kitware.VTK.vtkBorderWidget.SetResizable ( int  _arg) [virtual]

Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.

virtual void Kitware.VTK.vtkBorderWidget.SetSelectable ( int  _arg) [virtual]

Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.

static internal void Kitware.VTK.vtkBorderWidget.vtkBorderWidget_CreateDefaultRepresentation_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkBorderWidget.vtkBorderWidget_GetBorderRepresentation_02 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkBorderWidget.vtkBorderWidget_GetResizable_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkBorderWidget.vtkBorderWidget_GetSelectable_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkBorderWidget.vtkBorderWidget_IsA_05 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkBorderWidget.vtkBorderWidget_IsTypeOf_06 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkBorderWidget.vtkBorderWidget_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkBorderWidget.vtkBorderWidget_NewInstance_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkBorderWidget.vtkBorderWidget_ResizableOff_09 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkBorderWidget.vtkBorderWidget_ResizableOn_10 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkBorderWidget.vtkBorderWidget_SafeDownCast_11 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkBorderWidget.vtkBorderWidget_SelectableOff_12 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkBorderWidget.vtkBorderWidget_SelectableOn_13 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkBorderWidget.vtkBorderWidget_SetRepresentation_14 ( HandleRef  pThis,
HandleRef  r 
) [private]
static internal void Kitware.VTK.vtkBorderWidget.vtkBorderWidget_SetResizable_15 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkBorderWidget.vtkBorderWidget_SetSelectable_16 ( HandleRef  pThis,
int  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkBorderWidget.MRClassNameKey = "15vtkBorderWidget" [static]
new const string Kitware.VTK.vtkBorderWidget.MRFullTypeName = "Kitware.VTK.vtkBorderWidget"

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