ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVImageSliceMapper Class Reference

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

#include <vtkPVImageSliceMapper.h>

Inherits vtkMapper.

Public Types

enum  { XY_PLANE = VTK_XY_PLANE, YZ_PLANE = VTK_YZ_PLANE, XZ_PLANE = VTK_XZ_PLANE }
 
typedef vtkMapper Superclass
 

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)
 This calls RenderPiece (in a for loop is streaming is necessary). More...
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 
virtual void SetSliceMode (int)
 
virtual int GetSliceMode ()
 
void SetSliceModeToYZPlane ()
 
void SetSliceModeToXZPlane ()
 
void SetSliceModeToXYPlane ()
 
virtual void Update (int port)
 Update that sets the update piece first. More...
 
virtual void Update ()
 
virtual int Update (int port, vtkInformationVector *requests)
 
virtual int Update (vtkInformation *requests)
 
virtual void ShallowCopy (vtkAbstractMapper *m)
 Make a shallow copy of this mapper. More...
 
void SetPainter (vtkPainter *)
 Get/Set the painter that does the actual rendering. More...
 
virtual vtkPainter * GetPainter ()
 Get/Set the painter that does the actual rendering. More...
 
void SetInputData (vtkImageData *in)
 Specify the input data to map. More...
 
virtual vtkImageData * GetInput ()
 Specify the input data to map. More...
 
virtual void SetSlice (int)
 Set/Get the current X/Y or Z slice number. More...
 
virtual int GetSlice ()
 Set/Get the current X/Y or Z slice number. More...
 
virtual void SetUseXYPlane (int)
 When set, the image slice is always rendered in the XY plane (Z==0) irrespective of the image bounds. More...
 
virtual void UseXYPlaneOn ()
 When set, the image slice is always rendered in the XY plane (Z==0) irrespective of the image bounds. More...
 
virtual void UseXYPlaneOff ()
 When set, the image slice is always rendered in the XY plane (Z==0) irrespective of the image bounds. More...
 
virtual int GetUseXYPlane ()
 When set, the image slice is always rendered in the XY plane (Z==0) irrespective of the image bounds. More...
 
virtual void SetPiece (int)
 If you want only a part of the data, specify by setting the piece. More...
 
virtual int GetPiece ()
 If you want only a part of the data, specify by setting the piece. More...
 
virtual void SetNumberOfPieces (int)
 If you want only a part of the data, specify by setting the piece. More...
 
virtual int GetNumberOfPieces ()
 If you want only a part of the data, specify by setting the piece. More...
 
virtual void SetNumberOfSubPieces (int)
 If you want only a part of the data, specify by setting the piece. More...
 
virtual int GetNumberOfSubPieces ()
 If you want only a part of the data, specify by setting the piece. More...
 
virtual void SetGhostLevel (int)
 Set the number of ghost cells to return. More...
 
virtual int GetGhostLevel ()
 Set the number of ghost cells to return. More...
 
virtual double * GetBounds ()
 Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
virtual void GetBounds (double bounds[6])
 Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). More...
 

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)
 Perform the actual rendering. More...
 
void UpdatePainterInformation ()
 Called when the PainterInformation becomes obsolete. More...
 

Protected Attributes

vtkInformation * PainterInformation
 
vtkTimeStamp PainterInformationUpdateTime
 
vtkObserver * Observer
 
vtkPainter * Painter
 
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 46 of file vtkPVImageSliceMapper.h.

Member Typedef Documentation

§ Superclass

Definition at line 50 of file vtkPVImageSliceMapper.h.

Member Enumeration Documentation

§ anonymous enum

anonymous enum
Enumerator
XY_PLANE 
YZ_PLANE 
XZ_PLANE 

Definition at line 84 of file vtkPVImageSliceMapper.h.

Constructor & Destructor Documentation

§ vtkPVImageSliceMapper()

vtkPVImageSliceMapper::vtkPVImageSliceMapper ( )
protected

§ ~vtkPVImageSliceMapper()

vtkPVImageSliceMapper::~vtkPVImageSliceMapper ( )
protected

Member Function Documentation

§ New()

static vtkPVImageSliceMapper* vtkPVImageSliceMapper::New ( )
static

§ GetClassName()

virtual const char* vtkPVImageSliceMapper::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

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

§ PrintSelf()

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

§ Render()

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

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

§ ReleaseGraphicsResources()

virtual void vtkPVImageSliceMapper::ReleaseGraphicsResources ( vtkWindow *  )
virtual

§ SetPainter()

void vtkPVImageSliceMapper::SetPainter ( vtkPainter *  )

Get/Set the painter that does the actual rendering.

§ GetPainter()

virtual vtkPainter* vtkPVImageSliceMapper::GetPainter ( )
virtual

Get/Set the painter that does the actual rendering.

§ SetInputData()

void vtkPVImageSliceMapper::SetInputData ( vtkImageData *  in)

Specify the input data to map.

§ GetInput()

virtual vtkImageData* vtkPVImageSliceMapper::GetInput ( )
virtual

Specify the input data to map.

§ SetSlice()

virtual void vtkPVImageSliceMapper::SetSlice ( int  )
virtual

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

§ GetSlice()

virtual int vtkPVImageSliceMapper::GetSlice ( )
virtual

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

§ SetSliceMode()

virtual void vtkPVImageSliceMapper::SetSliceMode ( int  )
virtual

§ GetSliceMode()

