VTK  9.5.2
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
20
21#ifndef vtkImageSliceMapper_h
22#define vtkImageSliceMapper_h
23
24#include "vtkImageMapper3D.h"
25#include "vtkRenderingCoreModule.h" // For export macro
26#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
27
28VTK_ABI_NAMESPACE_BEGIN
29class vtkCamera;
30class vtkPoints;
31
32class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkImageSliceMapper : public vtkImageMapper3D
33{
34public:
37 void PrintSelf(ostream& os, vtkIndent indent) override;
38
40
43 virtual void SetSliceNumber(int slice);
44 virtual int GetSliceNumber();
46
48
56
58
63 vtkSetClampMacro(Orientation, int, 0, 2);
64 vtkGetMacro(Orientation, int);
65 void SetOrientationToI() { this->SetOrientation(0); }
66 void SetOrientationToJ() { this->SetOrientation(1); }
67 void SetOrientationToK() { this->SetOrientation(2); }
68 // old methods
69 void SetOrientationToX() { this->SetOrientation(0); }
70 void SetOrientationToY() { this->SetOrientation(1); }
71 void SetOrientationToZ() { this->SetOrientation(2); }
73
75
79 vtkSetMacro(Cropping, vtkTypeBool);
80 vtkBooleanMacro(Cropping, vtkTypeBool);
81 vtkGetMacro(Cropping, vtkTypeBool);
83
85
89 vtkSetVector6Macro(CroppingRegion, int);
90 vtkGetVector6Macro(CroppingRegion, int);
92
96 void Render(vtkRenderer* renderer, vtkImageSlice* prop) override;
97
104
109
111
115 double* GetBounds() override;
116 void GetBounds(double bounds[6]) override { this->vtkAbstractMapper3D::GetBounds(bounds); }
118
119 // return the bounds in index space
120 void GetIndexBounds(double extent[6]) override;
121
127 void GetSlicePlaneInDataCoords(vtkMatrix4x4* propMatrix, double plane[4]) override;
128
133 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
134
136
140 void SetDisplayExtent(const int extent[6])
141 {
142 this->DisplayExtent[0] = extent[0];
143 this->DisplayExtent[1] = extent[1];
144 this->DisplayExtent[2] = extent[2];
145 this->DisplayExtent[3] = extent[3];
146 this->DisplayExtent[4] = extent[4];
147 this->DisplayExtent[5] = extent[5];
148 }
149
150
151protected:
154
159 void SetPoints(vtkPoints* points);
160 vtkPoints* GetPoints() { return this->Points; }
161
166 void SetExactPixelMatch(int v) { this->ExactPixelMatch = (v != 0); }
167
172 void SetPassColorData(int v) { this->PassColorData = (v != 0); }
173
179 int GetOrientationFromCamera(double const* propMatrix, vtkCamera* camera);
180
184 int GetSliceFromCamera(double const* propMatrix, vtkCamera* camera);
185
189 static void GetDimensionIndices(int orientation, int& xdim, int& ydim);
190
201
202private:
204 void operator=(const vtkImageSliceMapper&) = delete;
205
207};
208
209VTK_ABI_NAMESPACE_END
210#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:42
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.
friend class vtkImageResliceMapper
void SetOrientationToZ()
Set the orientation of the slices to display.
virtual void SetOrientation(int)
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:30
abstract specification for renderers
Definition vtkRenderer.h:60
window superclass for vtkRenderWindow
Definition vtkWindow.h:26
int vtkTypeBool
Definition vtkABI.h:64
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287
#define VTK_MARSHALAUTO