VTK
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkOpenGLGPUVolumeRayCastMapper Class Reference

OpenGL implementation of volume rendering through ray-casting. More...

#include <vtkOpenGLGPUVolumeRayCastMapper.h>

Inheritance diagram for vtkOpenGLGPUVolumeRayCastMapper:
[legend]
Collaboration diagram for vtkOpenGLGPUVolumeRayCastMapper:
[legend]

Public Types

enum  Passes { RenderPass, DepthPass = 1 }
 
typedef vtkGPUVolumeRayCastMapper Superclass
 
using VolumeInput = vtkVolumeInputHelper
 
using VolumeInputMap = std::map< int, vtkVolumeInputHelper >
 
- Public Types inherited from vtkGPUVolumeRayCastMapper
enum  { BinaryMaskType = 0, LabelMapMaskType }
 
enum  TFRangeType { SCALAR = 0, NATIVE }
 
typedef vtkVolumeMapper Superclass
 
- Public Types inherited from vtkVolumeMapper
enum  BlendModes {
  COMPOSITE_BLEND, MAXIMUM_INTENSITY_BLEND, MINIMUM_INTENSITY_BLEND, AVERAGE_INTENSITY_BLEND,
  ADDITIVE_BLEND, ISOSURFACE_BLEND
}
 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. More...
 
vtkOpenGLGPUVolumeRayCastMapperNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkTextureObjectGetDepthTexture ()
 
vtkTextureObjectGetColorTexture ()
 
void GetDepthImage (vtkImageData *im) override
 Low level API to export the depth texture as vtkImageData in RenderToImage mode. More...
 
void GetColorImage (vtkImageData *im) override
 Low level API to export the color texture as vtkImageData in RenderToImage mode. More...
 
virtual int GetCurrentPass ()
 
void SetSharedDepthTexture (vtkTextureObject *nt)
 
void SetPartitions (unsigned short x, unsigned short y, unsigned short z)
 Set a fixed number of partitions in which to split the volume during rendring. More...
 
bool PreLoadData (vtkRenderer *ren, vtkVolume *vol)
 Load the volume texture into GPU memory. More...
 
void ReleaseGraphicsResources (vtkWindow *window) override
 Release any graphics resources that are being consumed by this mapper. More...
 
- Public Member Functions inherited from vtkGPUVolumeRayCastMapper
vtkGPUVolumeRayCastMapperNewInstance () const
 
virtual void SetAutoAdjustSampleDistances (vtkTypeBool)
 If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use). More...
 
virtual vtkTypeBool GetAutoAdjustSampleDistances ()
 
virtual void AutoAdjustSampleDistancesOn ()
 
virtual void AutoAdjustSampleDistancesOff ()
 
virtual void SetLockSampleDistanceToInputSpacing (vtkTypeBool)
 Compute the sample distance from the data spacing. More...
 
virtual vtkTypeBool GetLockSampleDistanceToInputSpacing ()
 
virtual void LockSampleDistanceToInputSpacingOn ()
 
virtual void LockSampleDistanceToInputSpacingOff ()
 
virtual void SetUseJittering (vtkTypeBool)
 If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect. More...
 
virtual vtkTypeBool GetUseJittering ()
 
virtual void UseJitteringOn ()
 
virtual void UseJitteringOff ()
 
virtual void SetUseDepthPass (vtkTypeBool)
 If UseDepthPass is on, the mapper will use two passes. More...
 
virtual vtkTypeBool GetUseDepthPass ()
 
virtual void UseDepthPassOn ()
 
virtual void UseDepthPassOff ()
 
vtkContourValuesGetDepthPassContourValues ()
 Return handle to contour values container so that values can be set by the application. More...
 
virtual void SetSampleDistance (float)
 Set/Get the distance between samples used for rendering when AutoAdjustSampleDistances is off, or when this mapper has more than 1 second allocated to it for rendering. More...
 
virtual float GetSampleDistance ()
 
virtual void SetImageSampleDistance (float)
 Sampling distance in the XY image dimensions. More...
 
virtual float GetImageSampleDistance ()
 
virtual void SetMinimumImageSampleDistance (float)
 This is the minimum image sample distance allow when the image sample distance is being automatically adjusted. More...
 
virtual float GetMinimumImageSampleDistance ()
 
virtual void SetMaximumImageSampleDistance (float)
 This is the maximum image sample distance allow when the image sample distance is being automatically adjusted. More...
 