virtual int vtkPVImageSliceMapper::GetSliceMode ( )
virtual

§ SetSliceModeToYZPlane()

void vtkPVImageSliceMapper::SetSliceModeToYZPlane ( )
inline

Definition at line 93 of file vtkPVImageSliceMapper.h.

§ SetSliceModeToXZPlane()

void vtkPVImageSliceMapper::SetSliceModeToXZPlane ( )
inline

Definition at line 94 of file vtkPVImageSliceMapper.h.

§ SetSliceModeToXYPlane()

void vtkPVImageSliceMapper::SetSliceModeToXYPlane ( )
inline

Definition at line 95 of file vtkPVImageSliceMapper.h.

§ SetUseXYPlane()

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 is Off.

§ UseXYPlaneOn()

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 is Off.

§ UseXYPlaneOff()

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 is Off.

§ GetUseXYPlane()

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 is Off.

§ Update() [1/4]

virtual void vtkPVImageSliceMapper::Update ( int  port)
virtual

Update that sets the update piece first.

§ Update() [2/4]

virtual void vtkPVImageSliceMapper::Update ( )
inlinevirtual

Definition at line 111 of file vtkPVImageSliceMapper.h.

§ Update() [3/4]

virtual int vtkPVImageSliceMapper::Update ( int  port,
vtkInformationVector *  requests 
)
inlinevirtual

Definition at line 112 of file vtkPVImageSliceMapper.h.

§ Update() [4/4]

virtual int vtkPVImageSliceMapper::Update ( vtkInformation *  requests)
inlinevirtual

Definition at line 116 of file vtkPVImageSliceMapper.h.

§ SetPiece()

virtual void vtkPVImageSliceMapper::SetPiece ( int  )
virtual

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

§ GetPiece()

virtual int vtkPVImageSliceMapper::GetPiece ( )
virtual

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

§ SetNumberOfPieces()

virtual void vtkPVImageSliceMapper::SetNumberOfPieces ( int  )
virtual

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

§ GetNumberOfPieces()

virtual int vtkPVImageSliceMapper::GetNumberOfPieces ( )
virtual

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

§ SetNumberOfSubPieces()

virtual void vtkPVImageSliceMapper::SetNumberOfSubPieces ( int  )
virtual

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

§ GetNumberOfSubPieces()

virtual int vtkPVImageSliceMapper::GetNumberOfSubPieces ( )
virtual

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

§ SetGhostLevel()

virtual void vtkPVImageSliceMapper::SetGhostLevel ( int  )
virtual

Set the number of ghost cells to return.

§ GetGhostLevel()

virtual int vtkPVImageSliceMapper::GetGhostLevel ( )
virtual

Set the number of ghost cells to return.

§ GetBounds() [1/2]

virtual double* vtkPVImageSliceMapper::GetBounds ( )
virtual

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

§ GetBounds() [2/2]

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

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

Definition at line 144 of file vtkPVImageSliceMapper.h.

§ ShallowCopy()

virtual void vtkPVImageSliceMapper::ShallowCopy ( vtkAbstractMapper *  m)
virtual

Make a shallow copy of this mapper.

§ FillInputPortInformation()

virtual int vtkPVImageSliceMapper::FillInputPortInformation ( int  ,
vtkInformation *   
)
protectedvirtual

§ RenderPiece()

virtual void vtkPVImageSliceMapper::RenderPiece ( vtkRenderer *  ren,
vtkActor *  act 
)
protectedvirtual

Perform the actual rendering.

§ UpdatePainterInformation()

void vtkPVImageSliceMapper::UpdatePainterInformation ( )
protected

Called when the PainterInformation becomes obsolete.

It is called before Render request is propogated to the painter.

Member Data Documentation

§ PainterInformation

vtkInformation* vtkPVImageSliceMapper::PainterInformation
protected

Definition at line 177 of file vtkPVImageSliceMapper.h.

§ PainterInformationUpdateTime

vtkTimeStamp vtkPVImageSliceMapper::PainterInformationUpdateTime
protected

Definition at line 178 of file vtkPVImageSliceMapper.h.

§ Observer

vtkObserver* vtkPVImageSliceMapper::Observer
protected

Definition at line 180 of file vtkPVImageSliceMapper.h.

§ Painter

vtkPainter* vtkPVImageSliceMapper::Painter
protected

Definition at line 184 of file vtkPVImageSliceMapper.h.

§ Piece

int vtkPVImageSliceMapper::Piece
protected

Definition at line 186 of file vtkPVImageSliceMapper.h.

§ NumberOfSubPieces

int vtkPVImageSliceMapper::NumberOfSubPieces
protected

Definition at line 187 of file vtkPVImageSliceMapper.h.

§ NumberOfPieces

int vtkPVImageSliceMapper::NumberOfPieces
protected

Definition at line 188 of file vtkPVImageSliceMapper.h.

§ GhostLevel

int vtkPVImageSliceMapper::GhostLevel
protected

Definition at line 189 of file vtkPVImageSliceMapper.h.

§ SliceMode

int vtkPVImageSliceMapper::SliceMode
protected

Definition at line 191 of file vtkPVImageSliceMapper.h.

§ Slice

int vtkPVImageSliceMapper::Slice
protected

Definition at line 192 of file vtkPVImageSliceMapper.h.

§ UseXYPlane

int vtkPVImageSliceMapper::UseXYPlane
protected

Definition at line 193 of file vtkPVImageSliceMapper.h.


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