AMR class for a volume mapper. More...

#include <vtkAMRVolumeMapper.h>

Inheritance diagram for vtkAMRVolumeMapper:

Collaboration diagram for vtkAMRVolumeMapper:

Public Types
enum	{ DefaultRenderMode = 0 , RayCastAndTextureRenderMode , RayCastRenderMode , TextureRenderMode , GPURenderMode , UndefinedRenderMode , InvalidRenderMode }

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.

vtkAMRVolumeMapper *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	SetScalarMode (int mode) override
	Control how the mapper works with scalar point data and cell attribute data.

const char *	GetScalarModeAsString ()
	Return the method for obtaining scalar data.

void	SetRequestedRenderModeToDefault ()
	Set the requested render mode to vtkAMRVolumeMapper::DefaultRenderMode.

void	SetRequestedRenderModeToRayCastAndTexture ()
	Set the requested render mode to vtkAMRVolumeMapper::RayCastAndTextureRenderMode.

void	SetRequestedRenderModeToRayCast ()
	Set the requested render mode to vtkAMRVolumeMapper::RayCastRenderMode.

void	SetRequestedRenderModeToTexture ()
	Set the requested render mode to vtkAMRVolumeMapper::TextureRenderMode.

void	SetRequestedRenderModeToGPU ()
	Set the requested render mode to vtkAMRVolumeMapper::GPURenderMode.

void	SetInterpolationModeToNearestNeighbor ()

void	SetInterpolationModeToLinear ()

void	SetInterpolationModeToCubic ()

void	Render (vtkRenderer ren, vtkVolume vol) override
	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.

void	ProcessUpdateExtentRequest (vtkRenderer renderer, vtkInformation info, vtkInformationVector *inputVector, vtkInformationVector outputVector)

void	ProcessInformationRequest (vtkRenderer renderer, vtkInformation info, vtkInformationVector *inputVector, vtkInformationVector outputVector)

void	UpdateResampler (vtkRenderer ren, vtkOverlappingAMR amr)

void	UpdateResamplerFrustrumMethod (vtkRenderer ren, vtkOverlappingAMR amr)


void	SetInputData (vtkImageData *) override
	Set the input data.

void	SetInputData (vtkDataSet *) override
	Set the input data.

void	SetInputData (vtkRectilinearGrid *) override
	Set the input data.

virtual void	SetInputData (vtkOverlappingAMR *)
	Set the input data.

void	SetInputConnection (int port, vtkAlgorithmOutput *input) override
	Set the input data.

void	SetInputConnection (vtkAlgorithmOutput *input) override
	Set 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).


void	SetBlendMode (int mode) override
	Set/Get the blend mode.

int	GetBlendMode () VTK_FUTURE_CONST override
	Set/Get the blend mode.


void	SelectScalarArray (int arrayNum) override
	When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array to use during rendering.

void	SelectScalarArray (const char *arrayName) override
	When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array to use during rendering.


char *	GetArrayName () override
	Get the array name or number and component to use for rendering.

int	GetArrayId () override
	Get the array name or number and component to use for rendering.

int	GetArrayAccessMode () override
	Get the array name or number and component to use for rendering.


void	SetCropping (vtkTypeBool) override
	Turn On/Off orthogonal cropping.

vtkTypeBool	GetCropping () VTK_FUTURE_CONST override
	Turn On/Off orthogonal cropping.


void	SetCroppingRegionPlanes (double arg1, double arg2, double arg3, double arg4, double arg5, double arg6) override
	Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

void	SetCroppingRegionPlanes (const double *planes) override
	Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

void	GetCroppingRegionPlanes (double *planes) override
	Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

double *	GetCroppingRegionPlanes () override
	Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.


void	SetCroppingRegionFlags (int mode) override
	Set the flags for the cropping regions.

int	GetCroppingRegionFlags () VTK_FUTURE_CONST override
	Set the flags for the cropping regions.


void	SetRequestedRenderMode (int mode)
	Set the requested render mode.

int	GetRequestedRenderMode ()
	Set the requested render mode.


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

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


virtual void	SetNumberOfSamples (int, int, int)
	Set/Get the number of samples/cells along the i/j/k directions.

virtual void	SetNumberOfSamples (int[3])
	Set/Get the number of samples/cells along the i/j/k directions.

