vtkOpenGLGPUVolumeRayCastMapper Class Reference

#include <vtkOpenGLGPUVolumeRayCastMapper.h>

Inheritance diagram for vtkOpenGLGPUVolumeRayCastMapper:

[legend]

Collaboration diagram for vtkOpenGLGPUVolumeRayCastMapper:

[legend]

List of all members.

Detailed Description

OpenGL subclass that draws the image to the screen.

This is the concrete implementation of a ray cast image display helper - a helper class responsible for drawing the image to the screen.

See also:: vtkGPUVolumeRayCastMapper

Events:: vtkCommand::VolumeMapperRenderProgressEvent

Definition at line 55 of file vtkOpenGLGPUVolumeRayCastMapper.h.


Public Types
typedef vtkGPUVolumeRayCastMapper	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	IsRenderSupported (vtkRenderWindow window, vtkVolumeProperty property)
Static Public Member Functions
static vtkOpenGLGPUVolumeRayCastMapper *	New ()
static int	IsTypeOf (const char *type)
static vtkOpenGLGPUVolumeRayCastMapper *	SafeDownCast (vtkObject *o)
static const char *	OpenGLErrorMessage (unsigned int errorCode)
static void	PrintError (const char *headerMessage)
Protected Member Functions
	vtkOpenGLGPUVolumeRayCastMapper ()
	~vtkOpenGLGPUVolumeRayCastMapper ()
virtual void	GPURender (vtkRenderer ren, vtkVolume vol)
virtual void	PreRender (vtkRenderer ren, vtkVolume vol, double datasetBounds[6], double scalarRange[2], int numberOfScalarComponents, unsigned int numberOfLevels)
virtual void	RenderBlock (vtkRenderer ren, vtkVolume vol, unsigned int level)
virtual void	PostRender (vtkRenderer *ren, int numberOfScalarComponents)
void	LoadExtensions (vtkRenderWindow *window)
void	CreateGLSLObjects ()
void	CreateOpenGLObjects ()
void	ReleaseGraphicsResources (vtkWindow *window)
int	AllocateFrameBuffers (vtkRenderer *ren)
void	SetupRender (vtkRenderer ren, vtkVolume vol)
void	CopyFBOToTexture ()
void	CleanupRender ()
void	RenderTextureToScreen (vtkRenderer *ren)
int	PowerOfTwoGreaterOrEqual (int x)
void	CheckFrameBufferStatus ()
vtkStdString	BufferToString (int buffer)
void	DisplayReadAndDrawBuffers ()
void	DisplayFrameBufferAttachments ()
void	DisplayFrameBufferAttachment (unsigned int uattachment)
void	GetLightingStatus ()
void	CheckCompilation (unsigned int fragmentShader)
int	CheckLinkage (unsigned int programShader)
void	PrintUniformVariables (unsigned int programShader)
void	ValidateProgram ()
void	ComputeReductionFactor (double allocatedTime)
int	RenderSubVolume (vtkRenderer ren, double bounds[6], vtkVolume vol)
void	LoadProjectionParameters (vtkRenderer ren, vtkVolume vol)
void	ComputeNumberOfCroppingRegions ()
void	GetTextureFormat (vtkImageData input, unsigned int internalFormat, unsigned int format, unsigned int type, int *componentSize)
bool	TestLoadingScalar (unsigned int internalFormat, unsigned int format, unsigned int type, int textureSize[3], int componentSize)
void	SlabsFromDatasetToIndex (double slabsDataSet[6], double slabsPoints[6])
void	SlabsFromIndexToDataset (double slabsPoints[6], double slabsDataSet[6])
const char *	GetEnabledString (unsigned char value)
void	GetOpenGLState ()
void	DebugDisplayBox (vtkPolyData *box)
void	UpdateNoiseTexture ()
virtual void	GetReductionRatio (double ratio[3])
void	BuildScaleBiasProgram ()

int	TestRequiredExtension (vtkOpenGLExtensionManager extensions, const char extensionName)

int	LoadScalarField (vtkImageData input, vtkImageData maskInput, int textureExtent[6], vtkVolume *volume)

int	UpdateColorTransferFunction (vtkVolume *vol, int numberOfScalarComponents)
int	UpdateOpacityTransferFunction (vtkVolume *vol, int numberOfScalarComponents, unsigned int level)

void	ClipBoundingBox (vtkRenderer ren, double worldBounds[6], vtkVolume vol)

int	RenderClippedBoundingBox (int tcoordFlag, size_t currentBlock, size_t numberOfBlocks, vtkRenderWindow *renWin)

