mitkVolumeRenderer Class Reference

mitkVolumeRenderer - an abstract class for volume rendering More...

#include <mitkVolumeRenderer.h>

Inherits mitkRenderer.

Inherited by mitkOoCVolumeRendererRayCasting, mitkOoCVolumeRendererRayCastingEx, mitkOoCVolumeRendererShearWarp, mitkOoCVolumeRendererTexture3D, mitkOoCVolumeRendererTexture3DEx, mitkVolumeRendererRayCasting, mitkVolumeRendererRayCastingLoD, mitkVolumeRendererSplatting, and mitkVolumeRendererTexture3D.

Inheritance diagram for mitkVolumeRenderer:

[legend]Collaboration diagram for mitkVolumeRenderer:

[legend]List of all members.

Public Member Functions
virtual void	PrintSelf (ostream &os)
void	SetCropping (bool isCropping)
void	CroppingOn ()
void	CroppingOff ()
int	GetCropping ()
void	SetCroppingRegionPlanes (float region[6])
void	SetCroppingRegionPlanes (float xmin, float xmax, float ymin, float ymax, float zmin, float zmax)
float *	GetCroppingRegionPlanes ()
void	GetCroppingRegionPlanes (float &xmin, float &xmax, float &ymin, float &ymax, float &zmin, float &zmax)
void	SetCroppingRegionFlags (int flags)
int	GetCroppingRegionFlags ()
void	SetCroppingRegionFlagsToSubVolume ()
void	SetCroppingRegionFlagsToFence ()
void	SetCroppingRegionFlagsToInvertedFence ()
void	SetCroppingRegionFlagsToCross ()
void	SetCroppingRegionFlagsToInvertedCross ()
void	SetClassifyMethod (int classifyMethod)
int	GetClassifyMethod ()
void	SetClassifyMethodToPreClassification ()
void	SetClassifyMethodToPostClassification ()
void	SetClassifyMethodToPreIntegration ()
virtual int	Render (mitkScene *scene, mitkVolumeModel *vol)=0

---

Detailed Description

mitkVolumeRenderer - an abstract class for volume rendering

mitkVolumeRenderer is an abstract class for volume rendering. Its concrete subclasses implement the actual volume rendering algorithm. Some codes are borrowed from VTK, and please see the copyright at end.

---

Member Function Documentation

void mitkVolumeRenderer::CroppingOff (   )  [inline]

Turn Off cropping

void mitkVolumeRenderer::CroppingOn (   )  [inline]

Turn On cropping

int mitkVolumeRenderer::GetClassifyMethod (   )  [inline]

Get the classification method used by volume rendering algorithm. Returns: Return the classification method. Return MITK_PRE_CLASSIFICATION, the classfication method is PreClassification (classify first). Return MITK_POST_CLASSIFICATION, the classfication method is PostClassification (interpolation first). Return MITK_PRE_INTEGRATION, the classfication method is Pre-integration.

int mitkVolumeRenderer::GetCropping (   )  [inline]

Get the status (On or Off) of cropping. Returns: Return non-zero value, cropping is On. Return zero, cropping is Off.

int mitkVolumeRenderer::GetCroppingRegionFlags (   )  [inline]

Get the flags for the cropping regions. Returns: Return the cropping flag

void mitkVolumeRenderer::GetCroppingRegionPlanes (  float &  xmin, float &  xmax, float &  ymin, float &  ymax, float &  zmin, float &  zmax )  [inline]

Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) Parameters: xmin  Return the xmin of cropping region xmax  Return the xmax of cropping region ymin  Return the ymin of cropping region ymax  Return the ymax of cropping region zmin  Return the zmin of cropping region zmax  Return the zmax of cropping region

float* mitkVolumeRenderer::GetCroppingRegionPlanes (   )  [inline]

Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) Returns: Return a float array, the elements is xmin, xmax, ymin, ymax, zmin, zmax in turn.

virtual void mitkVolumeRenderer::PrintSelf (  ostream &  os  )  [virtual]

