vtkRibbonFilter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkRibbonFilter_h
#define vtkRibbonFilter_h
 
#include "vtkFiltersModelingModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"
 
#define VTK_TCOORDS_OFF 0
#define VTK_TCOORDS_FROM_NORMALIZED_LENGTH 1
#define VTK_TCOORDS_FROM_LENGTH 2
#define VTK_TCOORDS_FROM_SCALARS 3
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCellArray;
class vtkCellData;
class vtkDataArray;
class vtkFloatArray;
class vtkPointData;
class vtkPoints;
 
class VTKFILTERSMODELING_EXPORT vtkRibbonFilter : public vtkPolyDataAlgorithm
{
public:
  vtkTypeMacro(vtkRibbonFilter, vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkRibbonFilter* New();
 
 
  vtkSetClampMacro(Width, double, 0, VTK_DOUBLE_MAX);
  vtkGetMacro(Width, double);
 
 
  vtkSetClampMacro(Angle, double, 0, 360);
  vtkGetMacro(Angle, double);
 
 
  vtkSetMacro(VaryWidth, vtkTypeBool);
  vtkGetMacro(VaryWidth, vtkTypeBool);
  vtkBooleanMacro(VaryWidth, vtkTypeBool);
 
 
  vtkSetMacro(WidthFactor, double);
  vtkGetMacro(WidthFactor, double);
 
 
  vtkSetVector3Macro(DefaultNormal, double);
  vtkGetVectorMacro(DefaultNormal, double, 3);
 
 
  vtkSetMacro(UseDefaultNormal, vtkTypeBool);
  vtkGetMacro(UseDefaultNormal, vtkTypeBool);
  vtkBooleanMacro(UseDefaultNormal, vtkTypeBool);
 
 
  vtkSetClampMacro(GenerateTCoords, int, VTK_TCOORDS_OFF, VTK_TCOORDS_FROM_SCALARS);
  vtkGetMacro(GenerateTCoords, int);
  void SetGenerateTCoordsToOff() { this->SetGenerateTCoords(VTK_TCOORDS_OFF); }
  void SetGenerateTCoordsToNormalizedLength()
  {
    this->SetGenerateTCoords(VTK_TCOORDS_FROM_NORMALIZED_LENGTH);
  }
  void SetGenerateTCoordsToUseLength() { this->SetGenerateTCoords(VTK_TCOORDS_FROM_LENGTH); }
  void SetGenerateTCoordsToUseScalars() { this->SetGenerateTCoords(VTK_TCOORDS_FROM_SCALARS); }
  const char* GetGenerateTCoordsAsString();
 
 
  vtkSetClampMacro(TextureLength, double, 0.000001, VTK_INT_MAX);
  vtkGetMacro(TextureLength, double);
 
protected:
  vtkRibbonFilter();
  ~vtkRibbonFilter() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  double Width;
  double Angle;
  vtkTypeBool VaryWidth; // controls whether width varies with scalar data
  double WidthFactor;
  double DefaultNormal[3];
  vtkTypeBool UseDefaultNormal;
  int GenerateTCoords;  // control texture coordinate generation
  double TextureLength; // this length is mapped to [0,1) texture space
 
  // Helper methods
  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);
  void GenerateStrip(vtkIdType offset, vtkIdType npts, const vtkIdType* pts, vtkIdType inCellId,
    vtkCellData* cd, vtkCellData* outCD, vtkCellArray* newStrips);
  void GenerateTextureCoords(vtkIdType offset, vtkIdType npts, const vtkIdType* pts,
    vtkPoints* inPts, vtkDataArray* inScalars, vtkFloatArray* newTCoords);
  vtkIdType ComputeOffset(vtkIdType offset, vtkIdType npts);
 
  // Helper data members
  double Theta;
 
private:
  vtkRibbonFilter(const vtkRibbonFilter&) = delete;
  void operator=(const vtkRibbonFilter&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif