vtkGPUVolumeRayCastMapper Class Reference

Ray casting performed on the GPU. More...

#include <vtkGPUVolumeRayCastMapper.h>

Inheritance diagram for vtkGPUVolumeRayCastMapper:

Collaboration diagram for vtkGPUVolumeRayCastMapper:

Public Types
enum	{ BinaryMaskType = 0 , LabelMapMaskType }
enum	TFRangeType { SCALAR = 0 , NATIVE }
typedef vtkVolumeMapper	Superclass
Public Types inherited from vtkVolumeMapper
enum	BlendModes {   COMPOSITE_BLEND , MAXIMUM_INTENSITY_BLEND , MINIMUM_INTENSITY_BLEND , AVERAGE_INTENSITY_BLEND ,   ADDITIVE_BLEND , ISOSURFACE_BLEND , SLICE_BLEND }
	Blend modes. More...
typedef vtkAbstractVolumeMapper	Superclass
Public Types inherited from vtkAbstractVolumeMapper
typedef vtkAbstractMapper3D	Superclass
Public Types inherited from vtkAbstractMapper3D
typedef vtkAbstractMapper	Superclass
Public Types inherited from vtkAbstractMapper
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkGPUVolumeRayCastMapper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkContourValues *	GetDepthPassContourValues ()
	Return handle to contour values container so that values can be set by the application.
virtual int	IsRenderSupported (vtkRenderWindow *vtkNotUsed(window), vtkVolumeProperty *vtkNotUsed(property))
	Based on hardware and properties, we may or may not be able to render using 3D texture mapping.
void	CreateCanonicalView (vtkRenderer *ren, vtkVolume *volume, vtkImageData *image, int blend_mode, double viewDirection[3], double viewUp[3])
virtual void	GetDepthImage (vtkImageData *)
	Low level API to export the depth texture as vtkImageData in RenderToImage mode.
virtual void	GetColorImage (vtkImageData *)
	Low level API to export the color texture as vtkImageData in RenderToImage mode.
void	Render (vtkRenderer *, vtkVolume *) override
	Initialize rendering for this volume.
virtual void	GPURender (vtkRenderer *, vtkVolume *)
	Handled in the subclass - the actual render method.
void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this mapper.
virtual void	GetReductionRatio (double ratio[3])=0
	Return how much the dataset has to be reduced in each dimension to fit on the GPU.
vtkDataSet *	GetInput () override
	Set/Get the input data.
int	GetInputCount ()
	Number of currently active ports.
vtkDataSet *	GetTransformedInput (int port=0)
double *	GetBoundsFromPort (int port)
virtual void	SetAutoAdjustSampleDistances (vtkTypeBool)
	If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).
virtual vtkTypeBool	GetAutoAdjustSampleDistances ()
	If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).
virtual void	AutoAdjustSampleDistancesOn ()
	If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).
virtual void	AutoAdjustSampleDistancesOff ()
	If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).
virtual void	SetLockSampleDistanceToInputSpacing (vtkTypeBool)
	Compute the sample distance from the data spacing.
virtual vtkTypeBool	GetLockSampleDistanceToInputSpacing ()
	Compute the sample distance from the data spacing.
virtual void	LockSampleDistanceToInputSpacingOn ()
	Compute the sample distance from the data spacing.
virtual void	LockSampleDistanceToInputSpacingOff ()
	Compute the sample distance from the data spacing.
virtual void	SetUseJittering (vtkTypeBool)
	If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect.
virtual vtkTypeBool	GetUseJittering ()
	If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect.
virtual void	UseJitteringOn ()
	If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect.
virtual void	UseJitteringOff ()
	If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect.
virtual void	SetUseDepthPass (vtkTypeBool)
	If UseDepthPass is on, the mapper will use two passes.
virtual vtkTypeBool	GetUseDepthPass ()
	If UseDepthPass is on, the mapper will use two passes.
virtual void	UseDepthPassOn ()
	If UseDepthPass is on, the mapper will use two passes.
virtual void	UseDepthPassOff ()
	If UseDepthPass is on, the mapper will use two passes.
virtual void	SetSampleDistance (float)
	Set/Get the distance between samples used for rendering when AutoAdjustSampleDistances is off, or when this mapper has more than 1 second allocated to it for rendering.
virtual float	GetSampleDistance ()
	Set/Get the distance between samples used for rendering when AutoAdjustSampleDistances is off, or when this mapper has more than 1 second allocated to it for rendering.
virtual void	SetImageSampleDistance (float)
	Sampling distance in the XY image dimensions.
virtual float	GetImageSampleDistance ()
	Sampling distance in the XY image dimensions.
virtual void	SetMinimumImageSampleDistance (float)
	This is the minimum image sample distance allow when the image sample distance is being automatically adjusted.
virtual float	GetMinimumImageSampleDistance ()
	This is the minimum image sample distance allow when the image sample distance is being automatically adjusted.
virtual void	SetMaximumImageSampleDistance (float)
	This is the maximum image sample distance allow when the image sample distance is being automatically adjusted.
virtual float	GetMaximumImageSampleDistance ()
	This is the maximum image sample distance allow when the image sample distance is being automatically adjusted.
virtual void	SetFinalColorWindow (float)
	Set/Get the window / level applied to the final color.
virtual float	GetFinalColorWindow ()
	Set/Get the window / level applied to the final color.
virtual void	SetFinalColorLevel (float)
	Set/Get the window / level applied to the final color.
virtual float	GetFinalColorLevel ()
	Set/Get the window / level applied to the final color.
virtual void	SetMaxMemoryInBytes (vtkIdType)
	Maximum size of the 3D texture in GPU memory.
virtual vtkIdType	GetMaxMemoryInBytes ()
	Maximum size of the 3D texture in GPU memory.
virtual void	SetMaxMemoryFraction (float)
	Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture.
virtual float	GetMaxMemoryFraction ()
	Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture.
virtual void	SetReportProgress (bool)
	Tells if the mapper will report intermediate progress.
virtual bool	GetReportProgress ()
	Tells if the mapper will report intermediate progress.
void	SetMaskInput (vtkImageData *mask)
	Optionally, set a mask input.
virtual vtkImageData *	GetMaskInput ()
	Optionally, set a mask input.
virtual void	SetMaskType (int)
	Set the mask type, if mask is to be used.
virtual int	GetMaskType ()
	Set the mask type, if mask is to be used.
void	SetMaskTypeToBinary ()
	Set the mask type, if mask is to be used.
void	SetMaskTypeToLabelMap ()
	Set the mask type, if mask is to be used.
virtual void	SetMaskBlendFactor (float)
	Tells how much mask color transfer function is used compared to the standard color transfer function when the mask is true.
virtual float	GetMaskBlendFactor ()
	Tells how much mask color transfer function is used compared to the standard color transfer function when the mask is true.
virtual void	SetGlobalIlluminationReach (float)
	This parameter acts as a balance between localness and globalness of shadows.
virtual float	GetGlobalIlluminationReach ()
	This parameter acts as a balance between localness and globalness of shadows.
virtual void	SetVolumetricScatteringBlending (float)
	This parameter controls the blending between surfacic approximation and volumetric multi-scattering.
virtual float	GetVolumetricScatteringBlending ()
	This parameter controls the blending between surfacic approximation and volumetric multi-scattering.
virtual void	SetRenderToImage (vtkTypeBool)
	Enable or disable setting output of volume rendering to be color and depth textures.
virtual vtkTypeBool	GetRenderToImage ()
	Enable or disable setting output of volume rendering to be color and depth textures.
virtual void	RenderToImageOn ()
	Enable or disable setting output of volume rendering to be color and depth textures.
virtual void	RenderToImageOff ()
	Enable or disable setting output of volume rendering to be color and depth textures.
virtual void	SetDepthImageScalarType (int)
	Set/Get the scalar type of the depth texture in RenderToImage mode.
virtual int	GetDepthImageScalarType ()
	Set/Get the scalar type of the depth texture in RenderToImage mode.
void	SetDepthImageScalarTypeToUnsignedChar ()
	Set/Get the scalar type of the depth texture in RenderToImage mode.
void	SetDepthImageScalarTypeToUnsignedShort ()
	Set/Get the scalar type of the depth texture in RenderToImage mode.
void	SetDepthImageScalarTypeToFloat ()
	Set/Get the scalar type of the depth texture in RenderToImage mode.
virtual void	SetClampDepthToBackface (vtkTypeBool)
	Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume.
virtual vtkTypeBool	GetClampDepthToBackface ()
	Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume.
virtual void	ClampDepthToBackfaceOn ()
	Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume.
virtual void	ClampDepthToBackfaceOff ()
	Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume.
virtual void	SetColorRangeType (int)
	Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values.
virtual int	GetColorRangeType ()
	Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values.
virtual void	SetScalarOpacityRangeType (int)
	Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values.
virtual int	GetScalarOpacityRangeType ()
	Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values.
virtual void	SetGradientOpacityRangeType (int)
	Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values.