void	BuildProgram (int parallelProjection, int raycastMethod, int shadeMethod, int componentMethod)

void	RenderWholeVolume (vtkRenderer ren, vtkVolume vol)

void	RenderRegions (vtkRenderer ren, vtkVolume vol)

double	ComputeMinimalSampleDistancePerPixel (vtkRenderer renderer, vtkVolume volume)
Protected Attributes
int	NumberOfCroppingRegions
double	BoundingBox [8][3]
vtkPolyData *	PolyDataBoundingBox
vtkPlaneCollection *	Planes
vtkPlane *	NearPlane
vtkClipConvexPolyData *	Clip
vtkMatrix4x4 *	InvVolumeMatrix
vtkDensifyPolyData *	Densify
int	OpenGLObjectsCreated
int	NumberOfFrameBuffers
unsigned int	FrameBufferObject
unsigned int	DepthRenderBufferObject
unsigned int	TextureObjects [5]
unsigned int	FragmentMainShader
unsigned int	FragmentProjectionShader
unsigned int	FragmentTraceShader
unsigned int	FragmentCroppingShader
unsigned int	FragmentComponentShader
unsigned int	FragmentShadeShader
unsigned int	ProgramShader
unsigned int	MaxValueFrameBuffer
unsigned int	MaxValueFrameBuffer2
int	ReducedSize [2]
vtkPolyData *	ClippedBoundingBox
int	LastSize [2]
double	ReductionFactor
vtkUnsupportedRequiredExtensionsStringStream *	UnsupportedRequiredExtensions
int	LoadExtensionsSucceeded
int	Supports_GL_ARB_texture_float
int	SupportsPixelBufferObjects
vtkTimeStamp	DataBufferTime
vtkMatrix4x4 *	TempMatrix [3]
double	TableRange [2]
int	ErrorLine
int	ErrorColumn
char *	ErrorString
int	LastParallelProjection
int	LastRayCastMethod
int	LastCroppingMode
int	LastComponent
int	LastShade
vtkImageData *	SmallInput
vtkTimeStamp	SmallInputBuildTime
unsigned int	ScaleBiasProgramShader
int	UFrameBufferTexture
int	UScale
int	UBias
unsigned int	SavedFrameBuffer
vtkTessellatedBoxSource *	BoxSource
float *	NoiseTexture
int	NoiseTextureSize
unsigned int	NoiseTextureId
bool	IgnoreSampleDistancePerPixel
vtkMapDataArrayTextureId *	ScalarsTextures
vtkMapMaskTextureId *	MaskTextures
vtkRGBTable *	RGBTable
vtkRGBTable *	Mask1RGBTable
vtkRGBTable *	Mask2RGBTable
vtkOpacityTables *	OpacityTables
vtkKWScalarField *	CurrentScalar
vtkKWMask *	CurrentMask
float	ActualSampleDistance
double	LastProgressEventTime
bool	PreserveOrientation

Member Typedef Documentation

typedef vtkGPUVolumeRayCastMapper vtkOpenGLGPUVolumeRayCastMapper::Superclass

Reimplemented from vtkGPUVolumeRayCastMapper.

Definition at line 59 of file vtkOpenGLGPUVolumeRayCastMapper.h.

Constructor & Destructor Documentation

vtkOpenGLGPUVolumeRayCastMapper::vtkOpenGLGPUVolumeRayCastMapper ( ) [protected]

vtkOpenGLGPUVolumeRayCastMapper::~vtkOpenGLGPUVolumeRayCastMapper ( ) [protected]

Member Function Documentation

static vtkOpenGLGPUVolumeRayCastMapper* vtkOpenGLGPUVolumeRayCastMapper::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkGPUVolumeRayCastMapper.

virtual const char* vtkOpenGLGPUVolumeRayCastMapper::GetClassName ( ) [virtual]

Reimplemented from vtkGPUVolumeRayCastMapper.

static int vtkOpenGLGPUVolumeRayCastMapper::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

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

static vtkOpenGLGPUVolumeRayCastMapper* vtkOpenGLGPUVolumeRayCastMapper::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkGPUVolumeRayCastMapper.

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

virtual int vtkOpenGLGPUVolumeRayCastMapper::IsRenderSupported	(	vtkRenderWindow *	window,
		vtkVolumeProperty *	property
	)			`[virtual]`

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.

static const char* vtkOpenGLGPUVolumeRayCastMapper::OpenGLErrorMessage ( unsigned int errorCode ) [static]

