volume render with 3D texture mapping More...

#include <vtkVolumeTextureMapper3D.h>

Inheritance diagram for vtkVolumeTextureMapper3D:

Collaboration diagram for vtkVolumeTextureMapper3D:

Public Types
enum	{ FRAGMENT_PROGRAM_METHOD =0, NVIDIA_METHOD =1, ATI_METHOD =2, NO_METHOD =3 }
	What rendering method is supported? More...

typedef vtkVolumeMapper	Superclass

Public Types inherited from vtkVolumeMapper
enum	BlendModes { COMPOSITE_BLEND, MAXIMUM_INTENSITY_BLEND, MINIMUM_INTENSITY_BLEND, AVERAGE_INTENSITY_BLEND, ADDITIVE_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 int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkVolumeTextureMapper3D *	NewInstance () const

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

virtual int	IsRenderSupported (vtkVolumeProperty , vtkRenderer vtkNotUsed(r))
	Based on hardware and properties, we may or may not be able to render using 3D texture mapping. More...

virtual void	Render (vtkRenderer , vtkVolume )
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Render the volume. More...

int	GetNumberOfScalarComponents (vtkImageData *input)
	Returns the number of components of the point scalar field. More...


virtual void	SetSampleDistance (float)
	The distance at which to space sampling planes. More...

virtual float	GetSampleDistance ()
	The distance at which to space sampling planes. More...


virtual int *	GetVolumeDimensions ()
	These are the dimensions of the 3D texture. More...

virtual void	GetVolumeDimensions (int data[3])
	These are the dimensions of the 3D texture. More...


virtual float *	GetVolumeSpacing ()
	This is the spacing of the 3D texture. More...

virtual void	GetVolumeSpacing (float data[3])
	This is the spacing of the 3D texture. More...


virtual int	GetNumberOfPolygons ()
	Allow access to the number of polygons used for the rendering. More...


virtual float	GetActualSampleDistance ()
	Allow access to the actual sample distance used to render the image. More...


virtual void	SetPreferredRenderMethod (int)
	Set the preferred render method. More...

void	SetPreferredMethodToFragmentProgram ()
	Set the preferred render method. More...

void	SetPreferredMethodToNVidia ()
	Set the preferred render method. More...

virtual int	GetPreferredRenderMethod ()
	Set the preferred render method. More...


virtual void	SetUseCompressedTexture (bool)
	Set/Get if the mapper use compressed textures (if supported by the hardware). More...

virtual bool	GetUseCompressedTexture ()
	Set/Get if the mapper use compressed textures (if supported by the hardware). More...

Public Member Functions inherited from vtkVolumeMapper
vtkVolumeMapper *	NewInstance () const

virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this mapper. More...

virtual void	SetInputData (vtkImageData *)
	Set/Get the input data. More...

virtual void	SetInputData (vtkDataSet *)
	Set/Get the input data. More...

vtkImageData *	GetInput ()
	Set/Get the input data. More...

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

void	SetBlendModeToComposite ()
	Set/Get the blend mode. More...

void	SetBlendModeToMaximumIntensity ()
	Set/Get the blend mode. More...

void	SetBlendModeToMinimumIntensity ()
	Set/Get the blend mode. More...

void	SetBlendModeToAverageIntensity ()
	Set/Get the blend mode. More...

void	SetBlendModeToAdditive ()
	Set/Get the blend mode. More...

virtual int	GetBlendMode ()
	Set/Get the blend mode. More...

virtual void	SetAverageIPScalarRange (double, double)
	Set/Get the scalar range to be considered for average intensity projection blend mode. More...

void	SetAverageIPScalarRange (double[2])
	Set/Get the scalar range to be considered for average intensity projection blend mode. More...

virtual double *	GetAverageIPScalarRange ()
	Set/Get the scalar range to be considered for average intensity projection blend mode. More...

virtual void	GetAverageIPScalarRange (double data[2])
	Set/Get the scalar range to be considered for average intensity projection blend mode. More...

virtual void	SetCropping (int)
	Turn On/Off orthogonal cropping. More...

virtual int	GetCropping ()
	Turn On/Off orthogonal cropping. More...

virtual void	CroppingOn ()
	Turn On/Off orthogonal cropping. More...

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

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

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

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

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

virtual double *	GetVoxelCroppingRegionPlanes ()
	Get the cropping region planes in voxels. More...

virtual void	GetVoxelCroppingRegionPlanes (double data[6])
	Get the cropping region planes in voxels. More...

virtual void	SetCroppingRegionFlags (int)
	Set the flags for the cropping regions. More...

virtual int	GetCroppingRegionFlags ()
	Set the flags for the cropping regions. More...

void	SetCroppingRegionFlagsToSubVolume ()
	Set the flags for the cropping regions. More...

void	SetCroppingRegionFlagsToFence ()
	Set the flags for the cropping regions. More...

void	SetCroppingRegionFlagsToInvertedFence ()
	Set the flags for the cropping regions. More...

void	SetCroppingRegionFlagsToCross ()
	Set the flags for the cropping regions. More...

void	SetCroppingRegionFlagsToInvertedCross ()
	Set the flags for the cropping regions. More...

Public Member Functions inherited from vtkAbstractVolumeMapper
vtkAbstractVolumeMapper *	NewInstance () const

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

virtual int	GetArrayId ()

virtual int	GetArrayAccessMode ()

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

vtkDataSet *	GetDataSetInput ()
	Set/Get the input data. More...

vtkDataObject *	GetDataObjectInput ()
	Set/Get the input data. More...

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

virtual void	GetBounds (double bounds[6])
	Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). More...

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

