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

vtkVolumeProMapper Class Reference

Superclass for VolumePRO volume rendering mappers. More...

#include <vtkVolumeProMapper.h>

Inheritance diagram for vtkVolumeProMapper:

Inheritance graph
[legend]
Collaboration diagram for vtkVolumeProMapper:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent index)
virtual void Render (vtkRenderer *, vtkVolume *)
int GetMapperType ()
virtual void SetBlendMode (int)
virtual int GetBlendMode ()
void SetBlendModeToComposite ()
void SetBlendModeToMaximumIntensity ()
void SetBlendModeToMinimumIntensity ()
const char * GetBlendModeAsString (void)
virtual void SetSubVolume (int, int, int, int, int, int)
virtual void SetSubVolume (int[6])
virtual int * GetSubVolume ()
virtual void GetSubVolume (int data[6])
virtual void SetCursor (int)
virtual int GetCursor ()
virtual void CursorOn ()
virtual void CursorOff ()
virtual void SetCursorType (int)
virtual int GetCursorType ()
void SetCursorTypeToCrossHair ()
void SetCursorTypeToPlane ()
const char * GetCursorTypeAsString (void)
virtual void SetCursorPosition (double, double, double)
virtual void SetCursorPosition (double[3])
virtual double * GetCursorPosition ()
virtual void GetCursorPosition (double data[3])
virtual void SetCursorXAxisColor (double, double, double)
virtual void SetCursorXAxisColor (double[3])
virtual double * GetCursorXAxisColor ()
virtual void GetCursorXAxisColor (double data[3])
virtual void SetCursorYAxisColor (double, double, double)
virtual void SetCursorYAxisColor (double[3])
virtual double * GetCursorYAxisColor ()
virtual void GetCursorYAxisColor (double data[3])
virtual void SetCursorZAxisColor (double, double, double)
virtual void SetCursorZAxisColor (double[3])
virtual double * GetCursorZAxisColor ()
virtual void GetCursorZAxisColor (double data[3])
virtual void SetSuperSampling (int)
virtual int GetSuperSampling ()
virtual void SuperSamplingOn ()
virtual void SuperSamplingOff ()
void SetSuperSamplingFactor (double x, double y, double z)
void SetSuperSamplingFactor (double f[3])
virtual double * GetSuperSamplingFactor ()
virtual void GetSuperSamplingFactor (double data[3])
virtual void SetCutPlane (int)
virtual int GetCutPlane ()
virtual void CutPlaneOn ()
virtual void CutPlaneOff ()
virtual void SetCutPlaneEquation (double, double, double, double)
virtual void SetCutPlaneEquation (double[4])
virtual double * GetCutPlaneEquation ()
virtual void GetCutPlaneEquation (double data[4])
virtual void SetCutPlaneThickness (double)
virtual double GetCutPlaneThickness ()
virtual void SetCutPlaneFallOffDistance (int)
virtual int GetCutPlaneFallOffDistance ()
virtual void SetGradientOpacityModulation (int)
virtual int GetGradientOpacityModulation ()
virtual void GradientOpacityModulationOn ()
virtual void GradientOpacityModulationOff ()
virtual void SetGradientDiffuseModulation (int)
virtual int GetGradientDiffuseModulation ()
virtual void GradientDiffuseModulationOn ()
virtual void GradientDiffuseModulationOff ()
virtual void SetGradientSpecularModulation (int)
virtual int GetGradientSpecularModulation ()
virtual void GradientSpecularModulationOn ()
virtual void GradientSpecularModulationOff ()
virtual int GetNoHardware ()
virtual int GetWrongVLIVersion ()
virtual int GetNumberOfBoards ()
virtual int GetMajorBoardVersion ()
virtual int GetMinorBoardVersion ()
virtual int GetAvailableBoardMemory ()
virtual void GetLockSizesForBoardMemory (unsigned int vtkNotUsed(type), unsigned int *vtkNotUsed(xSize), unsigned int *vtkNotUsed(ySize), unsigned int *vtkNotUsed(zSize))

Static Public Methods

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

Protected Methods

 vtkVolumeProMapper ()
 ~vtkVolumeProMapper ()
 vtkVolumeProMapper (const vtkVolumeProMapper &)