Return a string matching the OpenGL errorCode.

Postcondition:: result_exists: result!=0

static void vtkOpenGLGPUVolumeRayCastMapper::PrintError ( const char * headerMessage ) [static]

Display headerMessage on the standard output and the last OpenGL error message if any.

Precondition:: headerMessage_exists: headerMessage!=0

virtual void vtkOpenGLGPUVolumeRayCastMapper::GPURender	(	vtkRenderer *	,
		vtkVolume *
	)			`[protected, virtual]`

Handled in the subclass - the actual render method

Precondition:: input is up-to-date.

Reimplemented from vtkGPUVolumeRayCastMapper.

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

Implements vtkGPUVolumeRayCastMapper.

virtual void vtkOpenGLGPUVolumeRayCastMapper::RenderBlock	(	vtkRenderer *	ren,
		vtkVolume *	vol,
		unsigned int	level
	)			`[protected, virtual]`

Implements vtkGPUVolumeRayCastMapper.

virtual void vtkOpenGLGPUVolumeRayCastMapper::PostRender	(	vtkRenderer *	ren,
		int	numberOfScalarComponents
	)			`[protected, virtual]`

Implements vtkGPUVolumeRayCastMapper.

int vtkOpenGLGPUVolumeRayCastMapper::TestRequiredExtension	(	vtkOpenGLExtensionManager *	extensions,
		const char *	extensionName
	)			`[protected]`