virtual float GetMaximumImageSampleDistance ()
 
virtual void SetFinalColorWindow (float)
 Set/Get the window / level applied to the final color. More...
 
virtual float GetFinalColorWindow ()
 
virtual void SetFinalColorLevel (float)
 
virtual float GetFinalColorLevel ()
 
virtual void SetMaxMemoryInBytes (vtkIdType)
 Maximum size of the 3D texture in GPU memory. More...
 
virtual vtkIdType GetMaxMemoryInBytes ()
 
virtual void SetMaxMemoryFraction (float)
 Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture. More...
 
virtual float GetMaxMemoryFraction ()
 
virtual void SetReportProgress (bool)
 Tells if the mapper will report intermediate progress. More...
 
virtual bool GetReportProgress ()
 
void CreateCanonicalView (vtkRenderer *ren, vtkVolume *volume, vtkImageData *image, int blend_mode, double viewDirection[3], double viewUp[3])
 
void SetMaskInput (vtkImageData *mask)
 Optionally, set a mask input. More...
 
virtual vtkImageDataGetMaskInput ()
 
virtual void SetMaskType (int)
 Set the mask type, if mask is to be used. More...
 
virtual int GetMaskType ()
 
void SetMaskTypeToBinary ()
 
void SetMaskTypeToLabelMap ()
 
virtual void SetMaskBlendFactor (float)
 Tells how much mask color transfer function is used compared to the standard color transfer function when the mask is true. More...
 
virtual float GetMaskBlendFactor ()
 
virtual void SetRenderToImage (vtkTypeBool)
 Enable or disable setting output of volume rendering to be color and depth textures. More...
 
virtual vtkTypeBool GetRenderToImage ()
 
virtual void RenderToImageOn ()
 
virtual void RenderToImageOff ()
 
virtual void SetDepthImageScalarType (int)
 Set/Get the scalar type of the depth texture in RenderToImage mode. More...
 
virtual int GetDepthImageScalarType ()
 
void SetDepthImageScalarTypeToUnsignedChar ()
 
void SetDepthImageScalarTypeToUnsignedShort ()
 
void SetDepthImageScalarTypeToFloat ()
 
virtual void SetClampDepthToBackface (vtkTypeBool)
 Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume. More...
 
virtual vtkTypeBool GetClampDepthToBackface ()
 
virtual void ClampDepthToBackfaceOn ()
 
virtual void ClampDepthToBackfaceOff ()
 
void Render (vtkRenderer *, vtkVolume *) override
 Initialize rendering for this volume. More...
 
virtual void GetReductionRatio (double ratio[3])=0
 Return how much the dataset has to be reduced in each dimension to fit on the GPU. More...
 
virtual void SetColorRangeType (int)
 Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values. More...
 
virtual int GetColorRangeType ()
 
virtual void SetScalarOpacityRangeType (int)
 
virtual int GetScalarOpacityRangeType ()
 
virtual void SetGradientOpacityRangeType (int)
 
virtual int GetGradientOpacityRangeType ()
 
vtkImageDataGetInput () override
 
void RemoveInputConnection (int port, vtkAlgorithmOutput *input) override
 Add/Remove input connections. More...
 
void RemoveInputConnection (int port, int idx) override
 Remove a connection given by index idx. More...
 
void SetInputConnection (int port, vtkAlgorithmOutput *input) override
 Set the connection for the given input port index. More...
 
void SetInputConnection (vtkAlgorithmOutput *input) override
 
int GetInputCount ()
 Number of currently active ports. More...
 
vtkImageDataGetTransformedInput (const int port=0)
 
doubleGetBoundsFromPort (const int port)
 
- Public Member Functions inherited from vtkVolumeMapper
vtkVolumeMapperNewInstance () const
 
virtual void SetInputData (vtkImageData *)
 Set/Get the input data. More...
 
virtual void SetInputData (vtkDataSet *)
 
virtual void SetBlendMode (int)
 Set/Get the blend mode. More...
 
void SetBlendModeToComposite ()
 
void SetBlendModeToMaximumIntensity ()
 
void SetBlendModeToMinimumIntensity ()
 
void SetBlendModeToAverageIntensity ()
 
void SetBlendModeToAdditive ()
 
void SetBlendModeToIsoSurface ()
 
virtual int GetBlendMode ()
 