virtual int	GetGradientOpacityRangeType ()
	Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values.
void	RemoveInputConnection (int port, vtkAlgorithmOutput *input) override
	Add/Remove input connections.
void	RemoveInputConnection (int port, int idx) override
	Add/Remove input connections.
void	SetInputConnection (int port, vtkAlgorithmOutput *input) override
	Add/Remove input connections.
void	SetInputConnection (vtkAlgorithmOutput *input) override
	Add/Remove input connections.
virtual void	SetTransfer2DYAxisArray (const char *)
	Set/Get the transfer 2D Y axis array.
virtual char *	GetTransfer2DYAxisArray ()
	Set/Get the transfer 2D Y axis array.
Public Member Functions inherited from vtkVolumeMapper
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkVolumeMapper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Render (vtkRenderer *ren, vtkVolume *vol) override=0
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Render the volume.
void	ReleaseGraphicsResources (vtkWindow *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this mapper.
virtual void	SetInputData (vtkImageData *)
	Set/Get the input data.
virtual void	SetInputData (vtkDataSet *)
	Set/Get the input data.
virtual void	SetInputData (vtkRectilinearGrid *)
	Set/Get the input data.
virtual void	SetBlendMode (int)
	Set/Get the blend mode.
void	SetBlendModeToComposite ()
	Set/Get the blend mode.
void	SetBlendModeToMaximumIntensity ()
	Set/Get the blend mode.
void	SetBlendModeToMinimumIntensity ()
	Set/Get the blend mode.
void	SetBlendModeToAverageIntensity ()
	Set/Get the blend mode.
void	SetBlendModeToAdditive ()
	Set/Get the blend mode.
void	SetBlendModeToIsoSurface ()
	Set/Get the blend mode.
void	SetBlendModeToSlice ()
	Set/Get the blend mode.
virtual int	GetBlendMode ()
	Set/Get the blend mode.
virtual void	SetAverageIPScalarRange (double, double)
	Set/Get the scalar range to be considered for average intensity projection blend mode.
void	SetAverageIPScalarRange (double[2])
	Set/Get the scalar range to be considered for average intensity projection blend mode.
virtual double *	GetAverageIPScalarRange ()
	Set/Get the scalar range to be considered for average intensity projection blend mode.
virtual void	GetAverageIPScalarRange (double data[2])
	Set/Get the scalar range to be considered for average intensity projection blend mode.
virtual void	SetCropping (vtkTypeBool)
	Turn On/Off orthogonal cropping.
virtual vtkTypeBool	GetCropping ()
	Turn On/Off orthogonal cropping.
virtual void	CroppingOn ()
	Turn On/Off orthogonal cropping.
virtual void	CroppingOff ()
	Turn On/Off orthogonal cropping.
virtual void	SetCroppingRegionPlanes (double, double, double, double, double, double)
	Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.
virtual void	SetCroppingRegionPlanes (double[6])
	Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.
virtual double *	GetCroppingRegionPlanes ()
	Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.
virtual void	GetCroppingRegionPlanes (double data[6])
	Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.
virtual double *	GetVoxelCroppingRegionPlanes ()
	Get the cropping region planes in voxels.
virtual void	GetVoxelCroppingRegionPlanes (double data[6])
	Get the cropping region planes in voxels.
virtual void	SetComputeNormalFromOpacity (bool)
	If enabled, the volume(s) whose shading is enabled will use the gradient of opacity instead of the scalar gradient to estimate the surface's normal when applying the shading model.
virtual bool	GetComputeNormalFromOpacity ()
	If enabled, the volume(s) whose shading is enabled will use the gradient of opacity instead of the scalar gradient to estimate the surface's normal when applying the shading model.
virtual void	ComputeNormalFromOpacityOn ()
	If enabled, the volume(s) whose shading is enabled will use the gradient of opacity instead of the scalar gradient to estimate the surface's normal when applying the shading model.
virtual void	ComputeNormalFromOpacityOff ()
	If enabled, the volume(s) whose shading is enabled will use the gradient of opacity instead of the scalar gradient to estimate the surface's normal when applying the shading model.
virtual void	SetCroppingRegionFlags (int)
	Set the flags for the cropping regions.
virtual int	GetCroppingRegionFlags ()
	Set the flags for the cropping regions.
void	SetCroppingRegionFlagsToSubVolume ()
	Set the flags for the cropping regions.
void	SetCroppingRegionFlagsToFence ()
	Set the flags for the cropping regions.
void	SetCroppingRegionFlagsToInvertedFence ()
	Set the flags for the cropping regions.
void	SetCroppingRegionFlagsToCross ()
	Set the flags for the cropping regions.
void	SetCroppingRegionFlagsToInvertedCross ()
	Set the flags for the cropping regions.
Public Member Functions inherited from vtkAbstractVolumeMapper
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAbstractVolumeMapper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual char *	GetArrayName ()
	Get the array name or number and component to use for rendering.
virtual int	GetArrayId ()
virtual int	GetArrayAccessMode ()
const char *	GetScalarModeAsString ()
	Return the method for obtaining scalar data.
virtual void	Render (vtkRenderer *ren, vtkVolume *vol)=0
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Render the volume.
void	ReleaseGraphicsResources (vtkWindow *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this mapper.
virtual vtkDataSet *	GetDataSetInput ()
	Set/Get the input data.
virtual vtkDataObject *	GetDataObjectInput ()
	Set/Get the input data.
double *	GetBounds () override
	Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).
void	GetBounds (double bounds[6]) override
	Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).
virtual void	SetScalarMode (int)
	Control how the mapper works with scalar point data and cell attribute data.
virtual int	GetScalarMode ()
	Control how the mapper works with scalar point data and cell attribute data.
virtual void	SetArrayAccessMode (int)
	Control how the mapper works with scalar point data and cell attribute data.
void	SetScalarModeToDefault ()
	Control how the mapper works with scalar point data and cell attribute data.
void	SetScalarModeToUsePointData ()
	Control how the mapper works with scalar point data and cell attribute data.
void	SetScalarModeToUseCellData ()
	Control how the mapper works with scalar point data and cell attribute data.
void	SetScalarModeToUsePointFieldData ()
	Control how the mapper works with scalar point data and cell attribute data.
void	SetScalarModeToUseCellFieldData ()
	Control how the mapper works with scalar point data and cell attribute data.
virtual void	SelectScalarArray (int arrayNum)
	When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array to use during rendering.
virtual void	SelectScalarArray (const char *arrayName)
	When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array to use during rendering.
virtual float	GetGradientMagnitudeScale ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE.
virtual float	GetGradientMagnitudeBias ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE.
virtual float	GetGradientMagnitudeScale (int)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE.
virtual float	GetGradientMagnitudeBias (int)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE.
Public Member Functions inherited from vtkAbstractMapper3D
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAbstractMapper3D *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual double *	GetBounds ()=0
	Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).
virtual void	GetBounds (double bounds[6])
	Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
double	GetLength ()
	Return the diagonal length of this mappers bounding box.
virtual vtkTypeBool	IsARayCastMapper ()
	Is this a ray cast mapper? A subclass would return 1 if the ray caster is needed to generate an image from this mapper.
virtual vtkTypeBool	IsARenderIntoImageMapper ()
	Is this a "render into image" mapper? A subclass would return 1 if the mapper produces an image by rendering into a software image buffer.
void	GetClippingPlaneInDataCoords (vtkMatrix4x4 *propMatrix, int i, double planeEquation[4])
	Get the ith clipping plane as a homogeneous plane equation.
double *	GetCenter ()
	Return the Center of this mapper's data.
void	GetCenter (double center[3])
	Return the Center of this mapper's data.
Public Member Functions inherited from vtkAbstractMapper
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAbstractMapper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkMTimeType	GetMTime () override
	Override Modifiedtime as we have added Clipping planes.
virtual void	ReleaseGraphicsResources (vtkWindow *)
	Release any graphics resources that are being consumed by this mapper.
void	SetClippingPlanes (vtkPlanes *planes)
	An alternative way to set clipping planes: use up to six planes found in the supplied instance of the implicit function vtkPlanes.
virtual void	ShallowCopy (vtkAbstractMapper *m)
	Make a shallow copy of this mapper.
int	GetNumberOfClippingPlanes ()
	Get the number of clipping planes.
virtual double	GetTimeToDraw ()
	Get the time required to draw the geometry last time it was rendered.
void	AddClippingPlane (vtkPlane *plane)
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).
void	RemoveClippingPlane (vtkPlane *plane)
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).
void	RemoveAllClippingPlanes ()
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).
virtual void	SetClippingPlanes (vtkPlaneCollection *)
	Get/Set the vtkPlaneCollection which specifies the clipping planes.
virtual vtkPlaneCollection *	GetClippingPlanes ()
	Get/Set the vtkPlaneCollection which specifies the clipping planes.
Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
virtual vtkTypeBool	ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.
virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.
void	UpdateProgress (double amount)
	Update the progress of the process object.
