VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends
vtkImageSliceMapper Class Reference

map a slice of a vtkImageData to the screen More...

#include <vtkImageSliceMapper.h>

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

List of all members.

Public Types

typedef vtkImageMapper3D Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Update ()
virtual void Render (vtkRenderer *renderer, vtkImageSlice *prop)
virtual void ReleaseGraphicsResources (vtkWindow *)
unsigned long GetMTime ()
virtual void SetSliceNumber (int slice)
virtual int GetSliceNumber ()
virtual int GetSliceNumberMinValue ()
virtual int GetSliceNumberMaxValue ()
virtual void SetOrientation (int)
virtual int GetOrientation ()
void SetOrientationToX ()
void SetOrientationToY ()
void SetOrientationToZ ()
virtual void SetCropping (int)
virtual void CroppingOn ()
virtual void CroppingOff ()
virtual int GetCropping ()
virtual void SetCroppingRegion (int, int, int, int, int, int)
virtual void SetCroppingRegion (int[6])
virtual intGetCroppingRegion ()
virtual void GetCroppingRegion (int &, int &, int &, int &, int &, int &)
virtual void GetCroppingRegion (int[6])
doubleGetBounds ()
void GetBounds (double bounds[6])
virtual void GetSlicePlaneInDataCoords (vtkMatrix4x4 *propMatrix, double plane[4])
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)

Static Public Member Functions

static vtkImageSliceMapperNew ()
static int IsTypeOf (const char *type)
static vtkImageSliceMapperSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageSliceMapper ()
 ~vtkImageSliceMapper ()
int GetOrientationFromCamera (vtkMatrix4x4 *propMatrix, vtkCamera *camera)
int GetSliceFromCamera (vtkMatrix4x4 *propMatrix, vtkCamera *camera)
void SetPoints (vtkPoints *points)
vtkPointsGetPoints ()
void SetExactPixelMatch (int v)
void SetPassColorData (int v)
void SetDisplayExtent (int extent[6])

Static Protected Member Functions

static void GetDimensionIndices (int orientation, int &xdim, int &ydim)

Protected Attributes

int SliceNumber
int SliceNumberMinValue
int SliceNumberMaxValue
int Orientation
int Cropping
int CroppingRegion [6]
int DisplayExtent [6]
int ExactPixelMatch
int PassColorData
vtkPointsPoints
vtkTimeStamp UpdateTime

Friends

class vtkImageResliceMapper

Detailed Description

map a slice of a vtkImageData to the screen

vtkImageSliceMapper is a mapper that will draw a 2D image, or a slice of a 3D image. For 3D images, the slice may be oriented in the X, Y, or Z direction. This mapper works via 2D textures with accelerated zoom and pan operations.

Thanks:
Thanks to David Gobbi at the Seaman Family MR Centre and Dept. of Clinical Neurosciences, Foothills Medical Centre, Calgary, for providing this class.
See also:
vtkImageSlice vtkImageProperty vtkImageResliceMapper
Tests:
vtkImageSliceMapper (Tests)

Definition at line 40 of file vtkImageSliceMapper.h.


Member Typedef Documentation

Reimplemented from vtkImageMapper3D.

Reimplemented in vtkMesaImageSliceMapper, and vtkOpenGLImageSliceMapper.

Definition at line 44 of file vtkImageSliceMapper.h.


Constructor & Destructor Documentation

vtkImageSliceMapper::vtkImageSliceMapper ( ) [protected]
vtkImageSliceMapper::~vtkImageSliceMapper ( ) [protected]

Member Function Documentation

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

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

Reimplemented from vtkAlgorithm.

Reimplemented in vtkMesaImageSliceMapper, and vtkOpenGLImageSliceMapper.

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

Reimplemented from vtkImageMapper3D.

Reimplemented in vtkMesaImageSliceMapper, and vtkOpenGLImageSliceMapper.

static int vtkImageSliceMapper::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 vtkImageMapper3D.