virtual int	GetScalarMode ()
	Control how the mapper works with scalar point data and cell attribute data. More...

void	SetScalarModeToDefault ()
	Control how the mapper works with scalar point data and cell attribute data. More...

void	SetScalarModeToUsePointData ()
	Control how the mapper works with scalar point data and cell attribute data. More...

void	SetScalarModeToUseCellData ()
	Control how the mapper works with scalar point data and cell attribute data. More...

void	SetScalarModeToUsePointFieldData ()
	Control how the mapper works with scalar point data and cell attribute data. More...

void	SetScalarModeToUseCellFieldData ()
	Control how the mapper works with scalar point data and cell attribute data. More...

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

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

virtual float	GetGradientMagnitudeScale ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE. More...

virtual float	GetGradientMagnitudeBias ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE. More...

virtual float	GetGradientMagnitudeScale (int)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE. More...

virtual float	GetGradientMagnitudeBias (int)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE. More...

Public Member Functions inherited from vtkAbstractMapper3D
vtkAbstractMapper3D *	NewInstance () const

double	GetLength ()
	Return the diagonal length of this mappers bounding box. More...

virtual int	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. More...

virtual int	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. More...

void	GetClippingPlaneInDataCoords (vtkMatrix4x4 *propMatrix, int i, double planeEquation[4])
	Get the ith clipping plane as a homogeneous plane equation. More...

int	GetNumberOfClippingPlanes ()
	Get the number of clipping planes. More...

double *	GetCenter ()
	Return the Center of this mapper's data. More...

void	GetCenter (double center[3])
	Return the Center of this mapper's data. More...

Public Member Functions inherited from vtkAbstractMapper
vtkAbstractMapper *	NewInstance () const

virtual vtkMTimeType	GetMTime ()
	Override Modifiedtime as we have added Clipping planes. More...

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

void	ShallowCopy (vtkAbstractMapper *m)
	Make a shallow copy of this mapper. More...

virtual double	GetTimeToDraw ()
	Get the time required to draw the geometry last time it was rendered. More...

void	AddClippingPlane (vtkPlane *plane)
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...

void	RemoveClippingPlane (vtkPlane *plane)
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...

void	RemoveAllClippingPlanes ()
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...

virtual void	SetClippingPlanes (vtkPlaneCollection *)
	Get/Set the vtkPlaneCollection which specifies the clipping planes. More...

virtual vtkPlaneCollection *	GetClippingPlanes ()
	Get/Set the vtkPlaneCollection which specifies the clipping planes. More...

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...

virtual int	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped. More...

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

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

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm. More...

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm. More...

void	UpdateProgress (double amount)
	Update the progress of the process object. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess(). More...

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...

void	RemoveAllInputs ()
	Remove all the input data. More...

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection. More...

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index. More...

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx. More...

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections. More...

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index. More...

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port. More...

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port. More...

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm. More...

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...

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

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...

virtual int	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). More...

virtual int	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date. More...

