VTK  9.3.20240527
vtkResliceCursorRepresentation.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
18#ifndef vtkResliceCursorRepresentation_h
19#define vtkResliceCursorRepresentation_h
20
21#include "vtkInteractionWidgetsModule.h" // For export macro
23#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
24
25VTK_ABI_NAMESPACE_BEGIN
26class vtkTextProperty;
27class vtkActor2D;
28class vtkTextMapper;
29class vtkImageData;
30class vtkImageReslice;
31class vtkPlane;
32class vtkPlaneSource;
35class vtkMatrix4x4;
38class vtkActor;
39class vtkImageActor;
40class vtkTexture;
41class vtkTextActor;
43
44// Private.
45#define VTK_RESLICE_CURSOR_REPRESENTATION_MAX_TEXTBUFF 128
46
47class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkResliceCursorRepresentation
49{
50public:
52
56 void PrintSelf(ostream& os, vtkIndent indent) override;
58
60
65 vtkSetClampMacro(Tolerance, int, 1, 100);
66 vtkGetMacro(Tolerance, int);
68
70
73 vtkSetMacro(ShowReslicedImage, vtkTypeBool);
74 vtkGetMacro(ShowReslicedImage, vtkTypeBool);
75 vtkBooleanMacro(ShowReslicedImage, vtkTypeBool);
77
79
83 vtkSetMacro(RestrictPlaneToVolume, vtkTypeBool);
84 vtkGetMacro(RestrictPlaneToVolume, vtkTypeBool);
85 vtkBooleanMacro(RestrictPlaneToVolume, vtkTypeBool);
87
89
94 vtkSetStringMacro(ThicknessLabelFormat);
95 vtkGetStringMacro(ThicknessLabelFormat);
97
98 // Used to communicate about the state of the representation
99 enum
100 {
101 Outside = 0,
107 OnAxis2
108 };
109 enum
110 {
111 None = 0,
116 TranslateSingleAxis
117 };
118
122 virtual char* GetThicknessLabelText();
123
125
128 virtual double* GetThicknessLabelPosition();
129 virtual void GetThicknessLabelPosition(double pos[3]);
130 virtual void GetWorldThicknessLabelPosition(double pos[3]);
132
136 void BuildRepresentation() override;
137
139
142 vtkGetObjectMacro(ResliceAxes, vtkMatrix4x4);
143 vtkGetObjectMacro(Reslice, vtkImageAlgorithm);
145
147
150 vtkGetObjectMacro(ImageActor, vtkImageActor);
152
154
162 vtkGetObjectMacro(LookupTable, vtkScalarsToColors);
164
166
172 vtkGetObjectMacro(ColorMap, vtkImageMapToColors);
175
177
183 void SetWindowLevel(double window, double level, int copy = 0);
184 void GetWindowLevel(double wl[2]);
185 double GetWindow() { return this->CurrentWindow; }
186 double GetLevel() { return this->CurrentLevel; }
188
190
192
196 vtkSetMacro(DisplayText, vtkTypeBool);
197 vtkGetMacro(DisplayText, vtkTypeBool);
198 vtkBooleanMacro(DisplayText, vtkTypeBool);
200
202
208
210
214 vtkSetMacro(UseImageActor, vtkTypeBool);
215 vtkGetMacro(UseImageActor, vtkTypeBool);
216 vtkBooleanMacro(UseImageActor, vtkTypeBool);
218
220
225 vtkGetMacro(ManipulationMode, int);
227
229
234 void ActivateText(int);
237
239
244 virtual void ResetCamera();
246
251
253
257 vtkGetObjectMacro(PlaneSource, vtkPlaneSource);
259
265 static int BoundPlane(double bounds[6], double origin[3], double p1[3], double p2[3]);
272 static void TransformPlane(vtkPlaneSource* planeToTransform, double targetCenter[3],
273 double targetNormal[3], double targetViewUp[3]);
274
275protected:
278
280
286 double outputSpacingX, double outputSpacingY, int extentX, int extentY);
288
292 virtual void WindowLevel(double x, double y);
293
297 virtual void UpdateReslicePlane();
298
303
304 // for negative window values.
306
307 // recompute origin to make the location of the reslice cursor consistent
308 // with its physical location
310
312 void GetVector1(double d[3]);
313 void GetVector2(double d[3]);
315
321
322 // Keep track if modifier is set
324
325 // Selection tolerance for the handles
327
328 // Format for printing the distance
330
352 double LastEventPosition[2];
356
359
360private:
362 void operator=(const vtkResliceCursorRepresentation&) = delete;
363};
364
365VTK_ABI_NAMESPACE_END
366#endif
a actor that draws 2D data
Definition vtkActor2D.h:145
represents an object (geometry & properties) in a rendered scene
Definition vtkActor.h:151
draw an image in a rendered 3D scene
Generic algorithm superclass for image algs.
topologically and geometrically regular array of data
map the input image through a lookup table
Reslices a volume along a new set of axes.
a simple class to control print indentation
Definition vtkIndent.h:108
represent and manipulate 4x4 transformation matrices
create an array of quadrilaterals located in a plane
perform various plane computations
Definition vtkPlane.h:135
generates a 2D reslice cursor polydata
represent the vtkResliceCursorWidget
int ManipulationMode
The widget sets the manipulation mode.
virtual void InitializeReslicePlane()
Initialize the reslice planes and the camera center.
virtual char * GetThicknessLabelText()
Get the text shown in the widget's label.
double GetLevel()
Set/Get the current window and level values.
~vtkResliceCursorRepresentation() override
double GetWindow()
Set/Get the current window and level values.
virtual void UpdateReslicePlane()
Update the reslice plane.
void GetVector1(double d[3])
virtual double * GetThicknessLabelPosition()
Get the position of the widget's label in display coordinates.
void GetVector2(double d[3])
void PrintSelf(ostream &os, vtkIndent indent) override
Standard VTK methods.
virtual void WindowLevel(double x, double y)
Process window level.
virtual vtkResliceCursorPolyDataAlgorithm * GetCursorAlgorithm()=0
Get the underlying cursor source.
void ManageTextDisplay()
INTERNAL - Do not use.
static void TransformPlane(vtkPlaneSource *planeToTransform, double targetCenter[3], double targetNormal[3], double targetViewUp[3])
First rotate planeToTransform to match targetPlane normal.
virtual vtkResliceCursor * GetResliceCursor()=0
static int BoundPlane(double bounds[6], double origin[3], double p1[3], double p2[3])
Fit the plane defined by origin, p1, p2 onto the bounds.
virtual void ComputeOrigin(vtkMatrix4x4 *)
void SetManipulationMode(int m)
INTERNAL - Do not use Set the manipulation mode.
void SetWindowLevel(double window, double level, int copy=0)
Set/Get the current window and level values.
virtual void CreateDefaultResliceAlgorithm()
Create New Reslice plane.
void GetWindowLevel(double wl[2])
Set/Get the current window and level values.
virtual void ResetCamera()
Initialize the reslice planes and the camera center.
virtual void SetColorMap(vtkImageMapToColors *)
Convenience method to get the vtkImageMapToColors filter used by this widget.
vtkTextProperty * GetTextProperty()
Set/Get the text property for the image data and window-level annotation.
virtual void ComputeReslicePlaneOrigin()
Compute the origin of the planes so as to capture the entire image.
void SetTextProperty(vtkTextProperty *tprop)
Set/Get the text property for the image data and window-level annotation.
void ActivateText(int)
INTERNAL - Do not use.
void BuildRepresentation() override
These are methods that satisfy vtkWidgetRepresentation's API.
virtual void SetLookupTable(vtkScalarsToColors *)
Set/Get the internal lookuptable (lut) to one defined by the user, or, alternatively,...
virtual void GetThicknessLabelPosition(double pos[3])
Get the position of the widget's label in display coordinates.
virtual void SetResliceParameters(double outputSpacingX, double outputSpacingY, int extentX, int extentY)
Create New Reslice plane.
virtual void GetWorldThicknessLabelPosition(double pos[3])
Get the position of the widget's label in display coordinates.
vtkScalarsToColors * CreateDefaultLookupTable()
Geometry for a reslice cursor.
Superclass for mapping scalar values to colors.
An actor that displays text.
2D text annotation
represent text properties.
handles properties associated with a texture map
Definition vtkTexture.h:167
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition vtkABI.h:64
#define VTK_RESLICE_CURSOR_REPRESENTATION_MAX_TEXTBUFF
#define VTK_MARSHALAUTO