vtkSmartVolumeMapper Class Reference

Adaptive volume mapper. More...

#include <vtkSmartVolumeMapper.h>

Inheritance diagram for vtkSmartVolumeMapper:

Collaboration diagram for vtkSmartVolumeMapper:

Public Types
enum	{   DefaultRenderMode = 0 , RayCastRenderMode = 1 , GPURenderMode = 2 , OSPRayRenderMode = 3 ,   AnariRenderMode = 4 , UndefinedRenderMode = 5 , InvalidRenderMode = 6 }
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.
vtkSmartVolumeMapper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	SetRequestedRenderMode (int mode)
	Set the requested render mode.
void	SetRequestedRenderModeToDefault ()
	Set the requested render mode to vtkSmartVolumeMapper::DefaultRenderMode.
void	SetRequestedRenderModeToRayCast ()
	Set the requested render mode to vtkSmartVolumeMapper::RayCastRenderMode.
void	SetRequestedRenderModeToGPU ()
	Set the requested render mode to vtkSmartVolumeMapper::GPURenderMode.
void	SetRequestedRenderModeToOSPRay ()
	Set the requested render mode to vtkSmartVolumeMapper::OSPRayRenderMode.
void	SetRequestedRenderModeToAnari ()
	Set the requested render mode to vtkSmartVolumeMapper::AnariRenderMode.
int	GetLastUsedRenderMode ()
	This will return the render mode used during the previous call to Render().
void	CreateCanonicalView (vtkRenderer *ren, vtkVolume *volume, vtkVolume *volume2, vtkImageData *image, int blend_mode, double viewDirection[3], double viewUp[3])
	This method can be used to render a representative view of the input data into the supplied image given the supplied blending mode, view direction, and view up vector.
void	Render (vtkRenderer *, vtkVolume *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Initialize rendering for this 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	SetFinalColorWindow (float)
	Set the final color window.
virtual float	GetFinalColorWindow ()
	Get the final color window.
virtual void	SetFinalColorLevel (float)
	Set the final color level.
virtual float	GetFinalColorLevel ()
	Get the final color level.
virtual int	GetRequestedRenderMode ()
	Get the requested render mode.
virtual void	SetMaxMemoryInBytes (vtkIdType)
	Value passed to the GPU mapper.
virtual vtkIdType	GetMaxMemoryInBytes ()
	Value passed to the GPU mapper.
virtual void	SetMaxMemoryFraction (float)
	Value passed to the GPU mapper.
virtual float	GetMaxMemoryFraction ()
	Value passed to the GPU mapper.
virtual void	SetInterpolationMode (int)
	Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).
virtual int	GetInterpolationMode ()
	Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).
void	SetInterpolationModeToNearestNeighbor ()
	Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).
void	SetInterpolationModeToLinear ()
	Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).
void	SetInterpolationModeToCubic ()
	Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).
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	SetInteractiveUpdateRate (double)
	If the DesiredUpdateRate of the vtkRenderWindow that caused the Render falls at or above this rate, the render is considered interactive and the mapper may be adjusted (depending on the render mode).
virtual double	GetInteractiveUpdateRate ()
	Get the update rate at or above which this is considered an interactive render.
virtual void	SetInteractiveAdjustSampleDistances (vtkTypeBool)
	If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and resets the AutoAdjustSampleDistances flag on the internal volume mapper.
virtual vtkTypeBool	GetInteractiveAdjustSampleDistances ()
	If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and resets the AutoAdjustSampleDistances flag on the internal volume mapper.
virtual void	InteractiveAdjustSampleDistancesOn ()
	If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and resets the AutoAdjustSampleDistances flag on the internal volume mapper.
virtual void	InteractiveAdjustSampleDistancesOff ()
	If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and resets the AutoAdjustSampleDistances flag on the internal volume mapper.
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	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	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	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 vtkDataSet *	GetInput ()
	Set/Get the input data.
virtual vtkDataSet *	GetInput (int port)
	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.
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.
void	SetInputArrayToProcess (const char *name, int fieldAssociation)
	Set the input data arrays that this algorithm will process.
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	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
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 vtkSmartVolumeMapper *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkSmartVolumeMapper *	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 Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkSmartVolumeMapper ()
	~vtkSmartVolumeMapper () override
void	ConnectMapperInput (vtkVolumeMapper *m)
	Connect input of the vtkSmartVolumeMapper to the input of the internal volume mapper by doing a shallow to avoid memory leaks.
