VTK  9.1.0
vtkImageMapper3D.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkImageMapper3D.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=========================================================================*/
138#ifndef vtkImageMapper3D_h
139#define vtkImageMapper3D_h
140
141#include "vtkAbstractMapper3D.h"
142#include "vtkRenderingCoreModule.h" // For export macro
143#include "vtkThreads.h" // for VTK_MAX_THREADS
144
145class vtkRenderer;
146class vtkProp3D;
147class vtkPoints;
148class vtkMatrix4x4;
149class vtkLookupTable;
151class vtkImageSlice;
152class vtkImageProperty;
153class vtkImageData;
154class vtkMultiThreader;
155class vtkImageToImageMapper3DFriendship;
156
157class VTKRENDERINGCORE_EXPORT vtkImageMapper3D : public vtkAbstractMapper3D
158{
159public:
161 void PrintSelf(ostream& os, vtkIndent indent) override;
162
166 virtual void Render(vtkRenderer* renderer, vtkImageSlice* prop) = 0;
167
174
176
184
186
192 vtkSetMacro(Border, vtkTypeBool);
193 vtkBooleanMacro(Border, vtkTypeBool);
194 vtkGetMacro(Border, vtkTypeBool);
196
198
204 vtkSetMacro(Background, vtkTypeBool);
205 vtkBooleanMacro(Background, vtkTypeBool);
206 vtkGetMacro(Background, vtkTypeBool);
208
210
215 vtkSetMacro(SliceAtFocalPoint, vtkTypeBool);
216 vtkBooleanMacro(SliceAtFocalPoint, vtkTypeBool);
217 vtkGetMacro(SliceAtFocalPoint, vtkTypeBool);
219
221
226 vtkSetMacro(SliceFacesCamera, vtkTypeBool);
227 vtkBooleanMacro(SliceFacesCamera, vtkTypeBool);
228 vtkGetMacro(SliceFacesCamera, vtkTypeBool);
230
232
239 vtkGetObjectMacro(SlicePlane, vtkPlane);
241
247 virtual void GetSlicePlaneInDataCoords(vtkMatrix4x4* propMatrix, double plane[4]);
248
250
253 vtkSetClampMacro(NumberOfThreads, int, 1, VTK_MAX_THREADS);
254 vtkGetMacro(NumberOfThreads, int);
256
258
267 vtkSetMacro(Streaming, vtkTypeBool);
268 vtkGetMacro(Streaming, vtkTypeBool);
269 vtkBooleanMacro(Streaming, vtkTypeBool);
271
272 // return the bounds in index space
273 virtual void GetIndexBounds(double extent[6]) = 0;
274
275protected:
278
280
283 int FillInputPortInformation(int port, vtkInformation* info) override;
284 int FillOutputPortInformation(int port, vtkInformation* info) override;
286
291 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
292
297 static void CheckerboardRGBA(unsigned char* data, int xsize, int ysize, double originx,
298 double originy, double spacingx, double spacingy);
299
305 unsigned char* MakeTextureData(vtkImageProperty* property, vtkImageData* input, int extent[6],
306 int& xsize, int& ysize, int& bytesPerPixel, bool& reuseTexture, bool& reuseData);
307
312 void MakeTextureGeometry(const int extent[6], double coords[12], double tcoords[8]);
313
321 virtual void ComputeTextureSize(
322 const int extent[6], int& xdim, int& ydim, int imageSize[2], int textureSize[2]);
323
329
333 vtkImageSlice* GetCurrentProp() { return this->CurrentProp; }
334
340
345 void GetBackgroundColor(vtkImageProperty* property, double color[4]);
346
353
354 // The slice.
358
359 // Information about the image, updated by UpdateInformation
360 double DataSpacing[3];
361 double DataOrigin[3];
362 double DataDirection[9];
363 int DataWholeExtent[6];
364
365 // Set by vtkImageStack when doing multi-pass rendering
369
370private:
371 // The prop this mapper is attached to, or zero if none.
372 vtkImageSlice* CurrentProp;
373 vtkRenderer* CurrentRenderer;
374
375 // The cached data-to-world matrix
376 vtkMatrix4x4* DataToWorldMatrix;
377
378 vtkImageMapper3D(const vtkImageMapper3D&) = delete;
379 void operator=(const vtkImageMapper3D&) = delete;
380
381 friend class vtkImageToImageMapper3DFriendship;
382};
383
384#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:157
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),...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkDataSet * GetDataSetInput()
The input data for this mapper.
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
vtkImageData * GetInput()
The input data for this mapper.
vtkImageSlice * GetCurrentProp()
Get the vtkImage prop associated with this mapper, or zero if none.
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...
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...
vtkDataObject * GetDataObjectInput()
The input data for this mapper.
virtual void Render(vtkRenderer *renderer, vtkImageSlice *prop)=0
This should only be called by the renderer.
vtkRenderer * GetCurrentRenderer()
Get the renderer associated with this mapper, or zero if none.
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.
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.
vtkTypeBool SliceAtFocalPoint
vtkMatrix4x4 * GetDataToWorldMatrix()
Get the data-to-world matrix for this mapper, according to the assembly path for its prop.
image display properties
represents an image in a 3D scene
a simple class to control print indentation
Definition: vtkIndent.h:113
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:145
A class for performing multithreaded execution.
perform various plane computations
Definition: vtkPlane.h:143
represent and manipulate 3D points
Definition: vtkPoints.h:143
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:93
abstract specification for renderers
Definition: vtkRenderer.h:182
Superclass for mapping scalar values to colors.
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
int vtkTypeBool
Definition: vtkABI.h:69