VTK  9.2.6
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=========================================================================*/
37#ifndef vtkVolume_h
38#define vtkVolume_h
39
40#include "vtkProp3D.h"
41#include "vtkRenderingCoreModule.h" // For export macro
42
43class vtkRenderer;
46class vtkWindow;
49
50class VTKRENDERINGCORE_EXPORT vtkVolume : public vtkProp3D
51{
52public:
53 vtkTypeMacro(vtkVolume, vtkProp3D);
54 void PrintSelf(ostream& os, vtkIndent indent) override;
55
61 static vtkVolume* New();
62
64
68 vtkGetObjectMacro(Mapper, vtkAbstractVolumeMapper);
70
72
75 virtual void SetProperty(vtkVolumeProperty* property);
78
84 void GetVolumes(vtkPropCollection* vc) override;
85
89 void Update();
90
92
96 double* GetBounds() VTK_SIZEHINT(6) override;
97 void GetBounds(double bounds[6]) { this->vtkProp3D::GetBounds(bounds); }
98 double GetMinXBound();
99 double GetMaxXBound();
100 double GetMinYBound();
101 double GetMaxYBound();
102 double GetMinZBound();
103 double GetMaxZBound();
105
110
118
122 void ShallowCopy(vtkProp* prop) override;
123
132 int RenderVolumetricGeometry(vtkViewport* viewport) override;
133
141
148
154 float* GetScalarOpacityArray() { return this->GetScalarOpacityArray(0); }
155
162
167 float* GetGrayArray(int);
168 float* GetGrayArray() { return this->GetGrayArray(0); }
169
174 float* GetRGBArray(int);
175 float* GetRGBArray() { return this->GetRGBArray(0); }
176
183
188 float GetArraySize() { return static_cast<float>(this->ArraySize); }
189
195
200 void UpdateScalarOpacityforSampleSize(vtkRenderer* ren, float sample_distance);
201
209 bool GetSupportsSelection() override { return true; }
210
211protected:
213 ~vtkVolume() override;
214
217
218 // The rgb transfer function array - for unsigned char data this
219 // is 256 elements, for short or unsigned short it is 65536 elements
220 // This is a sample at each scalar value of the rgb transfer
221 // function. A time stamp is kept to know when it needs rebuilding
222 float* RGBArray[VTK_MAX_VRCOMP];
224
225 // The gray transfer function array - for unsigned char data this
226 // is 256 elements, for short or unsigned short it is 65536 elements
227 // This is a sample at each scalar value of the gray transfer
228 // function. A time stamp is kept to know when it needs rebuilding
229 float* GrayArray[VTK_MAX_VRCOMP];
231
232 // The scalar opacity transfer function array - for unsigned char data this
233 // is 256 elements, for short or unsigned short it is 65536 elements
234 // This is a sample at each scalar value of the opacity transfer
235 // function. A time stamp is kept to know when it needs rebuilding
236 float* ScalarOpacityArray[VTK_MAX_VRCOMP];
237 vtkTimeStamp ScalarOpacityArrayMTime[VTK_MAX_VRCOMP];
238
239 // The corrected scalar opacity transfer function array - this is identical
240 // to the opacity transfer function array when the step size is 1.
241 // In other cases, it is corrected to reflect the new material thickness
242 // modelled by a step size different than 1.
243 float* CorrectedScalarOpacityArray[VTK_MAX_VRCOMP];
244 vtkTimeStamp CorrectedScalarOpacityArrayMTime[VTK_MAX_VRCOMP];
245
246 // CorrectedStepSize is the step size currently modelled by
247 // CorrectedArray. It is used to determine when the
248 // CorrectedArray needs to be updated to match SampleDistance
249 // in the volume mapper.
251
252 // Number of elements in the rgb, gray, and opacity transfer function arrays
254
255 // The magnitude of gradient opacity transfer function array
256 float GradientOpacityArray[VTK_MAX_VRCOMP][256];
257 float GradientOpacityConstant[VTK_MAX_VRCOMP];
258 vtkTimeStamp GradientOpacityArrayMTime[VTK_MAX_VRCOMP];
259
260 // Function to compute screen coverage of this volume
262
263private:
264 vtkVolume(const vtkVolume&) = delete;
265 void operator=(const vtkVolume&) = delete;
266};
267
268#endif
Abstract class for a volume mapper.
a simple class to control print indentation
Definition: vtkIndent.h:40
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:50
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:36
abstract specification for Viewports
Definition: vtkViewport.h:56
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:51
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:209
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:182
~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:215
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:250
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:154
float * GetRGBArray()
Definition: vtkVolume.h:175
float * GetCorrectedScalarOpacityArray()
Definition: vtkVolume.h:147
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:161
int ArraySize
Definition: vtkVolume.h:253
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:216
virtual vtkVolumeProperty * GetProperty()
Set/Get the volume property.
float * GetGrayArray()
Definition: vtkVolume.h:168
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:188
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(...)