void	ConnectFilterInput (vtkImageResample *f)
	Connect input of the vtkSmartVolumeMapper to the input of the internal resample filter by doing a shallow to avoid memory leaks.
void	Initialize (vtkRenderer *ren, vtkVolume *vol)
	The initialize method.
void	ComputeRenderMode (vtkRenderer *ren, vtkVolume *vol)
	The method that computes the render mode from the requested render mode based on the support status for each render method.
virtual vtkGPUVolumeRayCastMapper *	GetGPUMapper ()
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
int	InterpolationMode
	Used for downsampling.
vtkImageResample *	GPUResampleFilter
	This is the resample filter that may be used if we need to create a low resolution version of the volume for GPU rendering.
int	InitializedBlendMode
	We need to keep track of the blend mode we had when we initialized because we need to reinitialize (and recheck hardware support) if it changes.
vtkTypeBool	UseJittering
	Enable / disable stochastic jittering.
float	SampleDistance
	The distance between sample points along the ray.
float	GlobalIlluminationReach = 0.0
	Secondary rays ambient/global adjustment coefficient.
float	VolumetricScatteringBlending = 0.0
	Blending coefficient between surfacic and volumetric models in GPU Mapper.
vtkTypeBool	AutoAdjustSampleDistances
	Set whether or not the sample distance should be automatically calculated within the internal volume mapper.
double	InteractiveUpdateRate
	If the DesiredUpdateRate of the vtkRenderWindow causing the Render is at or above this value, the render is considered interactive.
vtkTypeBool	InteractiveAdjustSampleDistances
	If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and resets the AutoAdjustSampleDistances flag on the internal volume mapper.
char *	Transfer2DYAxisArray
	Define the array used for the Y axis of transfer 2D.
int	LowResMode = LowResModeDisabled
float	FinalColorWindow
	Window / level ivars.
float	FinalColorLevel
	Window / level ivars.
vtkIdType	MaxMemoryInBytes
	GPU mapper-specific memory ivars.
float	MaxMemoryFraction
	GPU mapper-specific memory ivars.
int	RequestedRenderMode
	The requested render mode is used to compute the current render mode.
int	CurrentRenderMode
	The requested render mode is used to compute the current render mode.
int	Initialized
	Initialization variables.
vtkTimeStamp	SupportStatusCheckTime
	Initialization variables.
int	GPUSupported
	Initialization variables.
int	RayCastSupported
	Initialization variables.
int	LowResGPUNecessary
	Initialization variables.
vtkImageMagnitude *	ImageMagnitude
	This filter is used to compute the magnitude of 3-component data.
vtkImageData *	InputDataMagnitude
	This filter is used to compute the magnitude of 3-component data.
vtkGPUVolumeRayCastMapper *	GPULowResMapper
	The three potential mappers.
vtkGPUVolumeRayCastMapper *	GPUMapper
	The three potential mappers.
vtkFixedPointVolumeRayCastMapper *	RayCastMapper
	The three potential mappers.
int	VectorMode
	VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.
int	VectorComponent
	VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.
vtkTimeStamp	MagnitudeUploadTime
	VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.
vtkDataSet *	LastInput
	Keep a cache of the last input to the mapper so that input data changes can be propagated to the resample filter and internal mappers.
vtkDataSet *	LastFilterInput
	Keep a cache of the last input to the mapper so that input data changes can be propagated to the resample filter and internal mappers.
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

Friends
class	vtkMultiBlockVolumeMapper
	Expose GPU mapper for additional customization.
enum	VectorModeType { DISABLED = -1 , MAGNITUDE = 0 , COMPONENT = 1 }
	VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities. More...
void	SetVectorMode (int mode)
	VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.
virtual int	GetVectorMode ()
	VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.
virtual void	SetVectorComponent (int)
	VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.
virtual int	GetVectorComponent ()
	VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.
enum	LowResModeType { LowResModeDisabled = 0 , LowResModeResample = 1 }
	LowResDisable disables low res mode (default) LowResResample enable low res mode by automatically resampling the volume, this enable large volume to be displayed at higher frame rate at the cost of rendering quality Actual resample factor will be determined using MaxMemoryInBytes and MaxMemoryFraction. More...
virtual void	SetLowResMode (int)
	LowResDisable disables low res mode (default) LowResResample enable low res mode by automatically resampling the volume, this enable large volume to be displayed at higher frame rate at the cost of rendering quality Actual resample factor will be determined using MaxMemoryInBytes and MaxMemoryFraction.
