VTK  9.1.0
vtkVolume.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkVolume.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=========================================================================*/
31#ifndef vtkVolume_h
32#define vtkVolume_h
33
34#include "vtkProp3D.h"
35#include "vtkRenderingCoreModule.h" // For export macro
36
37class vtkRenderer;
40class vtkWindow;
43
44class VTKRENDERINGCORE_EXPORT vtkVolume : public vtkProp3D
45{
46public:
47 vtkTypeMacro(vtkVolume, vtkProp3D);
48 void PrintSelf(ostream& os, vtkIndent indent) override;
49
55 static vtkVolume* New();
56
58
62 vtkGetObjectMacro(Mapper, vtkAbstractVolumeMapper);
64
66
69 virtual void SetProperty(vtkVolumeProperty* property);
72
78 void GetVolumes(vtkPropCollection* vc) override;
79
83 void Update();
84
86
90 double* GetBounds() VTK_SIZEHINT(6) override;
91 void GetBounds(double bounds[6]) { this->vtkProp3D::GetBounds(bounds); }
92 double GetMinXBound();
93 double GetMaxXBound();
94 double GetMinYBound();
95 double GetMaxYBound();
96 double GetMinZBound();
97 double GetMaxZBound();
99
104
112
116 void ShallowCopy(vtkProp* prop) override;
117
126 int RenderVolumetricGeometry(vtkViewport* viewport) override;
127
135
142
148 float* GetScalarOpacityArray() { return this->GetScalarOpacityArray(0); }
149
156
161 float* GetGrayArray(int);
162 float* GetGrayArray() { return this->GetGrayArray(0); }
163
168 float* GetRGBArray(int);
169 float* GetRGBArray() { return this->GetRGBArray(0); }
170
177
182 float GetArraySize() { return static_cast<float>(this->ArraySize); }
183
189
194 void UpdateScalarOpacityforSampleSize(vtkRenderer* ren, float sample_distance);
195
203 bool GetSupportsSelection() override { return true; }
204
205protected:
207 ~vtkVolume() override;
208
211
212 // The rgb transfer function array - for unsigned char data this
213 // is 256 elements, for short or unsigned short it is 65536 elements
214 // This is a sample at each scalar value of the rgb transfer
215 // function. A time stamp is kept to know when it needs rebuilding
216 float* RGBArray[VTK_MAX_VRCOMP];
218
219 // The gray transfer function array - for unsigned char data this
220 // is 256 elements, for short or unsigned short it is 65536 elements
221 // This is a sample at each scalar value of the gray transfer
222 // function. A time stamp is kept to know when it needs rebuilding
223 float* GrayArray[VTK_MAX_VRCOMP];
225
226 // The scalar opacity transfer function array - for unsigned char data this
227 // is 256 elements, for short or unsigned short it is 65536 elements
228 // This is a sample at each scalar value of the opacity transfer
229 // function. A time stamp is kept to know when it needs rebuilding
230 float* ScalarOpacityArray[VTK_MAX_VRCOMP];
231 vtkTimeStamp ScalarOpacityArrayMTime[VTK_MAX_VRCOMP];
232
233 // The corrected scalar opacity transfer function array - this is identical
234 // to the opacity transfer function array when the step size is 1.
235 // In other cases, it is corrected to reflect the new material thickness
236 // modelled by a step size different than 1.
237 float* CorrectedScalarOpacityArray[VTK_MAX_VRCOMP];
238 vtkTimeStamp CorrectedScalarOpacityArrayMTime[VTK_MAX_VRCOMP];
239
240 // CorrectedStepSize is the step size currently modelled by
241 // CorrectedArray. It is used to determine when the
242 // CorrectedArray needs to be updated to match SampleDistance
243 // in the volume mapper.
245
246 // Number of elements in the rgb, gray, and opacity transfer function arrays
248
249 // The magnitude of gradient opacity transfer function array
250 float GradientOpacityArray[VTK_MAX_VRCOMP][256];
251 float GradientOpacityConstant[VTK_MAX_VRCOMP];
252 vtkTimeStamp GradientOpacityArrayMTime[VTK_MAX_VRCOMP];
253
254 // Function to compute screen coverage of this volume
256
257private:
258 vtkVolume(const vtkVolume&) = delete;
259 void operator=(const vtkVolume&) = delete;
260};
261
262#endif
Abstract class for a volume mapper.
a simple class to control print indentation
Definition: vtkIndent.h:34
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:44
double * GetBounds() override=0
Return a reference to the Prop3D's composite transform.
an ordered list of Props
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:57
abstract specification for renderers
Definition: vtkRenderer.h:73
record modification and/or execution time
Definition: vtkTimeStamp.h:33
abstract specification for Viewports
Definition: vtkViewport.h:47
an ordered list of volumes
represents the common properties for rendering a volume.
represents a volume (data & properties) in a rendered scene
Definition: vtkVolume.h:45
void UpdateTransferFunctions(vtkRenderer *ren)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
vtkMTimeType GetRedrawMTime() override
Return the mtime of anything that would cause the rendered image to appear differently.
double GetMaxZBound()
Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
double ComputeScreenCoverage(vtkViewport *vp)
bool GetSupportsSelection() override
Used by vtkHardwareSelector to determine if the prop supports hardware selection.
Definition: vtkVolume.h:203
double GetMaxXBound()
Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
virtual void SetProperty(vtkVolumeProperty *property)
Set/Get the volume property.
float GetGradientOpacityConstant()
Definition: vtkVolume.h:176
~vtkVolume() override
float * GetGrayArray(int)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
void GetVolumes(vtkPropCollection *vc) override
For some exporters and other other operations we must be able to collect all the actors or volumes.
vtkAbstractVolumeMapper * Mapper
Definition: vtkVolume.h:209
static vtkVolume * New()
Creates a Volume with the following defaults: origin(0,0,0) position=(0,0,0) scale=1 visibility=1 pic...
float CorrectedStepSize
Definition: vtkVolume.h:244
void UpdateScalarOpacityforSampleSize(vtkRenderer *ren, float sample_distance)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
float GetGradientOpacityConstant(int)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
vtkMTimeType GetMTime() override
Return the MTime also considering the property etc.
void ShallowCopy(vtkProp *prop) override
Shallow copy of this vtkVolume.
void SetMapper(vtkAbstractVolumeMapper *mapper)
Set/Get the volume mapper.
float * GetScalarOpacityArray()
Definition: vtkVolume.h:148
float * GetRGBArray()
Definition: vtkVolume.h:169
float * GetCorrectedScalarOpacityArray()
Definition: vtkVolume.h:141
double GetMinYBound()
Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
float * GetGradientOpacityArray()
Definition: vtkVolume.h:155
int ArraySize
Definition: vtkVolume.h:247
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
float * GetGradientOpacityArray(int)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
double GetMinXBound()
Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
float * GetCorrectedScalarOpacityArray(int)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
int RenderVolumetricGeometry(vtkViewport *viewport) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
float * GetScalarOpacityArray(int)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
vtkVolumeProperty * Property
Definition: vtkVolume.h:210
virtual vtkVolumeProperty * GetProperty()
Set/Get the volume property.
float * GetGrayArray()
Definition: vtkVolume.h:162
void Update()
Update the volume rendering pipeline by updating the volume mapper.
double GetMinZBound()
Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
float * GetRGBArray(int)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
double * GetBounds() override
Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
float GetArraySize()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
Definition: vtkVolume.h:182
double GetMaxYBound()
Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
#define VTK_MAX_VRCOMP
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287
#define VTK_SIZEHINT(...)