virtual int *	GetNumberOfSamples ()
	Set/Get the number of samples/cells along the i/j/k directions.

virtual void	GetNumberOfSamples (int &, int &, int &)
	Set/Get the number of samples/cells along the i/j/k directions.

virtual void	GetNumberOfSamples (int[3])
	Set/Get the number of samples/cells along the i/j/k directions.


virtual void	SetRequestedResamplingMode (int)
	Select the type of resampling technique approach to use.

virtual int	GetRequestedResamplingMode ()
	Select the type of resampling technique approach to use.

virtual void	SetFreezeFocalPoint (bool)
	Select the type of resampling technique approach to use.

virtual bool	GetFreezeFocalPoint ()
	Select the type of resampling technique approach to use.


virtual void	SetResamplerUpdateTolerance (double)
	Sets/Gets the tolerance used to determine if the resampler needs to be updated.

virtual double	GetResamplerUpdateTolerance ()
	Sets/Gets the tolerance used to determine if the resampler needs to be updated.


virtual void	SetUseDefaultThreading (bool)
	Sets/Gets a flag that indicates the internal volume mapper should use the default number of threads.

virtual bool	GetUseDefaultThreading ()
	Sets/Gets a flag that indicates the internal volume mapper should use the default number of threads.

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 vtkDataSet *	GetInput ()
	Set/Get the input data.

virtual vtkDataSet *	GetInput (int port)
	Set/Get the input data.

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 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	CroppingOn ()
	Turn On/Off orthogonal cropping.

virtual void	CroppingOff ()
	Turn On/Off orthogonal cropping.

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 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.

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.

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 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	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 vtkAMRVolumeMapper *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAMRVolumeMapper *	SafeDownCast (vtkObjectBase *o)

static bool	ComputeResamplerBoundsFrustumMethod (vtkCamera camera, vtkRenderer renderer, const double data_bounds[6], double out_bounds[6])
	Utility method used by UpdateResamplerFrustrumMethod() to compute the bounds.

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

	vtkAMRVolumeMapper ()

	~vtkAMRVolumeMapper () override

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.

void	UpdateGrid ()

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
vtkSmartVolumeMapper *	InternalMapper

vtkAMRResampleFilter *	Resampler

vtkUniformGrid *	Grid

int	NumberOfSamples [3]

bool	HasMetaData

int	RequestedResamplingMode

bool	FreezeFocalPoint

double	LastFocalPointPosition [3]

double	LastPostionFPDistance

double	ResamplerUpdateTolerance

bool	GridNeedsToBeUpdated

bool	UseDefaultThreading

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

AMR class for a volume mapper.

vtkAMRVolumeMapper is the definition of a volume mapper. for AMR Structured Data

Tests:: vtkAMRVolumeMapper (Tests)

Definition at line 32 of file vtkAMRVolumeMapper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkVolumeMapper vtkAMRVolumeMapper::Superclass

Definition at line 36 of file vtkAMRVolumeMapper.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
DefaultRenderMode
RayCastAndTextureRenderMode
RayCastRenderMode
TextureRenderMode
GPURenderMode
UndefinedRenderMode
InvalidRenderMode

Definition at line 151 of file vtkAMRVolumeMapper.h.

Constructor & Destructor Documentation

◆ vtkAMRVolumeMapper()

vtkAMRVolumeMapper::vtkAMRVolumeMapper ( )

protected

◆ ~vtkAMRVolumeMapper()

vtkAMRVolumeMapper::~vtkAMRVolumeMapper ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkAMRVolumeMapper * vtkAMRVolumeMapper::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkAMRVolumeMapper::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 vtkAMRVolumeMapper * vtkAMRVolumeMapper::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAMRVolumeMapper::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkVolumeMapper.

◆ NewInstance()

vtkAMRVolumeMapper * vtkAMRVolumeMapper::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetInputData() [1/4]

void vtkAMRVolumeMapper::SetInputData ( vtkImageData * )

overridevirtual

Set the input data.

Reimplemented from vtkVolumeMapper.

◆ SetInputData() [2/4]

void vtkAMRVolumeMapper::SetInputData ( vtkDataSet * )

overridevirtual

Set the input data.

Reimplemented from vtkVolumeMapper.

◆ SetInputData() [3/4]

void vtkAMRVolumeMapper::SetInputData ( vtkRectilinearGrid * )

