Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkTubeFilter Class Reference

filter that generates tubes around lines. More...

#include <vtkTubeFilter.h>

Inheritance diagram for vtkTubeFilter:

Inheritance graph
Collaboration diagram for vtkTubeFilter:

Collaboration graph
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetRadius (float)
virtual float GetRadius ()
virtual void SetVaryRadius (int)
virtual int GetVaryRadius ()
void SetVaryRadiusToVaryRadiusOff ()
void SetVaryRadiusToVaryRadiusByScalar ()
void SetVaryRadiusToVaryRadiusByVector ()
const char * GetVaryRadiusAsString ()
virtual void SetNumberOfSides (int)
virtual int GetNumberOfSides ()
virtual void SetRadiusFactor (float)
virtual float GetRadiusFactor ()
virtual void SetDefaultNormal (float, float, float)
virtual void SetDefaultNormal (float[3])
virtual float * GetDefaultNormal ()
virtual void GetDefaultNormal (float data[3])
virtual void SetUseDefaultNormal (int)
virtual int GetUseDefaultNormal ()
virtual void UseDefaultNormalOn ()
virtual void UseDefaultNormalOff ()
virtual void SetCapping (int)
virtual int GetCapping ()
virtual void CappingOn ()
virtual void CappingOff ()
virtual void SetOnRatio (int)
virtual int GetOnRatio ()
virtual void SetOffset (int)
virtual int GetOffset ()

Static Public Methods

int IsTypeOf (const char *type)
vtkTubeFilter * SafeDownCast (vtkObject *o)
vtkTubeFilter * New ()

Protected Methods

 vtkTubeFilter ()
 ~vtkTubeFilter ()
 vtkTubeFilter (const vtkTubeFilter &)
void operator= (const vtkTubeFilter &)
void Execute ()

Protected Attributes

float Radius
int VaryRadius
int NumberOfSides
float RadiusFactor
float DefaultNormal [3]
int UseDefaultNormal
int Capping
int OnRatio
int Offset

Detailed Description

filter that generates tubes around lines.

2000/12/10 20:08:56

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. You can also specify which of the sides are visible. This is useful for generating interesting striping effects.

This filter is typically used to create thick or dramatic lines. Another common use is to combine this filter with vtkStreamLine to generate streamtubes.

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.)
See also:
vtkRibbonFilter vtkStreamLine
vtkTubeFilter (examples)

Definition at line 84 of file vtkTubeFilter.h.

Constructor & Destructor Documentation

vtkTubeFilter::vtkTubeFilter   [protected]

vtkTubeFilter::~vtkTubeFilter   [inline, protected]

Definition at line 150 of file vtkTubeFilter.h.

vtkTubeFilter::vtkTubeFilter const vtkTubeFilter &    [inline, protected]

Definition at line 151 of file vtkTubeFilter.h.

Member Function Documentation

virtual const char* vtkTubeFilter::GetClassName   [virtual]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataToPolyDataFilter.

