VTK  9.0.1
vtkUnstructuredGridVolumeRayCastMapper.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkUnstructuredGridVolumeRayCastMapper.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 =========================================================================*/
15 
26 #ifndef vtkUnstructuredGridVolumeRayCastMapper_h
27 #define vtkUnstructuredGridVolumeRayCastMapper_h
28 
29 #include "vtkRenderingVolumeModule.h" // For export macro
31 
32 class vtkDoubleArray;
33 class vtkIdList;
34 class vtkMultiThreader;
36 class vtkRenderer;
37 class vtkTimerLog;
41 class vtkVolume;
42 
43 class VTKRENDERINGVOLUME_EXPORT vtkUnstructuredGridVolumeRayCastMapper
45 {
46 public:
49  void PrintSelf(ostream& os, vtkIndent indent) override;
50 
52 
57  vtkSetClampMacro(ImageSampleDistance, float, 0.1f, 100.0f);
58  vtkGetMacro(ImageSampleDistance, float);
60 
62 
66  vtkSetClampMacro(MinimumImageSampleDistance, float, 0.1f, 100.0f);
67  vtkGetMacro(MinimumImageSampleDistance, float);
69 
71 
75  vtkSetClampMacro(MaximumImageSampleDistance, float, 0.1f, 100.0f);
76  vtkGetMacro(MaximumImageSampleDistance, float);
78 
80 
86  vtkSetClampMacro(AutoAdjustSampleDistances, vtkTypeBool, 0, 1);
87  vtkGetMacro(AutoAdjustSampleDistances, vtkTypeBool);
88  vtkBooleanMacro(AutoAdjustSampleDistances, vtkTypeBool);
90 
92 
96  vtkSetMacro(NumberOfThreads, int);
97  vtkGetMacro(NumberOfThreads, int);
99 
101 
105  vtkSetClampMacro(IntermixIntersectingGeometry, vtkTypeBool, 0, 1);
106  vtkGetMacro(IntermixIntersectingGeometry, vtkTypeBool);
107  vtkBooleanMacro(IntermixIntersectingGeometry, vtkTypeBool);
109 
111 
115  vtkGetObjectMacro(RayCastFunction, vtkUnstructuredGridVolumeRayCastFunction);
117 
119 
124  vtkGetObjectMacro(RayIntegrator, vtkUnstructuredGridVolumeRayIntegrator);
126 
131  void Render(vtkRenderer*, vtkVolume*) override;
132 
140 
141  vtkGetVectorMacro(ImageInUseSize, int, 2);
142  vtkGetVectorMacro(ImageOrigin, int, 2);
143  vtkGetVectorMacro(ImageViewportSize, int, 2);
144 
145  void CastRays(int threadID, int threadCount);
146 
147 protected:
150 
155 
158 
160 
161  // This is how big the image would be if it covered the entire viewport
162  int ImageViewportSize[2];
163 
164  // This is how big the allocated memory for image is. This may be bigger
165  // or smaller than ImageFullSize - it will be bigger if necessary to
166  // ensure a power of 2, it will be smaller if the volume only covers a
167  // small region of the viewport
168  int ImageMemorySize[2];
169 
170  // This is the size of subregion in ImageSize image that we are using for
171  // the current image. Since ImageSize is a power of 2, there is likely
172  // wasted space in it. This number will be used for things such as clearing
173  // the image if necessary.
174  int ImageInUseSize[2];
175 
176  // This is the location in ImageFullSize image where our ImageSize image
177  // is located.
178  int ImageOrigin[2];
179 
180  // This is the allocated image
181  unsigned char* Image;
182 
188 
189  void StoreRenderTime(vtkRenderer* ren, vtkVolume* vol, float t);
191 
193 
194  float* ZBuffer;
195  int ZBufferSize[2];
196  int ZBufferOrigin[2];
197 
198  // Get the ZBuffer value corresponding to location (x,y) where (x,y)
199  // are indexing into the ImageInUse image. This must be converted to
200  // the zbuffer image coordinates. Nearest neighbor value is returned.
201  double GetZBufferValue(int x, int y);
202 
204 
209 
214 
217 
220 
221 private:
223  void operator=(const vtkUnstructuredGridVolumeRayCastMapper&) = delete;
224 };
225 
226 #endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
dynamic, self-adjusting array of double
list of point or cell ids
Definition: vtkIdList.h:31
a simple class to control print indentation
Definition: vtkIndent.h:34
A class for performing multithreaded execution.
helper class that draws the image to the screen
abstract specification for renderers
Definition: vtkRenderer.h:59
Timer support and logging.
Definition: vtkTimerLog.h:91
Abstract class for an unstructured grid volume mapper.
vtkUnstructuredGridVolumeRayCastIterator is a superclass for iterating over the intersections of a vi...
A software mapper for unstructured volumes.
vtkUnstructuredGridVolumeRayIntegrator * RealRayIntegrator
void Render(vtkRenderer *, vtkVolume *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Initialize rendering for this volume.
vtkUnstructuredGridVolumeRayIntegrator * RayIntegrator
vtkUnstructuredGridVolumeRayCastIterator ** RayCastIterators
virtual void SetRayCastFunction(vtkUnstructuredGridVolumeRayCastFunction *f)
Set/Get the helper class for casting rays.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void CastRays(int threadID, int threadCount)
static vtkUnstructuredGridVolumeRayCastMapper * New()
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
vtkUnstructuredGridVolumeRayCastFunction * RayCastFunction
void StoreRenderTime(vtkRenderer *ren, vtkVolume *vol, float t)
float RetrieveRenderTime(vtkRenderer *ren, vtkVolume *vol)
virtual void SetRayIntegrator(vtkUnstructuredGridVolumeRayIntegrator *ri)
Set/Get the helper class for integrating rays.
double GetMinimumBoundsDepth(vtkRenderer *ren, vtkVolume *vol)
a superclass for volume ray integration functions
represents a volume (data & properties) in a rendered scene
Definition: vtkVolume.h:45
window superclass for vtkRenderWindow
Definition: vtkWindow.h:35
int vtkTypeBool
Definition: vtkABI.h:69