vtkVolumeTextureMapper Class Reference

#include <vtkVolumeTextureMapper.h>

Inheritance diagram for vtkVolumeTextureMapper:

[legend]Collaboration diagram for vtkVolumeTextureMapper:

[legend]List of all members.

---

Detailed Description

Abstract class for a volume mapper.

vtkVolumeTextureMapper is the abstract definition of a volume mapper that uses a texture mapping approach.

See also:

vtkVolumeMapper

Definition at line 37 of file vtkVolumeTextureMapper.h.

Public Types
typedef vtkVolumeMapper	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	SetGradientEstimator (vtkEncodedGradientEstimator *gradest)
virtual vtkEncodedGradientEstimator *	GetGradientEstimator ()
virtual vtkEncodedGradientShader *	GetGradientShader ()
float *	GetGradientOpacityArray ()
unsigned char *	GetRGBAArray ()
float *	GetRedDiffuseShadingTable ()
float *	GetGreenDiffuseShadingTable ()
float *	GetBlueDiffuseShadingTable ()
float *	GetRedSpecularShadingTable ()
float *	GetGreenSpecularShadingTable ()
float *	GetBlueSpecularShadingTable ()
unsigned short *	GetEncodedNormals ()
unsigned char *	GetGradientMagnitudes ()
virtual int	GetShade ()
virtual vtkRenderWindow *	GetRenderWindow ()
virtual double *	GetDataOrigin ()
virtual void	GetDataOrigin (double data[3])
virtual double *	GetDataSpacing ()
virtual void	GetDataSpacing (double data[3])
virtual void	Render (vtkRenderer *ren, vtkVolume *vol)=0
virtual float	GetGradientMagnitudeScale ()
virtual float	GetGradientMagnitudeBias ()
virtual float	GetGradientMagnitudeScale (int)
virtual float	GetGradientMagnitudeBias (int)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkVolumeTextureMapper *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkVolumeTextureMapper ()
	~vtkVolumeTextureMapper ()
void	InitializeRender (vtkRenderer *ren, vtkVolume *vol)
virtual void	ReportReferences (vtkGarbageCollector *)
Protected Attributes
vtkEncodedGradientEstimator *	GradientEstimator
vtkEncodedGradientShader *	GradientShader
int	Shade
float *	GradientOpacityArray
unsigned char *	RGBAArray
int	ArraySize
int	NumberOfComponents
float *	RedDiffuseShadingTable
float *	GreenDiffuseShadingTable
float *	BlueDiffuseShadingTable
float *	RedSpecularShadingTable
float *	GreenSpecularShadingTable
float *	BlueSpecularShadingTable
double	DataOrigin [3]
double	DataSpacing [3]
unsigned short *	EncodedNormals
unsigned char *	GradientMagnitudes
float	SampleDistance
vtkRenderWindow *	RenderWindow

---

Member Typedef Documentation

typedef vtkVolumeMapper vtkVolumeTextureMapper::Superclass

Reimplemented from vtkVolumeMapper. Reimplemented in vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper2D, and vtkVolumeTextureMapper2D. Definition at line 40 of file vtkVolumeTextureMapper.h.

---

Constructor & Destructor Documentation

vtkVolumeTextureMapper::vtkVolumeTextureMapper (   )  [protected]

vtkVolumeTextureMapper::~vtkVolumeTextureMapper (   )  [protected]

---

Member Function Documentation

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

Reimplemented from vtkVolumeMapper. Reimplemented in vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper2D, and vtkVolumeTextureMapper2D.

static int vtkVolumeTextureMapper::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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkVolumeMapper. Reimplemented in vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper2D, and vtkVolumeTextureMapper2D.

virtual int vtkVolumeTextureMapper::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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkVolumeMapper. Reimplemented in vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper2D, and vtkVolumeTextureMapper2D.

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

Reimplemented from vtkVolumeMapper. Reimplemented in vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper2D, and vtkVolumeTextureMapper2D.

void vtkVolumeTextureMapper::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 vtkVolumeMapper. Reimplemented in vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper2D, and vtkVolumeTextureMapper2D.

virtual void vtkVolumeTextureMapper::Update (   )  [virtual]

