vtk
Class vtkTubeFilter

java.lang.Object
  vtk.vtkObjectBase
      vtk.vtkObject
          vtk.vtkProcessObject
              vtk.vtkSource
                  vtk.vtkPolyDataSource
                      vtk.vtkPolyDataToPolyDataFilter
                          vtk.vtkTubeFilter

All Implemented Interfaces:

java.io.Serializable

public class vtkTubeFilter

extends vtkPolyDataToPolyDataFilter

implements java.io.Serializable

vtkTubeFilter - filter that generates tubes around lines. 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. Other options include the ability to cap the tube and generate texture coordinates. Texture coordinates can be used with an associated texture map to create interesting effects such as marking the tube with stripes corresponding to length or time. This filter is typically used to create thick or dramatic lines. Another common use is to combine this filter with vtkStreamLine to generate streamtubes. JavaBean wrapper for vtkTubeFilter object.

Author:

vtk2jbean Automatic JavaBean wrapper for VTK.

See Also:

vtkRibbonFilter, Serialized Form

Field Summary

protected java.beans.PropertyChangeSupport

changes

Fields inherited from class vtk.vtkObjectBase

vtkId

Constructor Summary

	vtkTubeFilter()
protected	vtkTubeFilter(int dmy)

Method Summary

void	cappingOff() Turn on/off whether to cap the ends with polygons.
void	cappingOn() Turn on/off whether to cap the ends with polygons.
int	getCapping() Turn on/off whether to cap the ends with polygons.
java.lang.String	getClassName() Return the class name as a string.
double[]	getDefaultNormal() Set the default normal to use if no normals are supplied, and the DefaultNormalOn is set.
int	getGenerateTCoords() Control whether and how texture coordinates are produced.
java.lang.String	getGenerateTCoordsAsString() Control whether and how texture coordinates are produced.
int	getGenerateTCoordsMaxValue() Control whether and how texture coordinates are produced.
int	getGenerateTCoordsMinValue() Control whether and how texture coordinates are produced.
int	getNumberOfSides() Set the number of sides for the tube.
int	getNumberOfSidesMaxValue() Set the number of sides for the tube.
int	getNumberOfSidesMinValue() Set the number of sides for the tube.
int	getOffset() Control the striping of the tubes.
int	getOffsetMaxValue() Control the striping of the tubes.
int	getOffsetMinValue() Control the striping of the tubes.
int	getOnRatio() Control the striping of the tubes.
int	getOnRatioMaxValue() Control the striping of the tubes.
int	getOnRatioMinValue() Control the striping of the tubes.
double	getRadius() Set the minimum tube radius (minimum because the tube radius may vary).
double	getRadiusFactor() Set the maximum tube radius in terms of a multiple of the minimum radius.
double	getRadiusMaxValue() Set the minimum tube radius (minimum because the tube radius may vary).
double	getRadiusMinValue() Set the minimum tube radius (minimum because the tube radius may vary).
int	getSidesShareVertices() Set a boolean to control whether tube sides should share vertices.
double	getTextureLength() Control the conversion of units during the texture coordinates calculation.
double	getTextureLengthMaxValue() Control the conversion of units during the texture coordinates calculation.
double	getTextureLengthMinValue() Control the conversion of units during the texture coordinates calculation.
vtkTubeFilter	getThisTubeFilter()
int	getUseDefaultNormal() Set a boolean to control whether to use default normals.
int	getVaryRadius() Turn on/off the variation of tube radius with scalar value.
java.lang.String	getVaryRadiusAsString() Turn on/off the variation of tube radius with scalar value.
int	getVaryRadiusMaxValue() Turn on/off the variation of tube radius with scalar value.
int	getVaryRadiusMinValue() Turn on/off the variation of tube radius with scalar value.
int	isA(java.lang.String id0) Return 1 if this class is the same type of (or a subclass of) the named class.
void	setCapping(int id0) Turn on/off whether to cap the ends with polygons.
void	setDefaultNormal(double[] id0) Set the default normal to use if no normals are supplied, and the DefaultNormalOn is set.
void	setDefaultNormal(double id0, double id1, double id2) Set the default normal to use if no normals are supplied, and the DefaultNormalOn is set.
void	setGenerateTCoords(int id0) Control whether and how texture coordinates are produced.
void	setGenerateTCoordsToNormalizedLength() Control whether and how texture coordinates are produced.
void	setGenerateTCoordsToOff() Control whether and how texture coordinates are produced.
void	setGenerateTCoordsToUseLength() Control whether and how texture coordinates are produced.
void	setGenerateTCoordsToUseScalars() Control whether and how texture coordinates are produced.
void	setNumberOfSides(int id0) Set the number of sides for the tube.
void	setOffset(int id0) Control the striping of the tubes.
void	setOnRatio(int id0) Control the striping of the tubes.
void	setRadius(double id0) Set the minimum tube radius (minimum because the tube radius may vary).
void	setRadiusFactor(double id0) Set the maximum tube radius in terms of a multiple of the minimum radius.
void	setSidesShareVertices(int id0) Set a boolean to control whether tube sides should share vertices.
void	setTextureLength(double id0) Control the conversion of units during the texture coordinates calculation.
void	setUseDefaultNormal(int id0) Set a boolean to control whether to use default normals.
void	setVaryRadius(int id0) Turn on/off the variation of tube radius with scalar value.
void	setVaryRadiusToVaryRadiusByAbsoluteScalar() Turn on/off the variation of tube radius with scalar value.
void	setVaryRadiusToVaryRadiusByScalar() Turn on/off the variation of tube radius with scalar value.
void	setVaryRadiusToVaryRadiusByVector() Turn on/off the variation of tube radius with scalar value.
void	setVaryRadiusToVaryRadiusOff() Turn on/off the variation of tube radius with scalar value.
void	sidesShareVerticesOff() Set a boolean to control whether tube sides should share vertices.
void	sidesShareVerticesOn() Set a boolean to control whether tube sides should share vertices.
void	useDefaultNormalOff() Set a boolean to control whether to use default normals.
void	useDefaultNormalOn() Set a boolean to control whether to use default normals.
protected void	VTKCastInit()
void	VTKInit()

