vtkRectilinearWipeWidget Class Reference
#include <vtkRectilinearWipeWidget.h>
Detailed Description
interactively control an instance of vtkImageRectilinearWipe filterThe 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:
Selecting the center point, horizontal separator, and verticel separator: LeftButtonPressEvent - move the separators LeftButtonReleaseEvent - release the separators MouseMoveEvent - move the separatorsSelecting 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:
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
In turn, when these widget events are processed, the vtkRectilinearWipeWidget invokes the following VTK events (which observers can listen for):
vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select) vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect) vtkCommand::InteractionEvent (on vtkWidgetEvent::Move)
- Warning:
- 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.
- See also:
- vtkRectilinearWipeProp vtkImageRectilinearWipe vtkImageActor vtkCheckerboardWidget
- Events:
- vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent
Definition at line 90 of file vtkRectilinearWipeWidget.h.
| typedef vtkAbstractWidget | Superclass |
| static int | IsTypeOf (const char *type) |
| static vtkRectilinearWipeWidget * | SafeDownCast (vtkObject *o) |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
Public Member Functions | |
| virtual void | CreateDefaultRepresentation () |
| void | SetRepresentation (vtkRectilinearWipeRepresentation *r) |
| vtkRectilinearWipeRepresentation * | GetRectilinearWipeRepresentation () |
Static Public Member Functions | |
| static vtkRectilinearWipeWidget * | New () |
Protected Types | |
| enum | _WidgetState { Start = 0, Selected } |
Protected Member Functions | |
| vtkRectilinearWipeWidget () | |
| ~vtkRectilinearWipeWidget () | |
| void | SetCursor (int state) |
Static Protected Member Functions | |
| static void | SelectAction (vtkAbstractWidget *) |
| static void | MoveAction (vtkAbstractWidget *) |
| static void | EndSelectAction (vtkAbstractWidget *) |
Protected Attributes | |
| int | WidgetState |
Member Typedef Documentation
Standard macros.
Reimplemented from vtkAbstractWidget.
Definition at line 98 of file vtkRectilinearWipeWidget.h.
Member Enumeration Documentation
enum vtkRectilinearWipeWidget::_WidgetState [protected] |
Constructor & Destructor Documentation
| vtkRectilinearWipeWidget::vtkRectilinearWipeWidget | ( | ) | [protected] |
| vtkRectilinearWipeWidget::~vtkRectilinearWipeWidget | ( | ) | [protected] |
Member Function Documentation
| static vtkRectilinearWipeWidget* vtkRectilinearWipeWidget::New | ( | ) | [static] |
Instantiate the class.
Reimplemented from vtkObject.
| virtual const char* vtkRectilinearWipeWidget::GetClassName | ( | ) | [virtual] |
Standard macros.
Reimplemented from vtkAbstractWidget.
| static int vtkRectilinearWipeWidget::IsTypeOf | ( | const char * | type | ) | [static] |
Standard macros.
Reimplemented from vtkAbstractWidget.
| virtual int vtkRectilinearWipeWidget::IsA | ( | const char * | type | ) | [virtual] |
Standard macros.
Reimplemented from vtkAbstractWidget.
| static vtkRectilinearWipeWidget* vtkRectilinearWipeWidget::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Standard macros.
Reimplemented from vtkAbstractWidget.
| void vtkRectilinearWipeWidget::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Standard macros.
Reimplemented from vtkAbstractWidget.
| void vtkRectilinearWipeWidget::SetRepresentation | ( | vtkRectilinearWipeRepresentation * | r | ) | [inline] |
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.
Definition at line 106 of file vtkRectilinearWipeWidget.h.
| vtkRectilinearWipeRepresentation* vtkRectilinearWipeWidget::GetRectilinearWipeRepresentation | ( | ) | [inline] |
Return the representation as a vtkRectilinearWipeRepresentation.
Definition at line 112 of file vtkRectilinearWipeWidget.h.
| virtual void vtkRectilinearWipeWidget::CreateDefaultRepresentation | ( | ) | [virtual] |
Create the default widget representation if one is not set.
Implements vtkAbstractWidget.
| static void vtkRectilinearWipeWidget::SelectAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkRectilinearWipeWidget::MoveAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkRectilinearWipeWidget::EndSelectAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| void vtkRectilinearWipeWidget::SetCursor | ( | int | state | ) | [protected] |
Member Data Documentation
int vtkRectilinearWipeWidget::WidgetState [protected] |
Definition at line 132 of file vtkRectilinearWipeWidget.h.
The documentation for this class was generated from the following file:
- dox/Widgets/vtkRectilinearWipeWidget.h
