VTK
vtkRibbonFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkRibbonFilter.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 =========================================================================*/
42 #ifndef vtkRibbonFilter_h
43 #define vtkRibbonFilter_h
44 
45 #include "vtkFiltersModelingModule.h" // For export macro
46 #include "vtkPolyDataAlgorithm.h"
47 
48 #define VTK_TCOORDS_OFF 0
49 #define VTK_TCOORDS_FROM_NORMALIZED_LENGTH 1
50 #define VTK_TCOORDS_FROM_LENGTH 2
51 #define VTK_TCOORDS_FROM_SCALARS 3
52 
53 class vtkCellArray;
54 class vtkCellData;
55 class vtkDataArray;
56 class vtkFloatArray;
57 class vtkPointData;
58 class vtkPoints;
59 
60 class VTKFILTERSMODELING_EXPORT vtkRibbonFilter : public vtkPolyDataAlgorithm
61 {
62 public:
64  void PrintSelf(ostream& os, vtkIndent indent) override;
65 
70  static vtkRibbonFilter *New();
71 
73 
77  vtkSetClampMacro(Width,double,0,VTK_DOUBLE_MAX);
78  vtkGetMacro(Width,double);
80 
82 
86  vtkSetClampMacro(Angle,double,0,360);
87  vtkGetMacro(Angle,double);
89 
91 
95  vtkSetMacro(VaryWidth,vtkTypeBool);
96  vtkGetMacro(VaryWidth,vtkTypeBool);
97  vtkBooleanMacro(VaryWidth,vtkTypeBool);
99 
101 
105  vtkSetMacro(WidthFactor,double);
106  vtkGetMacro(WidthFactor,double);
108 
110 
114  vtkSetVector3Macro(DefaultNormal,double);
115  vtkGetVectorMacro(DefaultNormal,double,3);
117 
119 
123  vtkSetMacro(UseDefaultNormal,vtkTypeBool);
124  vtkGetMacro(UseDefaultNormal,vtkTypeBool);
125  vtkBooleanMacro(UseDefaultNormal,vtkTypeBool);
127 
129 
133  vtkSetClampMacro(GenerateTCoords,int,VTK_TCOORDS_OFF,
135  vtkGetMacro(GenerateTCoords,int);
137  {this->SetGenerateTCoords(VTK_TCOORDS_OFF);}
139  {this->SetGenerateTCoords(VTK_TCOORDS_FROM_NORMALIZED_LENGTH);}
141  {this->SetGenerateTCoords(VTK_TCOORDS_FROM_LENGTH);}
143  {this->SetGenerateTCoords(VTK_TCOORDS_FROM_SCALARS);}
144  const char *GetGenerateTCoordsAsString();
146 
148 
154  vtkSetClampMacro(TextureLength,double,0.000001,VTK_INT_MAX);
155  vtkGetMacro(TextureLength,double);
157 
158 protected:
159  vtkRibbonFilter();
160  ~vtkRibbonFilter() override;
161 
163  double Width;
164  double Angle;
165  vtkTypeBool VaryWidth; //controls whether width varies with scalar data
166  double WidthFactor;
167  double DefaultNormal[3];
169  int GenerateTCoords; //control texture coordinate generation
170  double TextureLength; //this length is mapped to [0,1) texture space
171 
172  // Helper methods
173  int GeneratePoints(vtkIdType offset, vtkIdType npts, vtkIdType *pts,
174  vtkPoints *inPts, vtkPoints *newPts,
175  vtkPointData *pd, vtkPointData *outPD,
176  vtkFloatArray *newNormals, vtkDataArray *inScalars,
177  double range[2], vtkDataArray *inNormals);
178  void GenerateStrip(vtkIdType offset, vtkIdType npts, vtkIdType *pts,
179  vtkIdType inCellId, vtkCellData *cd, vtkCellData *outCD,
180  vtkCellArray *newStrips);
181  void GenerateTextureCoords(vtkIdType offset, vtkIdType npts, vtkIdType *pts,
182  vtkPoints *inPts, vtkDataArray *inScalars,
183  vtkFloatArray *newTCoords);
184  vtkIdType ComputeOffset(vtkIdType offset,vtkIdType npts);
185 
186  // Helper data members
187  double Theta;
188 
189 private:
190  vtkRibbonFilter(const vtkRibbonFilter&) = delete;
191  void operator=(const vtkRibbonFilter&) = delete;
192 };
193 
194 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:39
vtkRibbonFilter::GenerateTCoords
int GenerateTCoords
Definition: vtkRibbonFilter.h:169
VTK_INT_MAX
#define VTK_INT_MAX
Definition: vtkType.h:159
vtkRibbonFilter::TextureLength
double TextureLength
Definition: vtkRibbonFilter.h:170
vtkRibbonFilter::SetGenerateTCoordsToOff
void SetGenerateTCoordsToOff()
Definition: vtkRibbonFilter.h:136
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:37
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkFloatArray
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:41
vtkRibbonFilter
create oriented ribbons from lines defined in polygonal dataset
Definition: vtkRibbonFilter.h:60
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
vtkX3D::range
Definition: vtkX3D.h:238
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
vtkRibbonFilter::SetGenerateTCoordsToNormalizedLength
void SetGenerateTCoordsToNormalizedLength()
Definition: vtkRibbonFilter.h:138
vtkPolyDataAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
VTK_TCOORDS_OFF
#define VTK_TCOORDS_OFF
Definition: vtkRibbonFilter.h:48
vtkRibbonFilter::Theta
double Theta
Definition: vtkRibbonFilter.h:187
VTK_TCOORDS_FROM_SCALARS
#define VTK_TCOORDS_FROM_SCALARS
Definition: vtkRibbonFilter.h:51
vtkPolyDataAlgorithm.h
vtkX3D::offset
Definition: vtkX3D.h:438
vtkRibbonFilter::WidthFactor
double WidthFactor
Definition: vtkRibbonFilter.h:166
vtkPolyDataAlgorithm::RequestData
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.
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
vtkRibbonFilter::SetGenerateTCoordsToUseScalars
void SetGenerateTCoordsToUseScalars()
Definition: vtkRibbonFilter.h:142
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkRibbonFilter::Width
double Width
Definition: vtkRibbonFilter.h:163
VTK_TCOORDS_FROM_LENGTH
#define VTK_TCOORDS_FROM_LENGTH
Definition: vtkRibbonFilter.h:50
vtkRibbonFilter::VaryWidth
vtkTypeBool VaryWidth
Definition: vtkRibbonFilter.h:165
vtkRibbonFilter::Angle
double Angle
Definition: vtkRibbonFilter.h:164
VTK_TCOORDS_FROM_NORMALIZED_LENGTH
#define VTK_TCOORDS_FROM_NORMALIZED_LENGTH
Definition: vtkRibbonFilter.h:49
vtkRibbonFilter::SetGenerateTCoordsToUseLength
void SetGenerateTCoordsToUseLength()
Definition: vtkRibbonFilter.h:140
vtkRibbonFilter::UseDefaultNormal
vtkTypeBool UseDefaultNormal
Definition: vtkRibbonFilter.h:168
VTK_DOUBLE_MAX
#define VTK_DOUBLE_MAX
Definition: vtkType.h:169
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkPolyDataAlgorithm::New
static vtkPolyDataAlgorithm * New()
vtkPolyDataAlgorithm
Superclass for algorithms that produce only polydata as output.
Definition: vtkPolyDataAlgorithm.h:44