overridevirtual

Set the input data.

Reimplemented from vtkVolumeMapper.

◆ SetInputData() [4/4]

virtual void vtkAMRVolumeMapper::SetInputData ( vtkOverlappingAMR * )

virtual

Set the input data.

◆ SetInputConnection() [1/2]

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

overridevirtual

Set the input data.

Reimplemented from vtkAlgorithm.

◆ SetInputConnection() [2/2]

void vtkAMRVolumeMapper::SetInputConnection ( vtkAlgorithmOutput * input )

inlineoverridevirtual

Set the input data.

Reimplemented from vtkAlgorithm.

Definition at line 48 of file vtkAMRVolumeMapper.h.

◆ GetBounds() [1/2]

double * vtkAMRVolumeMapper::GetBounds ( )

overridevirtual

Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).

Reimplemented from vtkAbstractVolumeMapper.

◆ GetBounds() [2/2]

void vtkAMRVolumeMapper::GetBounds ( double bounds[6] )

inlineoverridevirtual

Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).

Reimplemented from vtkAbstractVolumeMapper.

Definition at line 60 of file vtkAMRVolumeMapper.h.

◆ SetScalarMode()

void vtkAMRVolumeMapper::SetScalarMode ( int mode )

overridevirtual

Control how the mapper works with scalar point data and cell attribute data.

By default (ScalarModeToDefault), the mapper will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the mapper to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectScalarArray.

Reimplemented from vtkAbstractVolumeMapper.

◆ SetBlendMode()

void vtkAMRVolumeMapper::SetBlendMode ( int mode )

overridevirtual

Set/Get the blend mode.

Additive blend mode adds scalars along the ray and multiply them by their opacity mapping value.

Reimplemented from vtkVolumeMapper.

◆ GetBlendMode()

int vtkAMRVolumeMapper::GetBlendMode ( )

overridevirtual

Set/Get the blend mode.

Additive blend mode adds scalars along the ray and multiply them by their opacity mapping value.

Reimplemented from vtkVolumeMapper.

◆ SelectScalarArray() [1/2]

void vtkAMRVolumeMapper::SelectScalarArray ( int arrayNum )

overridevirtual

When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array to use during rendering.

The transfer function in the vtkVolumeProperty (attached to the calling vtkVolume) will decide how to convert vectors to colors.

Reimplemented from vtkAbstractVolumeMapper.

◆ SelectScalarArray() [2/2]

void vtkAMRVolumeMapper::SelectScalarArray ( const char * arrayName )

overridevirtual

When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array to use during rendering.

The transfer function in the vtkVolumeProperty (attached to the calling vtkVolume) will decide how to convert vectors to colors.

Reimplemented from vtkAbstractVolumeMapper.

◆ GetArrayName()

char * vtkAMRVolumeMapper::GetArrayName ( )

overridevirtual

Get the array name or number and component to use for rendering.

Reimplemented from vtkAbstractVolumeMapper.

◆ GetArrayId()

int vtkAMRVolumeMapper::GetArrayId ( )

overridevirtual

Get the array name or number and component to use for rendering.

Reimplemented from vtkAbstractVolumeMapper.

◆ GetArrayAccessMode()

int vtkAMRVolumeMapper::GetArrayAccessMode ( )

overridevirtual

Get the array name or number and component to use for rendering.

Reimplemented from vtkAbstractVolumeMapper.

◆ GetScalarModeAsString()

const char * vtkAMRVolumeMapper::GetScalarModeAsString ( )

Return the method for obtaining scalar data.

◆ SetCropping()

void vtkAMRVolumeMapper::SetCropping ( vtkTypeBool )

overridevirtual

Turn On/Off orthogonal cropping.

(Clipping planes are perpendicular to the coordinate axes.)

Reimplemented from vtkVolumeMapper.

◆ GetCropping()

vtkTypeBool vtkAMRVolumeMapper::GetCropping ( )

overridevirtual

Turn On/Off orthogonal cropping.

(Clipping planes are perpendicular to the coordinate axes.)

Reimplemented from vtkVolumeMapper.

◆ SetCroppingRegionPlanes() [1/2]

void vtkAMRVolumeMapper::SetCroppingRegionPlanes	(	double	arg1,
		double	arg2,
		double	arg3,
		double	arg4,
		double	arg5,
		double	arg6
	)