int vtkTubeFilter::IsTypeOf const char *    type [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataToPolyDataFilter.

virtual int vtkTubeFilter::IsA const char *    type [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataToPolyDataFilter.

vtkTubeFilter* vtkTubeFilter::SafeDownCast vtkObject   o [static]

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataToPolyDataFilter.

void vtkTubeFilter::PrintSelf ostream &    os,
vtkIndent    indent

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkSource.

vtkTubeFilter* vtkTubeFilter::New   [static]

Construct object with radius 0.5, radius variation turned off, the number of sides set to 3, and radius factor of 10.

Reimplemented from vtkPolyDataSource.

virtual void vtkTubeFilter::SetRadius float    [virtual]

Set the minimum tube radius (minimum because the tube radius may vary).

virtual float vtkTubeFilter::GetRadius   [virtual]

virtual void vtkTubeFilter::SetVaryRadius int    [virtual]

Turn on/off the variation of tube radius with scalar value.

virtual int vtkTubeFilter::GetVaryRadius   [virtual]

void vtkTubeFilter::SetVaryRadiusToVaryRadiusOff   [inline]

Definition at line 103 of file vtkTubeFilter.h.

void vtkTubeFilter::SetVaryRadiusToVaryRadiusByScalar   [inline]

Definition at line 105 of file vtkTubeFilter.h.

void vtkTubeFilter::SetVaryRadiusToVaryRadiusByVector   [inline]

Definition at line 107 of file vtkTubeFilter.h.

const char * vtkTubeFilter::GetVaryRadiusAsString void    [inline]

Return the method of varying tube radius descriptive character string.

Definition at line 170 of file vtkTubeFilter.h.

virtual void vtkTubeFilter::SetNumberOfSides int    [virtual]

Set the number of sides for the tube. At a minimum, number of sides is 3.

virtual int vtkTubeFilter::GetNumberOfSides   [virtual]

virtual void vtkTubeFilter::SetRadiusFactor float    [virtual]

Set the maximum tube radius in terms of a multiple of the minimum radius.

virtual float vtkTubeFilter::GetRadiusFactor   [virtual]

virtual void vtkTubeFilter::SetDefaultNormal float   ,
float   ,

Set the default normal to use if no normals are supplied, and the DefaultNormalOn is set.

virtual void vtkTubeFilter::SetDefaultNormal float   [3] [virtual]

virtual float* vtkTubeFilter::GetDefaultNormal   [virtual]

virtual void vtkTubeFilter::GetDefaultNormal float    data[3] [virtual]

virtual void vtkTubeFilter::SetUseDefaultNormal int    [virtual]

Set a boolean to control whether to use default normals. DefaultNormalOn is set.

virtual int vtkTubeFilter::GetUseDefaultNormal   [virtual]

virtual void vtkTubeFilter::UseDefaultNormalOn   [virtual]

virtual void vtkTubeFilter::UseDefaultNormalOff   [virtual]

virtual void vtkTubeFilter::SetCapping int    [virtual]

Turn on/off whether to cap the ends with polygons.

virtual int vtkTubeFilter::GetCapping   [virtual]

virtual void vtkTubeFilter::CappingOn   [virtual]

virtual void vtkTubeFilter::CappingOff   [virtual]

virtual void vtkTubeFilter::SetOnRatio int    [virtual]

Control the striping of the tubes. If OnRatio is greater than 1, then every nth tube side is turned on, beginning with the Offset side.

virtual int vtkTubeFilter::GetOnRatio   [virtual]

virtual void vtkTubeFilter::SetOffset int    [virtual]

Control the striping of the tubes. The offset sets the first tube side that is visible. Offset is generally used with OnRatio to create nifty striping effects.

virtual int vtkTubeFilter::GetOffset   [virtual]

void vtkTubeFilter::operator= const vtkTubeFilter &    [inline, protected]

Definition at line 152 of file vtkTubeFilter.h.

void vtkTubeFilter::Execute   [protected, virtual]

Reimplemented from vtkSource.

Member Data Documentation

float vtkTubeFilter::Radius [protected]

Definition at line 157 of file vtkTubeFilter.h.

int vtkTubeFilter::VaryRadius [protected]

Definition at line 158 of file vtkTubeFilter.h.

int vtkTubeFilter::NumberOfSides [protected]

Definition at line 159 of file vtkTubeFilter.h.

float vtkTubeFilter::RadiusFactor [protected]

Definition at line 160 of file vtkTubeFilter.h.

float vtkTubeFilter::DefaultNormal[3] [protected]

Definition at line 161 of file vtkTubeFilter.h.

int vtkTubeFilter::UseDefaultNormal [protected]

Definition at line 162 of file vtkTubeFilter.h.

int vtkTubeFilter::Capping [protected]

Definition at line 163 of file vtkTubeFilter.h.

int vtkTubeFilter::OnRatio [protected]

Definition at line 164 of file vtkTubeFilter.h.

int vtkTubeFilter::Offset [protected]

Definition at line 165 of file vtkTubeFilter.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 13:01:22 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001