bool	CheckAbort ()
	Checks to see if this filter should abort.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
	String based versions of SetInputArrayToProcess().
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS void	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual void	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual VTK_UNBLOCKTHREADS void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
void	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
bool	UsesGarbageCollector () const override
	Participate in garbage collection.
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.
virtual double	GetProgress ()
	Get the execution progress of a process object.
void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.
vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.
virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.
virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual VTK_UNBLOCKTHREADS void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.
virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
void	SetNoPriorTemporalAccessInformationKey (int key)
	Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
void	SetNoPriorTemporalAccessInformationKey ()
	Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkGPUVolumeRayCastMapper *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkGPUVolumeRayCastMapper *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkVolumeMapper
static vtkTypeBool	IsTypeOf (const char *type)
static vtkVolumeMapper *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractVolumeMapper
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAbstractVolumeMapper *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractMapper3D
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAbstractMapper3D *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractMapper
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAbstractMapper *	SafeDownCast (vtkObjectBase *o)
static vtkDataArray *	GetScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
	Internal helper function for getting the active scalars.
static vtkAbstractArray *	GetAbstractScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
	Internal helper function for getting the active scalars as an abstract array.
static vtkUnsignedCharArray *	GetGhostArray (vtkDataSet *input, int scalarMode, unsigned char &ghostsToSkip)
	Returns the ghost array associated with the corresponding scalar mode, if present.
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static vtkInformationIntegerKey *	ABORTED ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Types
using	DataMap = std::unordered_map< int, vtkDataSet * >

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGPUVolumeRayCastMapper ()
	~vtkGPUVolumeRayCastMapper () override
int	FillInputPortInformation (int port, vtkInformation *info) override
	Handle inputs.
void	TransformInput (int port)
	A transformation is applied (translation) to the input.
void	CanonicalViewRender (vtkRenderer *, vtkVolume *)
virtual void	PreRender (vtkRenderer *ren, vtkVolume *vol, double datasetBounds[6], double scalarRange[2], int numberOfScalarComponents, unsigned int numberOfLevels)=0
virtual void	RenderBlock (vtkRenderer *ren, vtkVolume *vol, unsigned int level)=0
virtual void	PostRender (vtkRenderer *ren, int numberOfScalarComponents)=0
vtkDataSet *	GetInput (int port) override
	Set/Get the input data.
void	SetCellFlag (int cellFlag)
	Called by the AMR Volume Mapper.
void	RemovePortInternal (int port)
virtual void	ClipCroppingRegionPlanes ()
	Compute the cropping planes clipped by the bounds of the volume.
void	SetTransformedInput (vtkDataSet *)
vtkDataSet *	FindData (int port, DataMap &container)
int	ValidateRender (vtkRenderer *, vtkVolume *)
	This method is used by the Render() method to validate everything before attempting to render.
int	ValidateInputs ()
	This method is used by the Render() method to validate everything before attempting to render.
int	ValidateInput (vtkVolumeProperty *property, int port)
	This method is used by the Render() method to validate everything before attempting to render.
void	CloneInputs ()
	Shallow-copy the inputs into a transform-adjusted clone.
void	CloneInput (vtkDataSet *input, int port)
	Shallow-copy the inputs into a transform-adjusted clone.
virtual void	SetAMRMode (vtkTypeBool)
	Set the mapper in AMR Mode or not.
virtual vtkTypeBool	GetAMRMode ()
	Set the mapper in AMR Mode or not.
virtual void	AMRModeOn ()
	Set the mapper in AMR Mode or not.
virtual void	AMRModeOff ()
	Set the mapper in AMR Mode or not.
Protected Member Functions inherited from vtkVolumeMapper
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkVolumeMapper ()
	~vtkVolumeMapper () override
double	SpacingAdjustedSampleDistance (double inputSpacing[3], int inputExtent[6])
	Compute a sample distance from the data spacing.
int	FillInputPortInformation (int, vtkInformation *) override
	Fill the input port information objects for this algorithm.
void	ConvertCroppingRegionPlanesToVoxels ()
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.
Protected Member Functions inherited from vtkAbstractVolumeMapper
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAbstractVolumeMapper ()
	~vtkAbstractVolumeMapper () override
int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.
Protected Member Functions inherited from vtkAbstractMapper3D
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAbstractMapper3D ()
	~vtkAbstractMapper3D () override=default
Protected Member Functions inherited from vtkAbstractMapper
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAbstractMapper ()
	~vtkAbstractMapper () override
Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAlgorithm ()
	~vtkAlgorithm () override
bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.
virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.
virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.
void	ReportReferences (vtkGarbageCollector *) override
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.
virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.
void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.
void	AddInputDataInternal (int port, vtkDataObject *input)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTypeBool	LockSampleDistanceToInputSpacing
vtkTypeBool	AutoAdjustSampleDistances
float	ImageSampleDistance
float	MinimumImageSampleDistance
float	MaximumImageSampleDistance
vtkTypeBool	RenderToImage
int	DepthImageScalarType
vtkTypeBool	ClampDepthToBackface
vtkTypeBool	UseJittering
float	GlobalIlluminationReach = 0.0
float	VolumetricScatteringBlending = 0.0
vtkTypeBool	UseDepthPass
vtkContourValues *	DepthPassContourValues
float	SampleDistance
int	SmallVolumeRender
double	BigTimeToDraw
double	SmallTimeToDraw
float	FinalColorWindow
float	FinalColorLevel
int	GeneratingCanonicalView
vtkImageData *	CanonicalViewImageData
vtkImageData *	MaskInput
float	MaskBlendFactor
int	MaskType
vtkTypeBool	AMRMode
int	ColorRangeType
int	ScalarOpacityRangeType
int	GradientOpacityRangeType
int	CellFlag
double	ClippedCroppingRegionPlanes [6]
vtkIdType	MaxMemoryInBytes
float	MaxMemoryFraction
bool	ReportProgress
std::vector< int >	Ports
std::vector< int >	RemovedPorts
DataMap	TransformedInputs
DataMap	LastInputs
	This is needed only to check if the input data has been changed since the last Render() call.
char *	Transfer2DYAxisArray
	Define the array used for the Y axis of transfer 2D.
Protected Attributes inherited from vtkVolumeMapper
int	BlendMode
bool	ComputeNormalFromOpacity = false
	Is the normal for volume shading computed from opacity or from scalars.
double	AverageIPScalarRange [2]
	Threshold range for average intensity projection.
vtkTypeBool	Cropping
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.
double	CroppingRegionPlanes [6]
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.
double	VoxelCroppingRegionPlanes [6]
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.
int	CroppingRegionFlags
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.
Protected Attributes inherited from vtkAbstractVolumeMapper
int	ScalarMode
char *	ArrayName
int	ArrayId
int	ArrayAccessMode
Protected Attributes inherited from vtkAbstractMapper3D
double	Bounds [6]
double	Center [3]
Protected Attributes inherited from vtkAbstractMapper
vtkTimerLog *	Timer
double	TimeToDraw
vtkWindow *	LastWindow
vtkPlaneCollection *	ClippingPlanes
Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool >	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Ray casting performed on the GPU.

vtkGPUVolumeRayCastMapper is a volume mapper that performs ray casting on the GPU using fragment programs.

This mapper supports connections in multiple ports of input 0 (port 0 being the only required connection). It is up to the concrete implementation whether additional inputs will be used during rendering. This class maintains a list of the currently active input ports (Ports) as well as a list of the ports that have been disconnected (RemovedPorts). RemovedPorts is used the the concrete implementation to clean up internal structures.

Events:

vtkCommand::VolumeMapperRenderEndEvent vtkCommand::VolumeMapperRenderStartEvent

Tests:

vtkGPUVolumeRayCastMapper (Tests)

Definition at line 37 of file vtkGPUVolumeRayCastMapper.h.

Member Typedef Documentation

Superclass

typedef vtkVolumeMapper vtkGPUVolumeRayCastMapper::Superclass

Definition at line 41 of file vtkGPUVolumeRayCastMapper.h.

DataMap

using vtkGPUVolumeRayCastMapper::DataMap = std::unordered_map<int, vtkDataSet*>

protected

Definition at line 608 of file vtkGPUVolumeRayCastMapper.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
BinaryMaskType
LabelMapMaskType

Definition at line 233 of file vtkGPUVolumeRayCastMapper.h.

TFRangeType

enum vtkGPUVolumeRayCastMapper::TFRangeType

Enumerator
SCALAR
NATIVE

Definition at line 391 of file vtkGPUVolumeRayCastMapper.h.

Constructor & Destructor Documentation

vtkGPUVolumeRayCastMapper()

vtkGPUVolumeRayCastMapper::vtkGPUVolumeRayCastMapper ( )

protected

~vtkGPUVolumeRayCastMapper()

vtkGPUVolumeRayCastMapper::~vtkGPUVolumeRayCastMapper ( )

overrideprotected

Member Function Documentation

New()

static vtkGPUVolumeRayCastMapper * vtkGPUVolumeRayCastMapper::New ( )

static