Reimplemented in vtkMesaImageSliceMapper, and vtkOpenGLImageSliceMapper.

virtual int vtkImageSliceMapper::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 vtkImageMapper3D.

Reimplemented in vtkMesaImageSliceMapper, and vtkOpenGLImageSliceMapper.

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

Reimplemented from vtkImageMapper3D.

Reimplemented in vtkMesaImageSliceMapper, and vtkOpenGLImageSliceMapper.

void vtkImageSliceMapper::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 vtkImageMapper3D.

Reimplemented in vtkMesaImageSliceMapper, and vtkOpenGLImageSliceMapper.

virtual void vtkImageSliceMapper::SetSliceNumber ( int  slice) [virtual]

The slice to display, if there are multiple slices.

virtual int vtkImageSliceMapper::GetSliceNumber ( ) [virtual]

The slice to display, if there are multiple slices.

virtual int vtkImageSliceMapper::GetSliceNumberMinValue ( ) [virtual]

Use GetSliceNumberMinValue() and GetSliceNumberMaxValue() to get the range of allowed slices. These methods call UpdateInformation as a side-effect.

virtual int vtkImageSliceMapper::GetSliceNumberMaxValue ( ) [virtual]

Use GetSliceNumberMinValue() and GetSliceNumberMaxValue() to get the range of allowed slices. These methods call UpdateInformation as a side-effect.

virtual void vtkImageSliceMapper::SetOrientation ( int  ) [virtual]

Set the orientation of the slices to display. The default orientation is 2, which is Z.

virtual int vtkImageSliceMapper::GetOrientation ( ) [virtual]

Set the orientation of the slices to display. The default orientation is 2, which is Z.

void vtkImageSliceMapper::SetOrientationToX ( ) [inline]

Set the orientation of the slices to display. The default orientation is 2, which is Z.

Definition at line 66 of file vtkImageSliceMapper.h.

void vtkImageSliceMapper::SetOrientationToY ( ) [inline]

Set the orientation of the slices to display. The default orientation is 2, which is Z.

Definition at line 67 of file vtkImageSliceMapper.h.

void vtkImageSliceMapper::SetOrientationToZ ( ) [inline]

Set the orientation of the slices to display. The default orientation is 2, which is Z.

Definition at line 68 of file vtkImageSliceMapper.h.

virtual void vtkImageSliceMapper::SetCropping ( int  ) [virtual]

Use the specified CroppingRegion. The default is to display the full slice.

virtual void vtkImageSliceMapper::CroppingOn ( ) [virtual]

Use the specified CroppingRegion. The default is to display the full slice.

virtual void vtkImageSliceMapper::CroppingOff ( ) [virtual]

Use the specified CroppingRegion. The default is to display the full slice.

virtual int vtkImageSliceMapper::GetCropping ( ) [virtual]

Use the specified CroppingRegion. The default is to display the full slice.

virtual void vtkImageSliceMapper::SetCroppingRegion ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
) [virtual]

Set the display extent. This is ignored unless Cropping is set.

virtual void vtkImageSliceMapper::SetCroppingRegion ( int  [6]) [virtual]

Set the display extent. This is ignored unless Cropping is set.

virtual int* vtkImageSliceMapper::GetCroppingRegion ( ) [virtual]

Set the display extent. This is ignored unless Cropping is set.

virtual void vtkImageSliceMapper::GetCroppingRegion ( int ,
int ,
int ,
int ,
int ,
int  
) [virtual]

Set the display extent. This is ignored unless Cropping is set.

virtual void vtkImageSliceMapper::GetCroppingRegion ( int  [6]) [virtual]

Set the display extent. This is ignored unless Cropping is set.

virtual void vtkImageSliceMapper::Update ( ) [virtual]

Override Update to handle some tricky details.

Reimplemented from vtkAlgorithm.

virtual void vtkImageSliceMapper::Render ( vtkRenderer renderer,
vtkImageSlice prop 
) [virtual]

This should only be called by the renderer.