virtual void	UpdateDataObject ()
	Create output object(s). More...

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream. More...

virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date. More...

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...

int	SetUpdateExtentToWholeExtent (int port)
	If the whole output extent is required, this method can be called to set the output update extent to the whole extent. More...

int	SetUpdateExtentToWholeExtent ()
	Convenience function equivalent to SetUpdateExtentToWholeExtent(0) This method assumes that the whole extent is known (that UpdateInformation has been called). More...

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
	Set the output update extent in terms of piece and ghost levels. More...

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
	Convenience function equivalent to SetUpdateExtent(0, piece, numPieces, ghostLevel) More...

void	SetUpdateExtent (int port, int extent[6])
	Set the output update extent for data objects that use 3D extents. More...

void	SetUpdateExtent (int extent[6])
	Convenience function equivalent to SetUpdateExtent(0, extent) More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm. More...

void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection. More...

virtual void	SetAbortExecute (int)
	Set/Get the AbortExecute flag for the process object. More...

virtual int	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	SetProgress (double)
	Set/Get the execution progress of a process object. More...

virtual double	GetProgress ()
	Set/Get the execution progress of a process object. More...

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state. More...

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...

virtual void	Update ()
	Bring this algorithm's outputs up-to-date. More...

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports. More...

virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports. More...

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

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

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents. More...

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

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

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents. More...

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

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

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

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

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

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

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkVolumeTextureMapper3D *	SafeDownCast (vtkObjectBase *o)

static vtkVolumeTextureMapper3D *	New ()

Static Public Member Functions inherited from vtkVolumeMapper
static int	IsTypeOf (const char *type)

static vtkVolumeMapper *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractVolumeMapper
static int	IsTypeOf (const char *type)

static vtkAbstractVolumeMapper *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractMapper3D
static int	IsTypeOf (const char *type)

static vtkAbstractMapper3D *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractMapper
static int	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. More...

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

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements. More...

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

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...

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

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkVolumeTextureMapper3D ()

	~vtkVolumeTextureMapper3D ()

void	ComputePolygons (vtkRenderer ren, vtkVolume vol, double bounds[6])
	For the given viewing direction, compute the set of polygons. More...

virtual int	IsTextureSizeSupported (int vtkNotUsed(size)[3], int vtkNotUsed(components))
	Impemented in subclass - check is texture size is OK. More...


int	UpdateVolumes (vtkVolume *)
	Update the internal RGBA representation of the volume. More...

int	UpdateColorLookup (vtkVolume *)
	Update the internal RGBA representation of the volume. More...

Protected Member Functions inherited from vtkVolumeMapper
	vtkVolumeMapper ()

	~vtkVolumeMapper ()

double	SpacingAdjustedSampleDistance (double inputSpacing[3], int inputExtent[6])
	Compute a sample distance from the data spacing. More...

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

void	ConvertCroppingRegionPlanesToVoxels ()
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates. More...

Protected Member Functions inherited from vtkAbstractVolumeMapper
	vtkAbstractVolumeMapper ()

	~vtkAbstractVolumeMapper ()

Protected Member Functions inherited from vtkAbstractMapper3D
	vtkAbstractMapper3D ()

	~vtkAbstractMapper3D ()

Protected Member Functions inherited from vtkAbstractMapper
	vtkAbstractMapper ()

	~vtkAbstractMapper ()

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm () override

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm. More...

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm. More...

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm. More...

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive. More...

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port. More...

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port. More...

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input. More...

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

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

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

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

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

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

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

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. More...

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
float *	PolygonBuffer

float *	IntersectionBuffer

int	NumberOfPolygons

int	BufferSize

unsigned char *	Volume1

unsigned char *	Volume2

unsigned char *	Volume3

int	VolumeSize

int	VolumeComponents

int	VolumeDimensions [3]

float	VolumeSpacing [3]

float	SampleDistance

float	ActualSampleDistance

vtkImageData *	SavedTextureInput

vtkImageData *	SavedParametersInput

vtkColorTransferFunction *	SavedRGBFunction

vtkPiecewiseFunction *	SavedGrayFunction

vtkPiecewiseFunction *	SavedScalarOpacityFunction

vtkPiecewiseFunction *	SavedGradientOpacityFunction

int	SavedColorChannels

float	SavedSampleDistance