virtual int	GetLowResMode ()
	LowResDisable disables low res mode (default) LowResResample enable low res mode by automatically resampling the volume, this enable large volume to be displayed at higher frame rate at the cost of rendering quality Actual resample factor will be determined using MaxMemoryInBytes and MaxMemoryFraction.

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

Adaptive volume mapper.

vtkSmartVolumeMapper is a volume mapper that will delegate to a specific volume mapper based on rendering parameters and available hardware. Use the SetRequestedRenderMode() method to control the behavior of the selection. The following options are available:

vtkSmartVolumeMapper::DefaultRenderMode:

Allow the vtkSmartVolumeMapper to select the best mapper based on rendering parameters and hardware support. If GPU ray casting is supported, the vtkGPUVolumeRayCastMapper mapper will be used for all rendering. If not, then the vtkFixedPointVolumeRayCastMapper will be used exclusively. This is the default requested render mode, and is generally the best option. When you use this option, your volume will always be rendered, but the method used to render it may vary based on parameters and platform.

vtkSmartVolumeMapper::RayCastRenderMode:

Use the vtkFixedPointVolumeRayCastMapper for both interactive and still rendering. When you use this option your volume will always be rendered with the vtkFixedPointVolumeRayCastMapper.

vtkSmartVolumeMapper::GPURenderMode:

Use the vtkGPUVolumeRayCastMapper, if supported, for both interactive and still rendering. If the GPU ray caster is not supported (due to hardware limitations or rendering parameters) then no image will be rendered. Use this option only if you have already checked for supported based on the current hardware, number of scalar components, and rendering parameters in the vtkVolumeProperty.

vtkSmartVolumeMapper::GPURenderMode:

You can adjust the contrast and brightness in the rendered image using the FinalColorWindow and FinalColorLevel ivars. By default the FinalColorWindow is set to 1.0, and the FinalColorLevel is set to 0.5, which applies no correction to the computed image. To apply the window / level operation to the computer image color, first a Scale and Bias value are computed:

 scale = 1.0 / this->FinalColorWindow
 bias  = 0.5 - this->FinalColorLevel / this->FinalColorWindow
 

To compute a new color (R', G', B', A') from an existing color (R,G,B,A) for a pixel, the following equation is used:

 R' = R*scale + bias*A
 G' = G*scale + bias*A
 B' = B*scale + bias*A
 A' = A
 

Note that bias is multiplied by the alpha component before adding because the red, green, and blue component of the color are already pre-multiplied by alpha. Also note that the window / level operation leaves the alpha component unchanged - it only adjusts the RGB values.

Online Examples:

OpenVRVolume

Tests:

vtkSmartVolumeMapper (Tests)

Definition at line 103 of file vtkSmartVolumeMapper.h.

Member Typedef Documentation

Superclass

typedef vtkVolumeMapper vtkSmartVolumeMapper::Superclass

Definition at line 107 of file vtkSmartVolumeMapper.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
DefaultRenderMode
RayCastRenderMode
GPURenderMode
OSPRayRenderMode
AnariRenderMode
UndefinedRenderMode
InvalidRenderMode

Definition at line 150 of file vtkSmartVolumeMapper.h.

VectorModeType

enum vtkSmartVolumeMapper::VectorModeType

VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.

In this mode, a single component in the vector can be selected for rendering. In addition, the mapper can compute a scalar field representing the magnitude of this vector using a vtkImageMagnitude object (MAGNITUDE mode).

Enumerator
DISABLED
MAGNITUDE
COMPONENT

Definition at line 371 of file vtkSmartVolumeMapper.h.

LowResModeType

enum vtkSmartVolumeMapper::LowResModeType

LowResDisable disables low res mode (default) LowResResample enable low res mode by automatically resampling the volume, this enable large volume to be displayed at higher frame rate at the cost of rendering quality Actual resample factor will be determined using MaxMemoryInBytes and MaxMemoryFraction.

Enumerator
LowResModeDisabled
LowResModeResample

Definition at line 401 of file vtkSmartVolumeMapper.h.

Constructor & Destructor Documentation

vtkSmartVolumeMapper()

vtkSmartVolumeMapper::vtkSmartVolumeMapper ( )

protected

~vtkSmartVolumeMapper()

vtkSmartVolumeMapper::~vtkSmartVolumeMapper ( )

overrideprotected

Member Function Documentation

New()

static vtkSmartVolumeMapper * vtkSmartVolumeMapper::New ( )

