VTK
vtkAbstractVolumeMapper.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAbstractVolumeMapper.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
26 #ifndef vtkAbstractVolumeMapper_h
27 #define vtkAbstractVolumeMapper_h
28 
29 #include "vtkRenderingCoreModule.h" // For export macro
30 #include "vtkAbstractMapper3D.h"
31 
32 class vtkRenderer;
33 class vtkVolume;
34 class vtkWindow;
35 class vtkDataSet;
36 
38 {
39 public:
41  void PrintSelf( ostream& os, vtkIndent indent );
42 
44 
48 
50 
52  virtual double *GetBounds();
53  virtual void GetBounds(double bounds[6])
54  { this->vtkAbstractMapper3D::GetBounds(bounds); };
56 
58 
67  vtkSetMacro(ScalarMode,int);
68  vtkGetMacro(ScalarMode,int);
70  this->SetScalarMode(VTK_SCALAR_MODE_DEFAULT);};
72  this->SetScalarMode(VTK_SCALAR_MODE_USE_POINT_DATA);};
74  this->SetScalarMode(VTK_SCALAR_MODE_USE_CELL_DATA);};
76  this->SetScalarMode(VTK_SCALAR_MODE_USE_POINT_FIELD_DATA);};
78  this->SetScalarMode(VTK_SCALAR_MODE_USE_CELL_FIELD_DATA);};
80 
82 
86  virtual void SelectScalarArray(int arrayNum);
87  virtual void SelectScalarArray(const char* arrayName);
89 
91 
92  virtual char* GetArrayName() { return this->ArrayName; }
93  virtual int GetArrayId() { return this->ArrayId; }
94  virtual int GetArrayAccessMode() { return this->ArrayAccessMode; }
96 
98  const char *GetScalarModeAsString();
99 
100 //BTX
102 
103  virtual float GetGradientMagnitudeScale() {return 1.0f;};
104  virtual float GetGradientMagnitudeBias() {return 0.0f;};
105  virtual float GetGradientMagnitudeScale(int) {return 1.0f;};
106  virtual float GetGradientMagnitudeBias(int) {return 0.0f;};
108 
109 
112  virtual void Render(vtkRenderer *ren, vtkVolume *vol)=0;
113 
119 
120 //ETX
121 
122 protected:
125 
126  // see algorithm for more info
128 
130  char *ArrayName;
131  int ArrayId;
133 
134 private:
135  vtkAbstractVolumeMapper(const vtkAbstractVolumeMapper&); // Not implemented.
136  void operator=(const vtkAbstractVolumeMapper&); // Not implemented.
137 };
138 
139 
140 #endif
141 
142 
vtkAbstractVolumeMapper::GetArrayName
virtual char * GetArrayName()
Definition: vtkAbstractVolumeMapper.h:92
VTK_SCALAR_MODE_DEFAULT
#define VTK_SCALAR_MODE_DEFAULT
Definition: vtkAbstractMapper.h:33
VTK_SCALAR_MODE_USE_CELL_FIELD_DATA
#define VTK_SCALAR_MODE_USE_CELL_FIELD_DATA
Definition: vtkAbstractMapper.h:37
VTK_SCALAR_MODE_USE_POINT_DATA
#define VTK_SCALAR_MODE_USE_POINT_DATA
Definition: vtkAbstractMapper.h:34
vtkAbstractVolumeMapper::ScalarMode
int ScalarMode
Definition: vtkAbstractVolumeMapper.h:129
vtkVolume
represents a volume (data & properties) in a rendered scene
Definition: vtkVolume.h:50
VTK_SCALAR_MODE_USE_POINT_FIELD_DATA
#define VTK_SCALAR_MODE_USE_POINT_FIELD_DATA
Definition: vtkAbstractMapper.h:36
vtkAbstractMapper3D::GetBounds
virtual double * GetBounds()=0
vtkAbstractVolumeMapper::GetScalarModeAsString
const char * GetScalarModeAsString()
vtkAbstractVolumeMapper::vtkAbstractVolumeMapper
vtkAbstractVolumeMapper()
vtkAbstractVolumeMapper::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
vtkAbstractVolumeMapper::ReleaseGraphicsResources
virtual void ReleaseGraphicsResources(vtkWindow *)
Definition: vtkAbstractVolumeMapper.h:118
vtkTypeMacro
#define vtkTypeMacro(thisClass, superclass)
Definition: vtkSetGet.h:642
vtkAbstractVolumeMapper::GetBounds
virtual void GetBounds(double bounds[6])
Definition: vtkAbstractVolumeMapper.h:53
vtkAbstractVolumeMapper::GetArrayId
virtual int GetArrayId()
Definition: vtkAbstractVolumeMapper.h:93
vtkAbstractVolumeMapper::GetArrayAccessMode
virtual int GetArrayAccessMode()
Definition: vtkAbstractVolumeMapper.h:94
vtkAbstractVolumeMapper::GetGradientMagnitudeScale
virtual float GetGradientMagnitudeScale()
Definition: vtkAbstractVolumeMapper.h:103
vtkAbstractMapper3D.h
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:34
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkAbstractVolumeMapper::ArrayName
char * ArrayName
Definition: vtkAbstractVolumeMapper.h:130
VTK_SCALAR_MODE_USE_CELL_DATA
#define VTK_SCALAR_MODE_USE_CELL_DATA
Definition: vtkAbstractMapper.h:35
vtkAbstractVolumeMapper::ArrayAccessMode
int ArrayAccessMode
Definition: vtkAbstractVolumeMapper.h:132
vtkAbstractVolumeMapper::SelectScalarArray
virtual void SelectScalarArray(const char *arrayName)
vtkAbstractVolumeMapper::SetScalarModeToUseCellData
void SetScalarModeToUseCellData()
Definition: vtkAbstractVolumeMapper.h:73
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkRenderingCoreModule.h
vtkAbstractVolumeMapper::SetScalarModeToDefault
void SetScalarModeToDefault()
Definition: vtkAbstractVolumeMapper.h:69
vtkAbstractVolumeMapper::FillInputPortInformation
virtual int FillInputPortInformation(int port, vtkInformation *info)
vtkGetMacro
#define vtkGetMacro(name, type)
Definition: vtkSetGet.h:93
vtkAbstractVolumeMapper::ArrayId
int ArrayId
Definition: vtkAbstractVolumeMapper.h:131
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkAbstractVolumeMapper::GetBounds
virtual double * GetBounds()
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkAbstractMapper3D
abstract class specifies interface to map 3D data
Definition: vtkAbstractMapper3D.h:42
vtkAbstractVolumeMapper::SetScalarModeToUseCellFieldData
void SetScalarModeToUseCellFieldData()
Definition: vtkAbstractVolumeMapper.h:77
vtkAbstractVolumeMapper
Abstract class for a volume mapper.
Definition: vtkAbstractVolumeMapper.h:38
vtkRenderer
abstract specification for renderers
Definition: vtkRenderer.h:64
vtkAbstractVolumeMapper::SelectScalarArray
virtual void SelectScalarArray(int arrayNum)
vtkAbstractVolumeMapper::SetScalarModeToUsePointData
void SetScalarModeToUsePointData()
Definition: vtkAbstractVolumeMapper.h:71
vtkAbstractVolumeMapper::GetDataSetInput
vtkDataSet * GetDataSetInput()
vtkAbstractVolumeMapper::GetGradientMagnitudeScale
virtual float GetGradientMagnitudeScale(int)
Definition: vtkAbstractVolumeMapper.h:105
vtkAbstractVolumeMapper::SetScalarModeToUsePointFieldData
void SetScalarModeToUsePointFieldData()
Definition: vtkAbstractVolumeMapper.h:75
VTKRENDERINGCORE_EXPORT
#define VTKRENDERINGCORE_EXPORT
Definition: vtkRenderingCoreModule.h:15
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:65
vtkAbstractVolumeMapper::~vtkAbstractVolumeMapper
~vtkAbstractVolumeMapper()
vtkAbstractVolumeMapper::GetGradientMagnitudeBias
virtual float GetGradientMagnitudeBias()
Definition: vtkAbstractVolumeMapper.h:104
vtkAbstractVolumeMapper::GetDataObjectInput
vtkDataObject * GetDataObjectInput()
vtkAbstractVolumeMapper::GetGradientMagnitudeBias
virtual float GetGradientMagnitudeBias(int)
Definition: vtkAbstractVolumeMapper.h:106
vtkAbstractVolumeMapper::Render
virtual void Render(vtkRenderer *ren, vtkVolume *vol)=0