Methods inherited from class vtk.vtkPolyDataToPolyDataFilter

getInput, getThisPolyDataToPolyDataFilter, setInput

Methods inherited from class vtk.vtkPolyDataSource

getOutput, getOutput, getThisPolyDataSource, setOutput

Methods inherited from class vtk.vtkSource

computeInputUpdateExtents, getNumberOfOutputs, getOutputIndex, getReleaseDataFlag, getThisSource, inRegisterLoop, propagateUpdateExtent, releaseDataFlagOff, releaseDataFlagOn, setReleaseDataFlag, triggerAsynchronousUpdate, unRegister, unRegisterAllOutputs, update, updateData, updateInformation, updateWholeExtent

Methods inherited from class vtk.vtkProcessObject

abortExecuteOff, abortExecuteOn, getAbortExecute, getErrorCode, getNumberOfInputs, getProgress, getProgressMaxValue, getProgressMinValue, getProgressText, getThisProcessObject, removeAllInputs, setAbortExecute, setProgress, setProgressText, squeezeInputArray, updateProgress

Methods inherited from class vtk.vtkObject

AddObserver, breakOnError, debugOff, debugOn, getDebug, getGlobalWarningDisplay, getMTime, getThisObject, globalWarningDisplayOff, globalWarningDisplayOn, hasObserver, hasObserver, invokeEvent, invokeEvent, modified, Print, PrintRevisions, register, removeObserver, removeObservers, removeObservers, setDebug, setGlobalWarningDisplay

Methods inherited from class vtk.vtkObjectBase

addPropertyChangeListener, finalize, getReferenceCount, getThisObjectBase, isTypeOf, removePropertyChangeListener, setReferenceCount, VTKDelete

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

changes

protected java.beans.PropertyChangeSupport changes

Constructor Detail

vtkTubeFilter

public vtkTubeFilter()

vtkTubeFilter

protected vtkTubeFilter(int dmy)

Method Detail

getThisTubeFilter

public vtkTubeFilter getThisTubeFilter()

getClassName

public java.lang.String getClassName()

Description copied from class: vtkObjectBase

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

Overrides:

getClassName in class vtkPolyDataToPolyDataFilter

isA

public int isA(java.lang.String id0)

Description copied from class: vtkObjectBase

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:

isA in class vtkPolyDataToPolyDataFilter

setRadius

public void setRadius(double id0)

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

getRadiusMinValue

public double getRadiusMinValue()

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

getRadiusMaxValue

public double getRadiusMaxValue()

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

getRadius

public double getRadius()

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

setVaryRadius

public void setVaryRadius(int id0)

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

getVaryRadiusMinValue

public int getVaryRadiusMinValue()

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

getVaryRadiusMaxValue

public int getVaryRadiusMaxValue()

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

getVaryRadius

public int getVaryRadius()

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

setVaryRadiusToVaryRadiusOff

public void setVaryRadiusToVaryRadiusOff()

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

setVaryRadiusToVaryRadiusByScalar

public void setVaryRadiusToVaryRadiusByScalar()

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

setVaryRadiusToVaryRadiusByVector

public void setVaryRadiusToVaryRadiusByVector()

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

setVaryRadiusToVaryRadiusByAbsoluteScalar

public void setVaryRadiusToVaryRadiusByAbsoluteScalar()

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

getVaryRadiusAsString

public java.lang.String getVaryRadiusAsString()

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

setNumberOfSides

public void setNumberOfSides(int id0)

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

getNumberOfSidesMinValue

public int getNumberOfSidesMinValue()

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

getNumberOfSidesMaxValue

public int getNumberOfSidesMaxValue()

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

getNumberOfSides

public int getNumberOfSides()

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

setRadiusFactor

public void setRadiusFactor(double id0)

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

getRadiusFactor

public double getRadiusFactor()

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

setDefaultNormal

public void setDefaultNormal(double id0,
                             double id1,
                             double id2)

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

setDefaultNormal

public void setDefaultNormal(double[] id0)

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

getDefaultNormal