static

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkSmartVolumeMapper::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.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkSmartVolumeMapper::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkVolumeMapper.

NewInstance()

vtkSmartVolumeMapper * vtkSmartVolumeMapper::NewInstance

(

)

const

PrintSelf()

void vtkSmartVolumeMapper::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.

SetFinalColorWindow()

virtual void vtkSmartVolumeMapper::SetFinalColorWindow ( float  )

virtual

Set the final color window.

This controls the contrast of the image. The default value is 1.0. The Window can be negative (this causes a "negative" effect on the image) Although Window can be set to 0.0, any value less than 0.00001 and greater than or equal to 0.0 will be set to 0.00001, and any value greater than -0.00001 but less than or equal to 0.0 will be set to -0.00001. Initial value is 1.0.

GetFinalColorWindow()

virtual float vtkSmartVolumeMapper::GetFinalColorWindow ( )

virtual

Get the final color window.

Initial value is 1.0.

SetFinalColorLevel()

virtual void vtkSmartVolumeMapper::SetFinalColorLevel ( float  )

virtual

Set the final color level.

The level controls the brightness of the image. The final color window will be centered at the final color level, and together represent a linear remapping of color values. The default value for the level is 0.5.

GetFinalColorLevel()

virtual float vtkSmartVolumeMapper::GetFinalColorLevel ( )

virtual

Get the final color level.

SetRequestedRenderMode()

void vtkSmartVolumeMapper::SetRequestedRenderMode

(

int

mode

)

Set the requested render mode.

The default is vtkSmartVolumeMapper::DefaultRenderMode.

SetRequestedRenderModeToDefault()

void vtkSmartVolumeMapper::SetRequestedRenderModeToDefault

(

)

Set the requested render mode to vtkSmartVolumeMapper::DefaultRenderMode.

This is the best option for an application that must adapt to different data types, hardware, and rendering parameters.

SetRequestedRenderModeToRayCast()

void vtkSmartVolumeMapper::SetRequestedRenderModeToRayCast

(

)

Set the requested render mode to vtkSmartVolumeMapper::RayCastRenderMode.

This option will use software rendering exclusively. This is a good option if you know there is no hardware acceleration.

SetRequestedRenderModeToGPU()

void vtkSmartVolumeMapper::SetRequestedRenderModeToGPU

(

)

Set the requested render mode to vtkSmartVolumeMapper::GPURenderMode.

This option will use hardware accelerated rendering exclusively. This is a good option if you know there is hardware acceleration.

SetRequestedRenderModeToOSPRay()

void vtkSmartVolumeMapper::SetRequestedRenderModeToOSPRay

(

)

Set the requested render mode to vtkSmartVolumeMapper::OSPRayRenderMode.

This option will use intel OSPRay to do software rendering exclusively.

SetRequestedRenderModeToAnari()

void vtkSmartVolumeMapper::SetRequestedRenderModeToAnari

(

)

Set the requested render mode to vtkSmartVolumeMapper::AnariRenderMode.

This option will use ANARI to do rendering exclusively.

GetRequestedRenderMode()

virtual int vtkSmartVolumeMapper::GetRequestedRenderMode ( )

virtual

Get the requested render mode.

GetLastUsedRenderMode()

int vtkSmartVolumeMapper::GetLastUsedRenderMode

(

)

This will return the render mode used during the previous call to Render().

SetMaxMemoryInBytes()

virtual void vtkSmartVolumeMapper::SetMaxMemoryInBytes ( vtkIdType  )

virtual

Value passed to the GPU mapper.

Ignored by other mappers. 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. Useful if the automatic detection is defective or missing.

GetMaxMemoryInBytes()

virtual vtkIdType vtkSmartVolumeMapper::GetMaxMemoryInBytes ( )

virtual

Value passed to the GPU mapper.

Ignored by other mappers. 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. Useful if the automatic detection is defective or missing.

SetMaxMemoryFraction()

virtual void vtkSmartVolumeMapper::SetMaxMemoryFraction ( float  )

virtual

Value passed to the GPU mapper.

Ignored by other mappers. Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture. Valid values are 0.1 to 1.0.

GetMaxMemoryFraction()

virtual float vtkSmartVolumeMapper::GetMaxMemoryFraction ( )

virtual

Value passed to the GPU mapper.

Ignored by other mappers. Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture. Valid values are 0.1 to 1.0.

SetInterpolationMode()

virtual void vtkSmartVolumeMapper::SetInterpolationMode ( int  )

virtual

Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).

GetInterpolationMode()

