vtkUnstructuredGridVolumeZSweepMapper Class Reference

#include <vtkUnstructuredGridVolumeZSweepMapper.h>

Inheritance diagram for vtkUnstructuredGridVolumeZSweepMapper:

[legend]

Collaboration diagram for vtkUnstructuredGridVolumeZSweepMapper:

[legend]

List of all members.

Detailed Description

Unstructured grid volume mapper based the ZSweep Algorithm.

This is a volume mapper for unstructured grid implemented with the ZSweep algorithm. This is a software projective method.

See also:: vtkVolumetMapper

Background:: The algorithm is described in the following paper: Ricardo Farias, Joseph S. B. Mitchell and Claudio T. Silva. ZSWEEP: An Efficient and Exact Projection Algorithm for Unstructured Volume Rendering. In 2000 Volume Visualization Symposium, pages 91--99. October 2000. http://www.cse.ogi.edu/~csilva/papers/volvis2000.pdf

Tests:: vtkUnstructuredGridVolumeZSweepMapper (Tests)

Definition at line 72 of file vtkUnstructuredGridVolumeZSweepMapper.h.


Public Types
typedef vtkUnstructuredGridVolumeMapper	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	GetMaxPixelListSize ()
void	SetMaxPixelListSize (int size)
virtual int *	GetImageInUseSize ()
virtual void	GetImageInUseSize (int data[2])
virtual int *	GetImageOrigin ()
virtual void	GetImageOrigin (int data[2])
virtual int *	GetImageViewportSize ()
virtual void	GetImageViewportSize (int data[2])

virtual void	SetImageSampleDistance (float)
virtual float	GetImageSampleDistance ()

virtual void	SetMinimumImageSampleDistance (float)
virtual float	GetMinimumImageSampleDistance ()

virtual void	SetMaximumImageSampleDistance (float)
virtual float	GetMaximumImageSampleDistance ()

virtual void	SetAutoAdjustSampleDistances (int)
virtual int	GetAutoAdjustSampleDistances ()
virtual void	AutoAdjustSampleDistancesOn ()
virtual void	AutoAdjustSampleDistancesOff ()

virtual void	SetIntermixIntersectingGeometry (int)
virtual int	GetIntermixIntersectingGeometry ()
virtual void	IntermixIntersectingGeometryOn ()
virtual void	IntermixIntersectingGeometryOff ()

virtual void	SetRayIntegrator (vtkUnstructuredGridVolumeRayIntegrator *ri)
virtual vtkUnstructuredGridVolumeRayIntegrator *	GetRayIntegrator ()

void	Render (vtkRenderer ren, vtkVolume vol)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkUnstructuredGridVolumeZSweepMapper *	SafeDownCast (vtkObject *o)
static vtkUnstructuredGridVolumeZSweepMapper *	New ()
Protected Member Functions
	vtkUnstructuredGridVolumeZSweepMapper ()
	~vtkUnstructuredGridVolumeZSweepMapper ()
void	BuildUseSets ()
void	CreateAndCleanPixelList ()
void	MainLoop (vtkRenderWindow *renWin)
void	CompositeFunction (double zTarget)
unsigned char	ColorComponentRealToByte (float color)
void	RasterizeFace (vtkIdType faceIds[3], int externalSide)
void	StoreRenderTime (vtkRenderer ren, vtkVolume vol, float t)
float	RetrieveRenderTime (vtkRenderer ren, vtkVolume vol)
double	GetMinimumBoundsDepth (vtkRenderer ren, vtkVolume vol)
void	AllocateUseSet (vtkIdType size)
void	AllocateVertices (vtkIdType size)
void	SavePixelListFrame ()

int	ReorderTriangle (vtkIdType v[3], vtkIdType w[3])

void	ProjectAndSortVertices (vtkRenderer ren, vtkVolume vol)

void	RasterizeTriangle (vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkVertexEntry ve0, vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkVertexEntry ve1, vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkVertexEntry *ve2, bool exitFace)

void	RasterizeSpan (int y, vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkScreenEdge left, vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkScreenEdge right, bool exitFace)

void	RasterizeLine (vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkVertexEntry v0, vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkVertexEntry v1, bool exitFace)

