ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkPVImageSliceMapper Class Reference

Mapper for vtkImageData that renders the image using a texture applied to a quad. More...

#include <vtkPVImageSliceMapper.h>

Inheritance diagram for vtkPVImageSliceMapper:
Inheritance graph
[legend]
Collaboration diagram for vtkPVImageSliceMapper:
Collaboration graph
[legend]

List of all members.

Public Types

enum  { XY_PLANE = VTK_XY_PLANE, YZ_PLANE = VTK_YZ_PLANE, XZ_PLANE = VTK_XZ_PLANE }

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Render (vtkRenderer *ren, vtkActor *act)
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual void SetSliceMode (int)
virtual int GetSliceMode ()
void SetSliceModeToYZPlane ()
void SetSliceModeToXZPlane ()
void SetSliceModeToXYPlane ()
virtual void Update ()
virtual void ShallowCopy (vtkAbstractMapper *m)
void SetPainter (vtkPainter *)
virtual vtkPainterGetPainter ()
void SetInputData (vtkImageData *in)
virtual vtkImageDataGetInput ()
virtual void SetSlice (int)
virtual int GetSlice ()
virtual void SetUseXYPlane (int)
virtual void UseXYPlaneOn ()
virtual void UseXYPlaneOff ()
virtual int GetUseXYPlane ()
virtual void SetPiece (int)
virtual int GetPiece ()
virtual void SetNumberOfPieces (int)
virtual int GetNumberOfPieces ()
virtual void SetNumberOfSubPieces (int)
virtual int GetNumberOfSubPieces ()
virtual void SetGhostLevel (int)
virtual int GetGhostLevel ()
virtual doubleGetBounds ()
virtual void GetBounds (double bounds[6])

Static Public Member Functions

static vtkPVImageSliceMapperNew ()
static int IsTypeOf (const char *type)
static vtkPVImageSliceMapperSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkPVImageSliceMapper ()
 ~vtkPVImageSliceMapper ()
virtual int FillInputPortInformation (int, vtkInformation *)
virtual void RenderPiece (vtkRenderer *ren, vtkActor *act)
void UpdatePainterInformation ()

Protected Attributes

vtkInformationPainterInformation
vtkTimeStamp PainterInformationUpdateTime
vtkPainterPainter
int Piece
int NumberOfSubPieces
int NumberOfPieces
int GhostLevel
int SliceMode
int Slice
int UseXYPlane

Detailed Description

Mapper for vtkImageData that renders the image using a texture applied to a quad.

vtkPVImageSliceMapper is a mapper for vtkImageData that renders the image by loading the image as a texture and then applying it to a quad. For 3D images, this mapper only shows a single Z slice which can be choosen using SetZSlice. By default, the image data scalars are rendering, however, this mapper provides API to select another point or cell data array. Internally, this mapper uses painters similar to those employed by vtkPainterPolyDataMapper.

See also:
vtkPainterPolyDataMapper

Definition at line 39 of file vtkPVImageSliceMapper.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
XY_PLANE 
YZ_PLANE 
XZ_PLANE 

Definition at line 70 of file vtkPVImageSliceMapper.h.


Constructor & Destructor Documentation

vtkPVImageSliceMapper::vtkPVImageSliceMapper ( ) [protected]
vtkPVImageSliceMapper::~vtkPVImageSliceMapper ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkAlgorithm.

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

Reimplemented from vtkMapper.

static int vtkPVImageSliceMapper::IsTypeOf ( const char *  type) [static]

Reimplemented from vtkMapper.

virtual int vtkPVImageSliceMapper::IsA ( const char *  type) [virtual]

Reimplemented from vtkMapper.

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

Reimplemented from vtkMapper.

void vtkPVImageSliceMapper::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Reimplemented from vtkMapper.

virtual void vtkPVImageSliceMapper::Render ( vtkRenderer ren,
vtkActor act 
) [virtual]

This calls RenderPiece (in a for loop is streaming is necessary).

Implements vtkMapper.

virtual void vtkPVImageSliceMapper::ReleaseGraphicsResources ( vtkWindow ) [virtual]

Reimplemented from vtkMapper.

void vtkPVImageSliceMapper::SetPainter ( vtkPainter )

Get/Set the painter that does the actual rendering.

virtual vtkPainter* vtkPVImageSliceMapper::GetPainter ( ) [virtual]

Get/Set the painter that does the actual rendering.

void vtkPVImageSliceMapper::SetInputData ( vtkImageData in)

Specify the input data to map.

virtual vtkImageData* vtkPVImageSliceMapper::GetInput ( ) [virtual]

Specify the input data to map.

Reimplemented from vtkMapper.

virtual void vtkPVImageSliceMapper::SetSlice ( int  ) [virtual]