virtual int vtkSmartVolumeMapper::GetInterpolationMode ( )

virtual

Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).

SetInterpolationModeToNearestNeighbor()

void vtkSmartVolumeMapper::SetInterpolationModeToNearestNeighbor

(

)

Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).

SetInterpolationModeToLinear()

void vtkSmartVolumeMapper::SetInterpolationModeToLinear

(

)

Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).

SetInterpolationModeToCubic()

void vtkSmartVolumeMapper::SetInterpolationModeToCubic

(

)

Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).

CreateCanonicalView()

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

This method can be used to render a representative view of the input data into the supplied image given the supplied blending mode, view direction, and view up vector.

SetUseJittering()

virtual void vtkSmartVolumeMapper::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.

This is only used by the GPU mapper.

GetUseJittering()

virtual vtkTypeBool vtkSmartVolumeMapper::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.

This is only used by the GPU mapper.

UseJitteringOn()

virtual void vtkSmartVolumeMapper::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.

This is only used by the GPU mapper.

UseJitteringOff()

virtual void vtkSmartVolumeMapper::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.

This is only used by the GPU mapper.

SetInteractiveUpdateRate()

virtual void vtkSmartVolumeMapper::SetInteractiveUpdateRate ( double  )

virtual

If the DesiredUpdateRate of the vtkRenderWindow that caused the Render falls at or above this rate, the render is considered interactive and the mapper may be adjusted (depending on the render mode).

Initial value is 1.0.

GetInteractiveUpdateRate()

virtual double vtkSmartVolumeMapper::GetInteractiveUpdateRate ( )

virtual

Get the update rate at or above which this is considered an interactive render.

Initial value is 1.0.

SetInteractiveAdjustSampleDistances()

virtual void vtkSmartVolumeMapper::SetInteractiveAdjustSampleDistances ( vtkTypeBool  )

virtual

If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and resets the AutoAdjustSampleDistances flag on the internal volume mapper.

This flag along with InteractiveUpdateRate is useful to adjust volume mapper sample distance based on whether the render is interactive or still. By default, InteractiveAdjustSampleDistances is enabled.

GetInteractiveAdjustSampleDistances()

virtual vtkTypeBool vtkSmartVolumeMapper::GetInteractiveAdjustSampleDistances ( )

virtual

If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and resets the AutoAdjustSampleDistances flag on the internal volume mapper.

This flag along with InteractiveUpdateRate is useful to adjust volume mapper sample distance based on whether the render is interactive or still. By default, InteractiveAdjustSampleDistances is enabled.

InteractiveAdjustSampleDistancesOn()

virtual void vtkSmartVolumeMapper::InteractiveAdjustSampleDistancesOn ( )

virtual

If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and resets the AutoAdjustSampleDistances flag on the internal volume mapper.

This flag along with InteractiveUpdateRate is useful to adjust volume mapper sample distance based on whether the render is interactive or still. By default, InteractiveAdjustSampleDistances is enabled.

InteractiveAdjustSampleDistancesOff()

virtual void vtkSmartVolumeMapper::InteractiveAdjustSampleDistancesOff ( )

virtual

If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and resets the AutoAdjustSampleDistances flag on the internal volume mapper.

This flag along with InteractiveUpdateRate is useful to adjust volume mapper sample distance based on whether the render is interactive or still. By default, InteractiveAdjustSampleDistances is enabled.

SetAutoAdjustSampleDistances()

virtual void vtkSmartVolumeMapper::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).

Note that, this flag is ignored when InteractiveAdjustSampleDistances is enabled. To explicitly set and use this flag, one must disable InteractiveAdjustSampleDistances.

GetAutoAdjustSampleDistances()

virtual vtkTypeBool vtkSmartVolumeMapper::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).

Note that, this flag is ignored when InteractiveAdjustSampleDistances is enabled. To explicitly set and use this flag, one must disable InteractiveAdjustSampleDistances.

AutoAdjustSampleDistancesOn()

virtual void vtkSmartVolumeMapper::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).

Note that, this flag is ignored when InteractiveAdjustSampleDistances is enabled. To explicitly set and use this flag, one must disable InteractiveAdjustSampleDistances.

AutoAdjustSampleDistancesOff()

virtual void vtkSmartVolumeMapper::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).

Note that, this flag is ignored when InteractiveAdjustSampleDistances is enabled. To explicitly set and use this flag, one must disable InteractiveAdjustSampleDistances.

SetSampleDistance()

virtual void vtkSmartVolumeMapper::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.