double	GetZBufferValue (int x, int y)
Protected Attributes
int	MaxPixelListSize
float	ImageSampleDistance
float	MinimumImageSampleDistance
float	MaximumImageSampleDistance
int	AutoAdjustSampleDistances
vtkRayCastImageDisplayHelper *	ImageDisplayHelper
int	ImageViewportSize [2]
int	ImageMemorySize [2]
int	ImageInUseSize [2]
int	ImageOrigin [2]
unsigned char *	Image
float *	RealRGBAImage
float *	RenderTimeTable
vtkVolume **	RenderVolumeTable
vtkRenderer **	RenderRendererTable
int	RenderTableSize
int	RenderTableEntries
int	IntermixIntersectingGeometry
float *	ZBuffer
int	ZBufferSize [2]
int	ZBufferOrigin [2]
vtkDataArray *	Scalars
int	CellScalars
double	FaceScalars [2]
int	FaceSide
vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkSpan *	Span
vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkPixelListFrame *	PixelListFrame
vtkGenericCell *	Cell
vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkUseSet *	UseSet
vtkPriorityQueue *	EventList
vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkVertices *	Vertices
vtkTransform *	PerspectiveTransform
vtkMatrix4x4 *	PerspectiveMatrix
int	MaxPixelListSizeReached
int	XBounds [2]
int	YBounds [2]
vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkSimpleScreenEdge *	SimpleEdge
vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkDoubleScreenEdge *	DoubleEdge
vtkUnstructuredGridVolumeRayIntegrator *	RayIntegrator
vtkUnstructuredGridVolumeRayIntegrator *	RealRayIntegrator
vtkTimeStamp	SavedTriangleListMTime
vtkDoubleArray *	IntersectionLengths
vtkDoubleArray *	NearIntersections
vtkDoubleArray *	FarIntersections
vtkIdType	MaxRecordedPixelListSize
vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkPixelListEntryMemory *	MemoryManager

Member Typedef Documentation

typedef vtkUnstructuredGridVolumeMapper vtkUnstructuredGridVolumeZSweepMapper::Superclass

Reimplemented from vtkUnstructuredGridVolumeMapper.

Definition at line 75 of file vtkUnstructuredGridVolumeZSweepMapper.h.

Constructor & Destructor Documentation

vtkUnstructuredGridVolumeZSweepMapper::vtkUnstructuredGridVolumeZSweepMapper ( ) [protected]

vtkUnstructuredGridVolumeZSweepMapper::~vtkUnstructuredGridVolumeZSweepMapper ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkUnstructuredGridVolumeMapper.

static int vtkUnstructuredGridVolumeZSweepMapper::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkUnstructuredGridVolumeMapper.

virtual int vtkUnstructuredGridVolumeZSweepMapper::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkUnstructuredGridVolumeMapper.

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

Reimplemented from vtkUnstructuredGridVolumeMapper.

void vtkUnstructuredGridVolumeZSweepMapper::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 vtkUnstructuredGridVolumeMapper.

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

Set MaxPixelListSize to 32.

Reimplemented from vtkAlgorithm.

virtual void vtkUnstructuredGridVolumeZSweepMapper::SetImageSampleDistance ( float ) [virtual]

Sampling distance in the XY image dimensions. Default value of 1 meaning 1 ray cast per pixel. If set to 0.5, 4 rays will be cast per pixel. If set to 2.0, 1 ray will be cast for every 4 (2 by 2) pixels.

virtual float vtkUnstructuredGridVolumeZSweepMapper::GetImageSampleDistance ( ) [virtual]

Sampling distance in the XY image dimensions. Default value of 1 meaning 1 ray cast per pixel. If set to 0.5, 4 rays will be cast per pixel. If set to 2.0, 1 ray will be cast for every 4 (2 by 2) pixels.

virtual void vtkUnstructuredGridVolumeZSweepMapper::SetMinimumImageSampleDistance ( float ) [virtual]

This is the minimum image sample distance allow when the image sample distance is being automatically adjusted

virtual float vtkUnstructuredGridVolumeZSweepMapper::GetMinimumImageSampleDistance ( ) [virtual]

This is the minimum image sample distance allow when the image sample distance is being automatically adjusted

virtual void vtkUnstructuredGridVolumeZSweepMapper::SetMaximumImageSampleDistance ( float ) [virtual]

This is the maximum image sample distance allow when the image sample distance is being automatically adjusted

virtual float vtkUnstructuredGridVolumeZSweepMapper::GetMaximumImageSampleDistance ( ) [virtual]

This is the maximum image sample distance allow when the image sample distance is being automatically adjusted

virtual void vtkUnstructuredGridVolumeZSweepMapper::SetAutoAdjustSampleDistances ( int ) [virtual]

If AutoAdjustSampleDistances is on, the the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual int vtkUnstructuredGridVolumeZSweepMapper::GetAutoAdjustSampleDistances ( ) [virtual]

If AutoAdjustSampleDistances is on, the the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual void vtkUnstructuredGridVolumeZSweepMapper::AutoAdjustSampleDistancesOn ( ) [virtual]

If AutoAdjustSampleDistances is on, the the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual void vtkUnstructuredGridVolumeZSweepMapper::AutoAdjustSampleDistancesOff ( ) [virtual]

If AutoAdjustSampleDistances is on, the the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual void vtkUnstructuredGridVolumeZSweepMapper::SetIntermixIntersectingGeometry ( int ) [virtual]

If IntermixIntersectingGeometry is turned on, the zbuffer will be captured and used to limit the traversal of the rays.

virtual int vtkUnstructuredGridVolumeZSweepMapper::GetIntermixIntersectingGeometry ( ) [virtual]

If IntermixIntersectingGeometry is turned on, the zbuffer will be captured and used to limit the traversal of the rays.

virtual void vtkUnstructuredGridVolumeZSweepMapper::IntermixIntersectingGeometryOn ( ) [virtual]

If IntermixIntersectingGeometry is turned on, the zbuffer will be captured and used to limit the traversal of the rays.