IsTypeOf()

static vtkTypeBool vtkGPUVolumeRayCastMapper::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkVolumeMapper.

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

SafeDownCast()

static vtkGPUVolumeRayCastMapper * vtkGPUVolumeRayCastMapper::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkGPUVolumeRayCastMapper::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkVolumeMapper.

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

NewInstance()

vtkGPUVolumeRayCastMapper * vtkGPUVolumeRayCastMapper::NewInstance

(

)

const

PrintSelf()

void vtkGPUVolumeRayCastMapper::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

SetAutoAdjustSampleDistances()

virtual void vtkGPUVolumeRayCastMapper::SetAutoAdjustSampleDistances ( vtkTypeBool  )

virtual

If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

GetAutoAdjustSampleDistances()

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::GetAutoAdjustSampleDistances ( )

virtual

If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

AutoAdjustSampleDistancesOn()

virtual void vtkGPUVolumeRayCastMapper::AutoAdjustSampleDistancesOn ( )

virtual

If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

AutoAdjustSampleDistancesOff()

virtual void vtkGPUVolumeRayCastMapper::AutoAdjustSampleDistancesOff ( )

virtual

If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

SetLockSampleDistanceToInputSpacing()

virtual void vtkGPUVolumeRayCastMapper::SetLockSampleDistanceToInputSpacing ( vtkTypeBool  )

virtual

Compute the sample distance from the data spacing.

When the number of voxels is 8, the sample distance will be roughly 1/200 the average voxel size. The distance will grow proportionally to numVoxels^(1/3). Off by default.

GetLockSampleDistanceToInputSpacing()

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::GetLockSampleDistanceToInputSpacing ( )

virtual

Compute the sample distance from the data spacing.

When the number of voxels is 8, the sample distance will be roughly 1/200 the average voxel size. The distance will grow proportionally to numVoxels^(1/3). Off by default.

LockSampleDistanceToInputSpacingOn()

virtual void vtkGPUVolumeRayCastMapper::LockSampleDistanceToInputSpacingOn ( )

virtual

Compute the sample distance from the data spacing.

When the number of voxels is 8, the sample distance will be roughly 1/200 the average voxel size. The distance will grow proportionally to numVoxels^(1/3). Off by default.

LockSampleDistanceToInputSpacingOff()

virtual void vtkGPUVolumeRayCastMapper::LockSampleDistanceToInputSpacingOff ( )

virtual

Compute the sample distance from the data spacing.

When the number of voxels is 8, the sample distance will be roughly 1/200 the average voxel size. The distance will grow proportionally to numVoxels^(1/3). Off by default.

SetUseJittering()

virtual void vtkGPUVolumeRayCastMapper::SetUseJittering ( vtkTypeBool  )

virtual

If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect.

GetUseJittering()

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::GetUseJittering ( )

virtual

If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect.

UseJitteringOn()

virtual void vtkGPUVolumeRayCastMapper::UseJitteringOn ( )

virtual

If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect.

UseJitteringOff()

virtual void vtkGPUVolumeRayCastMapper::UseJitteringOff ( )

virtual

If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect.

SetUseDepthPass()

virtual void vtkGPUVolumeRayCastMapper::SetUseDepthPass ( vtkTypeBool  )

virtual

If UseDepthPass is on, the mapper will use two passes.

In the first pass, an isocontour depth buffer will be utilized as starting point for ray-casting hence eliminating traversal on voxels that are not going to participate in final rendering. UseDepthPass requires reasonable contour values to be set which can be set by calling GetDepthPassContourValues() method and using vtkControurValues API.

GetUseDepthPass()

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::GetUseDepthPass ( )

virtual

If UseDepthPass is on, the mapper will use two passes.

In the first pass, an isocontour depth buffer will be utilized as starting point for ray-casting hence eliminating traversal on voxels that are not going to participate in final rendering. UseDepthPass requires reasonable contour values to be set which can be set by calling GetDepthPassContourValues() method and using vtkControurValues API.

UseDepthPassOn()

virtual void vtkGPUVolumeRayCastMapper::UseDepthPassOn ( )

virtual

If UseDepthPass is on, the mapper will use two passes.

In the first pass, an isocontour depth buffer will be utilized as starting point for ray-casting hence eliminating traversal on voxels that are not going to participate in final rendering. UseDepthPass requires reasonable contour values to be set which can be set by calling GetDepthPassContourValues() method and using vtkControurValues API.

UseDepthPassOff()

virtual void vtkGPUVolumeRayCastMapper::UseDepthPassOff ( )

virtual

If UseDepthPass is on, the mapper will use two passes.

In the first pass, an isocontour depth buffer will be utilized as starting point for ray-casting hence eliminating traversal on voxels that are not going to participate in final rendering. UseDepthPass requires reasonable contour values to be set which can be set by calling GetDepthPassContourValues() method and using vtkControurValues API.

GetDepthPassContourValues()

vtkContourValues * vtkGPUVolumeRayCastMapper::GetDepthPassContourValues

(

)

Return handle to contour values container so that values can be set by the application.

Contour values will be used only when UseDepthPass is on.

SetSampleDistance()

virtual void vtkGPUVolumeRayCastMapper::SetSampleDistance ( float  )

virtual

Set/Get the distance between samples used for rendering when AutoAdjustSampleDistances is off, or when this mapper has more than 1 second allocated to it for rendering.

Initial value is 1.0.

GetSampleDistance()

virtual float vtkGPUVolumeRayCastMapper::GetSampleDistance ( )

virtual

Set/Get the distance between samples used for rendering when AutoAdjustSampleDistances is off, or when this mapper has more than 1 second allocated to it for rendering.

Initial value is 1.0.

SetImageSampleDistance()

virtual void vtkGPUVolumeRayCastMapper::SetImageSampleDistance ( float  )

virtual

Sampling distance in the XY image dimensions.

Default value of 1 meaning 1 ray cast per pixel. If set to 0.5, 4 rays will be cast per pixel. If set to 2.0, 1 ray will be cast for every 4 (2 by 2) pixels. This value will be adjusted to meet a desired frame rate when AutoAdjustSampleDistances is on.

GetImageSampleDistance()

virtual float vtkGPUVolumeRayCastMapper::GetImageSampleDistance ( )

virtual

Sampling distance in the XY image dimensions.

Default value of 1 meaning 1 ray cast per pixel. If set to 0.5, 4 rays will be cast per pixel. If set to 2.0, 1 ray will be cast for every 4 (2 by 2) pixels. This value will be adjusted to meet a desired frame rate when AutoAdjustSampleDistances is on.

SetMinimumImageSampleDistance()

virtual void vtkGPUVolumeRayCastMapper::SetMinimumImageSampleDistance ( float  )

virtual

This is the minimum image sample distance allow when the image sample distance is being automatically adjusted.

GetMinimumImageSampleDistance()

virtual float vtkGPUVolumeRayCastMapper::GetMinimumImageSampleDistance ( )

virtual

This is the minimum image sample distance allow when the image sample distance is being automatically adjusted.

SetMaximumImageSampleDistance()

virtual void vtkGPUVolumeRayCastMapper::SetMaximumImageSampleDistance ( float  )

virtual

This is the maximum image sample distance allow when the image sample distance is being automatically adjusted.

GetMaximumImageSampleDistance()

virtual float vtkGPUVolumeRayCastMapper::GetMaximumImageSampleDistance ( )

virtual

This is the maximum image sample distance allow when the image sample distance is being automatically adjusted.

SetFinalColorWindow()

virtual void vtkGPUVolumeRayCastMapper::SetFinalColorWindow ( float  )

virtual

Set/Get the window / level applied to the final color.

This allows brightness / contrast adjustments on the final image. window is the width of the window. level is the center of the window. Initial window value is 1.0 Initial level value is 0.5 window cannot be null but can be negative, this way values will be reversed. |window| can be larger than 1.0 level can be any real value.

GetFinalColorWindow()

virtual float vtkGPUVolumeRayCastMapper::GetFinalColorWindow ( )

virtual

Set/Get the window / level applied to the final color.

This allows brightness / contrast adjustments on the final image. window is the width of the window. level is the center of the window. Initial window value is 1.0 Initial level value is 0.5 window cannot be null but can be negative, this way values will be reversed. |window| can be larger than 1.0 level can be any real value.

SetFinalColorLevel()

virtual void vtkGPUVolumeRayCastMapper::SetFinalColorLevel ( float  )

virtual

Set/Get the window / level applied to the final color.

This allows brightness / contrast adjustments on the final image. window is the width of the window. level is the center of the window. Initial window value is 1.0 Initial level value is 0.5 window cannot be null but can be negative, this way values will be reversed. |window| can be larger than 1.0 level can be any real value.

GetFinalColorLevel()

virtual float vtkGPUVolumeRayCastMapper::GetFinalColorLevel ( )

virtual

Set/Get the window / level applied to the final color.