Update the volume rendering pipeline by updating the scalar input Reimplemented from vtkAlgorithm.

virtual void vtkVolumeTextureMapper::SetGradientEstimator (  vtkEncodedGradientEstimator *  gradest  )  [virtual]

Set / Get the gradient estimator used to estimate normals

virtual vtkEncodedGradientEstimator* vtkVolumeTextureMapper::GetGradientEstimator (   )  [virtual]

Update the volume rendering pipeline by updating the scalar input

virtual vtkEncodedGradientShader* vtkVolumeTextureMapper::GetGradientShader (   )  [virtual]

Get the gradient shader.

float* vtkVolumeTextureMapper::GetGradientOpacityArray (   )  [inline]

Allow access to the arrays / variables from the templated functions in the subclasses. Definition at line 61 of file vtkVolumeTextureMapper.h.

unsigned char* vtkVolumeTextureMapper::GetRGBAArray (   )  [inline]

Allow access to the arrays / variables from the templated functions in the subclasses. Definition at line 62 of file vtkVolumeTextureMapper.h.

float* vtkVolumeTextureMapper::GetRedDiffuseShadingTable (   )  [inline]

Allow access to the arrays / variables from the templated functions in the subclasses. Definition at line 63 of file vtkVolumeTextureMapper.h.

float* vtkVolumeTextureMapper::GetGreenDiffuseShadingTable (   )  [inline]

Allow access to the arrays / variables from the templated functions in the subclasses. Definition at line 64 of file vtkVolumeTextureMapper.h.

float* vtkVolumeTextureMapper::GetBlueDiffuseShadingTable (   )  [inline]

Allow access to the arrays / variables from the templated functions in the subclasses. Definition at line 65 of file vtkVolumeTextureMapper.h.

float* vtkVolumeTextureMapper::GetRedSpecularShadingTable (   )  [inline]

Allow access to the arrays / variables from the templated functions in the subclasses. Definition at line 66 of file vtkVolumeTextureMapper.h.

float* vtkVolumeTextureMapper::GetGreenSpecularShadingTable (   )  [inline]

Allow access to the arrays / variables from the templated functions in the subclasses. Definition at line 67 of file vtkVolumeTextureMapper.h.

float* vtkVolumeTextureMapper::GetBlueSpecularShadingTable (   )  [inline]

Allow access to the arrays / variables from the templated functions in the subclasses. Definition at line 68 of file vtkVolumeTextureMapper.h.

unsigned short* vtkVolumeTextureMapper::GetEncodedNormals (  void   )  [inline]

Allow access to the arrays / variables from the templated functions in the subclasses. Definition at line 69 of file vtkVolumeTextureMapper.h.

unsigned char* vtkVolumeTextureMapper::GetGradientMagnitudes (  void   )  [inline]

Allow access to the arrays / variables from the templated functions in the subclasses. Definition at line 70 of file vtkVolumeTextureMapper.h.

virtual int vtkVolumeTextureMapper::GetShade (   )  [virtual]

Allow access to the arrays / variables from the templated functions in the subclasses.

virtual vtkRenderWindow* vtkVolumeTextureMapper::GetRenderWindow (   )  [virtual]

Allow access to the arrays / variables from the templated functions in the subclasses.

virtual double* vtkVolumeTextureMapper::GetDataOrigin (   )  [virtual]

Allow access to the arrays / variables from the templated functions in the subclasses.

virtual void vtkVolumeTextureMapper::GetDataOrigin (  double  data[3]  )  [virtual]

Allow access to the arrays / variables from the templated functions in the subclasses.

virtual double* vtkVolumeTextureMapper::GetDataSpacing (   )  [virtual]

Allow access to the arrays / variables from the templated functions in the subclasses.

virtual void vtkVolumeTextureMapper::GetDataSpacing (  double  data[3]  )  [virtual]

Allow access to the arrays / variables from the templated functions in the subclasses.

