VTK  9.2.6
vtkImageSliceMapper.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkImageSliceMapper.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=========================================================================*/
42#ifndef vtkImageSliceMapper_h
43#define vtkImageSliceMapper_h
44
45#include "vtkImageMapper3D.h"
46#include "vtkRenderingCoreModule.h" // For export macro
47
48class vtkCamera;
49class vtkPoints;
50
51class VTKRENDERINGCORE_EXPORT vtkImageSliceMapper : public vtkImageMapper3D
52{
53public:
56 void PrintSelf(ostream& os, vtkIndent indent) override;
57
59
62 virtual void SetSliceNumber(int slice);
63 virtual int GetSliceNumber();
65
67
75
77
82 vtkSetClampMacro(Orientation, int, 0, 2);
83 vtkGetMacro(Orientation, int);
84 void SetOrientationToI() { this->SetOrientation(0); }
85 void SetOrientationToJ() { this->SetOrientation(1); }
86 void SetOrientationToK() { this->SetOrientation(2); }
87 // old methods
88 void SetOrientationToX() { this->SetOrientation(0); }
89 void SetOrientationToY() { this->SetOrientation(1); }
90 void SetOrientationToZ() { this->SetOrientation(2); }
92
94
98 vtkSetMacro(Cropping, vtkTypeBool);
99 vtkBooleanMacro(Cropping, vtkTypeBool);
100 vtkGetMacro(Cropping, vtkTypeBool);
102
104
108 vtkSetVector6Macro(CroppingRegion, int);
109 vtkGetVector6Macro(CroppingRegion, int);
111
115 void Render(vtkRenderer* renderer, vtkImageSlice* prop) override;
116
123
128
130
134 double* GetBounds() override;
135 void GetBounds(double bounds[6]) override { this->vtkAbstractMapper3D::GetBounds(bounds); }
137
138 // return the bounds in index space
139 void GetIndexBounds(double extent[6]) override;
140
146 void GetSlicePlaneInDataCoords(vtkMatrix4x4* propMatrix, double plane[4]) override;
147
152 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
153
155
159 void SetDisplayExtent(const int extent[6])
160 {
161 this->DisplayExtent[0] = extent[0];
162 this->DisplayExtent[1] = extent[1];
163 this->DisplayExtent[2] = extent[2];
164 this->DisplayExtent[3] = extent[3];
165 this->DisplayExtent[4] = extent[4];
166 this->DisplayExtent[5] = extent[5];
167 }
169
170protected:
173
178 void SetPoints(vtkPoints* points);
179 vtkPoints* GetPoints() { return this->Points; }
180
185 void SetExactPixelMatch(int v) { this->ExactPixelMatch = (v != 0); }
186
191 void SetPassColorData(int v) { this->PassColorData = (v != 0); }
192
198 int GetOrientationFromCamera(double const* propMatrix, vtkCamera* camera);
199
203 int GetSliceFromCamera(double const* propMatrix, vtkCamera* camera);
204
208 static void GetDimensionIndices(int orientation, int& xdim, int& ydim);
209
215 int CroppingRegion[6];
216 int DisplayExtent[6];
220
221private:
223 void operator=(const vtkImageSliceMapper&) = delete;
224
226};
227
228#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:61
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:49
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:49
abstract specification for renderers
Definition vtkRenderer.h:82
window superclass for vtkRenderWindow
Definition vtkWindow.h:48
int vtkTypeBool
Definition vtkABI.h:69
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287