overridevirtual

Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

Reimplemented from vtkVolumeMapper.

◆ SetCroppingRegionPlanes() [2/2]

void vtkAMRVolumeMapper::SetCroppingRegionPlanes ( const double * planes )

inlineoverride

Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

Definition at line 127 of file vtkAMRVolumeMapper.h.

◆ GetCroppingRegionPlanes() [1/2]

void vtkAMRVolumeMapper::GetCroppingRegionPlanes ( double * planes )

override

Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

◆ GetCroppingRegionPlanes() [2/2]

double * vtkAMRVolumeMapper::GetCroppingRegionPlanes ( )

overridevirtual

Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

Reimplemented from vtkVolumeMapper.

◆ SetCroppingRegionFlags()

void vtkAMRVolumeMapper::SetCroppingRegionFlags ( int mode )

overridevirtual

Set the flags for the cropping regions.

The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross.

Reimplemented from vtkVolumeMapper.

◆ GetCroppingRegionFlags()

int vtkAMRVolumeMapper::GetCroppingRegionFlags ( )

overridevirtual

Set the flags for the cropping regions.

The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross.

Reimplemented from vtkVolumeMapper.

◆ SetRequestedRenderMode()

void vtkAMRVolumeMapper::SetRequestedRenderMode ( int mode )

Set the requested render mode.

The default is vtkSmartVolumeMapper::DefaultRenderMode.

◆ GetRequestedRenderMode()

int vtkAMRVolumeMapper::GetRequestedRenderMode ( )

Set the requested render mode.

The default is vtkSmartVolumeMapper::DefaultRenderMode.

◆ SetRequestedRenderModeToDefault()

void vtkAMRVolumeMapper::SetRequestedRenderModeToDefault ( )

inline

Set the requested render mode to vtkAMRVolumeMapper::DefaultRenderMode.

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

Definition at line 176 of file vtkAMRVolumeMapper.h.

◆ SetRequestedRenderModeToRayCastAndTexture()

void vtkAMRVolumeMapper::SetRequestedRenderModeToRayCastAndTexture ( )

inline

Set the requested render mode to vtkAMRVolumeMapper::RayCastAndTextureRenderMode.

This is a good option if you want to avoid using advanced OpenGL functionality, but would still like to used 3D texture mapping, if available, for interactive rendering.

Definition at line 188 of file vtkAMRVolumeMapper.h.

◆ SetRequestedRenderModeToRayCast()

void vtkAMRVolumeMapper::SetRequestedRenderModeToRayCast ( )

inline

Set the requested render mode to vtkAMRVolumeMapper::RayCastRenderMode.

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

Definition at line 198 of file vtkAMRVolumeMapper.h.

◆ SetRequestedRenderModeToTexture()

void vtkAMRVolumeMapper::SetRequestedRenderModeToTexture ( )

inline

Set the requested render mode to vtkAMRVolumeMapper::TextureRenderMode.

This is a good option if you want to use 3D texture mapping, if available, for interactive rendering.

Definition at line 209 of file vtkAMRVolumeMapper.h.

◆ SetRequestedRenderModeToGPU()

void vtkAMRVolumeMapper::SetRequestedRenderModeToGPU ( )

inline

Set the requested render mode to vtkAMRVolumeMapper::GPURenderMode.

This will do the volume rendering on the GPU

Definition at line 219 of file vtkAMRVolumeMapper.h.

◆ SetInterpolationMode()

void vtkAMRVolumeMapper::SetInterpolationMode ( int mode )

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

◆ GetInterpolationMode()

int vtkAMRVolumeMapper::GetInterpolationMode ( )

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

◆ SetInterpolationModeToNearestNeighbor()

void vtkAMRVolumeMapper::SetInterpolationModeToNearestNeighbor ( )

inline

Definition at line 233 of file vtkAMRVolumeMapper.h.

◆ SetInterpolationModeToLinear()

void vtkAMRVolumeMapper::SetInterpolationModeToLinear ( )

inline

Definition at line 235 of file vtkAMRVolumeMapper.h.

◆ SetInterpolationModeToCubic()

void vtkAMRVolumeMapper::SetInterpolationModeToCubic ( )

inline

Definition at line 237 of file vtkAMRVolumeMapper.h.