VTK
vtkTubeFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkTubeFilter.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 =========================================================================*/
60 #ifndef vtkTubeFilter_h
61 #define vtkTubeFilter_h
62 
63 #include "vtkFiltersCoreModule.h" // For export macro
64 #include "vtkPolyDataAlgorithm.h"
65 
66 #define VTK_VARY_RADIUS_OFF 0
67 #define VTK_VARY_RADIUS_BY_SCALAR 1
68 #define VTK_VARY_RADIUS_BY_VECTOR 2
69 #define VTK_VARY_RADIUS_BY_ABSOLUTE_SCALAR 3
70 
71 #define VTK_TCOORDS_OFF 0
72 #define VTK_TCOORDS_FROM_NORMALIZED_LENGTH 1
73 #define VTK_TCOORDS_FROM_LENGTH 2
74 #define VTK_TCOORDS_FROM_SCALARS 3
75 
76 class vtkCellArray;
77 class vtkCellData;
78 class vtkDataArray;
79 class vtkFloatArray;
80 class vtkPointData;
81 class vtkPoints;
82 
83 class VTKFILTERSCORE_EXPORT vtkTubeFilter : public vtkPolyDataAlgorithm
84 {
85 public:
87  void PrintSelf(ostream& os, vtkIndent indent) override;
88 
93  static vtkTubeFilter *New();
94 
96 
99  vtkSetClampMacro(Radius,double,0.0,VTK_DOUBLE_MAX);
100  vtkGetMacro(Radius,double);
102 
104 
107  vtkSetClampMacro(VaryRadius,int,
109  vtkGetMacro(VaryRadius,int);
111  {this->SetVaryRadius(VTK_VARY_RADIUS_OFF);};
113  {this->SetVaryRadius(VTK_VARY_RADIUS_BY_SCALAR);};
115  {this->SetVaryRadius(VTK_VARY_RADIUS_BY_VECTOR);};
117  {this->SetVaryRadius(VTK_VARY_RADIUS_BY_ABSOLUTE_SCALAR);};
118  const char *GetVaryRadiusAsString();
120 
122 
125  vtkSetClampMacro(NumberOfSides,int,3,VTK_INT_MAX);
126  vtkGetMacro(NumberOfSides,int);
128 
130 
133  vtkSetMacro(RadiusFactor,double);
134  vtkGetMacro(RadiusFactor,double);
136 
138 
142  vtkSetVector3Macro(DefaultNormal,double);
143  vtkGetVectorMacro(DefaultNormal,double,3);
145 
147 
151  vtkSetMacro(UseDefaultNormal,vtkTypeBool);
152  vtkGetMacro(UseDefaultNormal,vtkTypeBool);
153  vtkBooleanMacro(UseDefaultNormal,vtkTypeBool);
155 
157 
162  vtkSetMacro(SidesShareVertices, vtkTypeBool);
163  vtkGetMacro(SidesShareVertices, vtkTypeBool);
164  vtkBooleanMacro(SidesShareVertices, vtkTypeBool);
166 
168 
171  vtkSetMacro(Capping,vtkTypeBool);
172  vtkGetMacro(Capping,vtkTypeBool);
173  vtkBooleanMacro(Capping,vtkTypeBool);
175 
177 
182  vtkSetClampMacro(OnRatio,int,1,VTK_INT_MAX);
183  vtkGetMacro(OnRatio,int);
185 
187 
192  vtkSetClampMacro(Offset,int,0,VTK_INT_MAX);
193  vtkGetMacro(Offset,int);
195 
197 
203  vtkSetClampMacro(GenerateTCoords,int,VTK_TCOORDS_OFF,
205  vtkGetMacro(GenerateTCoords,int);
207  {this->SetGenerateTCoords(VTK_TCOORDS_OFF);}
209  {this->SetGenerateTCoords(VTK_TCOORDS_FROM_NORMALIZED_LENGTH);}
211  {this->SetGenerateTCoords(VTK_TCOORDS_FROM_LENGTH);}
213  {this->SetGenerateTCoords(VTK_TCOORDS_FROM_SCALARS);}
214  const char *GetGenerateTCoordsAsString();
216 
218 
224  vtkSetClampMacro(TextureLength,double,0.000001,VTK_INT_MAX);
225  vtkGetMacro(TextureLength,double);
227 
229 
234  vtkSetMacro(OutputPointsPrecision,int);
235  vtkGetMacro(OutputPointsPrecision,int);
237 
238 protected:
239  vtkTubeFilter();
240  ~vtkTubeFilter() override {}
241 
242  // Usual data generation method
244 
245  double Radius; //minimum radius of tube
246  int VaryRadius; //controls radius variation
247  int NumberOfSides; //number of sides to create tube
248  double RadiusFactor; //maximum allowable radius
249  double DefaultNormal[3];
252  vtkTypeBool Capping; //control whether tubes are capped
253  int OnRatio; //control the generation of the sides of the tube
254  int Offset; //control the generation of the sides
255  int GenerateTCoords; //control texture coordinate generation
257  double TextureLength; //this length is mapped to [0,1) texture space
258 
259  // Helper methods
260  int GeneratePoints(vtkIdType offset, vtkIdType npts, vtkIdType *pts,
261  vtkPoints *inPts, vtkPoints *newPts,
262  vtkPointData *pd, vtkPointData *outPD,
263  vtkFloatArray *newNormals, vtkDataArray *inScalars,
264  double range[2], vtkDataArray *inVectors, double maxNorm,
265  vtkDataArray *inNormals);
266  void GenerateStrips(vtkIdType offset, vtkIdType npts, vtkIdType *pts,
267  vtkIdType inCellId, vtkCellData *cd, vtkCellData *outCD,
268  vtkCellArray *newStrips);
269  void GenerateTextureCoords(vtkIdType offset, vtkIdType npts, vtkIdType *pts,
270  vtkPoints *inPts, vtkDataArray *inScalars,
271  vtkFloatArray *newTCoords);
272  vtkIdType ComputeOffset(vtkIdType offset,vtkIdType npts);
273 
274  // Helper data members
275  double Theta;
276 
277 private:
278  vtkTubeFilter(const vtkTubeFilter&) = delete;
279  void operator=(const vtkTubeFilter&) = delete;
280 };
281 
282 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:39
VTK_VARY_RADIUS_BY_SCALAR
#define VTK_VARY_RADIUS_BY_SCALAR
Definition: vtkTubeFilter.h:67
VTK_INT_MAX
#define VTK_INT_MAX
Definition: vtkType.h:159
VTK_VARY_RADIUS_OFF
#define VTK_VARY_RADIUS_OFF
Definition: vtkTubeFilter.h:66
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:37
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkTubeFilter::VaryRadius
int VaryRadius
Definition: vtkTubeFilter.h:246
vtkFloatArray
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:41
VTK_TCOORDS_FROM_LENGTH
#define VTK_TCOORDS_FROM_LENGTH
Definition: vtkTubeFilter.h:73
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
vtkX3D::range
Definition: vtkX3D.h:238
vtkTubeFilter::Theta
double Theta
Definition: vtkTubeFilter.h:275
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
vtkTubeFilter::OutputPointsPrecision
int OutputPointsPrecision
Definition: vtkTubeFilter.h:256
vtkTubeFilter::~vtkTubeFilter
~vtkTubeFilter() override
Definition: vtkTubeFilter.h:240
vtkPolyDataAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkTubeFilter::SetVaryRadiusToVaryRadiusByVector
void SetVaryRadiusToVaryRadiusByVector()
Definition: vtkTubeFilter.h:114
vtkTubeFilter::Radius
double Radius
Definition: vtkTubeFilter.h:245
vtkPolyDataAlgorithm.h
vtkTubeFilter
filter that generates tubes around lines
Definition: vtkTubeFilter.h:83
vtkTubeFilter::Offset
int Offset
Definition: vtkTubeFilter.h:254
vtkTubeFilter::GenerateTCoords
int GenerateTCoords
Definition: vtkTubeFilter.h:255
vtkTubeFilter::SetVaryRadiusToVaryRadiusOff
void SetVaryRadiusToVaryRadiusOff()
Definition: vtkTubeFilter.h:110
VTK_VARY_RADIUS_BY_ABSOLUTE_SCALAR
#define VTK_VARY_RADIUS_BY_ABSOLUTE_SCALAR
Definition: vtkTubeFilter.h:69
vtkX3D::offset
Definition: vtkX3D.h:438
vtkTubeFilter::SidesShareVertices
vtkTypeBool SidesShareVertices
Definition: vtkTubeFilter.h:251
vtkTubeFilter::SetVaryRadiusToVaryRadiusByAbsoluteScalar
void SetVaryRadiusToVaryRadiusByAbsoluteScalar()
Definition: vtkTubeFilter.h:116
vtkPolyDataAlgorithm::RequestData
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.
vtkTubeFilter::SetGenerateTCoordsToUseLength
void SetGenerateTCoordsToUseLength()
Definition: vtkTubeFilter.h:210
vtkTubeFilter::NumberOfSides
int NumberOfSides
Definition: vtkTubeFilter.h:247
vtkTubeFilter::OnRatio
int OnRatio
Definition: vtkTubeFilter.h:253
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:38
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:50
VTK_TCOORDS_FROM_SCALARS
#define VTK_TCOORDS_FROM_SCALARS
Definition: vtkTubeFilter.h:74
vtkTubeFilter::RadiusFactor
double RadiusFactor
Definition: vtkTubeFilter.h:248
vtkTubeFilter::SetVaryRadiusToVaryRadiusByScalar
void SetVaryRadiusToVaryRadiusByScalar()
Definition: vtkTubeFilter.h:112
VTK_TCOORDS_OFF
#define VTK_TCOORDS_OFF
Definition: vtkTubeFilter.h:71
vtkTubeFilter::SetGenerateTCoordsToUseScalars
void SetGenerateTCoordsToUseScalars()
Definition: vtkTubeFilter.h:212
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkTubeFilter::SetGenerateTCoordsToNormalizedLength
void SetGenerateTCoordsToNormalizedLength()
Definition: vtkTubeFilter.h:208
VTK_VARY_RADIUS_BY_VECTOR
#define VTK_VARY_RADIUS_BY_VECTOR
Definition: vtkTubeFilter.h:68
VTK_TCOORDS_FROM_NORMALIZED_LENGTH
#define VTK_TCOORDS_FROM_NORMALIZED_LENGTH
Definition: vtkTubeFilter.h:72
vtkTubeFilter::TextureLength
double TextureLength
Definition: vtkTubeFilter.h:257
vtkTubeFilter::UseDefaultNormal
vtkTypeBool UseDefaultNormal
Definition: vtkTubeFilter.h:250
VTK_DOUBLE_MAX
#define VTK_DOUBLE_MAX
Definition: vtkType.h:169
vtkTubeFilter::Capping
vtkTypeBool Capping
Definition: vtkTubeFilter.h:252
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkPolyDataAlgorithm::New
static vtkPolyDataAlgorithm * New()
vtkTubeFilter::SetGenerateTCoordsToOff
void SetGenerateTCoordsToOff()
Definition: vtkTubeFilter.h:206
vtkPolyDataAlgorithm
Superclass for algorithms that produce only polydata as output.
Definition: vtkPolyDataAlgorithm.h:44