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
24#ifndef vtkImageSliceMapper_h
25#define vtkImageSliceMapper_h
26
27#include "vtkImageMapper3D.h"
28#include "vtkRenderingCoreModule.h" // For export macro
29
30VTK_ABI_NAMESPACE_BEGIN
31class vtkCamera;
32class vtkPoints;
33
34class VTKRENDERINGCORE_EXPORT vtkImageSliceMapper : public vtkImageMapper3D
35{
36public:
39 void PrintSelf(ostream& os, vtkIndent indent) override;
40
42
45 virtual void SetSliceNumber(int slice);
46 virtual int GetSliceNumber();
48
50
58
60
65 vtkSetClampMacro(Orientation, int, 0, 2);
66 vtkGetMacro(Orientation, int);
67 void SetOrientationToI() { this->SetOrientation(0); }
68 void SetOrientationToJ() { this->SetOrientation(1); }
69 void SetOrientationToK() { this->SetOrientation(2); }
70 // old methods
71 void SetOrientationToX() { this->SetOrientation(0); }
72 void SetOrientationToY() { this->SetOrientation(1); }
73 void SetOrientationToZ() { this->SetOrientation(2); }
75
77
81 vtkSetMacro(Cropping, vtkTypeBool);
82 vtkBooleanMacro(Cropping, vtkTypeBool);
83 vtkGetMacro(Cropping, vtkTypeBool);
85
87
91 vtkSetVector6Macro(CroppingRegion, int);
92 vtkGetVector6Macro(CroppingRegion, int);
94
98 void Render(vtkRenderer* renderer, vtkImageSlice* prop) override;
99
106
111
113
117 double* GetBounds() override;
118 void GetBounds(double bounds[6]) override { this->vtkAbstractMapper3D::GetBounds(bounds); }
120
121 // return the bounds in index space
122 void GetIndexBounds(double extent[6]) override;
123
129 void GetSlicePlaneInDataCoords(vtkMatrix4x4* propMatrix, double plane[4]) override;
130
135 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
136
138
142 void SetDisplayExtent(const int extent[6])
143 {
144 this->DisplayExtent[0] = extent[0];
145 this->DisplayExtent[1] = extent[1];
146 this->DisplayExtent[2] = extent[2];
147 this->DisplayExtent[3] = extent[3];
148 this->DisplayExtent[4] = extent[4];
149 this->DisplayExtent[5] = extent[5];
150 }
152
153protected:
156
161 void SetPoints(vtkPoints* points);
162 vtkPoints* GetPoints() { return this->Points; }
163
168 void SetExactPixelMatch(int v) { this->ExactPixelMatch = (v != 0); }
169
174 void SetPassColorData(int v) { this->PassColorData = (v != 0); }
175
181 int GetOrientationFromCamera(double const* propMatrix, vtkCamera* camera);
182
186 int GetSliceFromCamera(double const* propMatrix, vtkCamera* camera);
187
191 static void GetDimensionIndices(int orientation, int& xdim, int& ydim);
192
198 int CroppingRegion[6];
199 int DisplayExtent[6];
203
204private:
206 void operator=(const vtkImageSliceMapper&) = delete;
207
209};
210
211VTK_ABI_NAMESPACE_END
212#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.
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.
double * GetBounds() override
The bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
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
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
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
int vtkTypeBool
Definition vtkABI.h:64
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:270