VTK  9.3.1
vtkImageMapper3D.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 #ifndef vtkImageMapper3D_h
21 #define vtkImageMapper3D_h
22 
23 #include "vtkAbstractMapper3D.h"
24 #include "vtkRenderingCoreModule.h" // For export macro
25 #include "vtkThreads.h" // for VTK_MAX_THREADS
26 
27 VTK_ABI_NAMESPACE_BEGIN
28 class vtkRenderer;
29 class vtkProp3D;
30 class vtkPoints;
31 class vtkMatrix4x4;
32 class vtkLookupTable;
33 class vtkScalarsToColors;
34 class vtkImageSlice;
35 class vtkImageProperty;
36 class vtkImageData;
37 class vtkMultiThreader;
38 class vtkImageToImageMapper3DFriendship;
39 
40 class VTKRENDERINGCORE_EXPORT vtkImageMapper3D : public vtkAbstractMapper3D
41 {
42 public:
44  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
49  virtual void Render(vtkRenderer* renderer, vtkImageSlice* prop) = 0;
50 
56  void ReleaseGraphicsResources(vtkWindow*) override = 0;
57 
59 
62  void SetInputData(vtkImageData* input);
63  vtkImageData* GetInput();
64  vtkDataSet* GetDataSetInput();
65  vtkDataObject* GetDataObjectInput();
67 
69 
75  vtkSetMacro(Border, vtkTypeBool);
76  vtkBooleanMacro(Border, vtkTypeBool);
77  vtkGetMacro(Border, vtkTypeBool);
79 
81 
87  vtkSetMacro(Background, vtkTypeBool);
88  vtkBooleanMacro(Background, vtkTypeBool);
89  vtkGetMacro(Background, vtkTypeBool);
91 
93 
98  vtkSetMacro(SliceAtFocalPoint, vtkTypeBool);
99  vtkBooleanMacro(SliceAtFocalPoint, vtkTypeBool);
100  vtkGetMacro(SliceAtFocalPoint, vtkTypeBool);
102 
104 
109  vtkSetMacro(SliceFacesCamera, vtkTypeBool);
110  vtkBooleanMacro(SliceFacesCamera, vtkTypeBool);
111  vtkGetMacro(SliceFacesCamera, vtkTypeBool);
113 
115 
122  vtkGetObjectMacro(SlicePlane, vtkPlane);
124 
130  virtual void GetSlicePlaneInDataCoords(vtkMatrix4x4* propMatrix, double plane[4]);
131 
133 
136  vtkSetClampMacro(NumberOfThreads, int, 1, VTK_MAX_THREADS);
137  vtkGetMacro(NumberOfThreads, int);
139 
141 
150  vtkSetMacro(Streaming, vtkTypeBool);
151  vtkGetMacro(Streaming, vtkTypeBool);
152  vtkBooleanMacro(Streaming, vtkTypeBool);
154 
155  // return the bounds in index space
156  virtual void GetIndexBounds(double extent[6]) = 0;
157 
158 protected:
160  ~vtkImageMapper3D() override;
161 
163 
166  int FillInputPortInformation(int port, vtkInformation* info) override;
169 
174  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
175 
180  static void CheckerboardRGBA(unsigned char* data, int xsize, int ysize, double originx,
181  double originy, double spacingx, double spacingy);
182 
199  unsigned char* MakeTextureData(vtkImageProperty* property, vtkImageData* input, int extent[6],
200  int& xsize, int& ysize, int& bytesPerPixel, bool& reuseTexture, bool& reuseData);
201 
206  void MakeTextureGeometry(const int extent[6], double coords[12], double tcoords[8]);
207 
215  virtual void ComputeTextureSize(
216  const int extent[6], int& xdim, int& ydim, int imageSize[2], int textureSize[2]);
217 
222  vtkRenderer* GetCurrentRenderer();
223 
227  vtkImageSlice* GetCurrentProp() { return this->CurrentProp; }
228 
233  vtkMatrix4x4* GetDataToWorldMatrix();
234 
239  void GetBackgroundColor(vtkImageProperty* property, double color[4]);
240 
247 
248  // The slice.
252 
253  // Information about the image, updated by UpdateInformation
254  double DataSpacing[3];
255  double DataOrigin[3];
256  double DataDirection[9];
257  int DataWholeExtent[6];
258 
259  // Set by vtkImageStack when doing multi-pass rendering
263 
264 private:
265  // The prop this mapper is attached to, or zero if none.
266  vtkImageSlice* CurrentProp;
267  vtkRenderer* CurrentRenderer;
268 
269  // The cached data-to-world matrix
270  vtkMatrix4x4* DataToWorldMatrix;
271 
272  vtkImageMapper3D(const vtkImageMapper3D&) = delete;
273  void operator=(const vtkImageMapper3D&) = delete;
274 
275  friend class vtkImageToImageMapper3DFriendship;
276 };
277 
278 VTK_ABI_NAMESPACE_END
279 #endif
vtkTypeBool SliceAtFocalPoint
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:30
Store vtkAlgorithm input/output information.
abstract class to specify dataset behavior
Definition: vtkDataSet.h:52
A class for performing multithreaded execution.
vtkScalarsToColors * DefaultLookupTable
map scalar values into colors via a lookup table
image display properties
vtkTypeBool Streaming
abstract specification for renderers
Definition: vtkRenderer.h:61
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:38
int vtkTypeBool
Definition: vtkABI.h:64
virtual vtkTypeBool ProcessRequest(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
Upstream/Downstream requests form the generalized interface through which executives invoke a algorit...
Superclass for mapping scalar values to colors.
window superclass for vtkRenderWindow
Definition: vtkWindow.h:27
virtual int FillOutputPortInformation(int port, vtkInformation *info)
Fill the output port information objects for this algorithm.
a simple class to control print indentation
Definition: vtkIndent.h:28
abstract class for mapping images to the screen
topologically and geometrically regular array of data
Definition: vtkImageData.h:42
perform various plane computations
Definition: vtkPlane.h:25
abstract class specifies interface to map 3D data
virtual int FillInputPortInformation(int port, vtkInformation *info)
Fill the input port information objects for this algorithm.
vtkImageSlice * GetCurrentProp()
Get the vtkImage prop associated with this mapper, or zero if none.
vtkMultiThreader * Threader
vtkTypeBool Background
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
represents an image in a 3D scene
Definition: vtkImageSlice.h:38
virtual void ReleaseGraphicsResources(vtkWindow *)
Release any graphics resources that are being consumed by this mapper.
Store zero or more vtkInformation instances.
general representation of visualization data
Definition: vtkDataObject.h:54
represent and manipulate 3D points
Definition: vtkPoints.h:28
vtkTypeBool SliceFacesCamera