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

vtkRectilinearWipeWidget - interactively control an instance of vtkImageRectilinearWipe filter More...

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

List of all members.

Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "24vtkRectilinearWipeWidget"
 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 vtkRectilinearWipeWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkRectilinearWipeWidget_CreateDefaultRepresentation_01 (HandleRef pThis)
static internal IntPtr vtkRectilinearWipeWidget_GetRectilinearWipeRepresentation_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkRectilinearWipeWidget_IsA_03 (HandleRef pThis, string type)
static internal int vtkRectilinearWipeWidget_IsTypeOf_04 (string type)
static internal IntPtr vtkRectilinearWipeWidget_NewInstance_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkRectilinearWipeWidget_SafeDownCast_07 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkRectilinearWipeWidget_SetRepresentation_08 (HandleRef pThis, HandleRef r)

Static Private Member Functions

static vtkRectilinearWipeWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkRectilinearWipeWidget - interactively control an instance of vtkImageRectilinearWipe filter

Description The vtkRectilinearWipeWidget is used to interactively control an instance of vtkImageRectilinearWipe (and an associated vtkImageActor used to display the rectilinear wipe). A rectilinear wipe is a 2x2 checkerboard pattern created by combining two separate images, where various combinations of the checker squares are possible. Using this widget, the user can adjust the layout of the checker pattern, such as moving the center point, moving the horizontal separator, or moving the vertical separator. These capabilities are particularly useful for comparing two images.

To use this widget, specify its representation (by default the representation is an instance of vtkRectilinearWipeProp). The representation generally requires that you specify an instance of vtkImageRectilinearWipe and an instance of vtkImageActor. Other instance variables may also be required to be set -- see the documentation for vtkRectilinearWipeProp (or appropriate subclass).

By default, the widget responds to the following events: <pre> Selecting the center point, horizontal separator, and verticel separator: LeftButtonPressEvent - move the separators LeftButtonReleaseEvent - release the separators MouseMoveEvent - move the separators </pre> Selecting the center point allows you to move the horizontal and vertical separators simultaneously. Otherwise only horizontal or vertical motion is possible/

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkRectilinearWipeWidget'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 motion has been invoked </pre>

In turn, when these widget events are processed, the vtkRectilinearWipeWidget invokes the following VTK events (which observers can listen for): <pre> vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select) vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect) vtkCommand::InteractionEvent (on vtkWidgetEvent::Move) </pre>

Caveats The appearance of this widget is defined by its representation, including any properties associated with the representation. The widget representation is a type of vtkProp that defines a particular API that works with this widget. If desired, the vtkProp may be subclassed to create new looks for the widget.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

Here is the call graph for this function:

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

Standard macros.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

static new int Kitware.VTK.vtkRectilinearWipeWidget.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.vtkRectilinearWipeWidget.vtkRectilinearWipeWidget_GetRectilinearWipeRepresentation_02 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkRectilinearWipeWidget.vtkRectilinearWipeWidget_IsA_03 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkRectilinearWipeWidget.vtkRectilinearWipeWidget_IsTypeOf_04 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkRectilinearWipeWidget.vtkRectilinearWipeWidget_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkRectilinearWipeWidget.vtkRectilinearWipeWidget_NewInstance_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkRectilinearWipeWidget.vtkRectilinearWipeWidget_SafeDownCast_07 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkRectilinearWipeWidget.vtkRectilinearWipeWidget_SetRepresentation_08 ( HandleRef  pThis,
HandleRef  r 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkRectilinearWipeWidget.MRClassNameKey = "24vtkRectilinearWipeWidget" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.


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