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)

Member Typedef Documentation

typedef vtkUnstructuredGridVolumeMapper vtkUnstructuredGridVolumeZSweepMapper::Superclass

Reimplemented from vtkUnstructuredGridVolumeMapper.
Definition at line 70 of file vtkUnstructuredGridVolumeZSweepMapper.h.

typedef vtkUnstructuredGridVolumeMapper vtkUnstructuredGridVolumeZSweepMapper::Superclass

Reimplemented from vtkUnstructuredGridVolumeMapper.
Definition at line 67 of file vtkUnstructuredGridVolumeZSweepMapper.h.

Constructor & Destructor Documentation

vtkUnstructuredGridVolumeZSweepMapper::vtkUnstructuredGridVolumeZSweepMapper ( ) [protected]

vtkUnstructuredGridVolumeZSweepMapper::~vtkUnstructuredGridVolumeZSweepMapper ( ) [protected]

vtkUnstructuredGridVolumeZSweepMapper::vtkUnstructuredGridVolumeZSweepMapper ( ) [protected]

vtkUnstructuredGridVolumeZSweepMapper::~vtkUnstructuredGridVolumeZSweepMapper ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkUnstructuredGridVolumeMapper.

static int vtkUnstructuredGridVolumeZSweepMapper::IsTypeOf ( const char * type ) [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 * type ) [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::SetScalarMode ( int ) [virtual]

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors.

virtual int vtkUnstructuredGridVolumeZSweepMapper::GetScalarMode ( ) [virtual]

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors.

void vtkUnstructuredGridVolumeZSweepMapper::SetScalarModeToDefault ( ) [inline]

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors.
Definition at line 89 of file vtkUnstructuredGridVolumeZSweepMapper.h.
References VTK_SCALAR_MODE_DEFAULT.

void vtkUnstructuredGridVolumeZSweepMapper::SetScalarModeToUsePointData ( ) [inline]

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors.
Definition at line 91 of file vtkUnstructuredGridVolumeZSweepMapper.h.
References VTK_SCALAR_MODE_USE_POINT_DATA.

void vtkUnstructuredGridVolumeZSweepMapper::SetScalarModeToUseCellData ( ) [inline]

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors.
Definition at line 93 of file vtkUnstructuredGridVolumeZSweepMapper.h.
References VTK_SCALAR_MODE_USE_CELL_DATA.

void vtkUnstructuredGridVolumeZSweepMapper::SetScalarModeToUsePointFieldData ( ) [inline]

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors.
Definition at line 95 of file vtkUnstructuredGridVolumeZSweepMapper.h.
References VTK_SCALAR_MODE_USE_POINT_FIELD_DATA.

void vtkUnstructuredGridVolumeZSweepMapper::SetScalarModeToUseCellFieldData ( ) [inline]

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors.
Definition at line 97 of file vtkUnstructuredGridVolumeZSweepMapper.h.
References VTK_SCALAR_MODE_USE_CELL_FIELD_DATA.

virtual void vtkUnstructuredGridVolumeZSweepMapper::SelectScalarArray ( int arrayNum ) [virtual]

When ScalarMode is set to UsePointFileData or UseCellFieldData, you can specify which array to use for coloring using these methods. The transfer function in the vtkVolumeProperty (attached to the calling vtkVolume) will decide how to convert vectors to colors.

virtual void vtkUnstructuredGridVolumeZSweepMapper::SelectScalarArray ( const char * arrayName ) [virtual]

When ScalarMode is set to UsePointFileData or UseCellFieldData, you can specify which array to use for coloring using these methods. The transfer function in the vtkVolumeProperty (attached to the calling vtkVolume) will decide how to convert vectors to colors.

virtual char* vtkUnstructuredGridVolumeZSweepMapper::GetArrayName ( ) [inline, virtual]

Get the array name or number and component to color by.
Definition at line 112 of file vtkUnstructuredGridVolumeZSweepMapper.h.

virtual int vtkUnstructuredGridVolumeZSweepMapper::GetArrayId ( ) [inline, virtual]

Get the array name or number and component to color by.
Definition at line 113 of file vtkUnstructuredGridVolumeZSweepMapper.h.

virtual int vtkUnstructuredGridVolumeZSweepMapper::GetArrayAccessMode ( ) [inline, virtual]

Get the array name or number and component to color by.
Definition at line 114 of file vtkUnstructuredGridVolumeZSweepMapper.h.

const char* vtkUnstructuredGridVolumeZSweepMapper::GetScalarModeAsString ( )

Return the method for obtaining scalar data.

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]

