forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkRectilinearWipeWidget.h
146 lines (127 loc) · 5.22 KB
/
vtkRectilinearWipeWidget.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*=========================================================================
Program: Visualization Toolkit
Module: vtkRectilinearWipeWidget.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkRectilinearWipeWidget
* @brief interactively control an instance of vtkImageRectilinearWipe filter
*
* 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>
*
* @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.
*
* @sa
* vtkRectilinearWipeProp vtkImageRectilinearWipe vtkImageActor
* vtkCheckerboardWidget
*/
#ifndef vtkRectilinearWipeWidget_h
#define vtkRectilinearWipeWidget_h
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkAbstractWidget.h"
class vtkRectilinearWipeRepresentation;
class VTKINTERACTIONWIDGETS_EXPORT vtkRectilinearWipeWidget : public vtkAbstractWidget
{
public:
/**
* Instantiate the class.
*/
static vtkRectilinearWipeWidget *New();
//@{
/**
* Standard macros.
*/
vtkTypeMacro(vtkRectilinearWipeWidget,vtkAbstractWidget);
void PrintSelf(ostream& os, vtkIndent indent);
//@}
/**
* 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 SetRepresentation(vtkRectilinearWipeRepresentation *r)
{this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));}
/**
* Return the representation as a vtkRectilinearWipeRepresentation.
*/
vtkRectilinearWipeRepresentation *GetRectilinearWipeRepresentation()
{return reinterpret_cast<vtkRectilinearWipeRepresentation*>(this->WidgetRep);}
/**
* Create the default widget representation if one is not set.
*/
virtual void CreateDefaultRepresentation();
protected:
vtkRectilinearWipeWidget();
~vtkRectilinearWipeWidget();
// These methods handle events
static void SelectAction(vtkAbstractWidget*);
static void MoveAction(vtkAbstractWidget*);
static void EndSelectAction(vtkAbstractWidget*);
// helper methods for cursor management
void SetCursor(int state);
// Manage the state of the widget
int WidgetState;
enum _WidgetState
{
Start=0,
Selected
};
private:
vtkRectilinearWipeWidget(const vtkRectilinearWipeWidget&) VTK_DELETE_FUNCTION;
void operator=(const vtkRectilinearWipeWidget&) VTK_DELETE_FUNCTION;
};
#endif