If SampleDistance is negative, it will be computed based on the dataset spacing. Initial value is -1.0.

GetSampleDistance()

virtual float vtkSmartVolumeMapper::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.

If SampleDistance is negative, it will be computed based on the dataset spacing. Initial value is -1.0.

SetGlobalIlluminationReach()

virtual void vtkSmartVolumeMapper::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.

This parameter is only used when the underlying mapper is a vtkGPUVolumeRayCastMapper.

GetGlobalIlluminationReach()

virtual float vtkSmartVolumeMapper::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.

This parameter is only used when the underlying mapper is a vtkGPUVolumeRayCastMapper.

SetVolumetricScatteringBlending()

virtual void vtkSmartVolumeMapper::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.

This parameter is only used when the underlying mapper is a vtkGPUVolumeRayCastMapper.

GetVolumetricScatteringBlending()

virtual float vtkSmartVolumeMapper::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.

This parameter is only used when the underlying mapper is a vtkGPUVolumeRayCastMapper.

Render()

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

overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Initialize rendering for this volume.

Implements vtkVolumeMapper.

ReleaseGraphicsResources()

void vtkSmartVolumeMapper::ReleaseGraphicsResources ( vtkWindow *  )

overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this mapper.

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

Reimplemented from vtkAbstractVolumeMapper.

SetVectorMode()

void vtkSmartVolumeMapper::SetVectorMode

(

int

mode

)

VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.

In this mode, a single component in the vector can be selected for rendering. In addition, the mapper can compute a scalar field representing the magnitude of this vector using a vtkImageMagnitude object (MAGNITUDE mode).

GetVectorMode()

virtual int vtkSmartVolumeMapper::GetVectorMode ( )

virtual

VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.

In this mode, a single component in the vector can be selected for rendering. In addition, the mapper can compute a scalar field representing the magnitude of this vector using a vtkImageMagnitude object (MAGNITUDE mode).

SetVectorComponent()

virtual void vtkSmartVolumeMapper::SetVectorComponent ( int  )

virtual

VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.

In this mode, a single component in the vector can be selected for rendering. In addition, the mapper can compute a scalar field representing the magnitude of this vector using a vtkImageMagnitude object (MAGNITUDE mode).

GetVectorComponent()

virtual int vtkSmartVolumeMapper::GetVectorComponent ( )

virtual

VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.

In this mode, a single component in the vector can be selected for rendering. In addition, the mapper can compute a scalar field representing the magnitude of this vector using a vtkImageMagnitude object (MAGNITUDE mode).

SetTransfer2DYAxisArray()

virtual void vtkSmartVolumeMapper::SetTransfer2DYAxisArray ( const char *  )

virtual

Set/Get the transfer 2D Y axis array.

GetTransfer2DYAxisArray()

virtual char * vtkSmartVolumeMapper::GetTransfer2DYAxisArray ( )

virtual

Set/Get the transfer 2D Y axis array.

SetLowResMode()

virtual void vtkSmartVolumeMapper::SetLowResMode ( int  )

virtual

LowResDisable disables low res mode (default) LowResResample enable low res mode by automatically resampling the volume, this enable large volume to be displayed at higher frame rate at the cost of rendering quality Actual resample factor will be determined using MaxMemoryInBytes and MaxMemoryFraction.

GetLowResMode()

virtual int vtkSmartVolumeMapper::GetLowResMode ( )

virtual

LowResDisable disables low res mode (default) LowResResample enable low res mode by automatically resampling the volume, this enable large volume to be displayed at higher frame rate at the cost of rendering quality Actual resample factor will be determined using MaxMemoryInBytes and MaxMemoryFraction.

ConnectMapperInput()

void vtkSmartVolumeMapper::ConnectMapperInput ( vtkVolumeMapper *  m )

protected

Connect input of the vtkSmartVolumeMapper to the input of the internal volume mapper by doing a shallow to avoid memory leaks.

Precondition

m_exists: m!=0

ConnectFilterInput()

void vtkSmartVolumeMapper::ConnectFilterInput ( vtkImageResample *  f )

protected

Connect input of the vtkSmartVolumeMapper to the input of the internal resample filter by doing a shallow to avoid memory leaks.

Precondition

m_exists: f!=0

Initialize()

void vtkSmartVolumeMapper::Initialize ( vtkRenderer *  ren, vtkVolume *  vol  )

protected

The initialize method.

Called from ComputeRenderMode whenever something relevant has changed.

ComputeRenderMode()

