VTK  9.0.3
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 =========================================================================*/
36 #ifndef vtkRibbonFilter_h
37 #define vtkRibbonFilter_h
38 
39 #include "vtkFiltersModelingModule.h" // For export macro
40 #include "vtkPolyDataAlgorithm.h"
41 
42 #define VTK_TCOORDS_OFF 0
43 #define VTK_TCOORDS_FROM_NORMALIZED_LENGTH 1
44 #define VTK_TCOORDS_FROM_LENGTH 2
45 #define VTK_TCOORDS_FROM_SCALARS 3
46 
47 class vtkCellArray;
48 class vtkCellData;
49 class vtkDataArray;
50 class vtkFloatArray;
51 class vtkPointData;
52 class vtkPoints;
53 
54 class VTKFILTERSMODELING_EXPORT vtkRibbonFilter : public vtkPolyDataAlgorithm
55 {
56 public:
58  void PrintSelf(ostream& os, vtkIndent indent) override;
59 
64  static vtkRibbonFilter* New();
65 
67 
71  vtkSetClampMacro(Width, double, 0, VTK_DOUBLE_MAX);
72  vtkGetMacro(Width, double);
74 
76 
80  vtkSetClampMacro(Angle, double, 0, 360);
81  vtkGetMacro(Angle, double);
83 
85 
89  vtkSetMacro(VaryWidth, vtkTypeBool);
90  vtkGetMacro(VaryWidth, vtkTypeBool);
91  vtkBooleanMacro(VaryWidth, vtkTypeBool);
93 
95 
99  vtkSetMacro(WidthFactor, double);
100  vtkGetMacro(WidthFactor, double);
102 
104 
108  vtkSetVector3Macro(DefaultNormal, double);
109  vtkGetVectorMacro(DefaultNormal, double, 3);
111 
113 
117  vtkSetMacro(UseDefaultNormal, vtkTypeBool);
118  vtkGetMacro(UseDefaultNormal, vtkTypeBool);
119  vtkBooleanMacro(UseDefaultNormal, vtkTypeBool);
121 
123 
127  vtkSetClampMacro(GenerateTCoords, int, VTK_TCOORDS_OFF, VTK_TCOORDS_FROM_SCALARS);
128  vtkGetMacro(GenerateTCoords, int);
129  void SetGenerateTCoordsToOff() { this->SetGenerateTCoords(VTK_TCOORDS_OFF); }
131  {
132  this->SetGenerateTCoords(VTK_TCOORDS_FROM_NORMALIZED_LENGTH);
133  }
134  void SetGenerateTCoordsToUseLength() { this->SetGenerateTCoords(VTK_TCOORDS_FROM_LENGTH); }
135  void SetGenerateTCoordsToUseScalars() { this->SetGenerateTCoords(VTK_TCOORDS_FROM_SCALARS); }
138 
140 
146  vtkSetClampMacro(TextureLength, double, 0.000001, VTK_INT_MAX);
147  vtkGetMacro(TextureLength, double);
149 
150 protected:
152  ~vtkRibbonFilter() override;
153 
155  double Width;
156  double Angle;
157  vtkTypeBool VaryWidth; // controls whether width varies with scalar data
158  double WidthFactor;
159  double DefaultNormal[3];
161  int GenerateTCoords; // control texture coordinate generation
162  double TextureLength; // this length is mapped to [0,1) texture space
163 
164  // Helper methods
166  vtkPoints* newPts, vtkPointData* pd, vtkPointData* outPD, vtkFloatArray* newNormals,
167  vtkDataArray* inScalars, double range[2], vtkDataArray* inNormals);
168  void GenerateStrip(vtkIdType offset, vtkIdType npts, const vtkIdType* pts, vtkIdType inCellId,
169  vtkCellData* cd, vtkCellData* outCD, vtkCellArray* newStrips);
171  vtkPoints* inPts, vtkDataArray* inScalars, vtkFloatArray* newTCoords);
173 
174  // Helper data members
175  double Theta;
176 
177 private:
178  vtkRibbonFilter(const vtkRibbonFilter&) = delete;
179  void operator=(const vtkRibbonFilter&) = delete;
180 };
181 
182 #endif
object to represent cell connectivity
Definition: vtkCellArray.h:180
represent and manipulate cell attribute data
Definition: vtkCellData.h:33
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:36
a simple class to control print indentation
Definition: vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
represent and manipulate point attribute data
Definition: vtkPointData.h:32
represent and manipulate 3D points
Definition: vtkPoints.h:34
Superclass for algorithms that produce only polydata as output.
create oriented ribbons from lines defined in polygonal dataset
void SetGenerateTCoordsToUseLength()
void SetGenerateTCoordsToUseScalars()
void SetGenerateTCoordsToNormalizedLength()
const char * GetGenerateTCoordsAsString()
vtkIdType ComputeOffset(vtkIdType offset, vtkIdType npts)
vtkTypeBool UseDefaultNormal
void SetGenerateTCoordsToOff()
int GeneratePoints(vtkIdType offset, vtkIdType npts, const vtkIdType *pts, vtkPoints *inPts, vtkPoints *newPts, vtkPointData *pd, vtkPointData *outPD, vtkFloatArray *newNormals, vtkDataArray *inScalars, double range[2], vtkDataArray *inNormals)
vtkTypeBool VaryWidth
~vtkRibbonFilter() override
static vtkRibbonFilter * New()
Construct ribbon so that width is 0.1, the width does not vary with scalar values,...
void GenerateTextureCoords(vtkIdType offset, vtkIdType npts, const vtkIdType *pts, vtkPoints *inPts, vtkDataArray *inScalars, vtkFloatArray *newTCoords)
void GenerateStrip(vtkIdType offset, vtkIdType npts, const vtkIdType *pts, vtkIdType inCellId, vtkCellData *cd, vtkCellData *outCD, vtkCellArray *newStrips)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
@ range
Definition: vtkX3D.h:244
@ offset
Definition: vtkX3D.h:444
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_TCOORDS_FROM_SCALARS
#define VTK_TCOORDS_FROM_LENGTH
#define VTK_TCOORDS_FROM_NORMALIZED_LENGTH
#define VTK_TCOORDS_OFF
int vtkIdType
Definition: vtkType.h:338
#define VTK_DOUBLE_MAX
Definition: vtkType.h:165
#define VTK_INT_MAX
Definition: vtkType.h:155