float	SavedScalarOpacityDistance

unsigned char	ColorLookup [65536 *4]

unsigned char	AlphaLookup [65536]

float	TempArray1 [3 *4096]

float	TempArray2 [4096]

int	ColorTableSize

float	ColorTableScale

float	ColorTableOffset

unsigned char	DiffuseLookup [65536 *4]

unsigned char	SpecularLookup [65536 *4]

vtkTimeStamp	SavedTextureMTime

vtkTimeStamp	SavedParametersMTime

int	RenderMethod

int	PreferredRenderMethod

bool	UseCompressedTexture

bool	SupportsNonPowerOfTwoTextures

Protected Attributes inherited from vtkVolumeMapper
int	BlendMode

double	AverageIPScalarRange [2]
	Threshold range for average intensity projection. More...

int	Cropping
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates. More...

double	CroppingRegionPlanes [6]
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates. More...

double	VoxelCroppingRegionPlanes [6]
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates. More...

int	CroppingRegionFlags
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates. More...

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

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

volume render with 3D texture mapping

vtkVolumeTextureMapper3D renders a volume using 3D texture mapping. This class is actually an abstract superclass - with all the actual work done by vtkOpenGLVolumeTextureMapper3D.

This mappers currently supports:

any data type as input
one component, or two or four non-independent components
composite blending
intermixed opaque geometry
multiple volumes can be rendered if they can be sorted into back-to-front order (use the vtkFrustumCoverageCuller)

This mapper does not support:

more than one independent component
maximum intensity projection

Internally, this mapper will potentially change the resolution of the input data. The data will be resampled to be a power of two in each direction, and also no greater than 128*256*256 voxels (any aspect) for one or two component data, or 128*128*256 voxels (any aspect) for four component data. The limits are currently hardcoded after a check using the GL_PROXY_TEXTURE3D because some graphics drivers were always responding "yes" to the proxy call despite not being able to allocate that much texture memory.

Currently, calculations are computed using 8 bits per RGBA channel. In the future this should be expanded to handle newer boards that can support 15 bit float compositing.