Return the method for obtaining scalar data.

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

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]

Change the maximum size allowed for a pixel list. It is an advanced parameter.
Precondition:
positive_size: size>0

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.

void vtkUnstructuredGridVolumeZSweepMapper::ReorderTriangle ( vtkIdType v[3],

vtkIdType w[3]

) [protected]

Reorder vertices `v' in increasing order in `w'. Orientation does not matter for the algorithm.

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

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.

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] ) [protected]

Perform scan conversion of a triangle face.

void vtkUnstructuredGridVolumeZSweepMapper::RasterizeTriangle ( vtkVertexEntry * ve0,

vtkVertexEntry * ve1,

vtkVertexEntry * ve2

) [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,

vtkScreenEdge * left,

vtkScreenEdge * right

) [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 ( vtkVertexEntry * v0,

vtkVertexEntry * v1

) [protected]

Scan conversion of a straight line defined by endpoints v0 and v1.
Precondition:
v0_exists: v0!=0
v1_exists: v1!=0
y_ordered v0->GetScreenY()<=v1->GetScreenY()

void vtkUnstructuredGridVolumeZSweepMapper::StoreRenderTime ( vtkRenderer * ren,

vtkVolume * vol,

float t

) [protected]

float vtkUnstructuredGridVolumeZSweepMapper::RetrieveRenderTime ( vtkRenderer * ren,

vtkVolume * vol

) [protected]

double vtkUnstructuredGridVolumeZSweepMapper::GetZBufferValue ( int x,

int y

) [protected]

Return the value of the z-buffer at screen coordinates (x,y).

double vtkUnstructuredGridVolumeZSweepMapper::GetMinimumBoundsDepth ( vtkRenderer * ren,

vtkVolume * vol

) [protected]

void vtkUnstructuredGridVolumeZSweepMapper::AllocateUseSet ( vtkIdType size ) [protected]

Allocate an array of usesets of size `size' only if the current one is not large enough. Otherwise clear each use set of each vertex.

void vtkUnstructuredGridVolumeZSweepMapper::AllocateVertices ( vtkIdType size ) [protected]

Allocate a vertex array of size `size' only if the current one is not large enough.

void vtkUnstructuredGridVolumeZSweepMapper::SavePixelListFrame ( ) [protected]

For debugging purpose, save the pixel list frame as a dataset.

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

Reimplemented from vtkUnstructuredGridVolumeMapper.

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

Reimplemented from vtkUnstructuredGridVolumeMapper.

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

Set MaxPixelListSize to 32.
Reimplemented from vtkAlgorithm.

void vtkUnstructuredGridVolumeZSweepMapper::SetScalarModeToDefault ( ) [inline]

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors.
Definition at line 86 of file vtkUnstructuredGridVolumeZSweepMapper.h.
References VTK_SCALAR_MODE_DEFAULT.

void vtkUnstructuredGridVolumeZSweepMapper::SetScalarModeToUsePointData ( ) [inline]

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors.
Definition at line 88 of file vtkUnstructuredGridVolumeZSweepMapper.h.
References VTK_SCALAR_MODE_USE_POINT_DATA.

void vtkUnstructuredGridVolumeZSweepMapper::SetScalarModeToUseCellData ( ) [inline]

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors.
Definition at line 90 of file vtkUnstructuredGridVolumeZSweepMapper.h.
References VTK_SCALAR_MODE_USE_CELL_DATA.

void vtkUnstructuredGridVolumeZSweepMapper::SetScalarModeToUsePointFieldData ( ) [inline]

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors.
Definition at line 92 of file vtkUnstructuredGridVolumeZSweepMapper.h.
References VTK_SCALAR_MODE_USE_POINT_FIELD_DATA.

void vtkUnstructuredGridVolumeZSweepMapper::SetScalarModeToUseCellFieldData ( ) [inline]

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors.
Definition at line 94 of file vtkUnstructuredGridVolumeZSweepMapper.h.
References VTK_SCALAR_MODE_USE_CELL_FIELD_DATA.

virtual char* vtkUnstructuredGridVolumeZSweepMapper::GetArrayName ( ) [inline, virtual]

Get the array name or number and component to color by.
Definition at line 109 of file vtkUnstructuredGridVolumeZSweepMapper.h.

virtual int vtkUnstructuredGridVolumeZSweepMapper::GetArrayId ( ) [inline, virtual]

Get the array name or number and component to color by.
Definition at line 110 of file vtkUnstructuredGridVolumeZSweepMapper.h.