Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkImageMapper Class Reference

2D image display. More...

#include <vtkImageMapper.h>

Inheritance diagram for vtkImageMapper:

Inheritance graph
[legend]
Collaboration diagram for vtkImageMapper:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
unsigned long int GetMTime ()
virtual void SetColorWindow (float)
virtual float GetColorWindow ()
virtual void SetColorLevel (float)
virtual float GetColorLevel ()
virtual void SetInput (vtkImageData *)
virtual vtkImageData * GetInput ()
virtual void SetZSlice (int)
virtual int GetZSlice ()
int GetWholeZMin ()
int GetWholeZMax ()
void RenderStart (vtkViewport *viewport, vtkActor2D *actor)
virtual void RenderData (vtkViewport *, vtkImageData *, vtkActor2D *)=0
float GetColorShift ()
float GetColorScale ()
virtual void SetRenderToRectangle (int)
virtual int GetRenderToRectangle ()
virtual void RenderToRectangleOn ()
virtual void RenderToRectangleOff ()
virtual void SetUseCustomExtents (int)
virtual int GetUseCustomExtents ()
virtual void UseCustomExtentsOn ()
virtual void UseCustomExtentsOff ()
virtual void SetCustomDisplayExtents (int data[])
virtual int * GetCustomDisplayExtents ()
virtual void GetCustomDisplayExtents (int data[4])

Static Public Methods

int IsTypeOf (const char *type)
vtkImageMapper * SafeDownCast (vtkObject *o)
vtkImageMapper * New ()

Public Attributes

int DisplayExtent [6]

Protected Methods

 vtkImageMapper ()
 ~vtkImageMapper ()
 vtkImageMapper (const vtkImageMapper &)
void operator= (const vtkImageMapper &)

Protected Attributes

vtkImageData * Input
float ColorWindow
float ColorLevel
int PositionAdjustment [2]
int ZSlice
int UseCustomExtents
int CustomDisplayExtents [4]
int RenderToRectangle

Detailed Description

2D image display.

Date:
2000/12/11 12:51:02
Revision:
1.22
Thanks:
Thanks to Matt Turek who developed this class.
vtkImageMapper provides 2D image display support for vtk. It is a Mapper2D subclass that can be associated with an Actor2D and placed within a RenderWindow or ImageWindow.

See also:
vtkMapper2D vtkActor2D
Examples:
vtkImageMapper (examples)

Definition at line 67 of file vtkImageMapper.h.

Constructor & Destructor Documentation

vtkImageMapper::vtkImageMapper (    )  [protected]
 

vtkImageMapper::~vtkImageMapper (    )  [protected]
 

vtkImageMapper::vtkImageMapper (  const vtkImageMapper &    )  [inline, protected]
 

Definition at line 138 of file vtkImageMapper.h.

Member Function Documentation

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkMapper2D.

Reimplemented in vtkMesaImageMapper, vtkOpenGLImageMapper, vtkWin32ImageMapper, and vtkXImageMapper.

int vtkImageMapper::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkMapper2D.

Reimplemented in vtkMesaImageMapper, vtkOpenGLImageMapper, vtkWin32ImageMapper, and vtkXImageMapper.

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

Reimplemented from vtkMapper2D.

Reimplemented in vtkMesaImageMapper, vtkOpenGLImageMapper, vtkWin32ImageMapper, and vtkXImageMapper.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkMapper2D.

Reimplemented in vtkMesaImageMapper, vtkOpenGLImageMapper, vtkWin32ImageMapper, and vtkXImageMapper.

vtkImageMapper* vtkImageMapper::New (    )  [static]
 

Instantiate object with no start, end, or progress methods.

Reimplemented from vtkMapper2D.

Reimplemented in vtkMesaImageMapper, vtkOpenGLImageMapper, vtkWin32ImageMapper, and vtkXImageMapper.

void vtkImageMapper::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 vtkMapper2D.

Reimplemented in vtkWin32ImageMapper, and vtkXImageMapper.

unsigned long int vtkImageMapper::GetMTime (    )  [virtual]
 

Override Modifiedtime as we have added a lookuptable

Reimplemented from vtkObject.

Reimplemented in vtkWin32ImageMapper.

virtual void vtkImageMapper::SetColorWindow (  float    )  [virtual]
 

Set/Get the window value for window/level

virtual float vtkImageMapper::GetColorWindow (    )  [virtual]
 

virtual void vtkImageMapper::SetColorLevel (  float    )  [virtual]
 

Set/Get the level value for window/level