virtual void vtkVolumeTextureMapper::Render (  vtkRenderer *  ren, vtkVolume *  vol )  [pure virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Render the volume Implements vtkVolumeMapper. Implemented in vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper2D, and vtkVolumeTextureMapper2D.

virtual float vtkVolumeTextureMapper::GetGradientMagnitudeScale (   )  [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Values needed by the volume Reimplemented from vtkAbstractVolumeMapper.

virtual float vtkVolumeTextureMapper::GetGradientMagnitudeBias (   )  [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Render the volume Reimplemented from vtkAbstractVolumeMapper.

virtual float vtkVolumeTextureMapper::GetGradientMagnitudeScale (  int   )  [inline, virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Render the volume Reimplemented from vtkAbstractVolumeMapper. Definition at line 86 of file vtkVolumeTextureMapper.h. References vtkAbstractVolumeMapper::GetGradientMagnitudeScale().

virtual float vtkVolumeTextureMapper::GetGradientMagnitudeBias (  int   )  [inline, virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Render the volume Reimplemented from vtkAbstractVolumeMapper. Definition at line 88 of file vtkVolumeTextureMapper.h. References vtkAbstractVolumeMapper::GetGradientMagnitudeBias().

void vtkVolumeTextureMapper::InitializeRender (  vtkRenderer *  ren, vtkVolume *  vol )  [protected]

Reimplemented in vtkVolumeTextureMapper2D. Referenced by vtkVolumeTextureMapper2D::InitializeRender().

virtual void vtkVolumeTextureMapper::ReportReferences (  vtkGarbageCollector *   )  [protected, virtual]

Reimplemented from vtkAlgorithm.

---

Member Data Documentation

vtkEncodedGradientEstimator* vtkVolumeTextureMapper::GradientEstimator [protected]

Definition at line 105 of file vtkVolumeTextureMapper.h.

vtkEncodedGradientShader* vtkVolumeTextureMapper::GradientShader [protected]

Definition at line 106 of file vtkVolumeTextureMapper.h.

int vtkVolumeTextureMapper::Shade [protected]

Definition at line 107 of file vtkVolumeTextureMapper.h.

float* vtkVolumeTextureMapper::GradientOpacityArray [protected]

Definition at line 109 of file vtkVolumeTextureMapper.h.

unsigned char* vtkVolumeTextureMapper::RGBAArray [protected]

Definition at line 110 of file vtkVolumeTextureMapper.h.

int vtkVolumeTextureMapper::ArraySize [protected]

Definition at line 111 of file vtkVolumeTextureMapper.h.

int vtkVolumeTextureMapper::NumberOfComponents [protected]

Definition at line 112 of file vtkVolumeTextureMapper.h.

float* vtkVolumeTextureMapper::RedDiffuseShadingTable [protected]

Definition at line 114 of file vtkVolumeTextureMapper.h.

float* vtkVolumeTextureMapper::GreenDiffuseShadingTable [protected]

Definition at line 115 of file vtkVolumeTextureMapper.h.

float* vtkVolumeTextureMapper::BlueDiffuseShadingTable [protected]

Definition at line 116 of file vtkVolumeTextureMapper.h.

float* vtkVolumeTextureMapper::RedSpecularShadingTable [protected]

Definition at line 117 of file vtkVolumeTextureMapper.h.

float* vtkVolumeTextureMapper::GreenSpecularShadingTable [protected]

Definition at line 118 of file vtkVolumeTextureMapper.h.

float* vtkVolumeTextureMapper::BlueSpecularShadingTable [protected]

Definition at line 119 of file vtkVolumeTextureMapper.h.

double vtkVolumeTextureMapper::DataOrigin[3] [protected]

Definition at line 121 of file vtkVolumeTextureMapper.h.

double vtkVolumeTextureMapper::DataSpacing[3] [protected]

Definition at line 122 of file vtkVolumeTextureMapper.h.

unsigned short* vtkVolumeTextureMapper::EncodedNormals [protected]

Definition at line 124 of file vtkVolumeTextureMapper.h.

unsigned char* vtkVolumeTextureMapper::GradientMagnitudes [protected]

Definition at line 125 of file vtkVolumeTextureMapper.h.

float vtkVolumeTextureMapper::SampleDistance [protected]

Definition at line 127 of file vtkVolumeTextureMapper.h.

vtkRenderWindow* vtkVolumeTextureMapper::RenderWindow [protected]

Definition at line 129 of file vtkVolumeTextureMapper.h.

---

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

• dox/VolumeRendering/vtkVolumeTextureMapper.h

---