Print the necessary information about this object for the debugging purpose. Parameters: os  The specified ostream to output information. Reimplemented from mitkRenderer. Reimplemented in mitkOoCVolumeRendererRayCasting, mitkOoCVolumeRendererRayCastingEx, mitkOoCVolumeRendererShearWarp, mitkOoCVolumeRendererTexture3D, mitkOoCVolumeRendererTexture3DEx, mitkVolumeRendererRayCasting, mitkVolumeRendererRayCastingLoD, mitkVolumeRendererSplatting, and mitkVolumeRendererTexture3D.

virtual int mitkVolumeRenderer::Render (  mitkScene *  scene, mitkVolumeModel *  vol )  [pure virtual]

Internal function. Don't call it directly. Implemented in mitkOoCVolumeRendererRayCasting, mitkOoCVolumeRendererRayCastingEx, mitkOoCVolumeRendererShearWarp, mitkOoCVolumeRendererTexture3D, mitkOoCVolumeRendererTexture3DEx, mitkVolumeRendererRayCasting, mitkVolumeRendererRayCastingLoD, mitkVolumeRendererSplatting, and mitkVolumeRendererTexture3D.

void mitkVolumeRenderer::SetClassifyMethod (  int  classifyMethod  )  [inline]

Set the classification method used by volume rendering algorithm. Parameters: classifyMethod  Specify the classification method. classifyMethod = MITK_PRE_CLASSIFICATION, set the classfication method to PreClassification (classify first). classifyMethod = MITK_POST_CLASSIFICATION, set the classfication method to PostClassification (interpolation first). classifyMethod = MITK_PRE_INTEGRATION, set the classfication method to Pre-integration.

void mitkVolumeRenderer::SetClassifyMethodToPostClassification (   )  [inline]

Set the classification method to PostClassification (interpolation first).

void mitkVolumeRenderer::SetClassifyMethodToPreClassification (   )  [inline]

Set the classification method to PreClassification (classify first).

void mitkVolumeRenderer::SetClassifyMethodToPreIntegration (   )  [inline]

Set the classification method to Pre-integration.

void mitkVolumeRenderer::SetCropping (  bool  isCropping  )  [inline]

Turn On / Off cropping Parameters: isCropping  isCropping = true, turn on cropping isCropping = false, turn off cropping

void mitkVolumeRenderer::SetCroppingRegionFlags (  int  flags  )  [inline]

Set the flags for the cropping regions. Parameters: flags  Specify the cropping flag

void mitkVolumeRenderer::SetCroppingRegionFlagsToCross (   )  [inline]

Set the flags for the cropping regions to Cross

void mitkVolumeRenderer::SetCroppingRegionFlagsToFence (   )  [inline]

Set the flags for the cropping regions to Fence

void mitkVolumeRenderer::SetCroppingRegionFlagsToInvertedCross (   )  [inline]

Set the flags for the cropping regions to InvertedCross

void mitkVolumeRenderer::SetCroppingRegionFlagsToInvertedFence (   )  [inline]

Set the flags for the cropping regions to InvertedFence

void mitkVolumeRenderer::SetCroppingRegionFlagsToSubVolume (   )  [inline]

Set the flags for the cropping regions to SubVolume

void mitkVolumeRenderer::SetCroppingRegionPlanes (  float  xmin, float  xmax, float  ymin, float  ymax, float  zmin, float  zmax )  [inline]

Set the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) Parameters: xmin  Specify the xmin of cropping region xmax  Specify the xmax of cropping region ymin  Specify the ymin of cropping region ymax  Specify the ymax of cropping region zmin  Specify the zmin of cropping region zmax  Specify the zmax of cropping region

void mitkVolumeRenderer::SetCroppingRegionPlanes (  float  region[6]  )  [inline]

Set the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) Parameters: region[0]  Specify the xmin of cropping region region[1]  Specify the xmax of cropping region region[2]  Specify the ymin of cropping region region[3]  Specify the ymax of cropping region region[4]  Specify the zmin of cropping region region[5]  Specify the zmax of cropping region

---

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

• mitkVolumeRenderer.h

---