VTK  9.3.20240329
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
129 #ifndef vtkImageMapper3D_h
130 #define vtkImageMapper3D_h
131 
132 #include "vtkAbstractMapper3D.h"
133 #include "vtkRenderingCoreModule.h" // For export macro
134 #include "vtkThreads.h" // for VTK_MAX_THREADS
135 
136 VTK_ABI_NAMESPACE_BEGIN
137 class vtkRenderer;
138 class vtkProp3D;
139 class vtkPoints;
140 class vtkMatrix4x4;
141 class vtkLookupTable;
142 class vtkScalarsToColors;
143 class vtkImageSlice;
144 class vtkImageProperty;
145 class vtkImageData;
146 class vtkMultiThreader;
147 class vtkImageToImageMapper3DFriendship;
148 
149 class VTKRENDERINGCORE_EXPORT vtkImageMapper3D : public vtkAbstractMapper3D
150 {
151 public:
153  void PrintSelf(ostream& os, vtkIndent indent) override;
154 
158  virtual void Render(vtkRenderer* renderer, vtkImageSlice* prop) = 0;
159 
165  void ReleaseGraphicsResources(vtkWindow*) override = 0;
166 
168 
176 
178 
184  vtkSetMacro(Border, vtkTypeBool);
185  vtkBooleanMacro(Border, vtkTypeBool);
186  vtkGetMacro(Border, vtkTypeBool);
188 
190 
196  vtkSetMacro(Background, vtkTypeBool);
197  vtkBooleanMacro(Background, vtkTypeBool);
198  vtkGetMacro(Background, vtkTypeBool);
200 
202 
207  vtkSetMacro(SliceAtFocalPoint, vtkTypeBool);
208  vtkBooleanMacro(SliceAtFocalPoint, vtkTypeBool);
209  vtkGetMacro(SliceAtFocalPoint, vtkTypeBool);
211 
213 
218  vtkSetMacro(SliceFacesCamera, vtkTypeBool);
219  vtkBooleanMacro(SliceFacesCamera, vtkTypeBool);
220  vtkGetMacro(SliceFacesCamera, vtkTypeBool);
222 
224 
231  vtkGetObjectMacro(SlicePlane, vtkPlane);
233 
239  virtual void GetSlicePlaneInDataCoords(vtkMatrix4x4* propMatrix, double plane[4]);
240 
242 
245  vtkSetClampMacro(NumberOfThreads, int, 1, VTK_MAX_THREADS);
246  vtkGetMacro(NumberOfThreads, int);
248 
250 
259  vtkSetMacro(Streaming, vtkTypeBool);
260  vtkGetMacro(Streaming, vtkTypeBool);
261  vtkBooleanMacro(Streaming, vtkTypeBool);
263 
264  // return the bounds in index space
265  virtual void GetIndexBounds(double extent[6]) = 0;
266 
267 protected:
269  ~vtkImageMapper3D() override;
270 
272 
278 
283  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
284 
289  static void CheckerboardRGBA(unsigned char* data, int xsize, int ysize, double originx,
290  double originy, double spacingx, double spacingy);
291 
308  unsigned char* MakeTextureData(vtkImageProperty* property, vtkImageData* input, int extent[6],
309  int& xsize, int& ysize, int& bytesPerPixel, bool& reuseTexture, bool& reuseData);
310 
315  void MakeTextureGeometry(const int extent[6], double coords[12], double tcoords[8]);
316 
324  virtual void ComputeTextureSize(
325  const int extent[6], int& xdim, int& ydim, int imageSize[2], int textureSize[2]);
326 
332 
336  vtkImageSlice* GetCurrentProp() { return this->CurrentProp; }
337 
343 
348  void GetBackgroundColor(vtkImageProperty* property, double color[4]);
349 
356 
357  // The slice.
361 
362  // Information about the image, updated by UpdateInformation
363  double DataSpacing[3];
364  double DataOrigin[3];
365  double DataDirection[9];
366  int DataWholeExtent[6];
367 
368  // Set by vtkImageStack when doing multi-pass rendering
372 
373 private:
374  // The prop this mapper is attached to, or zero if none.
375  vtkImageSlice* CurrentProp;
376  vtkRenderer* CurrentRenderer;
377 
378  // The cached data-to-world matrix
379  vtkMatrix4x4* DataToWorldMatrix;
380 
381  vtkImageMapper3D(const vtkImageMapper3D&) = delete;
382  void operator=(const vtkImageMapper3D&) = delete;
383 
384  friend class vtkImageToImageMapper3DFriendship;
385 };
386 
387 VTK_ABI_NAMESPACE_END
388 #endif
abstract class specifies interface to map 3D data
general representation of visualization data
abstract class to specify dataset behavior
Definition: vtkDataSet.h:166
topologically and geometrically regular array of data
Definition: vtkImageData.h:156
abstract class for mapping images to the screen
virtual void GetSlicePlaneInDataCoords(vtkMatrix4x4 *propMatrix, double plane[4])
Get the plane as a homogeneous 4-vector that gives the plane equation coefficients.
virtual void ComputeTextureSize(const int extent[6], int &xdim, int &ydim, int imageSize[2], int textureSize[2])
Given an extent that describes a slice (it must have unit thickness in one of the three directions),...
vtkDataObject * GetDataObjectInput()
The input data for this mapper.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static void CheckerboardRGBA(unsigned char *data, int xsize, int ysize, double originx, double originy, double spacingx, double spacingy)
Checkerboard the alpha component of an RGBA image.
vtkScalarsToColors * DefaultLookupTable
vtkMultiThreader * Threader
int FillOutputPortInformation(int port, vtkInformation *info) override
See algorithm for more info.
vtkTypeBool SliceFacesCamera
void GetBackgroundColor(vtkImageProperty *property, double color[4])
Get the background color, by using the first color in the supplied lookup table, or black if there is...
vtkMatrix4x4 * GetDataToWorldMatrix()
Get the data-to-world matrix for this mapper, according to the assembly path for its prop.
virtual void Render(vtkRenderer *renderer, vtkImageSlice *prop)=0
This should only be called by the renderer.
unsigned char * MakeTextureData(vtkImageProperty *property, vtkImageData *input, int extent[6], int &xsize, int &ysize, int &bytesPerPixel, bool &reuseTexture, bool &reuseData)
Perform window/level and color mapping operations to produce unsigned char data that can be used as a...
vtkDataSet * GetDataSetInput()
The input data for this mapper.
vtkTypeBool Background
virtual void GetIndexBounds(double extent[6])=0
void ReleaseGraphicsResources(vtkWindow *) override=0
Release any graphics resources that are being consumed by this mapper.
vtkImageData * GetInput()
The input data for this mapper.
void MakeTextureGeometry(const int extent[6], double coords[12], double tcoords[8])
Compute the coordinates and texture coordinates for the image, given an extent that describes a singl...
~vtkImageMapper3D() override
void SetInputData(vtkImageData *input)
The input data for this mapper.
vtkTypeBool Streaming
vtkTypeBool ProcessRequest(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) override
Handle requests from the pipeline executive.
int FillInputPortInformation(int port, vtkInformation *info) override
See algorithm for more info.
vtkRenderer * GetCurrentRenderer()
Get the renderer associated with this mapper, or zero if none.
vtkImageSlice * GetCurrentProp()
Get the vtkImage prop associated with this mapper, or zero if none.
vtkTypeBool SliceAtFocalPoint
image display properties
represents an image in a 3D scene
a simple class to control print indentation
Definition: vtkIndent.h:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
map scalar values into colors via a lookup table
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:141
A class for performing multithreaded execution.
perform various plane computations
Definition: vtkPlane.h:135
represent and manipulate 3D points
Definition: vtkPoints.h:139
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:89
abstract specification for renderers
Definition: vtkRenderer.h:172
Superclass for mapping scalar values to colors.
window superclass for vtkRenderWindow
Definition: vtkWindow.h:48
@ Background
Definition: vtkX3D.h:71
@ info
Definition: vtkX3D.h:376
@ port
Definition: vtkX3D.h:447
@ extent
Definition: vtkX3D.h:345
@ color
Definition: vtkX3D.h:221
@ data
Definition: vtkX3D.h:315
int vtkTypeBool
Definition: vtkABI.h:64