void operator= (const vtkVolumeProMapper &)
int StatusOK ()

Protected Attributes

VLIContext * Context
VLIVolume * Volume
vtkImageData * VolumeInput
vtkTimeStamp * VolumeBuildTime
int VolumeDataType
VLILookupTable * LookupTable
int BlendMode
VLILight ** Lights
int NumberOfLights
int SubVolume [6]
int Cursor
int CursorType
double CursorPosition [3]
double CursorXAxisColor [3]
double CursorYAxisColor [3]
double CursorZAxisColor [3]
int CutPlane
VLICutPlane * Cut
double CutPlaneEquation [4]
double CutPlaneThickness
int CutPlaneFallOffDistance
int SuperSampling
double SuperSamplingFactor [3]
int GradientOpacityModulation
int GradientDiffuseModulation
int GradientSpecularModulation
int NumberOfBoards
int MajorBoardVersion
int MinorBoardVersion
int GradientTableSize
int NoHardware
int WrongVLIVersion
int DisplayedMessage

Detailed Description

Superclass for VolumePRO volume rendering mappers.

Date:
2000/12/10 20:08:27
Revision:
1.17

vtkVolumeProMapper is the superclass for VolumePRO volume rendering mappers. Any functionality that is general across all VolumePRO implementations is placed here in this class. Subclasses of this class are for the specific board implementations. Subclasses of that are for underlying graphics languages. Users should not create subclasses directly - a vtkVolumeProMapper will automatically create the object of the right type.

If you do not have the VolumePRO libraries when building this object, then the New method will create a default renderer that will not render. You can check the NumberOfBoards ivar to see if it is a real rendering class. To build with the VolumePRO board see vtkVolumeProVG500Mapper.h for instructions.

For more information on the VolumePRO hardware, please see:

http://www.3dvolumegraphics.com/3dvolumegraphics/product/index.htm

If you encounter any problems with this class, please inform Kitware, Inc. at kitware@kitware.com.

See also:
vtkVolumeMapper vtkVolumeProVG500Mapper vtkOpenGLVolumeProVG500Mapper
Examples:
vtkVolumeProMapper (examples)

Definition at line 99 of file vtkVolumeProMapper.h.

Constructor & Destructor Documentation

vtkVolumeProMapper::vtkVolumeProMapper (    )  [protected]
 

vtkVolumeProMapper::~vtkVolumeProMapper (    )  [protected]
 

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

Definition at line 218 of file vtkVolumeProMapper.h.

Member Function Documentation

virtual const char* vtkVolumeProMapper::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 vtkVolumeMapper.

Reimplemented in vtkOpenGLVolumeProVG500Mapper, and vtkVolumeProVG500Mapper.

int vtkVolumeProMapper::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 vtkVolumeMapper.

Reimplemented in vtkOpenGLVolumeProVG500Mapper, and vtkVolumeProVG500Mapper.

virtual int vtkVolumeProMapper::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 vtkVolumeMapper.

Reimplemented in vtkOpenGLVolumeProVG500Mapper, and vtkVolumeProVG500Mapper.

vtkVolumeProMapper* vtkVolumeProMapper::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 vtkVolumeMapper.

Reimplemented in vtkOpenGLVolumeProVG500Mapper, and vtkVolumeProVG500Mapper.