Return if the required OpenGL extension `extensionName' is supported. If not, its name is added to the string of unsupported but required extensions.

Precondition:: extensions_exist: extensions!=0
extensionName_exists: extensionName!=0

void vtkOpenGLGPUVolumeRayCastMapper::LoadExtensions ( vtkRenderWindow * window ) [protected]

Attempt to load required and optional OpenGL extensions for the current context window. Variable LoadExtensionsSucceeded is set if all required extensions has been loaded. In addition, variable Supports_GL_ARB_texture_float is set if this extension has been loaded.

Precondition:: : window_exists: window!=0

void vtkOpenGLGPUVolumeRayCastMapper::CreateGLSLObjects ( ) [protected]

Create GLSL OpenGL objects such fragment program Ids.

void vtkOpenGLGPUVolumeRayCastMapper::CreateOpenGLObjects ( ) [protected]

Create OpenGL objects such as textures, buffers and fragment program Ids. It only registers Ids, there is no actual initialization of textures or fragment program.

Precondition:: extensions_loaded: this->LoadExtensionsSucceeded

Postcondition:: done: this->OpenGLObjectsCreated==1

void vtkOpenGLGPUVolumeRayCastMapper::ReleaseGraphicsResources ( vtkWindow * window ) [protected, virtual]

Delete OpenGL objects.

Postcondition:: done: this->OpenGLObjectsCreated==0

Reimplemented from vtkGPUVolumeRayCastMapper.

int vtkOpenGLGPUVolumeRayCastMapper::AllocateFrameBuffers ( vtkRenderer * ren ) [protected]

Allocate memory on the GPU for the framebuffers according to the size of the window or reallocate if the size has changed. Return true if allocation succeeded.

Precondition:: ren_exists: ren!=0
opengl_objects_created: this->OpenGLObjectsCreated

Postcondition:: right_size: LastSize[]=window size.

int vtkOpenGLGPUVolumeRayCastMapper::LoadScalarField	(	vtkImageData *	input,
		vtkImageData *	maskInput,
		int	textureExtent[6],
		vtkVolume *	volume
	)			`[protected]`

Load the scalar field (one or four component scalar field), cell or point based for a given subextent of the whole extent (can be the whole extent) as a 3D texture on the GPU. Extents are expressed in point if the cell flag is false or in cells of the cell flag is true. It returns true if it succeeded, false if there is not enough memory on the GPU. If succeeded, it updates the LoadedExtent, LoadedBounds, LoadedCellFlag and LoadedTime. It also succeed if the scalar field is already loaded (ie since last load, input has not changed and cell flag has not changed and requested texture extents are enclosed in the loaded extent).

Precondition:

input_exists: input!=0

valid_point_extent: (this->CellFlag || (textureExtent[0]<textureExtent[1] && textureExtent[2]<textureExtent[3] && textureExtent[4]<textureExtent[5])))

valid_cell_extent: (!this->CellFlag || (textureExtent[0]<=textureExtent[1] && textureExtent[2]<=textureExtent[3] && textureExtent[4]<=textureExtent[5])))

int vtkOpenGLGPUVolumeRayCastMapper::UpdateColorTransferFunction	(	vtkVolume *	vol,
		int	numberOfScalarComponents
	)			`[protected]`

Allocate memory and load color table on the GPU or reload it if the transfer function changed.

Precondition:: vol_exists: vol!=0
valid_numberOfScalarComponents: numberOfScalarComponents==1 || numberOfScalarComponents==4

int vtkOpenGLGPUVolumeRayCastMapper::UpdateOpacityTransferFunction	(	vtkVolume *	vol,
		int	numberOfScalarComponents,
		unsigned int	level
	)			`[protected]`

Allocate memory and load color table on the GPU or reload it if the transfer function changed.

Precondition:: vol_exists: vol!=0
valid_numberOfScalarComponents: numberOfScalarComponents==1 || numberOfScalarComponents==4

void vtkOpenGLGPUVolumeRayCastMapper::SetupRender	(	vtkRenderer *	ren,
		vtkVolume *	vol
	)			`[protected]`

Prepare rendering in the offscreen framebuffer.

Precondition:: ren_exists: ren!=0
vol_exists: vol!=0

void vtkOpenGLGPUVolumeRayCastMapper::ClipBoundingBox	(	vtkRenderer *	ren,
		double	worldBounds[6],
		vtkVolume *	vol
	)			`[protected]`

Clip the bounding box with all clipping planes and the near and far plane

int vtkOpenGLGPUVolumeRayCastMapper::RenderClippedBoundingBox	(	int	tcoordFlag,
		size_t	currentBlock,
		size_t	numberOfBlocks,
		vtkRenderWindow *	renWin
	)			`[protected]`

Render the bounding box. The flag indicates whether or not tcoords are rendered too. Return abort status (true==abort).

Precondition:: valid_currentBlock: currentBlock>=0 && currentBlock<numberOfBlocks

void vtkOpenGLGPUVolumeRayCastMapper::CopyFBOToTexture ( ) [protected]

Method used to copy the state of the color buffer (which is in a frame buffer object) to a texture.

void vtkOpenGLGPUVolumeRayCastMapper::CleanupRender ( ) [protected]

Restore OpenGL state after rendering of the dataset.

void vtkOpenGLGPUVolumeRayCastMapper::RenderTextureToScreen ( vtkRenderer * ren ) [protected]

Render the offscreen buffer to the screen.

Precondition:: ren_exists: ren!=0

int vtkOpenGLGPUVolumeRayCastMapper::PowerOfTwoGreaterOrEqual ( int x ) [protected]

Compute y=2^n such that x<=y.

Precondition:: positive_x: x>=0

Postcondition:: valid_result: result>=x

void vtkOpenGLGPUVolumeRayCastMapper::CheckFrameBufferStatus ( ) [protected]

Display the status of the current framebuffer on the standard output.

vtkStdString vtkOpenGLGPUVolumeRayCastMapper::BufferToString ( int buffer ) [protected]

Create a string from a buffer id. The result has to be free by the caller.

void vtkOpenGLGPUVolumeRayCastMapper::DisplayReadAndDrawBuffers ( ) [protected]

Display the buffers assigned for drawing and reading operations.

void vtkOpenGLGPUVolumeRayCastMapper::DisplayFrameBufferAttachments ( ) [protected]

Display all the attachments of the current framebuffer object.

void vtkOpenGLGPUVolumeRayCastMapper::DisplayFrameBufferAttachment ( unsigned int uattachment ) [protected]

Display a given attachment for the current framebuffer object.

void vtkOpenGLGPUVolumeRayCastMapper::BuildProgram	(	int	parallelProjection,
		int	raycastMethod,
		int	shadeMethod,
		int	componentMethod
	)			`[protected]`

Concatenate the header string, projection type code and method to the final fragment code in this->FragmentCode.

Precondition:: valid_raycastMethod: raycastMethod>= vtkOpenGLGPUVolumeRayCastMapperMethodMaximumIntensityProjection && raycastMethod<=vtkOpenGLGPUVolumeRayCastMapperMethodMinIPFourDependen t

void vtkOpenGLGPUVolumeRayCastMapper::GetLightingStatus ( ) [protected]

Return the current OpenGL state about lighting.

void vtkOpenGLGPUVolumeRayCastMapper::CheckCompilation ( unsigned int fragmentShader ) [protected]

Check the compilation status of some fragment shader source.

int vtkOpenGLGPUVolumeRayCastMapper::CheckLinkage ( unsigned int programShader ) [protected]

Check the linkage status of the fragment program.

void vtkOpenGLGPUVolumeRayCastMapper::PrintUniformVariables ( unsigned int programShader ) [protected]

Print all active uniform variables

void vtkOpenGLGPUVolumeRayCastMapper::ValidateProgram ( ) [protected]

Is the program shader valid in the current OpenGL state? Debugging purpose only.

void vtkOpenGLGPUVolumeRayCastMapper::ComputeReductionFactor ( double allocatedTime ) [protected]

Update the reduction factor of the render viewport (this->ReductionFactor) according to the time spent in seconds to render the previous frame (this->TimeToDraw) and a time in seconds allocated to render the next frame (allocatedTime).

Precondition:

valid_current_reduction_range: this->ReductionFactor>0.0 && this->ReductionFactor<=1.0

positive_TimeToDraw: this->TimeToDraw>=0.0

positive_time: allocatedTime>0

Postcondition:: valid_new_reduction_range: this->ReductionFactor>0.0 && this->ReductionFactor<=1.0

void vtkOpenGLGPUVolumeRayCastMapper::RenderWholeVolume	(	vtkRenderer *	ren,
		vtkVolume *	vol
	)			`[protected]`

Render a subvolume.

Precondition:: this->ProgramShader!=0 and is linked.

void vtkOpenGLGPUVolumeRayCastMapper::RenderRegions	(	vtkRenderer *	ren,
		vtkVolume *	vol
	)			`[protected]`

Render a subvolume.

Precondition:: this->ProgramShader!=0 and is linked.

int vtkOpenGLGPUVolumeRayCastMapper::RenderSubVolume	(	vtkRenderer *	ren,
		double	bounds[6],
		vtkVolume *	vol
	)			`[protected]`

void vtkOpenGLGPUVolumeRayCastMapper::LoadProjectionParameters	(	vtkRenderer *	ren,
		vtkVolume *	vol
	)			`[protected]`

void vtkOpenGLGPUVolumeRayCastMapper::ComputeNumberOfCroppingRegions ( ) [protected]

Compute and return the number of cropping regions

void vtkOpenGLGPUVolumeRayCastMapper::GetTextureFormat	(	vtkImageData *	input,
		unsigned int *	internalFormat,
		unsigned int *	format,
		unsigned int *	type,
		int *	componentSize
	)			`[protected]`

bool vtkOpenGLGPUVolumeRayCastMapper::TestLoadingScalar	(	unsigned int	internalFormat,
		unsigned int	format,
		unsigned int	type,
		int	textureSize[3],
		int	componentSize
	)			`[protected]`

void vtkOpenGLGPUVolumeRayCastMapper::SlabsFromDatasetToIndex	(	double	slabsDataSet[6],
		double	slabsPoints[6]
	)			`[protected]`

void vtkOpenGLGPUVolumeRayCastMapper::SlabsFromIndexToDataset	(	double	slabsPoints[6],
		double	slabsDataSet[6]
	)			`[protected]`

const char* vtkOpenGLGPUVolumeRayCastMapper::GetEnabledString ( unsigned char value ) [protected]

void vtkOpenGLGPUVolumeRayCastMapper::GetOpenGLState ( ) [protected]

void vtkOpenGLGPUVolumeRayCastMapper::DebugDisplayBox ( vtkPolyData * box ) [protected]

void vtkOpenGLGPUVolumeRayCastMapper::UpdateNoiseTexture ( ) [protected]

double vtkOpenGLGPUVolumeRayCastMapper::ComputeMinimalSampleDistancePerPixel	(	vtkRenderer *	renderer,
		vtkVolume *	volume
	)			`[protected]`

Compute how each axis of a cell is projected on the viewport in pixel. This requires to have information about the camera and about the volume. It set the value of IgnoreSampleDistancePerPixel to true in case of degenerated case (axes aligned with the view).

virtual void vtkOpenGLGPUVolumeRayCastMapper::GetReductionRatio ( double ratio[3] ) [protected, virtual]

Return how much the dataset has to be reduced in each dimension to fit on the GPU. If the value is 1.0, there is no need to reduce the dataset.

Precondition:: the calling thread has a current OpenGL context.
mapper_supported: IsRenderSupported(renderer->GetRenderWindow(),0) The computation is based on hardware limits (3D texture indexable size) and MaxMemoryInBytes.

Postcondition:

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

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

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

Implements vtkGPUVolumeRayCastMapper.

void vtkOpenGLGPUVolumeRayCastMapper::BuildScaleBiasProgram ( ) [protected]

Build the fragment shader program that scale and bias a texture for window/level purpose.