This allows brightness / contrast adjustments on the final image. window is the width of the window. level is the center of the window. Initial window value is 1.0 Initial level value is 0.5 window cannot be null but can be negative, this way values will be reversed. |window| can be larger than 1.0 level can be any real value.

SetMaxMemoryInBytes()

virtual void vtkGPUVolumeRayCastMapper::SetMaxMemoryInBytes ( vtkIdType  )

virtual

Maximum size of the 3D texture in GPU memory.

Will default to the size computed from the graphics card. Can be adjusted by the user.

GetMaxMemoryInBytes()

virtual vtkIdType vtkGPUVolumeRayCastMapper::GetMaxMemoryInBytes ( )

virtual

Maximum size of the 3D texture in GPU memory.

Will default to the size computed from the graphics card. Can be adjusted by the user.

SetMaxMemoryFraction()

virtual void vtkGPUVolumeRayCastMapper::SetMaxMemoryFraction ( float  )

virtual

Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture.

Valid values are 0.1 to 1.0.

GetMaxMemoryFraction()

virtual float vtkGPUVolumeRayCastMapper::GetMaxMemoryFraction ( )

virtual

Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture.

Valid values are 0.1 to 1.0.

SetReportProgress()

virtual void vtkGPUVolumeRayCastMapper::SetReportProgress ( bool  )

virtual

Tells if the mapper will report intermediate progress.

Initial value is true. As the progress works with a GL blocking call (glFinish()), this can be useful for huge dataset but can slow down rendering of small dataset. It should be set to true for big dataset or complex shading and streaming but to false for small datasets.

GetReportProgress()

virtual bool vtkGPUVolumeRayCastMapper::GetReportProgress ( )

virtual

Tells if the mapper will report intermediate progress.

Initial value is true. As the progress works with a GL blocking call (glFinish()), this can be useful for huge dataset but can slow down rendering of small dataset. It should be set to true for big dataset or complex shading and streaming but to false for small datasets.

IsRenderSupported()

virtual int vtkGPUVolumeRayCastMapper::IsRenderSupported ( vtkRenderWindow *  vtkNotUsedwindow, vtkVolumeProperty *  vtkNotUsedproperty  )

inlinevirtual

Based on hardware and properties, we may or may not be able to render using 3D texture mapping.

This indicates if 3D texture mapping is supported by the hardware, and if the other extensions necessary to support the specific properties are available.

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

Definition at line 199 of file vtkGPUVolumeRayCastMapper.h.

CreateCanonicalView()

void vtkGPUVolumeRayCastMapper::CreateCanonicalView	(	vtkRenderer *	ren,
		vtkVolume *	volume,
		vtkImageData *	image,
		int	blend_mode,
		double	viewDirection[3],
		double	viewUp[3]
	)

SetMaskInput()

void vtkGPUVolumeRayCastMapper::SetMaskInput

(

vtkImageData *

mask

)

Optionally, set a mask input.

This mask may be a binary mask or a label map. This must be specified via SetMaskType.

If the mask is a binary mask, the volume rendering is confined to regions within the binary mask. The binary mask is assumed to have a datatype of UCHAR and values of 255 (inside) and 0 (outside).

The mask may also be a label map. The label map must have a datatype of UCHAR i.e. it can have upto 256 labels. The label 0 is reserved as a special label. In voxels with label value of 0, the default transfer functions supplied by vtkVolumeProperty are used.

For voxels with a label values greater than 0, the color transfer functions supplied using vtkVolumeProperty's label API are used.

For voxels with a label value greater than 0, the color transfer function is blended with the default color transfer function, with the blending weight determined by MaskBlendFactor.

GetMaskInput()

virtual vtkImageData * vtkGPUVolumeRayCastMapper::GetMaskInput ( )

virtual

Optionally, set a mask input.

This mask may be a binary mask or a label map. This must be specified via SetMaskType.

If the mask is a binary mask, the volume rendering is confined to regions within the binary mask. The binary mask is assumed to have a datatype of UCHAR and values of 255 (inside) and 0 (outside).

The mask may also be a label map. The label map must have a datatype of UCHAR i.e. it can have upto 256 labels. The label 0 is reserved as a special label. In voxels with label value of 0, the default transfer functions supplied by vtkVolumeProperty are used.

For voxels with a label values greater than 0, the color transfer functions supplied using vtkVolumeProperty's label API are used.

For voxels with a label value greater than 0, the color transfer function is blended with the default color transfer function, with the blending weight determined by MaskBlendFactor.

SetMaskType()

virtual void vtkGPUVolumeRayCastMapper::SetMaskType ( int  )

virtual

Set the mask type, if mask is to be used.

See documentation for SetMaskInput(). The default is a LabelMapMaskType.

GetMaskType()

virtual int vtkGPUVolumeRayCastMapper::GetMaskType ( )

virtual

Set the mask type, if mask is to be used.

See documentation for SetMaskInput(). The default is a LabelMapMaskType.

SetMaskTypeToBinary()

void vtkGPUVolumeRayCastMapper::SetMaskTypeToBinary

(

)

Set the mask type, if mask is to be used.

See documentation for SetMaskInput(). The default is a LabelMapMaskType.

SetMaskTypeToLabelMap()

void vtkGPUVolumeRayCastMapper::SetMaskTypeToLabelMap

(

)

Set the mask type, if mask is to be used.

See documentation for SetMaskInput(). The default is a LabelMapMaskType.

SetMaskBlendFactor()

virtual void vtkGPUVolumeRayCastMapper::SetMaskBlendFactor ( float  )

virtual

Tells how much mask color transfer function is used compared to the standard color transfer function when the mask is true.

This is relevant only for the label map mask. 0.0 means only standard color transfer function. 1.0 means only mask color transfer function. The default value is 1.0.

GetMaskBlendFactor()

virtual float vtkGPUVolumeRayCastMapper::GetMaskBlendFactor ( )

virtual

Tells how much mask color transfer function is used compared to the standard color transfer function when the mask is true.

This is relevant only for the label map mask. 0.0 means only standard color transfer function. 1.0 means only mask color transfer function. The default value is 1.0.

SetGlobalIlluminationReach()

virtual void vtkGPUVolumeRayCastMapper::SetGlobalIlluminationReach ( float  )

virtual

This parameter acts as a balance between localness and globalness of shadows.

A value of 0.0 will be faster, but we'll only capture local shadows. A value of 1.0 will be slower, but we'll capture all shadows. The default value is 0.0.

GetGlobalIlluminationReach()

virtual float vtkGPUVolumeRayCastMapper::GetGlobalIlluminationReach ( )

virtual

This parameter acts as a balance between localness and globalness of shadows.

A value of 0.0 will be faster, but we'll only capture local shadows. A value of 1.0 will be slower, but we'll capture all shadows. The default value is 0.0.

SetVolumetricScatteringBlending()

virtual void vtkGPUVolumeRayCastMapper::SetVolumetricScatteringBlending ( float  )

virtual

This parameter controls the blending between surfacic approximation and volumetric multi-scattering.

It is only considered when Shade is enabled. A value of 0.0 means that no scattered rays will be cast, no volumetric shadows A value of 1.0 means that the shader will smartly blend between the two models A value of 2.0 means that the shader only uses the volumetric scattering model. The blending is not uniform, and is done in the following way: a value in [0, 1] biases the shader to choose between the two models, and a value in [1, 2] forces the shader to use more the volumetric model.

GetVolumetricScatteringBlending()

virtual float vtkGPUVolumeRayCastMapper::GetVolumetricScatteringBlending ( )

virtual

This parameter controls the blending between surfacic approximation and volumetric multi-scattering.

It is only considered when Shade is enabled. A value of 0.0 means that no scattered rays will be cast, no volumetric shadows A value of 1.0 means that the shader will smartly blend between the two models A value of 2.0 means that the shader only uses the volumetric scattering model. The blending is not uniform, and is done in the following way: a value in [0, 1] biases the shader to choose between the two models, and a value in [1, 2] forces the shader to use more the volumetric model.

SetRenderToImage()

virtual void vtkGPUVolumeRayCastMapper::SetRenderToImage ( vtkTypeBool  )

virtual

Enable or disable setting output of volume rendering to be color and depth textures.

By default this is set to 0 (off). It should be noted that it is possible that underlying API specific mapper may not supoport RenderToImage mode.

Warning

• This method ignores any other volumes / props in the scene.
• This method does not respect the general attributes of the scene i.e. background color, etc. It always produces a color image that has a transparent white background outside the bounds of the volume.

See also

GetDepthImage(), GetColorImage()

GetRenderToImage()

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::GetRenderToImage ( )

virtual

Enable or disable setting output of volume rendering to be color and depth textures.

By default this is set to 0 (off). It should be noted that it is possible that underlying API specific mapper may not supoport RenderToImage mode.

Warning

• This method ignores any other volumes / props in the scene.
• This method does not respect the general attributes of the scene i.e. background color, etc. It always produces a color image that has a transparent white background outside the bounds of the volume.

See also

GetDepthImage(), GetColorImage()

RenderToImageOn()