virtual float vtkImageMapper::GetColorLevel (    )  [virtual]
 

virtual void vtkImageMapper::SetInput (  vtkImageData *    )  [virtual]
 

Set/Get the input for the image mapper.

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

virtual void vtkImageMapper::SetZSlice (  int    )  [virtual]
 

Set/Get the current slice number. The axis Z in ZSlice does not necessarily have any relation to the z axis of the data on disk. It is simply the axis orthogonal to the x,y, display plane. GetWholeZMax and Min are convenience methods for obtaining the number of slices that can be displayed. Again the number of slices is in reference to the display z axis, which is not necessarily the z axis on disk. (due to reformatting etc)

virtual int vtkImageMapper::GetZSlice (    )  [virtual]
 

int vtkImageMapper::GetWholeZMin (    ) 
 

int vtkImageMapper::GetWholeZMax (    ) 
 

void vtkImageMapper::RenderStart (  vtkViewport *    viewport,
vtkActor2D *    actor
) 
 

Draw the image to the screen.

Referenced by vtkOpenGLImageMapper::RenderOpaqueGeometry(), vtkMesaImageMapper::RenderOpaqueGeometry(), vtkXImageMapper::RenderOverlay(), and vtkWin32ImageMapper::RenderOverlay().

virtual void vtkImageMapper::RenderData (  vtkViewport *    viewport,
vtkImageData *    data,
vtkActor2D *    actor
)  [pure virtual]
 

Function called by Render to actually draw the image to to the screen

Reimplemented in vtkMesaImageMapper, vtkOpenGLImageMapper, vtkWin32ImageMapper, and vtkXImageMapper.

float vtkImageMapper::GetColorShift (    ) 
 

Methods used internally for performing the Window/Level mapping.

float vtkImageMapper::GetColorScale (    ) 
 

virtual void vtkImageMapper::SetRenderToRectangle (  int    )  [virtual]
 

If RenderToRectangle is set (by default not), then the imagemapper will render the image into the rectangle supplied by the Actor2D's PositionCoordinate and Position2Coordinate

virtual int vtkImageMapper::GetRenderToRectangle (    )  [virtual]
 

virtual void vtkImageMapper::RenderToRectangleOn (    )  [virtual]
 

virtual void vtkImageMapper::RenderToRectangleOff (    )  [virtual]
 

virtual void vtkImageMapper::SetUseCustomExtents (  int    )  [virtual]
 

Usually, the entire image is displayed, if UseCustomExtents is set (by default not), then the region supplied in the CustomDisplayExtents is used in preference. Note that the Custom extents are x,y only and the zslice is still applied

virtual int vtkImageMapper::GetUseCustomExtents (    )  [virtual]
 

virtual void vtkImageMapper::UseCustomExtentsOn (    )  [virtual]
 

virtual void vtkImageMapper::UseCustomExtentsOff (    )  [virtual]
 

virtual void vtkImageMapper::SetCustomDisplayExtents (  int    data[] )  [virtual]
 

The image extents which should be displayed with UseCustomExtents Note that the Custom extents are x,y only and the zslice is still applied

virtual int* vtkImageMapper::GetCustomDisplayExtents (    )  [virtual]
 

virtual void vtkImageMapper::GetCustomDisplayExtents (  int    data[4] )  [virtual]
 

void vtkImageMapper::operator= (  const vtkImageMapper &    )  [inline, protected]
 

Definition at line 139 of file vtkImageMapper.h.

Member Data Documentation

int vtkImageMapper::DisplayExtent[6]
 

Definition at line 112 of file vtkImageMapper.h.

vtkImageData* vtkImageMapper::Input [protected]
 

Definition at line 141 of file vtkImageMapper.h.

float vtkImageMapper::ColorWindow [protected]
 

Definition at line 142 of file vtkImageMapper.h.

float vtkImageMapper::ColorLevel [protected]
 

Definition at line 143 of file vtkImageMapper.h.

int vtkImageMapper::PositionAdjustment[2] [protected]
 

Definition at line 145 of file vtkImageMapper.h.

int vtkImageMapper::ZSlice [protected]
 

Definition at line 146 of file vtkImageMapper.h.

int vtkImageMapper::UseCustomExtents [protected]
 

Definition at line 147 of file vtkImageMapper.h.

int vtkImageMapper::CustomDisplayExtents[4] [protected]
 

Definition at line 148 of file vtkImageMapper.h.

int vtkImageMapper::RenderToRectangle [protected]
 

Definition at line 149 of file vtkImageMapper.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:48:44 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001