This mapper supports two main families of graphics hardware: nvidia and ATI. There are two different implementations of 3D texture mapping used - one based on nvidia's GL_NV_texture_shader2 and GL_NV_register_combiners2 extension, and one based on ATI's GL_ATI_fragment_shader (supported also by some nvidia boards) To use this class in an application that will run on various hardware configurations, you should have a back-up volume rendering method. You should create a vtkVolumeTextureMapper3D, assign its input, make sure you have a current OpenGL context (you've rendered at least once), then call IsRenderSupported with a vtkVolumeProperty as an argument. This method will return 0 if the input has more than one independent component, or if the graphics hardware does not support the set of required extensions for using at least one of the two implemented methods (nvidia or ati)

Thanks:: Thanks to Alexandre Gouaillard at the Megason Lab, Department of Systems Biology, Harvard Medical School https://wiki.med.harvard.edu/SysBio/Megason/ for the idea and initial patch to speed-up rendering with compressed textures.

See also: vtkVolumeMapper

Deprecated:

Examples:: vtkVolumeTextureMapper3D (Examples)

Tests:: vtkVolumeTextureMapper3D (Tests)

Definition at line 94 of file vtkVolumeTextureMapper3D.h.

Member Typedef Documentation

typedef vtkVolumeMapper vtkVolumeTextureMapper3D::Superclass

Definition at line 97 of file vtkVolumeTextureMapper3D.h.

Member Enumeration Documentation

anonymous enum

What rendering method is supported?

Enumerator
FRAGMENT_PROGRAM_METHOD
NVIDIA_METHOD
ATI_METHOD
NO_METHOD

Definition at line 163 of file vtkVolumeTextureMapper3D.h.

Constructor & Destructor Documentation

vtkVolumeTextureMapper3D::vtkVolumeTextureMapper3D ( )

protected

vtkVolumeTextureMapper3D::~vtkVolumeTextureMapper3D ( )

protected

Member Function Documentation

static int vtkVolumeTextureMapper3D::IsTypeOf ( const char * type )

static

virtual int vtkVolumeTextureMapper3D::IsA ( const char * name )

virtual

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

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

Reimplemented from vtkVolumeMapper.

Reimplemented in vtkOpenGLVolumeTextureMapper3D.

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

static

virtual vtkObjectBase* vtkVolumeTextureMapper3D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkVolumeMapper.

Reimplemented in vtkOpenGLVolumeTextureMapper3D.

vtkVolumeTextureMapper3D* vtkVolumeTextureMapper3D::NewInstance ( ) const

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

virtual

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

Reimplemented in vtkOpenGLVolumeTextureMapper3D.

static vtkVolumeTextureMapper3D* vtkVolumeTextureMapper3D::New ( )

static

virtual void vtkVolumeTextureMapper3D::SetSampleDistance ( float )

virtual

The distance at which to space sampling planes.

This may not be honored for interactive renders. An interactive render is defined as one that has less than 1 second of allocated render time.

virtual float vtkVolumeTextureMapper3D::GetSampleDistance ( )

virtual

The distance at which to space sampling planes.

This may not be honored for interactive renders. An interactive render is defined as one that has less than 1 second of allocated render time.

virtual int* vtkVolumeTextureMapper3D::GetVolumeDimensions ( )

virtual

These are the dimensions of the 3D texture.

virtual void vtkVolumeTextureMapper3D::GetVolumeDimensions ( int data[3] )

virtual

These are the dimensions of the 3D texture.

virtual float* vtkVolumeTextureMapper3D::GetVolumeSpacing ( )

virtual

This is the spacing of the 3D texture.

virtual void vtkVolumeTextureMapper3D::GetVolumeSpacing ( float data[3] )

virtual

This is the spacing of the 3D texture.

virtual int vtkVolumeTextureMapper3D::IsRenderSupported	(	vtkVolumeProperty *	,
		vtkRenderer *	vtkNotUsedr
	)

inlinevirtual

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

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

Definition at line 133 of file vtkVolumeTextureMapper3D.h.

virtual int vtkVolumeTextureMapper3D::GetNumberOfPolygons ( )

virtual

Allow access to the number of polygons used for the rendering.

virtual float vtkVolumeTextureMapper3D::GetActualSampleDistance ( )

virtual

Allow access to the actual sample distance used to render the image.

virtual void vtkVolumeTextureMapper3D::Render	(	vtkRenderer *	,
		vtkVolume *
	)

inlinevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Render the volume.

Implements vtkVolumeMapper.

Reimplemented in vtkOpenGLVolumeTextureMapper3D.

Definition at line 158 of file vtkVolumeTextureMapper3D.h.

int vtkVolumeTextureMapper3D::GetNumberOfScalarComponents ( vtkImageData * input )

Returns the number of components of the point scalar field.

virtual void vtkVolumeTextureMapper3D::SetPreferredRenderMethod ( int )

virtual

Set the preferred render method.

If it is supported, this one will be used. Don't allow ATI_METHOD - it is not actually supported.

void vtkVolumeTextureMapper3D::SetPreferredMethodToFragmentProgram ( )

inline

Set the preferred render method.

If it is supported, this one will be used. Don't allow ATI_METHOD - it is not actually supported.

Definition at line 185 of file vtkVolumeTextureMapper3D.h.

void vtkVolumeTextureMapper3D::SetPreferredMethodToNVidia ( )

inline

Set the preferred render method.

If it is supported, this one will be used. Don't allow ATI_METHOD - it is not actually supported.

Definition at line 187 of file vtkVolumeTextureMapper3D.h.

virtual int vtkVolumeTextureMapper3D::GetPreferredRenderMethod ( )

virtual

Set the preferred render method.

If it is supported, this one will be used. Don't allow ATI_METHOD - it is not actually supported.

virtual void vtkVolumeTextureMapper3D::SetUseCompressedTexture ( bool )

virtual

Set/Get if the mapper use compressed textures (if supported by the hardware).

Initial value is false. There are two reasons to use compressed textures: 1. rendering can be 4 times faster. 2. It saves some VRAM. There is one reason to not use compressed textures: quality may be lower than with uncompressed textures.

virtual bool vtkVolumeTextureMapper3D::GetUseCompressedTexture ( )

virtual

Set/Get if the mapper use compressed textures (if supported by the hardware).

Initial value is false. There are two reasons to use compressed textures: 1. rendering can be 4 times faster. 2. It saves some VRAM. There is one reason to not use compressed textures: quality may be lower than with uncompressed textures.