void vtkSmartVolumeMapper::ComputeRenderMode ( vtkRenderer *  ren, vtkVolume *  vol  )

protected

The method that computes the render mode from the requested render mode based on the support status for each render method.

GetGPUMapper()

virtual vtkGPUVolumeRayCastMapper * vtkSmartVolumeMapper::GetGPUMapper ( )

protectedvirtual

Friends And Related Symbol Documentation

vtkMultiBlockVolumeMapper

friend class vtkMultiBlockVolumeMapper

friend

Expose GPU mapper for additional customization.

Definition at line 506 of file vtkSmartVolumeMapper.h.

Member Data Documentation

FinalColorWindow

float vtkSmartVolumeMapper::FinalColorWindow

protected

Window / level ivars.

Definition at line 433 of file vtkSmartVolumeMapper.h.

FinalColorLevel

float vtkSmartVolumeMapper::FinalColorLevel

protected

Window / level ivars.

Definition at line 434 of file vtkSmartVolumeMapper.h.

MaxMemoryInBytes

vtkIdType vtkSmartVolumeMapper::MaxMemoryInBytes

protected

GPU mapper-specific memory ivars.

Definition at line 441 of file vtkSmartVolumeMapper.h.

MaxMemoryFraction

float vtkSmartVolumeMapper::MaxMemoryFraction

protected

GPU mapper-specific memory ivars.

Definition at line 442 of file vtkSmartVolumeMapper.h.

InterpolationMode

int vtkSmartVolumeMapper::InterpolationMode

protected

Used for downsampling.

Definition at line 448 of file vtkSmartVolumeMapper.h.

RequestedRenderMode

int vtkSmartVolumeMapper::RequestedRenderMode

protected

The requested render mode is used to compute the current render mode.

Note that the current render mode can be invalid if the requested mode is not supported.

Definition at line 456 of file vtkSmartVolumeMapper.h.

CurrentRenderMode

int vtkSmartVolumeMapper::CurrentRenderMode

protected

The requested render mode is used to compute the current render mode.

Note that the current render mode can be invalid if the requested mode is not supported.

Definition at line 457 of file vtkSmartVolumeMapper.h.

Initialized

int vtkSmartVolumeMapper::Initialized

protected

Initialization variables.

Definition at line 464 of file vtkSmartVolumeMapper.h.

SupportStatusCheckTime

vtkTimeStamp vtkSmartVolumeMapper::SupportStatusCheckTime

protected

Initialization variables.

Definition at line 465 of file vtkSmartVolumeMapper.h.

GPUSupported

int vtkSmartVolumeMapper::GPUSupported

protected

Initialization variables.

Definition at line 466 of file vtkSmartVolumeMapper.h.

RayCastSupported

int vtkSmartVolumeMapper::RayCastSupported

protected

Initialization variables.

Definition at line 467 of file vtkSmartVolumeMapper.h.

LowResGPUNecessary

int vtkSmartVolumeMapper::LowResGPUNecessary

protected

Initialization variables.

Definition at line 468 of file vtkSmartVolumeMapper.h.

GPUResampleFilter

vtkImageResample* vtkSmartVolumeMapper::GPUResampleFilter

protected

This is the resample filter that may be used if we need to create a low resolution version of the volume for GPU rendering.

Definition at line 475 of file vtkSmartVolumeMapper.h.

ImageMagnitude

vtkImageMagnitude* vtkSmartVolumeMapper::ImageMagnitude

protected

This filter is used to compute the magnitude of 3-component data.

MAGNITUDE is one of the supported modes when rendering separately a single independent component.

Note

This feature was added specifically for ParaView so it might eventually be moved into a derived mapper in ParaView.

Definition at line 487 of file vtkSmartVolumeMapper.h.

InputDataMagnitude

vtkImageData* vtkSmartVolumeMapper::InputDataMagnitude

protected

This filter is used to compute the magnitude of 3-component data.

MAGNITUDE is one of the supported modes when rendering separately a single independent component.

Note

This feature was added specifically for ParaView so it might eventually be moved into a derived mapper in ParaView.

Definition at line 488 of file vtkSmartVolumeMapper.h.

GPULowResMapper

vtkGPUVolumeRayCastMapper* vtkSmartVolumeMapper::GPULowResMapper

protected

The three potential mappers.

Definition at line 513 of file vtkSmartVolumeMapper.h.

GPUMapper

vtkGPUVolumeRayCastMapper* vtkSmartVolumeMapper::GPUMapper