virtual void vtkUnstructuredGridVolumeZSweepMapper::IntermixIntersectingGeometryOff ( ) [virtual]

If IntermixIntersectingGeometry is turned on, the zbuffer will be captured and used to limit the traversal of the rays.

int vtkUnstructuredGridVolumeZSweepMapper::GetMaxPixelListSize ( )

Maximum size allowed for a pixel list. Default is 32. During the rendering, if a list of pixel is full, incremental compositing is performed. Even if it is a user setting, it is an advanced parameter. You have to understand how the algorithm works to change this value.

void vtkUnstructuredGridVolumeZSweepMapper::SetMaxPixelListSize ( int size )

Change the maximum size allowed for a pixel list. It is an advanced parameter.

Precondition:: positive_size: size>1

virtual void vtkUnstructuredGridVolumeZSweepMapper::SetRayIntegrator ( vtkUnstructuredGridVolumeRayIntegrator * ri ) [virtual]

Set/Get the helper class for integrating rays. If set to NULL, a default integrator will be assigned.

virtual vtkUnstructuredGridVolumeRayIntegrator* vtkUnstructuredGridVolumeZSweepMapper::GetRayIntegrator ( ) [virtual]

Set/Get the helper class for integrating rays. If set to NULL, a default integrator will be assigned.

void vtkUnstructuredGridVolumeZSweepMapper::Render	(	vtkRenderer *	ren,
		vtkVolume *	vol
	)			`[virtual]`

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

Implements vtkUnstructuredGridVolumeMapper.

virtual int* vtkUnstructuredGridVolumeZSweepMapper::GetImageInUseSize ( ) [virtual]

virtual void vtkUnstructuredGridVolumeZSweepMapper::GetImageInUseSize ( int data[2] ) [virtual]

virtual int* vtkUnstructuredGridVolumeZSweepMapper::GetImageOrigin ( ) [virtual]

virtual void vtkUnstructuredGridVolumeZSweepMapper::GetImageOrigin ( int data[2] ) [virtual]

virtual int* vtkUnstructuredGridVolumeZSweepMapper::GetImageViewportSize ( ) [virtual]

virtual void vtkUnstructuredGridVolumeZSweepMapper::GetImageViewportSize ( int data[2] ) [virtual]

void vtkUnstructuredGridVolumeZSweepMapper::BuildUseSets ( ) [protected]

For each vertex, find the list of incident faces.

int vtkUnstructuredGridVolumeZSweepMapper::ReorderTriangle	(	vtkIdType	v[3],
		vtkIdType	w[3]
	)			`[protected]`

Reorder vertices `v' in increasing order in `w'. Return if the orientation has changed.

void vtkUnstructuredGridVolumeZSweepMapper::ProjectAndSortVertices	(	vtkRenderer *	ren,
		vtkVolume *	vol
	)			`[protected]`

Project and sort the vertices by z-coordinates in view space in the "event list" (an heap).

Precondition:: empty_list: this->EventList->GetNumberOfItems()==0

void vtkUnstructuredGridVolumeZSweepMapper::CreateAndCleanPixelList ( ) [protected]

Create an empty "pixel list" for each pixel of the screen.

void vtkUnstructuredGridVolumeZSweepMapper::MainLoop ( vtkRenderWindow * renWin ) [protected]

MainLoop of the Zsweep algorithm.

Postcondition:: empty_list: this->EventList->GetNumberOfItems()==0

void vtkUnstructuredGridVolumeZSweepMapper::CompositeFunction ( double zTarget ) [protected]

Do delayed compositing from back to front, stopping at zTarget for each pixel inside the bounding box.

unsigned char vtkUnstructuredGridVolumeZSweepMapper::ColorComponentRealToByte ( float color ) [protected]

Convert and clamp a float color component into a unsigned char.

void vtkUnstructuredGridVolumeZSweepMapper::RasterizeFace	(	vtkIdType	faceIds[3],
		int	externalSide
	)			`[protected]`

Perform scan conversion of a triangle face.

void vtkUnstructuredGridVolumeZSweepMapper::RasterizeTriangle	(	vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkVertexEntry *	ve0,
		vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkVertexEntry *	ve1,
		vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkVertexEntry *	ve2,
		bool	exitFace
	)			`[protected]`

Perform scan conversion of a triangle defined by its vertices.

Precondition:

ve0_exists: ve0!=0

ve1_exists: ve1!=0

ve2_exists: ve2!=0

void vtkUnstructuredGridVolumeZSweepMapper::RasterizeSpan	(	int	y,
		vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkScreenEdge *	left,
		vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkScreenEdge *	right,
		bool	exitFace
	)			`[protected]`

Perform scan conversion of an horizontal span from left ro right at line y.

Precondition:: left_exists: left!=0
right_exists: right!=0

void vtkUnstructuredGridVolumeZSweepMapper::RasterizeLine	(	vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkVertexEntry *	v0,
		vtkUnstructuredGridVolumeZSweepMapperNamespace::vtkVertexEntry *	v1,
		bool	exitFace
	)			`[protected]`