virtual void SetAverageIPScalarRange (double, double)
 Set/Get the scalar range to be considered for average intensity projection blend mode. More...
 
void SetAverageIPScalarRange (double[2])
 
virtual doubleGetAverageIPScalarRange ()
 
virtual void GetAverageIPScalarRange (double data[2])
 
virtual void SetCropping (vtkTypeBool)
 Turn On/Off orthogonal cropping. More...
 
virtual vtkTypeBool GetCropping ()
 
virtual void CroppingOn ()
 
virtual void CroppingOff ()
 
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])
 
virtual doubleGetCroppingRegionPlanes ()
 
virtual void GetCroppingRegionPlanes (double data[6])
 
virtual doubleGetVoxelCroppingRegionPlanes ()
 Get the cropping region planes in voxels. More...
 
virtual void GetVoxelCroppingRegionPlanes (double data[6])
 
virtual void SetCroppingRegionFlags (int)
 Set the flags for the cropping regions. More...
 
virtual int GetCroppingRegionFlags ()
 
void SetCroppingRegionFlagsToSubVolume ()
 
void SetCroppingRegionFlagsToFence ()
 
void SetCroppingRegionFlagsToInvertedFence ()
 
void SetCroppingRegionFlagsToCross ()
 
void SetCroppingRegionFlagsToInvertedCross ()
 
- Public Member Functions inherited from vtkAbstractVolumeMapper
vtkAbstractVolumeMapperNewInstance () const
 
virtual vtkDataSetGetDataSetInput ()
 Set/Get the input data. More...
 
virtual vtkDataObjectGetDataObjectInput ()
 
doubleGetBounds () override
 Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
void GetBounds (double bounds[6]) override
 Get the bounds for this mapper 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 ()
 
virtual void SetArrayAccessMode (int)
 
void SetScalarModeToDefault ()
 
void SetScalarModeToUsePointData ()
 
void SetScalarModeToUseCellData ()
 
void SetScalarModeToUsePointFieldData ()
 
void SetScalarModeToUseCellFieldData ()
 
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)
 
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...
 
virtual float GetGradientMagnitudeScale ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE. More...
 
virtual float GetGradientMagnitudeBias ()
 
virtual float GetGradientMagnitudeScale (int)
 
virtual float GetGradientMagnitudeBias (int)
 
- Public Member Functions inherited from vtkAbstractMapper3D
vtkAbstractMapper3DNewInstance () const
 
doubleGetCenter ()
 Return the Center of this mapper's data. More...
 
void GetCenter (double center[3])
 
double GetLength ()
 Return the diagonal length of this mappers bounding box. More...
 
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. More...
 
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. More...
 
void GetClippingPlaneInDataCoords (vtkMatrix4x4 *propMatrix, int i, double planeEquation[4])
 Get the ith clipping plane as a homogeneous plane equation. More...
 
- Public Member Functions inherited from vtkAbstractMapper
vtkAbstractMapperNewInstance () const
 
vtkMTimeType GetMTime () override
 Override Modifiedtime as we have added Clipping planes. 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)
 
void RemoveAllClippingPlanes ()
 
virtual void SetClippingPlanes (vtkPlaneCollection *)
 Get/Set the vtkPlaneCollection which specifies the clipping planes. More...
 
virtual vtkPlaneCollectionGetClippingPlanes ()
 
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...
 
virtual void ShallowCopy (vtkAbstractMapper *m)
 Make a shallow copy of this mapper. More...
 
int GetNumberOfClippingPlanes ()
 Get the number of clipping planes. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...
 
vtkTypeBool 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...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
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 Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
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)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
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...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
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). More...
 
virtual vtkTypeBool 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]=nullptr)
 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]=nullptr)
 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...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkOpenGLGPUVolumeRayCastMapperNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLGPUVolumeRayCastMapperSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkGPUVolumeRayCastMapper
static vtkGPUVolumeRayCastMapperNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGPUVolumeRayCastMapperSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkVolumeMapper
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVolumeMapperSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractVolumeMapper
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractVolumeMapperSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractMapper3D
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractMapper3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractMapper
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractMapperSafeDownCast (vtkObjectBase *o)
 
static vtkDataArrayGetScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
 Internal helper function for getting the active scalars. More...
 