protected

The three potential mappers.

Definition at line 514 of file vtkSmartVolumeMapper.h.

RayCastMapper

vtkFixedPointVolumeRayCastMapper* vtkSmartVolumeMapper::RayCastMapper

protected

The three potential mappers.

Definition at line 515 of file vtkSmartVolumeMapper.h.

InitializedBlendMode

int vtkSmartVolumeMapper::InitializedBlendMode

protected

We need to keep track of the blend mode we had when we initialized because we need to reinitialize (and recheck hardware support) if it changes.

Definition at line 523 of file vtkSmartVolumeMapper.h.

UseJittering

vtkTypeBool vtkSmartVolumeMapper::UseJittering

protected

Enable / disable stochastic jittering.

Definition at line 528 of file vtkSmartVolumeMapper.h.

SampleDistance

float vtkSmartVolumeMapper::SampleDistance

protected

The distance between sample points along the ray.

Definition at line 533 of file vtkSmartVolumeMapper.h.

GlobalIlluminationReach

float vtkSmartVolumeMapper::GlobalIlluminationReach = 0.0

protected

Secondary rays ambient/global adjustment coefficient.

Definition at line 538 of file vtkSmartVolumeMapper.h.

VolumetricScatteringBlending

float vtkSmartVolumeMapper::VolumetricScatteringBlending = 0.0

protected

Blending coefficient between surfacic and volumetric models in GPU Mapper.

Definition at line 543 of file vtkSmartVolumeMapper.h.

AutoAdjustSampleDistances

vtkTypeBool vtkSmartVolumeMapper::AutoAdjustSampleDistances

protected

Set whether or not the sample distance should be automatically calculated within the internal volume mapper.

Definition at line 549 of file vtkSmartVolumeMapper.h.

InteractiveUpdateRate

double vtkSmartVolumeMapper::InteractiveUpdateRate

protected

If the DesiredUpdateRate of the vtkRenderWindow causing the Render is at or above this value, the render is considered interactive.

Otherwise it is considered still.

Definition at line 556 of file vtkSmartVolumeMapper.h.

InteractiveAdjustSampleDistances

vtkTypeBool vtkSmartVolumeMapper::InteractiveAdjustSampleDistances

protected

If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and resets the AutoAdjustSampleDistances flag on the internal volume mapper.

This flag along with InteractiveUpdateRate is useful to adjust volume mapper sample distance based on whether the render is interactive or still.

Definition at line 565 of file vtkSmartVolumeMapper.h.

VectorMode

int vtkSmartVolumeMapper::VectorMode

protected

VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.

In this mode, a single component in the vector can be selected for rendering. In addition, the mapper can compute a scalar field representing the magnitude of this vector using a vtkImageMagnitude object (MAGNITUDE mode).

Definition at line 575 of file vtkSmartVolumeMapper.h.

VectorComponent

int vtkSmartVolumeMapper::VectorComponent

protected

VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.

In this mode, a single component in the vector can be selected for rendering. In addition, the mapper can compute a scalar field representing the magnitude of this vector using a vtkImageMagnitude object (MAGNITUDE mode).

Definition at line 576 of file vtkSmartVolumeMapper.h.

MagnitudeUploadTime

vtkTimeStamp vtkSmartVolumeMapper::MagnitudeUploadTime

protected

VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.

In this mode, a single component in the vector can be selected for rendering. In addition, the mapper can compute a scalar field representing the magnitude of this vector using a vtkImageMagnitude object (MAGNITUDE mode).

Definition at line 577 of file vtkSmartVolumeMapper.h.

LastInput

vtkDataSet* vtkSmartVolumeMapper::LastInput

protected

Keep a cache of the last input to the mapper so that input data changes can be propagated to the resample filter and internal mappers.

Definition at line 585 of file vtkSmartVolumeMapper.h.

LastFilterInput

vtkDataSet* vtkSmartVolumeMapper::LastFilterInput

protected

Keep a cache of the last input to the mapper so that input data changes can be propagated to the resample filter and internal mappers.

Definition at line 586 of file vtkSmartVolumeMapper.h.

Transfer2DYAxisArray

char* vtkSmartVolumeMapper::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 594 of file vtkSmartVolumeMapper.h.

LowResMode

int vtkSmartVolumeMapper::LowResMode = LowResModeDisabled

protected

Definition at line 596 of file vtkSmartVolumeMapper.h.

---

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

• Rendering/VolumeOpenGL2/vtkSmartVolumeMapper.h