Set/Get the current X/Y or Z slice number.

virtual int vtkPVImageSliceMapper::GetSlice ( ) [virtual]

Set/Get the current X/Y or Z slice number.

virtual void vtkPVImageSliceMapper::SetSliceMode ( int  ) [virtual]
virtual int vtkPVImageSliceMapper::GetSliceMode ( ) [virtual]
void vtkPVImageSliceMapper::SetSliceModeToYZPlane ( ) [inline]

Definition at line 80 of file vtkPVImageSliceMapper.h.

void vtkPVImageSliceMapper::SetSliceModeToXZPlane ( ) [inline]

Definition at line 82 of file vtkPVImageSliceMapper.h.

void vtkPVImageSliceMapper::SetSliceModeToXYPlane ( ) [inline]

Definition at line 84 of file vtkPVImageSliceMapper.h.

virtual void vtkPVImageSliceMapper::SetUseXYPlane ( int  ) [virtual]

When set, the image slice is always rendered in the XY plane (Z==0) irrespective of the image bounds. Default if Off.

virtual void vtkPVImageSliceMapper::UseXYPlaneOn ( ) [virtual]

When set, the image slice is always rendered in the XY plane (Z==0) irrespective of the image bounds. Default if Off.

virtual void vtkPVImageSliceMapper::UseXYPlaneOff ( ) [virtual]

When set, the image slice is always rendered in the XY plane (Z==0) irrespective of the image bounds. Default if Off.

virtual int vtkPVImageSliceMapper::GetUseXYPlane ( ) [virtual]

When set, the image slice is always rendered in the XY plane (Z==0) irrespective of the image bounds. Default if Off.

virtual void vtkPVImageSliceMapper::Update ( ) [virtual]

Update that sets the update piece first.

Reimplemented from vtkAlgorithm.

virtual void vtkPVImageSliceMapper::SetPiece ( int  ) [virtual]

If you want only a part of the data, specify by setting the piece.

virtual int vtkPVImageSliceMapper::GetPiece ( ) [virtual]

If you want only a part of the data, specify by setting the piece.

virtual void vtkPVImageSliceMapper::SetNumberOfPieces ( int  ) [virtual]

If you want only a part of the data, specify by setting the piece.

virtual int vtkPVImageSliceMapper::GetNumberOfPieces ( ) [virtual]

If you want only a part of the data, specify by setting the piece.

virtual void vtkPVImageSliceMapper::SetNumberOfSubPieces ( int  ) [virtual]

If you want only a part of the data, specify by setting the piece.

virtual int vtkPVImageSliceMapper::GetNumberOfSubPieces ( ) [virtual]

If you want only a part of the data, specify by setting the piece.

virtual void vtkPVImageSliceMapper::SetGhostLevel ( int  ) [virtual]

Set the number of ghost cells to return.

virtual int vtkPVImageSliceMapper::GetGhostLevel ( ) [virtual]

Set the number of ghost cells to return.

virtual double* vtkPVImageSliceMapper::GetBounds ( ) [virtual]

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

Reimplemented from vtkMapper.

virtual void vtkPVImageSliceMapper::GetBounds ( double  bounds[6]) [inline, virtual]

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

Reimplemented from vtkMapper.

Definition at line 118 of file vtkPVImageSliceMapper.h.

virtual void vtkPVImageSliceMapper::ShallowCopy ( vtkAbstractMapper m) [virtual]

Make a shallow copy of this mapper.

Reimplemented from vtkMapper.

virtual int vtkPVImageSliceMapper::FillInputPortInformation ( int  ,
vtkInformation  
) [protected, virtual]

Reimplemented from vtkAlgorithm.

virtual void vtkPVImageSliceMapper::RenderPiece ( vtkRenderer ren,
vtkActor act 
) [protected, virtual]

Perform the actual rendering.

void vtkPVImageSliceMapper::UpdatePainterInformation ( ) [protected]

Called when the PainterInformation becomes obsolete. It is called before Render request is propogated to the painter.


Member Data Documentation

Definition at line 141 of file vtkPVImageSliceMapper.h.

Definition at line 142 of file vtkPVImageSliceMapper.h.

Definition at line 143 of file vtkPVImageSliceMapper.h.

Definition at line 145 of file vtkPVImageSliceMapper.h.

Definition at line 146 of file vtkPVImageSliceMapper.h.

Definition at line 147 of file vtkPVImageSliceMapper.h.

Definition at line 148 of file vtkPVImageSliceMapper.h.

Definition at line 150 of file vtkPVImageSliceMapper.h.

Definition at line 151 of file vtkPVImageSliceMapper.h.

Definition at line 152 of file vtkPVImageSliceMapper.h.


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