static vtkAbstractArrayGetAbstractScalars (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 vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_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 vtkInformationIntegerKeyCAN_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 vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Public Attributes

VolumeInputMap AssembledInputs
 
- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOpenGLGPUVolumeRayCastMapper ()
 
 ~vtkOpenGLGPUVolumeRayCastMapper () override
 
void BuildDepthPassShader (vtkRenderer *ren, vtkVolume *vol, int noOfComponents, int independentComponents)
 
void BuildShader (vtkRenderer *ren)
 
void PreRender (vtkRenderer *vtkNotUsed(ren), vtkVolume *vtkNotUsed(vol), double vtkNotUsed(datasetBounds)[6], double vtkNotUsed(scalarRange)[2], int vtkNotUsed(noOfComponents), unsigned int vtkNotUsed(numberOfLevels)) override
 
void RenderBlock (vtkRenderer *vtkNotUsed(ren), vtkVolume *vtkNotUsed(vol), unsigned int vtkNotUsed(level)) override
 
void PostRender (vtkRenderer *vtkNotUsed(ren), int vtkNotUsed(noOfComponents)) override
 
void GPURender (vtkRenderer *ren, vtkVolume *vol) override
 Handled in the subclass - the actual render method. More...
 
void DoGPURender (vtkRenderer *ren, vtkOpenGLCamera *cam, vtkShaderProgram *shaderProgram, vtkOpenGLShaderProperty *shaderProperty)
 
void ComputeReductionFactor (double allocatedTime)
 
void GetReductionRatio (double *ratio) override
 
int IsRenderSupported (vtkRenderWindow *vtkNotUsed(window), vtkVolumeProperty *vtkNotUsed(property)) override
 Based on hardware and properties, we may or may not be able to render using 3D texture mapping. More...
 
vtkMTimeType GetRenderPassStageMTime (vtkVolume *vol)
 vtkOpenGLRenderPass API More...
 
void GetShaderTemplate (std::map< vtkShader::Type, vtkShader * > &shaders, vtkOpenGLShaderProperty *p)
 Create the basic shader template strings before substitutions. More...
 
void ReplaceShaderValues (std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
 Perform string replacements on the shader templates. More...
 
void ReplaceShaderCustomUniforms (std::map< vtkShader::Type, vtkShader * > &shaders, vtkOpenGLShaderProperty *p)
 RenderPass string replacements on shader templates called from ReplaceShaderValues. More...
 
void ReplaceShaderBase (std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
 
void ReplaceShaderTermination (std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
 
void ReplaceShaderShading (std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
 
void ReplaceShaderCompute (std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
 
void ReplaceShaderCropping (std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
 
void ReplaceShaderClipping (std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
 
void ReplaceShaderMasking (std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
 
void ReplaceShaderPicking (std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
 
void ReplaceShaderRTT (std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
 
void ReplaceShaderRenderPass (std::map< vtkShader::Type, vtkShader * > &shaders, vtkVolume *vol, bool prePass)
 
void SetShaderParametersRenderPass ()
 Update parameters from RenderPass. More...
 
- Protected Member Functions inherited from vtkGPUVolumeRayCastMapper
 vtkGPUVolumeRayCastMapper ()
 
 ~vtkGPUVolumeRayCastMapper () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Handle inputs. More...
 
void TransformInput (const int port)
 A transformation is applied (translation) to the input. More...
 
int ValidateRender (vtkRenderer *, vtkVolume *)
 This method is used by the Render() method to validate everything before attempting to render. More...
 
int ValidateInputs ()
 
int ValidateInput (vtkVolumeProperty *property, const int port)
 
void CloneInputs ()
 Shallow-copy the inputs into a transform-adjusted clone. More...
 
void CloneInput (vtkImageData *input, const int port)
 
void CanonicalViewRender (vtkRenderer *, vtkVolume *)
 
virtual void PreRender (vtkRenderer *ren, vtkVolume *vol, double datasetBounds[6], double scalarRange[2], int numberOfScalarComponents, unsigned int numberOfLevels)=0
 
virtual void RenderBlock (vtkRenderer *ren, vtkVolume *vol, unsigned int level)=0
 
virtual void PostRender (vtkRenderer *ren, int numberOfScalarComponents)=0
 
vtkImageDataGetInput (const int port) override
 
void SetCellFlag (int cellFlag)
 Called by the AMR Volume Mapper. More...
 
void RemovePortInternal (const int port)
 
virtual void SetAMRMode (vtkTypeBool)
 Set the mapper in AMR Mode or not. More...
 
virtual vtkTypeBool GetAMRMode ()
 
virtual void AMRModeOn ()
 
virtual void AMRModeOff ()
 
virtual void ClipCroppingRegionPlanes ()
 Compute the cropping planes clipped by the bounds of the volume. More...
 
void SetTransformedInput (vtkImageData *)
 
vtkImageDataFindData (int port, DataMap &container)
 
- Protected Member Functions inherited from vtkVolumeMapper
 vtkVolumeMapper ()
 
 ~vtkVolumeMapper () override
 
double SpacingAdjustedSampleDistance (double inputSpacing[3], int inputExtent[6])
 Compute a sample distance from the data spacing. More...
 
void ConvertCroppingRegionPlanesToVoxels ()
 
int FillInputPortInformation (int, vtkInformation *) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAbstractVolumeMapper
 vtkAbstractVolumeMapper ()
 
 ~vtkAbstractVolumeMapper () override
 
- Protected Member Functions inherited from vtkAbstractMapper3D
 vtkAbstractMapper3D ()
 
 ~vtkAbstractMapper3D () override
 
- Protected Member Functions inherited from vtkAbstractMapper
 vtkAbstractMapper ()
 
 ~vtkAbstractMapper () override
 
- 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...
 
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)
 
vtkDataArrayGetInputArrayToProcess (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...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. 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)
 
- 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkGenericOpenGLResourceFreeCallbackResourceCallback
 
vtkNew< vtkInformationLastRenderPassInfo
 Caches the vtkOpenGLRenderPass::RenderPasses() information. More...
 
double ReductionFactor
 
int CurrentPass
 
- Protected Attributes inherited from vtkGPUVolumeRayCastMapper
vtkTypeBool LockSampleDistanceToInputSpacing
 
vtkTypeBool AutoAdjustSampleDistances
 
float ImageSampleDistance
 
float MinimumImageSampleDistance
 
float MaximumImageSampleDistance
 
vtkTypeBool RenderToImage
 
int DepthImageScalarType
 
vtkTypeBool ClampDepthToBackface
 
vtkTypeBool UseJittering
 
vtkTypeBool UseDepthPass
 
vtkContourValuesDepthPassContourValues
 
float SampleDistance
 
int SmallVolumeRender
 
double BigTimeToDraw
 
double SmallTimeToDraw
 
float FinalColorWindow
 
float FinalColorLevel
 
int GeneratingCanonicalView
 
vtkImageDataCanonicalViewImageData
 
vtkImageDataMaskInput
 
float MaskBlendFactor
 
int MaskType
 
vtkTypeBool AMRMode
 
int ColorRangeType
 
int ScalarOpacityRangeType
 
int GradientOpacityRangeType
 
int CellFlag
 
double ClippedCroppingRegionPlanes [6]
 
vtkIdType MaxMemoryInBytes
 
float MaxMemoryFraction
 
bool ReportProgress
 
std::vector< intPorts
 
std::vector< intRemovedPorts
 
DataMap TransformedInputs
 
DataMap LastInputs
 This is needed only to check if the input data has been changed since the last Render() call. More...
 
- Protected Attributes inherited from vtkVolumeMapper
int BlendMode
 
double AverageIPScalarRange [2]
 Threshold range for average intensity projection. More...
 
vtkTypeBool Cropping
 Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates. More...
 
double CroppingRegionPlanes [6]
 
double VoxelCroppingRegionPlanes [6]
 
int CroppingRegionFlags
 
- 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
vtkTimerLogTimer
 
double TimeToDraw
 
vtkWindowLastWindow
 
vtkPlaneCollectionClippingPlanes
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkVolumeTexture
 

Additional Inherited Members

- Protected Types inherited from vtkGPUVolumeRayCastMapper
using DataMap = std::unordered_map< int, vtkImageData * >
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

OpenGL implementation of volume rendering through ray-casting.

Multiple Inputs

When multiple inputs are rendered simultaneously, it is possible to composite overlapping areas correctly. Inputs are connected directly to the mapper and their parameters (transfer functions, transformations, etc.) are specified through standard vtkVolume instances. These vtkVolume instances are to be registered in a special vtkProp3D, vtkMultiVolume.

Structures related to a particular active input are stored in a helper class (vtkVolumeInputHelper) and helper structures are kept in a port-referenced map (VolumeInputMap). The order of the inputs in the map is important as it defines the order in which parameters are bound to uniform variables (transformation matrices, bias, scale and every other required rendering parameter).

A separate code path is used when rendering multiple-inputs in order to facilitate the co-existance of these two modes (single/multiple), due to current feature incompatibilities with multiple inputs (e.g. texture-streaming, cropping, etc.).

Note
A limited set of the mapper features are currently supported for multiple inputs:
See also
vtkGPUVolumeRayCastMapper vtkVolumeInputHelper vtkVolumeTexture vtkMultiVolume

Definition at line 85 of file vtkOpenGLGPUVolumeRayCastMapper.h.

Member Typedef Documentation

◆ Superclass

Definition at line 97 of file vtkOpenGLGPUVolumeRayCastMapper.h.

◆ VolumeInput

Definition at line 293 of file vtkOpenGLGPUVolumeRayCastMapper.h.

◆ VolumeInputMap

Definition at line 294 of file vtkOpenGLGPUVolumeRayCastMapper.h.

Member Enumeration Documentation

◆ Passes

Enumerator
RenderPass 
DepthPass 

Definition at line 91 of file vtkOpenGLGPUVolumeRayCastMapper.h.

Constructor & Destructor Documentation

◆ vtkOpenGLGPUVolumeRayCastMapper()

vtkOpenGLGPUVolumeRayCastMapper::vtkOpenGLGPUVolumeRayCastMapper ( )
protected

◆ ~vtkOpenGLGPUVolumeRayCastMapper()

vtkOpenGLGPUVolumeRayCastMapper::~vtkOpenGLGPUVolumeRayCastMapper ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkOpenGLGPUVolumeRayCastMapper* vtkOpenGLGPUVolumeRayCastMapper::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenGLGPUVolumeRayCastMapper::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkGPUVolumeRayCastMapper.

◆ NewInstance()

vtkOpenGLGPUVolumeRayCastMapper* vtkOpenGLGPUVolumeRayCastMapper::NewInstance ( ) const

◆ PrintSelf()

void vtkOpenGLGPUVolumeRayCastMapper::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 vtkGPUVolumeRayCastMapper.

◆ GetDepthTexture()

vtkTextureObject* vtkOpenGLGPUVolumeRayCastMapper::GetDepthTexture ( )

◆ GetColorTexture()

vtkTextureObject* vtkOpenGLGPUVolumeRayCastMapper::GetColorTexture ( )

◆ GetDepthImage()

void vtkOpenGLGPUVolumeRayCastMapper::GetDepthImage ( vtkImageData )
overridevirtual

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

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

See also
SetRenderToImage()

Reimplemented from vtkGPUVolumeRayCastMapper.

◆ GetColorImage()

void vtkOpenGLGPUVolumeRayCastMapper::GetColorImage ( vtkImageData )
overridevirtual

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

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

See also
SetRenderToImage()

Reimplemented from vtkGPUVolumeRayCastMapper.

◆ GetCurrentPass()

virtual int vtkOpenGLGPUVolumeRayCastMapper::GetCurrentPass ( )
virtual

◆ SetSharedDepthTexture()

void vtkOpenGLGPUVolumeRayCastMapper::SetSharedDepthTexture ( vtkTextureObject nt)

◆ SetPartitions()

void vtkOpenGLGPUVolumeRayCastMapper::SetPartitions ( unsigned short  x,
unsigned short  y,
unsigned short  z 
)

Set a fixed number of partitions in which to split the volume during rendring.

This will force by-block rendering without trying to compute an optimum number of partitions.

◆ PreLoadData()

bool vtkOpenGLGPUVolumeRayCastMapper::PreLoadData ( vtkRenderer ren,
vtkVolume vol 
)

Load the volume texture into GPU memory.

Actual loading occurs in vtkVolumeTexture::LoadVolume. The mapper by default loads data lazily (at render time), so it is most commonly not necessary to call this function. This method is only exposed in order to support on-site loading which is useful in cases where the user needs to know a-priori whether loading will succeed or not.

◆ ReleaseGraphicsResources()

void vtkOpenGLGPUVolumeRayCastMapper::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

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

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

Warning
INTERNAL METHOD - NOT INTENDED FOR GENERAL USE

Reimplemented from vtkGPUVolumeRayCastMapper.

◆ BuildDepthPassShader()

void vtkOpenGLGPUVolumeRayCastMapper::BuildDepthPassShader ( vtkRenderer ren,
vtkVolume vol,
int  noOfComponents,
int  independentComponents 
)
protected

◆ BuildShader()

void vtkOpenGLGPUVolumeRayCastMapper::BuildShader ( vtkRenderer ren)
protected

◆ PreRender()

void vtkOpenGLGPUVolumeRayCastMapper::PreRender ( vtkRenderer vtkNotUsedren,
vtkVolume vtkNotUsedvol,
double   vtkNotUsed(datasetBounds)[6],
double   vtkNotUsed(scalarRange)[2],
int   vtkNotUsednoOfComponents,
unsigned int   vtkNotUsednumberOfLevels 
)
inlineoverrideprotected

Definition at line 179 of file vtkOpenGLGPUVolumeRayCastMapper.h.

◆ RenderBlock()

void vtkOpenGLGPUVolumeRayCastMapper::RenderBlock ( vtkRenderer vtkNotUsedren,
vtkVolume vtkNotUsedvol,
unsigned int   vtkNotUsedlevel 
)
inlineoverrideprotected

Definition at line 187 of file vtkOpenGLGPUVolumeRayCastMapper.h.

◆ PostRender()

void vtkOpenGLGPUVolumeRayCastMapper::PostRender ( vtkRenderer vtkNotUsedren,
int   vtkNotUsednoOfComponents 
)
inlineoverrideprotected

Definition at line 191 of file vtkOpenGLGPUVolumeRayCastMapper.h.

◆ GPURender()

void vtkOpenGLGPUVolumeRayCastMapper::GPURender ( vtkRenderer ,
vtkVolume  
)
overrideprotectedvirtual

Handled in the subclass - the actual render method.

Precondition
input is up-to-date.

Reimplemented from vtkGPUVolumeRayCastMapper.

◆ DoGPURender()

void vtkOpenGLGPUVolumeRayCastMapper::DoGPURender ( vtkRenderer ren,
vtkOpenGLCamera cam,
vtkShaderProgram shaderProgram,
vtkOpenGLShaderProperty shaderProperty 
)
protected

◆ ComputeReductionFactor()

void vtkOpenGLGPUVolumeRayCastMapper::ComputeReductionFactor ( double  allocatedTime)
protected

◆ GetReductionRatio()

void vtkOpenGLGPUVolumeRayCastMapper::GetReductionRatio ( double ratio)
inlineoverrideprotected

Definition at line 218 of file vtkOpenGLGPUVolumeRayCastMapper.h.

◆ IsRenderSupported()

int vtkOpenGLGPUVolumeRayCastMapper::IsRenderSupported ( vtkRenderWindow vtkNotUsedwindow,
vtkVolumeProperty vtkNotUsedproperty 
)
inlineoverrideprotectedvirtual

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

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

Reimplemented from vtkGPUVolumeRayCastMapper.

Definition at line 226 of file vtkOpenGLGPUVolumeRayCastMapper.h.

◆ GetRenderPassStageMTime()

vtkMTimeType vtkOpenGLGPUVolumeRayCastMapper::GetRenderPassStageMTime ( vtkVolume vol)
protected

◆ GetShaderTemplate()

void vtkOpenGLGPUVolumeRayCastMapper::GetShaderTemplate ( std::map< vtkShader::Type, vtkShader * > &  shaders,
vtkOpenGLShaderProperty p 
)
protected

Create the basic shader template strings before substitutions.

◆ ReplaceShaderValues()

void vtkOpenGLGPUVolumeRayCastMapper::ReplaceShaderValues ( std::map< vtkShader::Type, vtkShader * > &  shaders,
vtkRenderer ren,
vtkVolume vol,
int  numComps 
)
protected

Perform string replacements on the shader templates.

◆ ReplaceShaderCustomUniforms()

void vtkOpenGLGPUVolumeRayCastMapper::ReplaceShaderCustomUniforms ( std::map< vtkShader::Type, vtkShader * > &  shaders,
vtkOpenGLShaderProperty p 
)
protected

RenderPass string replacements on shader templates called from ReplaceShaderValues.

◆ ReplaceShaderBase()

void vtkOpenGLGPUVolumeRayCastMapper::ReplaceShaderBase ( std::map< vtkShader::Type, vtkShader * > &  shaders,
vtkRenderer ren,
vtkVolume vol,
int  numComps 
)
protected

◆ ReplaceShaderTermination()

void vtkOpenGLGPUVolumeRayCastMapper::ReplaceShaderTermination ( std::map< vtkShader::Type, vtkShader * > &  shaders,
vtkRenderer ren,
vtkVolume vol,
int  numComps 
)
protected

◆ ReplaceShaderShading()

void vtkOpenGLGPUVolumeRayCastMapper::ReplaceShaderShading ( std::map< vtkShader::Type, vtkShader * > &  shaders,
vtkRenderer ren,
vtkVolume vol,
int  numComps 
)
protected

◆ ReplaceShaderCompute()

void vtkOpenGLGPUVolumeRayCastMapper::ReplaceShaderCompute ( std::map< vtkShader::Type, vtkShader * > &  shaders,
vtkRenderer ren,
vtkVolume vol,
int  numComps 
)
protected

◆ ReplaceShaderCropping()

void vtkOpenGLGPUVolumeRayCastMapper::ReplaceShaderCropping ( std::map< vtkShader::Type, vtkShader * > &  shaders,
vtkRenderer ren,
vtkVolume vol,
int  numComps 
)
protected

◆ ReplaceShaderClipping()

void vtkOpenGLGPUVolumeRayCastMapper::ReplaceShaderClipping ( std::map< vtkShader::Type, vtkShader * > &  shaders,
vtkRenderer ren,
vtkVolume vol,
int  numComps 
)
protected

◆ ReplaceShaderMasking()

void vtkOpenGLGPUVolumeRayCastMapper::ReplaceShaderMasking ( std::map< vtkShader::Type, vtkShader * > &  shaders,
vtkRenderer ren,
vtkVolume vol,
int  numComps 
)
protected

◆ ReplaceShaderPicking()

void vtkOpenGLGPUVolumeRayCastMapper::ReplaceShaderPicking ( std::map< vtkShader::Type, vtkShader * > &  shaders,
vtkRenderer ren,
vtkVolume vol,
int  numComps 
)
protected

◆ ReplaceShaderRTT()

void vtkOpenGLGPUVolumeRayCastMapper::ReplaceShaderRTT ( std::map< vtkShader::Type, vtkShader * > &  shaders,
vtkRenderer ren,
vtkVolume vol,
int  numComps 
)
protected

◆ ReplaceShaderRenderPass()

void vtkOpenGLGPUVolumeRayCastMapper::ReplaceShaderRenderPass ( std::map< vtkShader::Type, vtkShader * > &  shaders,
vtkVolume vol,
bool  prePass 
)
protected

◆ SetShaderParametersRenderPass()

void vtkOpenGLGPUVolumeRayCastMapper::SetShaderParametersRenderPass ( )
protected

Update parameters from RenderPass.

Friends And Related Function Documentation

◆ vtkVolumeTexture

friend class vtkVolumeTexture
friend

Definition at line 301 of file vtkOpenGLGPUVolumeRayCastMapper.h.

Member Data Documentation

◆ ResourceCallback

vtkGenericOpenGLResourceFreeCallback* vtkOpenGLGPUVolumeRayCastMapper::ResourceCallback
protected

Definition at line 165 of file vtkOpenGLGPUVolumeRayCastMapper.h.

◆ LastRenderPassInfo

vtkNew<vtkInformation> vtkOpenGLGPUVolumeRayCastMapper::LastRenderPassInfo
protected

Caches the vtkOpenGLRenderPass::RenderPasses() information.

Note: Do not dereference the pointers held by this object. There is no guarantee that they are still valid!

Definition at line 286 of file vtkOpenGLGPUVolumeRayCastMapper.h.

◆ ReductionFactor

double vtkOpenGLGPUVolumeRayCastMapper::ReductionFactor
protected

Definition at line 289 of file vtkOpenGLGPUVolumeRayCastMapper.h.

◆ CurrentPass

int vtkOpenGLGPUVolumeRayCastMapper::CurrentPass
protected

Definition at line 290 of file vtkOpenGLGPUVolumeRayCastMapper.h.

◆ AssembledInputs

VolumeInputMap vtkOpenGLGPUVolumeRayCastMapper::AssembledInputs

Definition at line 295 of file vtkOpenGLGPUVolumeRayCastMapper.h.


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