public double[] getDefaultNormal()

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

setUseDefaultNormal

public void setUseDefaultNormal(int id0)

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

getUseDefaultNormal

public int getUseDefaultNormal()

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

useDefaultNormalOn

public void useDefaultNormalOn()

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

useDefaultNormalOff

public void useDefaultNormalOff()

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

setSidesShareVertices

public void setSidesShareVertices(int id0)

Set a boolean to control whether tube sides should share vertices. This creates independent strips, with constant normals so the tube is always faceted in appearance.

getSidesShareVertices

public int getSidesShareVertices()

Set a boolean to control whether tube sides should share vertices. This creates independent strips, with constant normals so the tube is always faceted in appearance.

sidesShareVerticesOn

public void sidesShareVerticesOn()

Set a boolean to control whether tube sides should share vertices. This creates independent strips, with constant normals so the tube is always faceted in appearance.

sidesShareVerticesOff

public void sidesShareVerticesOff()

Set a boolean to control whether tube sides should share vertices. This creates independent strips, with constant normals so the tube is always faceted in appearance.

setCapping

public void setCapping(int id0)

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

getCapping

public int getCapping()

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

cappingOn

public void cappingOn()

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

cappingOff

public void cappingOff()

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

setOnRatio

public void setOnRatio(int id0)

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.

getOnRatioMinValue

public int getOnRatioMinValue()

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.

getOnRatioMaxValue

public int getOnRatioMaxValue()

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.

getOnRatio

public int getOnRatio()

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.

setOffset

public void setOffset(int id0)

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.

getOffsetMinValue

public int getOffsetMinValue()

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.

getOffsetMaxValue

public int getOffsetMaxValue()

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.

getOffset

public int getOffset()

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.

setGenerateTCoords

public void setGenerateTCoords(int id0)

Control whether and how texture coordinates are produced. This is useful for striping the tube with length textures, etc. If you use scalars to create the texture, the scalars are assumed to be monotonically increasing (or decreasing).

getGenerateTCoordsMinValue

public int getGenerateTCoordsMinValue()

Control whether and how texture coordinates are produced. This is useful for striping the tube with length textures, etc. If you use scalars to create the texture, the scalars are assumed to be monotonically increasing (or decreasing).

getGenerateTCoordsMaxValue

public int getGenerateTCoordsMaxValue()

Control whether and how texture coordinates are produced. This is useful for striping the tube with length textures, etc. If you use scalars to create the texture, the scalars are assumed to be monotonically increasing (or decreasing).

getGenerateTCoords

public int getGenerateTCoords()

Control whether and how texture coordinates are produced. This is useful for striping the tube with length textures, etc. If you use scalars to create the texture, the scalars are assumed to be monotonically increasing (or decreasing).

setGenerateTCoordsToOff

public void setGenerateTCoordsToOff()

Control whether and how texture coordinates are produced. This is useful for striping the tube with length textures, etc. If you use scalars to create the texture, the scalars are assumed to be monotonically increasing (or decreasing).

setGenerateTCoordsToNormalizedLength

public void setGenerateTCoordsToNormalizedLength()

Control whether and how texture coordinates are produced. This is useful for striping the tube with length textures, etc. If you use scalars to create the texture, the scalars are assumed to be monotonically increasing (or decreasing).

setGenerateTCoordsToUseLength

public void setGenerateTCoordsToUseLength()

Control whether and how texture coordinates are produced. This is useful for striping the tube with length textures, etc. If you use scalars to create the texture, the scalars are assumed to be monotonically increasing (or decreasing).

setGenerateTCoordsToUseScalars

public void setGenerateTCoordsToUseScalars()

Control whether and how texture coordinates are produced. This is useful for striping the tube with length textures, etc. If you use scalars to create the texture, the scalars are assumed to be monotonically increasing (or decreasing).

getGenerateTCoordsAsString

public java.lang.String getGenerateTCoordsAsString()

Control whether and how texture coordinates are produced. This is useful for striping the tube with length textures, etc. If you use scalars to create the texture, the scalars are assumed to be monotonically increasing (or decreasing).

setTextureLength

public void setTextureLength(double id0)

Control the conversion of units during the texture coordinates calculation. The TextureLength indicates what length (whether calculated from scalars or length) is mapped to the [0,1) texture space.

getTextureLengthMinValue

public double getTextureLengthMinValue()

Control the conversion of units during the texture coordinates calculation. The TextureLength indicates what length (whether calculated from scalars or length) is mapped to the [0,1) texture space.

getTextureLengthMaxValue

public double getTextureLengthMaxValue()

Control the conversion of units during the texture coordinates calculation. The TextureLength indicates what length (whether calculated from scalars or length) is mapped to the [0,1) texture space.

getTextureLength

public double getTextureLength()

Control the conversion of units during the texture coordinates calculation. The TextureLength indicates what length (whether calculated from scalars or length) is mapped to the [0,1) texture space.

VTKInit

public void VTKInit()

Overrides:

VTKInit in class vtkObject

VTKCastInit

protected void VTKCastInit()

Overrides:

VTKCastInit in class vtkPolyDataToPolyDataFilter