void vtkVolumeProMapper::PrintSelf (  ostream &    os,
vtkIndent    index
)  [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.

vtkVolumeProMapper* vtkVolumeProMapper::New (    )  [static]
 

Automatically create the proper subclass

Reimplemented from vtkProcessObject.

Reimplemented in vtkOpenGLVolumeProVG500Mapper, and vtkVolumeProVG500Mapper.

virtual void vtkVolumeProMapper::Render (  vtkRenderer *    ren,
vtkVolume *    vol
)  [inline, virtual]
 

Render the image using the hardware and place it in the frame buffer

Reimplemented from vtkVolumeMapper.

Reimplemented in vtkVolumeProVG500Mapper.

Definition at line 109 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::GetMapperType (    )  [inline, virtual]
 

The Renderer and RayCaster rely on the information to compose images from various volume renderers

Reimplemented from vtkVolumeMapper.

Definition at line 113 of file vtkVolumeProMapper.h.

virtual void vtkVolumeProMapper::SetBlendMode (  int    )  [virtual]
 

Set the blend mode

virtual int vtkVolumeProMapper::GetBlendMode (    )  [virtual]
 

void vtkVolumeProMapper::SetBlendModeToComposite (    )  [inline]
 

Definition at line 119 of file vtkVolumeProMapper.h.

void vtkVolumeProMapper::SetBlendModeToMaximumIntensity (    )  [inline]
 

Definition at line 121 of file vtkVolumeProMapper.h.

void vtkVolumeProMapper::SetBlendModeToMinimumIntensity (    )  [inline]
 

Definition at line 123 of file vtkVolumeProMapper.h.

const char * vtkVolumeProMapper::GetBlendModeAsString (  void    )  [inline]
 

Get the blending mode as a descriptive string

Definition at line 288 of file vtkVolumeProMapper.h.

virtual void vtkVolumeProMapper::SetSubVolume (  int   ,
int   ,
int   ,
int   ,
int   ,
int   
)  [virtual]
 

Set the subvolume

virtual void vtkVolumeProMapper::SetSubVolume (  int   [6] )  [virtual]
 

virtual int* vtkVolumeProMapper::GetSubVolume (    )  [virtual]
 

virtual void vtkVolumeProMapper::GetSubVolume (  int    data[6] )  [virtual]
 

virtual void vtkVolumeProMapper::SetCursor (  int    )  [virtual]
 

Turn the cursor on / off

virtual int vtkVolumeProMapper::GetCursor (    )  [virtual]
 

virtual void vtkVolumeProMapper::CursorOn (    )  [virtual]
 

virtual void vtkVolumeProMapper::CursorOff (    )  [virtual]
 

virtual void vtkVolumeProMapper::SetCursorType (  int    )  [virtual]
 

Set the type of the cursor

virtual int vtkVolumeProMapper::GetCursorType (    )  [virtual]
 

void vtkVolumeProMapper::SetCursorTypeToCrossHair (    )  [inline]
 

Definition at line 140 of file vtkVolumeProMapper.h.

void vtkVolumeProMapper::SetCursorTypeToPlane (    )  [inline]
 

Definition at line 142 of file vtkVolumeProMapper.h.

const char * vtkVolumeProMapper::GetCursorTypeAsString (  void    )  [inline]
 

Get the cursor type as a descriptive string

Definition at line 304 of file vtkVolumeProMapper.h.

virtual void vtkVolumeProMapper::SetCursorPosition (  double   ,
double   ,
double   
)  [virtual]
 

Set/Get the cursor position

virtual void vtkVolumeProMapper::SetCursorPosition (  double   [3] )  [virtual]
 

virtual double* vtkVolumeProMapper::GetCursorPosition (    )  [virtual]
 

virtual void vtkVolumeProMapper::GetCursorPosition (  double    data[3] )  [virtual]
 

virtual void vtkVolumeProMapper::SetCursorXAxisColor (  double   ,
double   ,
double   
)  [virtual]
 

Set/Get the cursor color

virtual void vtkVolumeProMapper::SetCursorXAxisColor (  double   [3] )  [virtual]
 

virtual double* vtkVolumeProMapper::GetCursorXAxisColor (    )  [virtual]
 

virtual void vtkVolumeProMapper::GetCursorXAxisColor (  double    data[3] )  [virtual]
 

virtual void vtkVolumeProMapper::SetCursorYAxisColor (  double   ,
double   ,
double   
)  [virtual]
 

virtual void vtkVolumeProMapper::SetCursorYAxisColor (  double   [3] )  [virtual]
 

virtual double* vtkVolumeProMapper::GetCursorYAxisColor (    )  [virtual]
 

virtual void vtkVolumeProMapper::GetCursorYAxisColor (  double    data[3] )  [virtual]
 

virtual void vtkVolumeProMapper::SetCursorZAxisColor (  double   ,
double   ,
double   
)  [virtual]
 

virtual void vtkVolumeProMapper::SetCursorZAxisColor (  double   [3] )  [virtual]
 

virtual double* vtkVolumeProMapper::GetCursorZAxisColor (    )  [virtual]
 

virtual void vtkVolumeProMapper::GetCursorZAxisColor (  double    data[3] )  [virtual]
 

virtual void vtkVolumeProMapper::SetSuperSampling (  int    )  [virtual]
 

Turn supersampling on/off

virtual int vtkVolumeProMapper::GetSuperSampling (    )  [virtual]
 

virtual void vtkVolumeProMapper::SuperSamplingOn (    )  [virtual]
 

virtual void vtkVolumeProMapper::SuperSamplingOff (    )  [virtual]
 

void vtkVolumeProMapper::SetSuperSamplingFactor (  double    x,
double    y,
double    z
) 
 

Set the supersampling factors

void vtkVolumeProMapper::SetSuperSamplingFactor (  double    f[3] )  [inline]
 

Definition at line 165 of file vtkVolumeProMapper.h.

virtual double* vtkVolumeProMapper::GetSuperSamplingFactor (    )  [virtual]
 

virtual void vtkVolumeProMapper::GetSuperSamplingFactor (  double    data[3] )  [virtual]
 

virtual void vtkVolumeProMapper::SetCutPlane (  int    )  [virtual]
 

Turn on / off the cut plane

virtual int vtkVolumeProMapper::GetCutPlane (    )  [virtual]
 

virtual void vtkVolumeProMapper::CutPlaneOn (    )  [virtual]
 

virtual void vtkVolumeProMapper::CutPlaneOff (    )  [virtual]
 

virtual void vtkVolumeProMapper::SetCutPlaneEquation (  double   ,
double   ,
double   ,
double   
)  [virtual]
 

Set/Get the cut plane equation

virtual void vtkVolumeProMapper::SetCutPlaneEquation (  double   [4] )  [virtual]
 

virtual double* vtkVolumeProMapper::GetCutPlaneEquation (    )  [virtual]
 

virtual void vtkVolumeProMapper::GetCutPlaneEquation (  double    data[4] )  [virtual]
 

virtual void vtkVolumeProMapper::SetCutPlaneThickness (  double    )  [virtual]
 

Set / Get the cut plane thickness

virtual double vtkVolumeProMapper::GetCutPlaneThickness (    )  [virtual]
 

virtual void vtkVolumeProMapper::SetCutPlaneFallOffDistance (  int    )  [virtual]
 

Set / Get the cut plane falloff value for intensities

virtual int vtkVolumeProMapper::GetCutPlaneFallOffDistance (    )  [virtual]
 

virtual void vtkVolumeProMapper::SetGradientOpacityModulation (  int    )  [virtual]
 

Set/Get the gradient magnitude opacity modulation

virtual int vtkVolumeProMapper::GetGradientOpacityModulation (    )  [virtual]
 

virtual void vtkVolumeProMapper::GradientOpacityModulationOn (    )  [virtual]
 

virtual void vtkVolumeProMapper::GradientOpacityModulationOff (    )  [virtual]
 

virtual void vtkVolumeProMapper::SetGradientDiffuseModulation (  int    )  [virtual]
 

Set/Get the gradient magnitude diffuse modulation

virtual int vtkVolumeProMapper::GetGradientDiffuseModulation (    )  [virtual]
 

virtual void vtkVolumeProMapper::GradientDiffuseModulationOn (    )  [virtual]
 

virtual void vtkVolumeProMapper::GradientDiffuseModulationOff (    )  [virtual]
 

virtual void vtkVolumeProMapper::SetGradientSpecularModulation (  int    )  [virtual]
 

Set/Get the gradient magnitude specular modulation

virtual int vtkVolumeProMapper::GetGradientSpecularModulation (    )  [virtual]
 

virtual void vtkVolumeProMapper::GradientSpecularModulationOn (    )  [virtual]
 

virtual void vtkVolumeProMapper::GradientSpecularModulationOff (    )  [virtual]
 

virtual int vtkVolumeProMapper::GetNoHardware (    )  [virtual]
 

Conveniece methods for debugging

virtual int vtkVolumeProMapper::GetWrongVLIVersion (    )  [virtual]
 

virtual int vtkVolumeProMapper::GetNumberOfBoards (    )  [virtual]
 

Access methods for some board info

virtual int vtkVolumeProMapper::GetMajorBoardVersion (    )  [virtual]
 

virtual int vtkVolumeProMapper::GetMinorBoardVersion (    )  [virtual]
 

virtual int vtkVolumeProMapper::GetAvailableBoardMemory (    )  [inline, virtual]
 

Reimplemented in vtkVolumeProVG500Mapper.

Definition at line 209 of file vtkVolumeProMapper.h.

virtual void vtkVolumeProMapper::GetLockSizesForBoardMemory (  unsigned int vtkNotUsed(type)   ,
unsigned int *vtkNotUsed(xSize)   ,
unsigned int *vtkNotUsed(ySize)   ,
unsigned int *vtkNotUsed(zSize)   
)  [inline, virtual]
 

Definition at line 210 of file vtkVolumeProMapper.h.

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

Definition at line 219 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::StatusOK (    )  [protected]
 

Member Data Documentation

VLIContext* vtkVolumeProMapper::Context [protected]
 

Definition at line 224 of file vtkVolumeProMapper.h.

VLIVolume* vtkVolumeProMapper::Volume [protected]
 

Definition at line 228 of file vtkVolumeProMapper.h.

vtkImageData* vtkVolumeProMapper::VolumeInput [protected]
 

Definition at line 229 of file vtkVolumeProMapper.h.

vtkTimeStamp* vtkVolumeProMapper::VolumeBuildTime [protected]
 

Definition at line 230 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::VolumeDataType [protected]
 

Definition at line 233 of file vtkVolumeProMapper.h.

VLILookupTable* vtkVolumeProMapper::LookupTable [protected]
 

Definition at line 237 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::BlendMode [protected]
 

Definition at line 240 of file vtkVolumeProMapper.h.

VLILight** vtkVolumeProMapper::Lights [protected]
 

Definition at line 244 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::NumberOfLights [protected]
 

Definition at line 245 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::SubVolume[6] [protected]
 

Definition at line 248 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::Cursor [protected]
 

Definition at line 251 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::CursorType [protected]
 

Definition at line 252 of file vtkVolumeProMapper.h.

double vtkVolumeProMapper::CursorPosition[3] [protected]
 

Definition at line 253 of file vtkVolumeProMapper.h.

double vtkVolumeProMapper::CursorXAxisColor[3] [protected]
 

Definition at line 254 of file vtkVolumeProMapper.h.

double vtkVolumeProMapper::CursorYAxisColor[3] [protected]
 

Definition at line 255 of file vtkVolumeProMapper.h.

double vtkVolumeProMapper::CursorZAxisColor[3] [protected]
 

Definition at line 256 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::CutPlane [protected]
 

Definition at line 259 of file vtkVolumeProMapper.h.

VLICutPlane* vtkVolumeProMapper::Cut [protected]
 

Definition at line 260 of file vtkVolumeProMapper.h.

double vtkVolumeProMapper::CutPlaneEquation[4] [protected]
 

Definition at line 261 of file vtkVolumeProMapper.h.

double vtkVolumeProMapper::CutPlaneThickness [protected]
 

Definition at line 262 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::CutPlaneFallOffDistance [protected]
 

Definition at line 263 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::SuperSampling [protected]
 

Definition at line 266 of file vtkVolumeProMapper.h.

double vtkVolumeProMapper::SuperSamplingFactor[3] [protected]
 

Definition at line 267 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::GradientOpacityModulation [protected]
 

Definition at line 270 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::GradientDiffuseModulation [protected]
 

Definition at line 271 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::GradientSpecularModulation [protected]
 

Definition at line 272 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::NumberOfBoards [protected]
 

Definition at line 275 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::MajorBoardVersion [protected]
 

Definition at line 276 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::MinorBoardVersion [protected]
 

Definition at line 277 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::GradientTableSize [protected]
 

Definition at line 278 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::NoHardware [protected]
 

Definition at line 281 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::WrongVLIVersion [protected]
 

Definition at line 282 of file vtkVolumeProMapper.h.

int vtkVolumeProMapper::DisplayedMessage [protected]
 

Definition at line 283 of file vtkVolumeProMapper.h.

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