Implements vtkImageMapper3D.

Reimplemented in vtkMesaImageSliceMapper, and vtkOpenGLImageSliceMapper.

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

Release any graphics resources that are being consumed by this mapper. The parameter window is used to determine which graphic resources to release.

Implements vtkImageMapper3D.

Reimplemented in vtkMesaImageSliceMapper, and vtkOpenGLImageSliceMapper.

unsigned long vtkImageSliceMapper::GetMTime ( ) [virtual]

Get the mtime for the mapper.

Reimplemented from vtkAbstractMapper.

double* vtkImageSliceMapper::GetBounds ( ) [virtual]

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

Implements vtkAbstractMapper3D.

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

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

Reimplemented from vtkAbstractMapper3D.

Definition at line 103 of file vtkImageSliceMapper.h.

virtual void vtkImageSliceMapper::GetSlicePlaneInDataCoords ( vtkMatrix4x4 propMatrix,
double  plane[4] 
) [virtual]

Get the plane as a homogeneous 4-vector that gives the plane equation coefficients. It is computed from the Orientation and SliceNumber, the propMatrix is unused and can be zero.

Reimplemented from vtkImageMapper3D.

virtual int vtkImageSliceMapper::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inInfo,
vtkInformationVector outInfo 
) [virtual]

Handle requests from the pipeline executive.

Reimplemented from vtkImageMapper3D.

void vtkImageSliceMapper::SetPoints ( vtkPoints points) [protected]

Set points that describe a polygon on which the slice will be rendered.

vtkPoints* vtkImageSliceMapper::GetPoints ( ) [inline, protected]

Set points that describe a polygon on which the slice will be rendered.

Definition at line 130 of file vtkImageSliceMapper.h.

void vtkImageSliceMapper::SetExactPixelMatch ( int  v) [inline, protected]

Force linear interpolation. Internal method, for when this mapper is used as a helper class.

Definition at line 136 of file vtkImageSliceMapper.h.

void vtkImageSliceMapper::SetPassColorData ( int  v) [inline, protected]

Pass color data. Internal method, for when this mapper is used as a helper class.

Definition at line 143 of file vtkImageSliceMapper.h.

void vtkImageSliceMapper::SetDisplayExtent ( int  extent[6]) [inline, protected]

Set the display extent. Internal method, for when this mapper is used as a helper class.

Definition at line 150 of file vtkImageSliceMapper.h.

int vtkImageSliceMapper::GetOrientationFromCamera ( vtkMatrix4x4 propMatrix,
vtkCamera camera 
) [protected]

Get the camera orientation as a simple integer [0,1,2,3,4,5] that indicates one of the six major directions. The integers 0,1,2 are x,y,z and 3,4,5 are -x,-y,-z.

int vtkImageSliceMapper::GetSliceFromCamera ( vtkMatrix4x4 propMatrix,
vtkCamera camera 
) [protected]

Get the current slice as the one closest to the focal point.

static void vtkImageSliceMapper::GetDimensionIndices ( int  orientation,
int xdim,
int ydim 
) [static, protected]

Get the dimension indices according to the orientation.


Friends And Related Function Documentation

friend class vtkImageResliceMapper [friend]

Definition at line 186 of file vtkImageSliceMapper.h.


Member Data Documentation

Definition at line 170 of file vtkImageSliceMapper.h.

Definition at line 171 of file vtkImageSliceMapper.h.

Definition at line 172 of file vtkImageSliceMapper.h.

Definition at line 173 of file vtkImageSliceMapper.h.

Definition at line 174 of file vtkImageSliceMapper.h.

Definition at line 175 of file vtkImageSliceMapper.h.

Definition at line 176 of file vtkImageSliceMapper.h.

Definition at line 177 of file vtkImageSliceMapper.h.

Definition at line 178 of file vtkImageSliceMapper.h.

Definition at line 179 of file vtkImageSliceMapper.h.

Definition at line 180 of file vtkImageSliceMapper.h.


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