virtual void vtkGPUVolumeRayCastMapper::RenderToImageOn ( )

virtual

Enable or disable setting output of volume rendering to be color and depth textures.

By default this is set to 0 (off). It should be noted that it is possible that underlying API specific mapper may not supoport RenderToImage mode.

Warning

• This method ignores any other volumes / props in the scene.
• This method does not respect the general attributes of the scene i.e. background color, etc. It always produces a color image that has a transparent white background outside the bounds of the volume.

See also

GetDepthImage(), GetColorImage()

RenderToImageOff()

virtual void vtkGPUVolumeRayCastMapper::RenderToImageOff ( )

virtual

Enable or disable setting output of volume rendering to be color and depth textures.

By default this is set to 0 (off). It should be noted that it is possible that underlying API specific mapper may not supoport RenderToImage mode.

Warning

• This method ignores any other volumes / props in the scene.
• This method does not respect the general attributes of the scene i.e. background color, etc. It always produces a color image that has a transparent white background outside the bounds of the volume.

See also

GetDepthImage(), GetColorImage()

SetDepthImageScalarType()

virtual void vtkGPUVolumeRayCastMapper::SetDepthImageScalarType ( int  )

virtual

Set/Get the scalar type of the depth texture in RenderToImage mode.

By default, the type if VTK_FLOAT.

See also

SetRenderToImage()

GetDepthImageScalarType()

virtual int vtkGPUVolumeRayCastMapper::GetDepthImageScalarType ( )

virtual

Set/Get the scalar type of the depth texture in RenderToImage mode.

By default, the type if VTK_FLOAT.

See also

SetRenderToImage()

SetDepthImageScalarTypeToUnsignedChar()

void vtkGPUVolumeRayCastMapper::SetDepthImageScalarTypeToUnsignedChar

(

)

Set/Get the scalar type of the depth texture in RenderToImage mode.

By default, the type if VTK_FLOAT.

See also

SetRenderToImage()

SetDepthImageScalarTypeToUnsignedShort()

void vtkGPUVolumeRayCastMapper::SetDepthImageScalarTypeToUnsignedShort

(

)

Set/Get the scalar type of the depth texture in RenderToImage mode.

By default, the type if VTK_FLOAT.

See also

SetRenderToImage()

SetDepthImageScalarTypeToFloat()

void vtkGPUVolumeRayCastMapper::SetDepthImageScalarTypeToFloat

(

)

Set/Get the scalar type of the depth texture in RenderToImage mode.

By default, the type if VTK_FLOAT.

See also

SetRenderToImage()

SetClampDepthToBackface()

virtual void vtkGPUVolumeRayCastMapper::SetClampDepthToBackface ( vtkTypeBool  )

virtual

Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume.

This parameter is used when RenderToImage mode is enabled. When ClampDepthToBackFace is false, the fully transparent voxels will have a value of 1.0 in the depth image. When this is true, the fully transparent voxels will have the depth value of the face at which the ray exits the volume. By default, this is set to 0 (off).

See also

SetRenderToImage(), GetDepthImage()

GetClampDepthToBackface()

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::GetClampDepthToBackface ( )

virtual

Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume.

This parameter is used when RenderToImage mode is enabled. When ClampDepthToBackFace is false, the fully transparent voxels will have a value of 1.0 in the depth image. When this is true, the fully transparent voxels will have the depth value of the face at which the ray exits the volume. By default, this is set to 0 (off).

See also

SetRenderToImage(), GetDepthImage()

ClampDepthToBackfaceOn()

virtual void vtkGPUVolumeRayCastMapper::ClampDepthToBackfaceOn ( )

virtual

Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume.

This parameter is used when RenderToImage mode is enabled. When ClampDepthToBackFace is false, the fully transparent voxels will have a value of 1.0 in the depth image. When this is true, the fully transparent voxels will have the depth value of the face at which the ray exits the volume. By default, this is set to 0 (off).

See also

SetRenderToImage(), GetDepthImage()

ClampDepthToBackfaceOff()

virtual void vtkGPUVolumeRayCastMapper::ClampDepthToBackfaceOff ( )

virtual

Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume.

This parameter is used when RenderToImage mode is enabled. When ClampDepthToBackFace is false, the fully transparent voxels will have a value of 1.0 in the depth image. When this is true, the fully transparent voxels will have the depth value of the face at which the ray exits the volume. By default, this is set to 0 (off).

See also

SetRenderToImage(), GetDepthImage()

GetDepthImage()

virtual void vtkGPUVolumeRayCastMapper::GetDepthImage ( vtkImageData *  )

inlinevirtual

Low level API to export the depth texture as vtkImageData in RenderToImage mode.

Should be implemented by the graphics API specific mapper (GL or other).

See also

SetRenderToImage()

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

Definition at line 347 of file vtkGPUVolumeRayCastMapper.h.

GetColorImage()

virtual void vtkGPUVolumeRayCastMapper::GetColorImage ( vtkImageData *  )

inlinevirtual

Low level API to export the color texture as vtkImageData in RenderToImage mode.

Should be implemented by the graphics API specific mapper (GL or other).

See also

SetRenderToImage()

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

Definition at line 355 of file vtkGPUVolumeRayCastMapper.h.

Render()

void vtkGPUVolumeRayCastMapper::Render ( vtkRenderer *  , vtkVolume *    )

overridevirtual

Initialize rendering for this volume.

Warning

INTERNAL METHOD - NOT INTENDED FOR GENERAL USE

Implements vtkVolumeMapper.

GPURender()

virtual void vtkGPUVolumeRayCastMapper::GPURender ( vtkRenderer *  , vtkVolume *    )

inlinevirtual

Handled in the subclass - the actual render method.

Precondition

input is up-to-date.

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

Definition at line 367 of file vtkGPUVolumeRayCastMapper.h.

ReleaseGraphicsResources()

void vtkGPUVolumeRayCastMapper::ReleaseGraphicsResources ( vtkWindow *  )

inlineoverridevirtual

Release any graphics resources that are being consumed by this mapper.

The parameter window could be used to determine which graphic resources to release.

Warning

INTERNAL METHOD - NOT INTENDED FOR GENERAL USE

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

Definition at line 375 of file vtkGPUVolumeRayCastMapper.h.

GetReductionRatio()

virtual void vtkGPUVolumeRayCastMapper::GetReductionRatio ( double  ratio[3] )

pure virtual

Return how much the dataset has to be reduced in each dimension to fit on the GPU.

If the value is 1.0, there is no need to reduce the dataset.

Precondition

the calling thread has a current OpenGL context.

mapper_supported: IsRenderSupported(renderer->GetRenderWindow(),0) The computation is based on hardware limits (3D texture indexable size) and MaxMemoryInBytes.

Postcondition

valid_i_ratio: ratio[0]>0 && ratio[0]<=1.0

valid_j_ratio: ratio[1]>0 && ratio[1]<=1.0

valid_k_ratio: ratio[2]>0 && ratio[2]<=1.0

SetColorRangeType()

virtual void vtkGPUVolumeRayCastMapper::SetColorRangeType ( int  )

virtual

Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values.

When the range is set to TransferFunctionRange::SCALAR, the function is distributed over the entire scalar range. If it is set to TransferFunctionRange::NATIVE, the scalar values outside the native transfer function range will be truncated to native range. By default, the volume scalar range is used.

Note

The native range of the transfer function is the range returned by vtkColorTransferFunction::GetRange() or vtkPiecewiseFunction::GetRange().

There is no special API provided for 2D transfer functions considering that they are set as a pre-generated vtkImageData on this class i.e. the range is already encoded.

GetColorRangeType()

virtual int vtkGPUVolumeRayCastMapper::GetColorRangeType ( )

virtual

Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values.

When the range is set to TransferFunctionRange::SCALAR, the function is distributed over the entire scalar range. If it is set to TransferFunctionRange::NATIVE, the scalar values outside the native transfer function range will be truncated to native range. By default, the volume scalar range is used.

Note

The native range of the transfer function is the range returned by vtkColorTransferFunction::GetRange() or vtkPiecewiseFunction::GetRange().

There is no special API provided for 2D transfer functions considering that they are set as a pre-generated vtkImageData on this class i.e. the range is already encoded.

SetScalarOpacityRangeType()

virtual void vtkGPUVolumeRayCastMapper::SetScalarOpacityRangeType ( int  )

virtual

Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values.

When the range is set to TransferFunctionRange::SCALAR, the function is distributed over the entire scalar range. If it is set to TransferFunctionRange::NATIVE, the scalar values outside the native transfer function range will be truncated to native range. By default, the volume scalar range is used.

Note

The native range of the transfer function is the range returned by vtkColorTransferFunction::GetRange() or vtkPiecewiseFunction::GetRange().

There is no special API provided for 2D transfer functions considering that they are set as a pre-generated vtkImageData on this class i.e. the range is already encoded.

GetScalarOpacityRangeType()

virtual int vtkGPUVolumeRayCastMapper::GetScalarOpacityRangeType ( )

virtual

Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values.

