VTK  9.1.0
vtkImageCroppingRegionsWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageCroppingRegionsWidget.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
33 #ifndef vtkImageCroppingRegionsWidget_h
34 #define vtkImageCroppingRegionsWidget_h
35 
36 #include "vtk3DWidget.h"
37 #include "vtkInteractionWidgetsModule.h" // For export macro
38 
39 class vtkActor2D;
40 class vtkImageData;
41 class vtkLineSource;
42 class vtkVolumeMapper;
43 class vtkPolyData;
44 
45 class VTKINTERACTIONWIDGETS_EXPORT vtkImageCroppingRegionsWidget : public vtk3DWidget
46 {
47 public:
49 
54  void PrintSelf(ostream& os, vtkIndent indent) override;
56 
58 
62  void PlaceWidget(double bounds[6]) override;
64 
68  void SetEnabled(int enabling) override;
69 
71 
74  vtkGetVector6Macro(PlanePositions, double);
75  virtual void SetPlanePositions(double pos[6])
76  {
77  this->SetPlanePositions(pos[0], pos[1], pos[2], pos[3], pos[4], pos[5]);
78  }
79  virtual void SetPlanePositions(float pos[6])
80  {
81  this->SetPlanePositions(pos[0], pos[1], pos[2], pos[3], pos[4], pos[5]);
82  }
83  virtual void SetPlanePositions(
84  double xMin, double xMax, double yMin, double yMax, double zMin, double zMax);
86 
88 
91  virtual void SetCroppingRegionFlags(int flags);
92  vtkGetMacro(CroppingRegionFlags, int);
94 
99  enum
100  {
101  SLICE_ORIENTATION_YZ = 0,
102  SLICE_ORIENTATION_XZ = 1,
103  SLICE_ORIENTATION_XY = 2
104  };
105 
106  vtkGetMacro(SliceOrientation, int);
107  virtual void SetSliceOrientation(int orientation);
108  virtual void SetSliceOrientationToXY()
109  {
110  this->SetSliceOrientation(vtkImageCroppingRegionsWidget::SLICE_ORIENTATION_XY);
111  }
112  virtual void SetSliceOrientationToYZ()
113  {
114  this->SetSliceOrientation(vtkImageCroppingRegionsWidget::SLICE_ORIENTATION_YZ);
115  }
116  virtual void SetSliceOrientationToXZ()
117  {
118  this->SetSliceOrientation(vtkImageCroppingRegionsWidget::SLICE_ORIENTATION_XZ);
119  }
120 
122 
125  virtual void SetSlice(int num);
126  vtkGetMacro(Slice, int);
128 
130 
133  virtual void SetLine1Color(double r, double g, double b);
134  virtual void SetLine1Color(double rgb[3]) { this->SetLine1Color(rgb[0], rgb[1], rgb[2]); }
135  virtual double* GetLine1Color();
136  virtual void GetLine1Color(double rgb[3]);
138 
140 
143  virtual void SetLine2Color(double r, double g, double b);
144  virtual void SetLine2Color(double rgb[3]) { this->SetLine2Color(rgb[0], rgb[1], rgb[2]); }
145  virtual double* GetLine2Color();
146  virtual void GetLine2Color(double rgb[3]);
148 
150 
153  virtual void SetLine3Color(double r, double g, double b);
154  virtual void SetLine3Color(double rgb[3]) { this->SetLine3Color(rgb[0], rgb[1], rgb[2]); }
155  virtual double* GetLine3Color();
156  virtual void GetLine3Color(double rgb[3]);
158 
160 
163  virtual void SetLine4Color(double r, double g, double b);
164  virtual void SetLine4Color(double rgb[3]) { this->SetLine4Color(rgb[0], rgb[1], rgb[2]); }
165  virtual double* GetLine4Color();
166  virtual void GetLine4Color(double rgb[3]);
168 
170 
174  virtual void SetVolumeMapper(vtkVolumeMapper* mapper);
175  vtkGetObjectMacro(VolumeMapper, vtkVolumeMapper);
176  virtual void UpdateAccordingToInput();
178 
180 
189  void OnMouseMove();
191 
196  {
197  CroppingPlanesPositionChangedEvent = 10050
198  };
199 
200 protected:
203 
205 
206  vtkLineSource* LineSources[4];
207  vtkActor2D* LineActors[4];
208  vtkPolyData* RegionPolyData[9];
209  vtkActor2D* RegionActors[9];
210 
211  double PlanePositions[6];
212 
214  int Slice;
215 
217 
219 
221  int Moving;
222 
223  // Handles the events
224 
225  static void ProcessEvents(
226  vtkObject* object, unsigned long event, void* clientdata, void* calldata);
227 
228  void SetMouseCursor(int state);
229 
231  {
232  NoLine = 0,
240  MovingH2
241  };
242 
243  int ComputeWorldCoordinate(int x, int y, double* coord);
244 
247  void ConstrainPlanePositions(double positions[6]);
248 
249 private:
251  void operator=(const vtkImageCroppingRegionsWidget&) = delete;
252 };
253 
254 #endif
vtkImageCroppingRegionsWidget::GetLine2Color
virtual void GetLine2Color(double rgb[3])
Set/Get line 2 color.
vtkImageCroppingRegionsWidget::GetLine3Color
virtual void GetLine3Color(double rgb[3])
Set/Get line 3 color.
vtkImageCroppingRegionsWidget::SetSlice
virtual void SetSlice(int num)
Set/Get the slice number.
vtkVolumeMapper
Abstract class for a volume mapper.
Definition: vtkVolumeMapper.h:45
vtkImageCroppingRegionsWidget::SetMouseCursor
void SetMouseCursor(int state)
vtkImageCroppingRegionsWidget::GetSlicePosition
double GetSlicePosition()
vtkImageCroppingRegionsWidget::UpdateGeometry
void UpdateGeometry()
vtkImageCroppingRegionsWidget::SetLine4Color
virtual void SetLine4Color(double r, double g, double b)
Set/Get line 4 color.
vtkImageCroppingRegionsWidget::SetLine2Color
virtual void SetLine2Color(double r, double g, double b)
Set/Get line 2 color.
vtkImageCroppingRegionsWidget::MovingV2
@ MovingV2
Definition: vtkImageCroppingRegionsWidget.h:238
vtkImageCroppingRegionsWidget
widget for cropping an image
Definition: vtkImageCroppingRegionsWidget.h:46
vtkImageCroppingRegionsWidget::GetLine4Color
virtual void GetLine4Color(double rgb[3])
Set/Get line 4 color.
vtkImageCroppingRegionsWidget::UpdateOpacity
void UpdateOpacity()
vtkImageCroppingRegionsWidget::vtkImageCroppingRegionsWidget
vtkImageCroppingRegionsWidget()
vtkImageCroppingRegionsWidget::WidgetEventIds
WidgetEventIds
Events invoked by this widget.
Definition: vtkImageCroppingRegionsWidget.h:196
vtkImageCroppingRegionsWidget::UpdateAccordingToInput
virtual void UpdateAccordingToInput()
Set/Get the input volume mapper Update the widget according to its mapper.
vtkImageCroppingRegionsWidget::SetLine3Color
virtual void SetLine3Color(double rgb[3])
Set/Get line 3 color.
Definition: vtkImageCroppingRegionsWidget.h:154
vtkImageCroppingRegionsWidget::SLICE_ORIENTATION_XZ
@ SLICE_ORIENTATION_XZ
Definition: vtkImageCroppingRegionsWidget.h:102
vtkImageCroppingRegionsWidget::SetLine4Color
virtual void SetLine4Color(double rgb[3])
Set/Get line 4 color.
Definition: vtkImageCroppingRegionsWidget.h:164
vtkImageCroppingRegionsWidget::MovingH1AndV1
@ MovingH1AndV1
Definition: vtkImageCroppingRegionsWidget.h:233
vtkImageCroppingRegionsWidget::SetPlanePositions
virtual void SetPlanePositions(double pos[6])
Set/Get the plane positions that represent the cropped region.
Definition: vtkImageCroppingRegionsWidget.h:75
vtkImageCroppingRegionsWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Standard VTK methods.
vtkImageCroppingRegionsWidget::SetEnabled
void SetEnabled(int enabling) override
Enable/disable the widget.
vtkImageCroppingRegionsWidget::GetLine1Color
virtual void GetLine1Color(double rgb[3])
Set/Get line 1 color.
vtkImageCroppingRegionsWidget::MovingH2AndV2
@ MovingH2AndV2
Definition: vtkImageCroppingRegionsWidget.h:236
vtkImageCroppingRegionsWidget::SetLine2Color
virtual void SetLine2Color(double rgb[3])
Set/Get line 2 color.
Definition: vtkImageCroppingRegionsWidget.h:144
vtkImageCroppingRegionsWidget::GetLine2Color
virtual double * GetLine2Color()
Set/Get line 2 color.
vtkImageCroppingRegionsWidget::MoveHorizontalLine
void MoveHorizontalLine()
Callbacks for user interaction.
vtkImageCroppingRegionsWidget::SetCroppingRegionFlags
virtual void SetCroppingRegionFlags(int flags)
Set/Get the cropping region flags.
vtkImageCroppingRegionsWidget::MovingH2AndV1
@ MovingH2AndV1
Definition: vtkImageCroppingRegionsWidget.h:234
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:82
vtkImageCroppingRegionsWidget::SetLine1Color
virtual void SetLine1Color(double r, double g, double b)
Set/Get line 1 color.
vtkImageCroppingRegionsWidget::SetVolumeMapper
virtual void SetVolumeMapper(vtkVolumeMapper *mapper)
Set/Get the input volume mapper Update the widget according to its mapper.
vtkImageCroppingRegionsWidget::GetLine4Color
virtual double * GetLine4Color()
Set/Get line 4 color.
vtkImageCroppingRegionsWidget::GetLine3Color
virtual double * GetLine3Color()
Set/Get line 3 color.
vtkImageCroppingRegionsWidget::MouseCursorState
int MouseCursorState
Definition: vtkImageCroppingRegionsWidget.h:220
vtkImageCroppingRegionsWidget::SetLine1Color
virtual void SetLine1Color(double rgb[3])
Set/Get line 1 color.
Definition: vtkImageCroppingRegionsWidget.h:134
vtkImageCroppingRegionsWidget::OnMouseMove
void OnMouseMove()
Callbacks for user interaction.
vtkImageCroppingRegionsWidget::ComputeWorldCoordinate
int ComputeWorldCoordinate(int x, int y, double *coord)
vtkImageCroppingRegionsWidget::PlaceWidget
void PlaceWidget(double bounds[6]) override
Place/Adjust widget within bounds.
vtkImageCroppingRegionsWidget::MovingH1AndV2
@ MovingH1AndV2
Definition: vtkImageCroppingRegionsWidget.h:235
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:157
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:113
vtkImageCroppingRegionsWidget::SetPlanePositions
virtual void SetPlanePositions(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
Set/Get the plane positions that represent the cropped region.
vtkImageCroppingRegionsWidget::Moving
int Moving
Definition: vtkImageCroppingRegionsWidget.h:221
vtkImageCroppingRegionsWidget::SetSliceOrientationToXY
virtual void SetSliceOrientationToXY()
Definition: vtkImageCroppingRegionsWidget.h:108
vtkImageCroppingRegionsWidget::SetLine3Color
virtual void SetLine3Color(double r, double g, double b)
Set/Get line 3 color.
vtk3DWidget
an abstract superclass for 3D widgets
Definition: vtk3DWidget.h:71
vtkImageCroppingRegionsWidget::~vtkImageCroppingRegionsWidget
~vtkImageCroppingRegionsWidget() override
vtkImageCroppingRegionsWidget::MoveIntersectingLines
void MoveIntersectingLines()
Callbacks for user interaction.
vtkLineSource
create a line defined by two end points
Definition: vtkLineSource.h:170
vtkImageCroppingRegionsWidget::VolumeMapper
vtkVolumeMapper * VolumeMapper
Definition: vtkImageCroppingRegionsWidget.h:204
vtkImageCroppingRegionsWidget::SLICE_ORIENTATION_YZ
@ SLICE_ORIENTATION_YZ
Definition: vtkImageCroppingRegionsWidget.h:101
vtkImageCroppingRegionsWidget::SetSliceOrientationToXZ
virtual void SetSliceOrientationToXZ()
Definition: vtkImageCroppingRegionsWidget.h:116
vtkImageCroppingRegionsWidget::CroppingRegionFlags
int CroppingRegionFlags
Definition: vtkImageCroppingRegionsWidget.h:218
vtkActor2D
a actor that draws 2D data
Definition: vtkActor2D.h:149
vtkImageCroppingRegionsWidget::ConstrainPlanePositions
void ConstrainPlanePositions(double positions[6])
vtkX3D::orientation
@ orientation
Definition: vtkX3D.h:268
vtk3DWidget::PlaceWidget
virtual void PlaceWidget()
This method is used to initially place the widget.
vtkImageCroppingRegionsWidget::MoveVerticalLine
void MoveVerticalLine()
Callbacks for user interaction.
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:195
vtkImageCroppingRegionsWidget::Slice
int Slice
Definition: vtkImageCroppingRegionsWidget.h:214
vtkImageCroppingRegionsWidget::OnButtonPress
void OnButtonPress()
Callbacks for user interaction.
vtkImageCroppingRegionsWidget::UpdateCursorIcon
void UpdateCursorIcon()
Callbacks for user interaction.
vtk3DWidget.h
vtkImageCroppingRegionsWidget::WidgetStates
WidgetStates
Definition: vtkImageCroppingRegionsWidget.h:231
vtkImageCroppingRegionsWidget::GetLine1Color
virtual double * GetLine1Color()
Set/Get line 1 color.
vtkImageCroppingRegionsWidget::MovingV1
@ MovingV1
Definition: vtkImageCroppingRegionsWidget.h:237
vtkImageCroppingRegionsWidget::MovingH1
@ MovingH1
Definition: vtkImageCroppingRegionsWidget.h:239
vtkImageCroppingRegionsWidget::SliceOrientation
int SliceOrientation
Definition: vtkImageCroppingRegionsWidget.h:213
vtkImageCroppingRegionsWidget::ProcessEvents
static void ProcessEvents(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
vtkImageCroppingRegionsWidget::SetSliceOrientation
virtual void SetSliceOrientation(int orientation)
vtkImageCroppingRegionsWidget::New
static vtkImageCroppingRegionsWidget * New()
Standard VTK methods.
vtkImageCroppingRegionsWidget::SetPlanePositions
virtual void SetPlanePositions(float pos[6])
Set/Get the plane positions that represent the cropped region.
Definition: vtkImageCroppingRegionsWidget.h:79
vtkImageCroppingRegionsWidget::OnButtonRelease
void OnButtonRelease()
Callbacks for user interaction.
vtkImageCroppingRegionsWidget::SLICE_ORIENTATION_XY
@ SLICE_ORIENTATION_XY
Definition: vtkImageCroppingRegionsWidget.h:103
vtkImageCroppingRegionsWidget::SetSliceOrientationToYZ
virtual void SetSliceOrientationToYZ()
Definition: vtkImageCroppingRegionsWidget.h:112