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:
[legend]Collaboration diagram for vtkTubeFilter:
[legend]List of all members.
Detailed Description
filter that generates tubes around lines.
-
Date:
-
2001/10/11 13:37:21
-
Revision:
-
1.43
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.
-
Warning:
-
The number of tube sides must be greater than 3. If you wish to use fewer sides (i.e., a ribbon), use vtkRibbonFilter.
-
Warning:
-
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
-
Examples:
-
vtkTubeFilter (Examples)
-
Tests:
-
vtkTubeFilter (Tests)
Definition at line 88 of file vtkTubeFilter.h.
Constructor & Destructor Documentation
| vtkTubeFilter::vtkTubeFilter |
( |
|
) |
[protected] |
|
| vtkTubeFilter::~vtkTubeFilter |
( |
|
) |
[inline, protected] |
|
Member Function Documentation
| virtual const char* vtkTubeFilter::GetClassName |
( |
|
) |
[virtual] |
|
| 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] |
|
| void vtkTubeFilter::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
[virtual] |
|
|
|
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] |
|
|
|
Set the minimum tube radius (minimum because the tube radius may vary). |
| virtual void vtkTubeFilter::SetVaryRadius |
( |
int |
|
) |
[virtual] |
|
|
|
Turn on/off the variation of tube radius with scalar value. |
| virtual int vtkTubeFilter::GetVaryRadius |
( |
|
) |
[virtual] |
|
|
|
Turn on/off the variation of tube radius with scalar value. |
| void vtkTubeFilter::SetVaryRadiusToVaryRadiusOff |
( |
|
) |
[inline] |
|
|
|
Turn on/off the variation of tube radius with scalar value.
Definition at line 110 of file vtkTubeFilter.h. |
| void vtkTubeFilter::SetVaryRadiusToVaryRadiusByScalar |
( |
|
) |
[inline] |
|
|
|
Turn on/off the variation of tube radius with scalar value.
Definition at line 112 of file vtkTubeFilter.h. |
| void vtkTubeFilter::SetVaryRadiusToVaryRadiusByVector |
( |
|
) |
[inline] |
|
|
|
Turn on/off the variation of tube radius with scalar value.
Definition at line 114 of file vtkTubeFilter.h. |
| const char * vtkTubeFilter::GetVaryRadiusAsString |
( |
void |
|
) |
[inline] |
|
|
|
Return the method of varying tube radius descriptive character string.
Definition at line 193 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] |
|
|
|
Set the number of sides for the tube. At a minimum, number of sides is 3. |
| 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] |
|
|
|
Set the maximum tube radius in terms of a multiple of the minimum radius. |
| virtual void vtkTubeFilter::SetDefaultNormal |
( |
float |
, |
|
|
float |
, |
|
|
float |
|
|
) |
[virtual] |
|
|
|
Set the default normal to use if no normals are supplied, and the DefaultNormalOn is set. |
| virtual void vtkTubeFilter::SetDefaultNormal |
( |
float |
[3] |
) |
[virtual] |
|
|
|
Set the default normal to use if no normals are supplied, and the DefaultNormalOn is set. |
| virtual float* vtkTubeFilter::GetDefaultNormal |
( |
|
) |
[virtual] |
|
|
|
Set the default normal to use if no normals are supplied, and the DefaultNormalOn is set. |
| virtual void vtkTubeFilter::GetDefaultNormal |
( |
float |
data[3] |
) |
[virtual] |
|
|
|
Set the default normal to use if no normals are supplied, and the DefaultNormalOn is set. |
| virtual void vtkTubeFilter::SetUseDefaultNormal |
( |
int |
|
) |
[virtual] |
|
|
|
Set a boolean to control whether to use default normals. DefaultNormalOn is set. |
| virtual int vtkTubeFilter::GetUseDefaultNormal |
( |
|
) |
[virtual] |
|
|
|
Set a boolean to control whether to use default normals. DefaultNormalOn is set. |
| virtual void vtkTubeFilter::UseDefaultNormalOn |
( |
|
) |
[virtual] |
|
|
|
Set a boolean to control whether to use default normals. DefaultNormalOn is set. |
| virtual void vtkTubeFilter::UseDefaultNormalOff |
( |
|
) |
[virtual] |
|
|
|
Set a boolean to control whether to use default normals. DefaultNormalOn is set. |
| virtual void vtkTubeFilter::SetCapping |
( |
int |
|
) |
[virtual] |
|
|
|
Turn on/off whether to cap the ends with polygons. |
| virtual int vtkTubeFilter::GetCapping |
( |
|
) |
[virtual] |
|
|
|
Turn on/off whether to cap the ends with polygons. |
| virtual void vtkTubeFilter::CappingOn |
( |
|
) |
[virtual] |
|
|
|
Turn on/off whether to cap the ends with polygons. |
| virtual void vtkTubeFilter::CappingOff |
( |
|
) |
[virtual] |
|
|
|
Turn on/off whether to cap the ends with polygons. |
| 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] |
|
|
|
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 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] |
|
|
|
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. |
| void vtkTubeFilter::Execute |
( |
|
) |
[protected, virtual] |
|
|
|
This method is the old style execute method
Reimplemented from vtkSource. |
Member Data Documentation
float vtkTubeFilter::Radius [protected]
|
|
int vtkTubeFilter::VaryRadius [protected]
|
|
int vtkTubeFilter::NumberOfSides [protected]
|
|
float vtkTubeFilter::RadiusFactor [protected]
|
|
float vtkTubeFilter::DefaultNormal[3] [protected]
|
|
int vtkTubeFilter::UseDefaultNormal [protected]
|
|
int vtkTubeFilter::Capping [protected]
|
|
int vtkTubeFilter::OnRatio [protected]
|
|
int vtkTubeFilter::Offset [protected]
|
|
The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:44:45 2002 for VTK by
1.2.11.1 written by Dimitri van Heesch,
© 1997-2001