NAME
vtkTubeFilter - filter that generates tubes around lines
SYNOPSIS
#include "/opt/vtk-c++/graphics/vtkTubeFilter.h"
class VTK_EXPORT vtkTubeFilter : public vtkPolyDataToPolyDataFilter
vtkTubeFilter();
static vtkTubeFilter *New() {return new vtkTubeFilter;};
const char *GetClassName() {return "vtkTubeFilter";};
void PrintSelf(ostream& os, vtkIndent indent);
void SetRadius(float);
float GetRadius();
void SetVaryRadius(int);
VTK_VARY_RADIUS_OFF,VTK_VARY_RADIUS_BY_VECTOR);
int GetVaryRadius();
void SetVaryRadiusToVaryRadiusOff()
{this->SetVaryRadius(VTK_VARY_RADIUS_OFF);};
void SetVaryRadiusToVaryRadiusByScalar()
{this->SetVaryRadius(VTK_VARY_RADIUS_BY_SCALAR);};
void SetVaryRadiusToVaryRadiusByVector()
{this->SetVaryRadius(VTK_VARY_RADIUS_BY_VECTOR);};
char *GetVaryRadiusAsString();
void SetNumberOfSides(int);
int GetNumberOfSides();
void SetRadiusFactor(float);
float GetRadiusFactor();
void SetDefaultNormal(float, float, float);
void SetDefaultNormal(float *);
float *GetDefaultNormal();
void GetDefaultNormal(float data[3]);
void SetUseDefaultNormal(int);
int GetUseDefaultNormal();
void UseDefaultNormalOn();
void UseDefaultNormalOff();
DESCRIPTION
vtkTubeFilter is a filter that generates a tube around each input line. The tubes are made up of triangle strips and rotate around the tube with the rotation of the line normals. (If no normals are present, they are computed automatically.) The radius of the tube can be set to vary with scalar or vector value. If the radius varies with scalar value the radius is linearly adjusted. If the radius varies with vector value, a mass flux preserving variation is used. The number of sides for the tube also can be specified.
CAVEATS
The number of tube sides must be greater than 3. If you wish to use fewer sides (i.e., a ribbon), use vtkRibbonFilter.
The input line must not have duplicate points, or normals at points that are parallel to the incoming/outgoing line segments. (Duplicate points can be removed with vtkCleanPolyData.)
DEFINED MACROS
VTK_VARY_RADIUS_OFF 0
VTK_VARY_RADIUS_BY_SCALAR 1
VTK_VARY_RADIUS_BY_VECTOR 2
SUMMARY
void SetRadius(float)
Set the minimum tube radius (minimum because the tube radius may vary).
void SetVaryRadius(int)
Turn on/off the variation of tube radius with scalar value.
void SetNumberOfSides(int)
Set the number of sides for the tube. At a minimum, number of sides is 3.
void SetRadiusFactor(float)
Set the maximum tube radius in terms of a multiple of the minimum radius.
void SetDefaultNormal(float, float, float)
void SetDefaultNormal(float *)
Set the default normal to use if no normals are supplied, and the DefaultNormalOn is set.
void SetUseDefaultNormal(int)
Set a boolean to control whether to use default normals. DefaultNormalOn is set.
char *GetVaryRadiusAsString(void)
Return the method of varying tube radius descriptive character string.
vtkTubeFilter()
Construct object with radius 0.5, radius variation turned off, the number of sides set to 3, and radius factor of 10.