When the range is set to TransferFunctionRange::SCALAR, the function is distributed over the entire scalar range. If it is set to TransferFunctionRange::NATIVE, the scalar values outside the native transfer function range will be truncated to native range. By default, the volume scalar range is used.

Note

The native range of the transfer function is the range returned by vtkColorTransferFunction::GetRange() or vtkPiecewiseFunction::GetRange().

There is no special API provided for 2D transfer functions considering that they are set as a pre-generated vtkImageData on this class i.e. the range is already encoded.

SetGradientOpacityRangeType()

virtual void vtkGPUVolumeRayCastMapper::SetGradientOpacityRangeType ( int  )

virtual

Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values.

When the range is set to TransferFunctionRange::SCALAR, the function is distributed over the entire scalar range. If it is set to TransferFunctionRange::NATIVE, the scalar values outside the native transfer function range will be truncated to native range. By default, the volume scalar range is used.

Note

The native range of the transfer function is the range returned by vtkColorTransferFunction::GetRange() or vtkPiecewiseFunction::GetRange().

There is no special API provided for 2D transfer functions considering that they are set as a pre-generated vtkImageData on this class i.e. the range is already encoded.

GetGradientOpacityRangeType()

virtual int vtkGPUVolumeRayCastMapper::GetGradientOpacityRangeType ( )

virtual

Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values.

When the range is set to TransferFunctionRange::SCALAR, the function is distributed over the entire scalar range. If it is set to TransferFunctionRange::NATIVE, the scalar values outside the native transfer function range will be truncated to native range. By default, the volume scalar range is used.

Note

The native range of the transfer function is the range returned by vtkColorTransferFunction::GetRange() or vtkPiecewiseFunction::GetRange().

There is no special API provided for 2D transfer functions considering that they are set as a pre-generated vtkImageData on this class i.e. the range is already encoded.

GetInput() [1/2]

vtkDataSet * vtkGPUVolumeRayCastMapper::GetInput ( )

inlineoverridevirtual

Set/Get the input data.

Reimplemented from vtkVolumeMapper.

Definition at line 422 of file vtkGPUVolumeRayCastMapper.h.

RemoveInputConnection() [1/2]

void vtkGPUVolumeRayCastMapper::RemoveInputConnection ( int  port, vtkAlgorithmOutput *  input  )

overridevirtual

Add/Remove input connections.

Active and removed ports are cached in Ports and RemovedPorts respectively.

Reimplemented from vtkAlgorithm.

RemoveInputConnection() [2/2]

void vtkGPUVolumeRayCastMapper::RemoveInputConnection ( int  port, int  idx  )

overridevirtual

Add/Remove input connections.

Active and removed ports are cached in Ports and RemovedPorts respectively.

Reimplemented from vtkAlgorithm.

SetInputConnection() [1/2]

void vtkGPUVolumeRayCastMapper::SetInputConnection ( int  port, vtkAlgorithmOutput *  input  )

overridevirtual

Add/Remove input connections.

Active and removed ports are cached in Ports and RemovedPorts respectively.

Reimplemented from vtkAlgorithm.

SetInputConnection() [2/2]

void vtkGPUVolumeRayCastMapper::SetInputConnection ( vtkAlgorithmOutput *  input )

inlineoverridevirtual

Add/Remove input connections.

Active and removed ports are cached in Ports and RemovedPorts respectively.

Reimplemented from vtkAlgorithm.

Definition at line 432 of file vtkGPUVolumeRayCastMapper.h.

GetInputCount()

int vtkGPUVolumeRayCastMapper::GetInputCount

(

)

Number of currently active ports.

GetTransformedInput()

vtkDataSet * vtkGPUVolumeRayCastMapper::GetTransformedInput

(

int

port = 0

)

GetBoundsFromPort()

double * vtkGPUVolumeRayCastMapper::GetBoundsFromPort

(

int

port

)

SetTransfer2DYAxisArray()

virtual void vtkGPUVolumeRayCastMapper::SetTransfer2DYAxisArray ( const char *  )

virtual

Set/Get the transfer 2D Y axis array.

GetTransfer2DYAxisArray()

virtual char * vtkGPUVolumeRayCastMapper::GetTransfer2DYAxisArray ( )

virtual

Set/Get the transfer 2D Y axis array.

FillInputPortInformation()

int vtkGPUVolumeRayCastMapper::FillInputPortInformation ( int  port, vtkInformation *  info  )

overrideprotectedvirtual

Handle inputs.

This mapper provides an interface to support multiple inputs but it is up to the OpenGL implementation use them during rendering. Currently, only VolumeOpenGL2/vtkOpenGLGPUVolumeRayCastMapper makes use of these inputs.

See also

vtkOpenGLGPUVolumeRayCastMapper vtkMultiVolume

Reimplemented from vtkAbstractVolumeMapper.

TransformInput()

void vtkGPUVolumeRayCastMapper::TransformInput ( int  port )

protected

A transformation is applied (translation) to the input.

The resulting data is stored in TransformedInputs. Takes as an argument the port of an input connection.

///TODO Elaborate on why this is an issue, texture coords (?)

Todo:

This is the workaround to deal with GPUVolumeRayCastMapper not able to handle extents starting from non zero values. There is not a easy fix in the GPU volume ray cast mapper hence this fix has been introduced.

ValidateRender()

int vtkGPUVolumeRayCastMapper::ValidateRender ( vtkRenderer *  , vtkVolume *    )

protected

This method is used by the Render() method to validate everything before attempting to render.

This method returns 0 if something is not right - such as missing input, a null renderer or a null volume, no scalars, etc. In some cases it will produce a vtkErrorMacro message, and in others (for example, in the case of cropping planes that define a region with a volume or 0 or less) it will fail silently. If everything is OK, it will return with a value of 1.

ValidateInputs()

int vtkGPUVolumeRayCastMapper::ValidateInputs ( )

protected

This method is used by the Render() method to validate everything before attempting to render.

This method returns 0 if something is not right - such as missing input, a null renderer or a null volume, no scalars, etc. In some cases it will produce a vtkErrorMacro message, and in others (for example, in the case of cropping planes that define a region with a volume or 0 or less) it will fail silently. If everything is OK, it will return with a value of 1.

ValidateInput()

int vtkGPUVolumeRayCastMapper::ValidateInput ( vtkVolumeProperty *  property, int  port  )

protected

This method is used by the Render() method to validate everything before attempting to render.

This method returns 0 if something is not right - such as missing input, a null renderer or a null volume, no scalars, etc. In some cases it will produce a vtkErrorMacro message, and in others (for example, in the case of cropping planes that define a region with a volume or 0 or less) it will fail silently. If everything is OK, it will return with a value of 1.

CloneInputs()

void vtkGPUVolumeRayCastMapper::CloneInputs ( )

protected

Shallow-copy the inputs into a transform-adjusted clone.

See also

vtkGPUVolumeRayCastMapper::TransformInput

CloneInput()

void vtkGPUVolumeRayCastMapper::CloneInput ( vtkDataSet *  input, int  port  )

protected

Shallow-copy the inputs into a transform-adjusted clone.

See also

vtkGPUVolumeRayCastMapper::TransformInput

CanonicalViewRender()

void vtkGPUVolumeRayCastMapper::CanonicalViewRender ( vtkRenderer *  , vtkVolume *    )

protected

PreRender()

virtual void vtkGPUVolumeRayCastMapper::PreRender ( vtkRenderer *  ren, vtkVolume *  vol, double  datasetBounds[6], double  scalarRange[2], int  numberOfScalarComponents, unsigned int  numberOfLevels  )

protectedpure virtual

RenderBlock()

virtual void vtkGPUVolumeRayCastMapper::RenderBlock ( vtkRenderer *  ren, vtkVolume *  vol, unsigned int  level  )

protectedpure virtual

PostRender()

virtual void vtkGPUVolumeRayCastMapper::PostRender ( vtkRenderer *  ren, int  numberOfScalarComponents  )

protectedpure virtual

GetInput() [2/2]

vtkDataSet * vtkGPUVolumeRayCastMapper::GetInput ( int  port )

overrideprotectedvirtual

Set/Get the input data.

Reimplemented from vtkVolumeMapper.

SetCellFlag()

void vtkGPUVolumeRayCastMapper::SetCellFlag ( int  cellFlag )

protected

Called by the AMR Volume Mapper.

Set the flag that tells if the scalars are on point data (0) or cell data (1).

RemovePortInternal()

void vtkGPUVolumeRayCastMapper::RemovePortInternal ( int  port )

protected

SetAMRMode()

virtual void vtkGPUVolumeRayCastMapper::SetAMRMode ( vtkTypeBool  )

protectedvirtual

Set the mapper in AMR Mode or not.

Initial value is false. Called only by the vtkKWAMRVolumeMapper

GetAMRMode()

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::GetAMRMode ( )

protectedvirtual

Set the mapper in AMR Mode or not.

Initial value is false. Called only by the vtkKWAMRVolumeMapper

AMRModeOn()

virtual void vtkGPUVolumeRayCastMapper::AMRModeOn ( )

protectedvirtual

Set the mapper in AMR Mode or not.

Initial value is false. Called only by the vtkKWAMRVolumeMapper

AMRModeOff()

virtual void vtkGPUVolumeRayCastMapper::AMRModeOff ( )

protectedvirtual

Set the mapper in AMR Mode or not.

Initial value is false. Called only by the vtkKWAMRVolumeMapper

ClipCroppingRegionPlanes()

virtual void vtkGPUVolumeRayCastMapper::ClipCroppingRegionPlanes ( )

protectedvirtual

Compute the cropping planes clipped by the bounds of the volume.

The result is put into this->ClippedCroppingRegionPlanes. NOTE: IT WILL BE MOVED UP TO vtkVolumeMapper after bullet proof usage in this mapper. Other subclasses will use the ClippedCroppingRegionsPlanes members instead of CroppingRegionPlanes.

Precondition

volume_exists: this->GetInput()!=0

valid_cropping: this->Cropping && this->CroppingRegionPlanes[0]<this->CroppingRegionPlanes[1] && this->CroppingRegionPlanes[2]<this->CroppingRegionPlanes[3] && this->CroppingRegionPlanes[4]<this->CroppingRegionPlanes[5])

SetTransformedInput()

void vtkGPUVolumeRayCastMapper::SetTransformedInput ( vtkDataSet *  )

protected

FindData()

vtkDataSet * vtkGPUVolumeRayCastMapper::FindData ( int  port, DataMap &  container  )

protected

Member Data Documentation

LockSampleDistanceToInputSpacing

vtkTypeBool vtkGPUVolumeRayCastMapper::LockSampleDistanceToInputSpacing

protected

Definition at line 528 of file vtkGPUVolumeRayCastMapper.h.

AutoAdjustSampleDistances

vtkTypeBool vtkGPUVolumeRayCastMapper::AutoAdjustSampleDistances

protected

Definition at line 529 of file vtkGPUVolumeRayCastMapper.h.

ImageSampleDistance

float vtkGPUVolumeRayCastMapper::ImageSampleDistance

protected

Definition at line 530 of file vtkGPUVolumeRayCastMapper.h.

MinimumImageSampleDistance

float vtkGPUVolumeRayCastMapper::MinimumImageSampleDistance

protected

Definition at line 531 of file vtkGPUVolumeRayCastMapper.h.

MaximumImageSampleDistance

float vtkGPUVolumeRayCastMapper::MaximumImageSampleDistance

protected

Definition at line 532 of file vtkGPUVolumeRayCastMapper.h.

RenderToImage

vtkTypeBool vtkGPUVolumeRayCastMapper::RenderToImage

protected

Definition at line 535 of file vtkGPUVolumeRayCastMapper.h.

DepthImageScalarType

int vtkGPUVolumeRayCastMapper::DepthImageScalarType

protected

Definition at line 538 of file vtkGPUVolumeRayCastMapper.h.

ClampDepthToBackface

vtkTypeBool vtkGPUVolumeRayCastMapper::ClampDepthToBackface

protected

Definition at line 542 of file vtkGPUVolumeRayCastMapper.h.

UseJittering

vtkTypeBool vtkGPUVolumeRayCastMapper::UseJittering

protected

Definition at line 545 of file vtkGPUVolumeRayCastMapper.h.

GlobalIlluminationReach

float vtkGPUVolumeRayCastMapper::GlobalIlluminationReach = 0.0

protected

Definition at line 548 of file vtkGPUVolumeRayCastMapper.h.

VolumetricScatteringBlending

float vtkGPUVolumeRayCastMapper::VolumetricScatteringBlending = 0.0

protected

Definition at line 550 of file vtkGPUVolumeRayCastMapper.h.

UseDepthPass

vtkTypeBool vtkGPUVolumeRayCastMapper::UseDepthPass

protected

Definition at line 553 of file vtkGPUVolumeRayCastMapper.h.

DepthPassContourValues

vtkContourValues* vtkGPUVolumeRayCastMapper::DepthPassContourValues

protected

Definition at line 554 of file vtkGPUVolumeRayCastMapper.h.

SampleDistance

float vtkGPUVolumeRayCastMapper::SampleDistance

protected

Definition at line 557 of file vtkGPUVolumeRayCastMapper.h.

SmallVolumeRender

int vtkGPUVolumeRayCastMapper::SmallVolumeRender

protected

Definition at line 559 of file vtkGPUVolumeRayCastMapper.h.

BigTimeToDraw

double vtkGPUVolumeRayCastMapper::BigTimeToDraw

protected

Definition at line 560 of file vtkGPUVolumeRayCastMapper.h.

SmallTimeToDraw

double vtkGPUVolumeRayCastMapper::SmallTimeToDraw

protected

Definition at line 561 of file vtkGPUVolumeRayCastMapper.h.

FinalColorWindow

float vtkGPUVolumeRayCastMapper::FinalColorWindow

protected

Definition at line 563 of file vtkGPUVolumeRayCastMapper.h.

FinalColorLevel

float vtkGPUVolumeRayCastMapper::FinalColorLevel

protected

Definition at line 564 of file vtkGPUVolumeRayCastMapper.h.

GeneratingCanonicalView

int vtkGPUVolumeRayCastMapper::GeneratingCanonicalView

protected

Definition at line 567 of file vtkGPUVolumeRayCastMapper.h.

CanonicalViewImageData

vtkImageData* vtkGPUVolumeRayCastMapper::CanonicalViewImageData

protected

Definition at line 568 of file vtkGPUVolumeRayCastMapper.h.

MaskInput

vtkImageData* vtkGPUVolumeRayCastMapper::MaskInput

protected

Definition at line 580 of file vtkGPUVolumeRayCastMapper.h.

MaskBlendFactor

float vtkGPUVolumeRayCastMapper::MaskBlendFactor

protected

Definition at line 581 of file vtkGPUVolumeRayCastMapper.h.

MaskType

int vtkGPUVolumeRayCastMapper::MaskType

protected

Definition at line 582 of file vtkGPUVolumeRayCastMapper.h.

AMRMode

vtkTypeBool vtkGPUVolumeRayCastMapper::AMRMode

protected

Definition at line 584 of file vtkGPUVolumeRayCastMapper.h.

ColorRangeType

int vtkGPUVolumeRayCastMapper::ColorRangeType

protected

Definition at line 587 of file vtkGPUVolumeRayCastMapper.h.

ScalarOpacityRangeType

int vtkGPUVolumeRayCastMapper::ScalarOpacityRangeType

protected

Definition at line 588 of file vtkGPUVolumeRayCastMapper.h.

GradientOpacityRangeType

int vtkGPUVolumeRayCastMapper::GradientOpacityRangeType

protected

Definition at line 589 of file vtkGPUVolumeRayCastMapper.h.

CellFlag

int vtkGPUVolumeRayCastMapper::CellFlag

protected

Definition at line 592 of file vtkGPUVolumeRayCastMapper.h.

ClippedCroppingRegionPlanes

double vtkGPUVolumeRayCastMapper::ClippedCroppingRegionPlanes[6]

protected

Definition at line 612 of file vtkGPUVolumeRayCastMapper.h.

MaxMemoryInBytes

vtkIdType vtkGPUVolumeRayCastMapper::MaxMemoryInBytes

protected

Definition at line 614 of file vtkGPUVolumeRayCastMapper.h.

MaxMemoryFraction

float vtkGPUVolumeRayCastMapper::MaxMemoryFraction

protected

Definition at line 615 of file vtkGPUVolumeRayCastMapper.h.

ReportProgress

bool vtkGPUVolumeRayCastMapper::ReportProgress

protected

Definition at line 617 of file vtkGPUVolumeRayCastMapper.h.

Ports

std::vector<int> vtkGPUVolumeRayCastMapper::Ports

protected

Definition at line 618 of file vtkGPUVolumeRayCastMapper.h.

RemovedPorts

std::vector<int> vtkGPUVolumeRayCastMapper::RemovedPorts

protected

Definition at line 619 of file vtkGPUVolumeRayCastMapper.h.

TransformedInputs

DataMap vtkGPUVolumeRayCastMapper::TransformedInputs

protected

Definition at line 620 of file vtkGPUVolumeRayCastMapper.h.

LastInputs

DataMap vtkGPUVolumeRayCastMapper::LastInputs

protected

This is needed only to check if the input data has been changed since the last Render() call.

Definition at line 626 of file vtkGPUVolumeRayCastMapper.h.

Transfer2DYAxisArray

char* vtkGPUVolumeRayCastMapper::Transfer2DYAxisArray

protected

Define the array used for the Y axis of transfer 2D.

This is used when the transfer function mode is set to 2D. If unset, the default is to use the gradient of the scalar.

Definition at line 633 of file vtkGPUVolumeRayCastMapper.h.

---

The documentation for this class was generated from the following file:

• Rendering/Volume/vtkGPUVolumeRayCastMapper.h