VTK  9.3.0
vtkImageSliceMapper.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
21 #ifndef vtkImageSliceMapper_h
22 #define vtkImageSliceMapper_h
23 
24 #include "vtkImageMapper3D.h"
25 #include "vtkRenderingCoreModule.h" // For export macro
26 
27 VTK_ABI_NAMESPACE_BEGIN
28 class vtkCamera;
29 class vtkPoints;
30 
31 class VTKRENDERINGCORE_EXPORT vtkImageSliceMapper : public vtkImageMapper3D
32 {
33 public:
36  void PrintSelf(ostream& os, vtkIndent indent) override;
37 
39 
42  virtual void SetSliceNumber(int slice);
43  virtual int GetSliceNumber();
45 
47 
52  virtual int GetSliceNumberMinValue();
53  virtual int GetSliceNumberMaxValue();
55 
57 
62  vtkSetClampMacro(Orientation, int, 0, 2);
63  vtkGetMacro(Orientation, int);
64  void SetOrientationToI() { this->SetOrientation(0); }
65  void SetOrientationToJ() { this->SetOrientation(1); }
66  void SetOrientationToK() { this->SetOrientation(2); }
67  // old methods
68  void SetOrientationToX() { this->SetOrientation(0); }
69  void SetOrientationToY() { this->SetOrientation(1); }
70  void SetOrientationToZ() { this->SetOrientation(2); }
72 
74 
78  vtkSetMacro(Cropping, vtkTypeBool);
79  vtkBooleanMacro(Cropping, vtkTypeBool);
80  vtkGetMacro(Cropping, vtkTypeBool);
82 
84 
88  vtkSetVector6Macro(CroppingRegion, int);
89  vtkGetVector6Macro(CroppingRegion, int);
91 
95  void Render(vtkRenderer* renderer, vtkImageSlice* prop) override;
96 
103 
107  vtkMTimeType GetMTime() override;
108 
110 
114  double* GetBounds() override;
115  void GetBounds(double bounds[6]) override { this->vtkAbstractMapper3D::GetBounds(bounds); }
117 
118  // return the bounds in index space
119  void GetIndexBounds(double extent[6]) override;
120 
126  void GetSlicePlaneInDataCoords(vtkMatrix4x4* propMatrix, double plane[4]) override;
127 
132  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
133 
135 
139  void SetDisplayExtent(const int extent[6])
140  {
141  this->DisplayExtent[0] = extent[0];
142  this->DisplayExtent[1] = extent[1];
143  this->DisplayExtent[2] = extent[2];
144  this->DisplayExtent[3] = extent[3];
145  this->DisplayExtent[4] = extent[4];
146  this->DisplayExtent[5] = extent[5];
147  }
149 
150 protected:
153 
159  vtkPoints* GetPoints() { return this->Points; }
160 
165  void SetExactPixelMatch(int v) { this->ExactPixelMatch = (v != 0); }
166 
171  void SetPassColorData(int v) { this->PassColorData = (v != 0); }
172 
178  int GetOrientationFromCamera(double const* propMatrix, vtkCamera* camera);
179 
183  int GetSliceFromCamera(double const* propMatrix, vtkCamera* camera);
184 
188  static void GetDimensionIndices(int orientation, int& xdim, int& ydim);
189 
195  int CroppingRegion[6];
196  int DisplayExtent[6];
200 
201 private:
202  vtkImageSliceMapper(const vtkImageSliceMapper&) = delete;
203  void operator=(const vtkImageSliceMapper&) = delete;
204 
205  friend class vtkImageResliceMapper;
206 };
207 
208 VTK_ABI_NAMESPACE_END
209 #endif
virtual double * GetBounds()=0
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
a virtual camera for 3D rendering
Definition: vtkCamera.h:41
abstract class for mapping images to the screen
map a slice of a vtkImageData to the screen
map a slice of a vtkImageData to the screen
int GetOrientationFromCamera(double const *propMatrix, vtkCamera *camera)
Get the camera orientation as a simple integer [0,1,2,3,4,5] that indicates one of the six major dire...
virtual int GetSliceNumberMaxValue()
Use GetSliceNumberMinValue() and GetSliceNumberMaxValue() to get the range of allowed slices.
void GetIndexBounds(double extent[6]) override
void SetOrientationToX()
Set the orientation of the slices to display.
void SetOrientationToZ()
Set the orientation of the slices to display.
virtual int GetSliceNumberMinValue()
Use GetSliceNumberMinValue() and GetSliceNumberMaxValue() to get the range of allowed slices.
void GetSlicePlaneInDataCoords(vtkMatrix4x4 *propMatrix, double plane[4]) override
Get the plane as a homogeneous 4-vector that gives the plane equation coefficients.
virtual void SetSliceNumber(int slice)
The slice to display, if there are multiple slices.
void GetBounds(double bounds[6]) override
The bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
void SetExactPixelMatch(int v)
Force linear interpolation.
double * GetBounds() override
The bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
int GetSliceFromCamera(double const *propMatrix, vtkCamera *camera)
Get the current slice as the one closest to the focal point.
void SetPoints(vtkPoints *points)
Set points that describe a polygon on which the slice will be rendered.
static void GetDimensionIndices(int orientation, int &xdim, int &ydim)
Get the dimension indices according to the orientation.
void SetPassColorData(int v)
Pass color data.
vtkMTimeType GetMTime() override
Get the mtime for the mapper.
~vtkImageSliceMapper() override
void Render(vtkRenderer *renderer, vtkImageSlice *prop) override
This should only be called by the renderer.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetDisplayExtent(const int extent[6])
Set the display extent.
virtual int GetSliceNumber()
The slice to display, if there are multiple slices.
vtkTypeBool ProcessRequest(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) override
Handle requests from the pipeline executive.
void SetOrientationToK()
Set the orientation of the slices to display.
void SetOrientationToI()
Set the orientation of the slices to display.
static vtkImageSliceMapper * New()
void SetOrientationToJ()
Set the orientation of the slices to display.
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this mapper.
void SetOrientationToY()
Set the orientation of the slices to display.
represents an image in a 3D scene
Definition: vtkImageSlice.h:39
a simple class to control print indentation
Definition: vtkIndent.h:29
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:31
represent and manipulate 3D points
Definition: vtkPoints.h:29
abstract specification for renderers
Definition: vtkRenderer.h:62
window superclass for vtkRenderWindow
Definition: vtkWindow.h:28
@ points
Definition: vtkX3D.h:446
@ orientation
Definition: vtkX3D.h:262
@ extent
Definition: vtkX3D.h:345
int vtkTypeBool
Definition: vtkABI.h:64
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270