VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTubeFilter Class Reference

filter that generates tubes around lines More...

#include <vtkTubeFilter.h>

Inheritance diagram for vtkTubeFilter:
[legend]
Collaboration diagram for vtkTubeFilter:
[legend]

Public Types

typedef vtkPolyDataAlgorithm Superclass
 
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkTubeFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetRadius (double)
 Set the minimum tube radius (minimum because the tube radius may vary). More...
 
virtual double GetRadius ()
 
virtual void SetVaryRadius (int)
 Turn on/off the variation of tube radius with scalar value. More...
 
virtual int GetVaryRadius ()
 
void SetVaryRadiusToVaryRadiusOff ()
 
void SetVaryRadiusToVaryRadiusByScalar ()
 
void SetVaryRadiusToVaryRadiusByVector ()
 
void SetVaryRadiusToVaryRadiusByAbsoluteScalar ()
 
const char * GetVaryRadiusAsString ()
 
virtual void SetNumberOfSides (int)
 Set the number of sides for the tube. More...
 
virtual int GetNumberOfSides ()
 
virtual void SetRadiusFactor (double)
 Set the maximum tube radius in terms of a multiple of the minimum radius. More...
 
virtual double GetRadiusFactor ()
 
virtual void SetDefaultNormal (double, double, double)
 Set the default normal to use if no normals are supplied, and the DefaultNormalOn is set. More...
 
virtual void SetDefaultNormal (double[3])
 
virtual doubleGetDefaultNormal ()
 
virtual void GetDefaultNormal (double data[3])
 
virtual void SetUseDefaultNormal (vtkTypeBool)
 Set a boolean to control whether to use default normals. More...
 
virtual vtkTypeBool GetUseDefaultNormal ()
 
virtual void UseDefaultNormalOn ()
 
virtual void UseDefaultNormalOff ()
 
virtual void SetSidesShareVertices (vtkTypeBool)
 Set a boolean to control whether tube sides should share vertices. More...
 
virtual vtkTypeBool GetSidesShareVertices ()
 
virtual void SidesShareVerticesOn ()
 
virtual void SidesShareVerticesOff ()
 
virtual void SetCapping (vtkTypeBool)
 Turn on/off whether to cap the ends with polygons. More...
 
virtual vtkTypeBool GetCapping ()
 
virtual void CappingOn ()
 
virtual void CappingOff ()
 
virtual void SetOnRatio (int)
 Control the striping of the tubes. More...
 
virtual int GetOnRatio ()
 
virtual void SetOffset (int)
 Control the striping of the tubes. More...
 
virtual int GetOffset ()
 
virtual void SetGenerateTCoords (int)
 Control whether and how texture coordinates are produced. More...
 
virtual int GetGenerateTCoords ()
 
void SetGenerateTCoordsToOff ()
 
void SetGenerateTCoordsToNormalizedLength ()
 
void SetGenerateTCoordsToUseLength ()
 
void SetGenerateTCoordsToUseScalars ()
 
const char * GetGenerateTCoordsAsString ()
 
virtual void SetTextureLength (double)
 Control the conversion of units during the texture coordinates calculation. More...
 
virtual double GetTextureLength ()
 
virtual void SetOutputPointsPrecision (int)
 Set/get the desired precision for the output types. More...
 
virtual int GetOutputPointsPrecision ()
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTubeFilterSafeDownCast (vtkObjectBase *o)
 
static vtkTubeFilterNew ()
 Construct object with radius 0.5, radius variation turned off, the number of sides set to 3, and radius factor of 10. More...
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkTubeFilter ()
 
 ~vtkTubeFilter () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
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 *inVectors, double maxNorm, vtkDataArray *inNormals)
 
void GenerateStrips (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)
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double Radius
 
int VaryRadius
 
int NumberOfSides
 
double RadiusFactor
 
double DefaultNormal [3]
 
vtkTypeBool UseDefaultNormal
 
vtkTypeBool SidesShareVertices
 
vtkTypeBool Capping
 
int OnRatio
 
int Offset
 
int GenerateTCoords
 
int OutputPointsPrecision
 
double TextureLength
 
double Theta
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

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 vtkStreamTracer 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.
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.) If a line does not meet this criteria, then that line is not tubed.
See also
vtkRibbonFilter vtkStreamTracer
Thanks:
Michael Finch for absolute scalar radius
Examples:
vtkTubeFilter (Examples)
Tests:
vtkTubeFilter (Tests)

Definition at line 83 of file vtkTubeFilter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 86 of file vtkTubeFilter.h.

Constructor & Destructor Documentation

◆ vtkTubeFilter()

vtkTubeFilter::vtkTubeFilter ( )
protected

◆ ~vtkTubeFilter()

vtkTubeFilter::~vtkTubeFilter ( )
inlineoverrideprotected

Definition at line 240 of file vtkTubeFilter.h.

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkTubeFilter::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkTubeFilter::IsA ( const char *  name)
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 vtkPolyDataAlgorithm.

◆ SafeDownCast()

static vtkTubeFilter* vtkTubeFilter::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTubeFilter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

◆ NewInstance()

vtkTubeFilter* vtkTubeFilter::NewInstance ( ) const

◆ PrintSelf()

void vtkTubeFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 vtkPolyDataAlgorithm.

◆ New()

static 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.

◆ SetRadius()

virtual void vtkTubeFilter::SetRadius ( double  )
virtual

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

◆ GetRadius()

virtual double vtkTubeFilter::GetRadius ( )
virtual

◆ SetVaryRadius()

virtual void vtkTubeFilter::SetVaryRadius ( int  )
virtual

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

◆ GetVaryRadius()

virtual int vtkTubeFilter::GetVaryRadius ( )
virtual

◆ SetVaryRadiusToVaryRadiusOff()

void vtkTubeFilter::SetVaryRadiusToVaryRadiusOff ( )
inline

Definition at line 110 of file vtkTubeFilter.h.

◆ SetVaryRadiusToVaryRadiusByScalar()

void vtkTubeFilter::SetVaryRadiusToVaryRadiusByScalar ( )
inline

Definition at line 112 of file vtkTubeFilter.h.

◆ SetVaryRadiusToVaryRadiusByVector()

void vtkTubeFilter::SetVaryRadiusToVaryRadiusByVector ( )
inline

Definition at line 114 of file vtkTubeFilter.h.

◆ SetVaryRadiusToVaryRadiusByAbsoluteScalar()

void vtkTubeFilter::SetVaryRadiusToVaryRadiusByAbsoluteScalar ( )
inline

Definition at line 116 of file vtkTubeFilter.h.

◆ GetVaryRadiusAsString()

const char* vtkTubeFilter::GetVaryRadiusAsString ( )

◆ SetNumberOfSides()

virtual void vtkTubeFilter::SetNumberOfSides ( int  )
virtual

Set the number of sides for the tube.

At a minimum, number of sides is 3.

◆ GetNumberOfSides()

virtual int vtkTubeFilter::GetNumberOfSides ( )
virtual

◆ SetRadiusFactor()

virtual void vtkTubeFilter::SetRadiusFactor ( double  )
virtual

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

◆ GetRadiusFactor()

virtual double vtkTubeFilter::GetRadiusFactor ( )
virtual

◆ SetDefaultNormal() [1/2]

virtual void vtkTubeFilter::SetDefaultNormal ( double  ,
double  ,
double   
)
virtual

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

◆ SetDefaultNormal() [2/2]

virtual void vtkTubeFilter::SetDefaultNormal ( double  [3])
virtual

◆ GetDefaultNormal() [1/2]

virtual double* vtkTubeFilter::GetDefaultNormal ( )
virtual

◆ GetDefaultNormal() [2/2]

virtual void vtkTubeFilter::GetDefaultNormal ( double  data[3])
virtual

◆ SetUseDefaultNormal()

virtual void vtkTubeFilter::SetUseDefaultNormal ( vtkTypeBool  )
virtual

Set a boolean to control whether to use default normals.

DefaultNormalOn is set.

◆ GetUseDefaultNormal()

virtual vtkTypeBool vtkTubeFilter::GetUseDefaultNormal ( )
virtual

◆ UseDefaultNormalOn()

virtual void vtkTubeFilter::UseDefaultNormalOn ( )
virtual

◆ UseDefaultNormalOff()

virtual void vtkTubeFilter::UseDefaultNormalOff ( )
virtual

◆ SetSidesShareVertices()

virtual void vtkTubeFilter::SetSidesShareVertices ( vtkTypeBool  )
virtual

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()

virtual vtkTypeBool vtkTubeFilter::GetSidesShareVertices ( )
virtual

◆ SidesShareVerticesOn()

virtual void vtkTubeFilter::SidesShareVerticesOn ( )
virtual

◆ SidesShareVerticesOff()

virtual void vtkTubeFilter::SidesShareVerticesOff ( )
virtual

◆ SetCapping()

virtual void vtkTubeFilter::SetCapping ( vtkTypeBool  )
virtual

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

Initial value is off.

◆ GetCapping()

virtual vtkTypeBool vtkTubeFilter::GetCapping ( )
virtual

◆ CappingOn()

virtual void vtkTubeFilter::CappingOn ( )
virtual

◆ CappingOff()

virtual void vtkTubeFilter::CappingOff ( )
virtual

◆ SetOnRatio()

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.

◆ GetOnRatio()

virtual int vtkTubeFilter::GetOnRatio ( )
virtual

◆ SetOffset()

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.

◆ GetOffset()

virtual int vtkTubeFilter::GetOffset ( )
virtual

◆ SetGenerateTCoords()

virtual void vtkTubeFilter::SetGenerateTCoords ( int  )
virtual

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()

virtual int vtkTubeFilter::GetGenerateTCoords ( )
virtual

◆ SetGenerateTCoordsToOff()

void vtkTubeFilter::SetGenerateTCoordsToOff ( )
inline

Definition at line 206 of file vtkTubeFilter.h.

◆ SetGenerateTCoordsToNormalizedLength()

void vtkTubeFilter::SetGenerateTCoordsToNormalizedLength ( )
inline

Definition at line 208 of file vtkTubeFilter.h.

◆ SetGenerateTCoordsToUseLength()

void vtkTubeFilter::SetGenerateTCoordsToUseLength ( )
inline

Definition at line 210 of file vtkTubeFilter.h.

◆ SetGenerateTCoordsToUseScalars()

void vtkTubeFilter::SetGenerateTCoordsToUseScalars ( )
inline

Definition at line 212 of file vtkTubeFilter.h.

◆ GetGenerateTCoordsAsString()

const char* vtkTubeFilter::GetGenerateTCoordsAsString ( )

◆ SetTextureLength()

virtual void vtkTubeFilter::SetTextureLength ( double  )
virtual

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()

virtual double vtkTubeFilter::GetTextureLength ( )
virtual

◆ SetOutputPointsPrecision()

virtual void vtkTubeFilter::SetOutputPointsPrecision ( int  )
virtual

Set/get the desired precision for the output types.

See the documentation for the vtkAlgorithm::DesiredOutputPrecision enum for an explanation of the available precision settings.

◆ GetOutputPointsPrecision()

virtual int vtkTubeFilter::GetOutputPointsPrecision ( )
virtual

◆ RequestData()

int vtkTubeFilter::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

◆ GeneratePoints()

int vtkTubeFilter::GeneratePoints ( vtkIdType  offset,
vtkIdType  npts,
const vtkIdType pts,
vtkPoints inPts,
vtkPoints newPts,
vtkPointData pd,
vtkPointData outPD,
vtkFloatArray newNormals,
vtkDataArray inScalars,
double  range[2],
vtkDataArray inVectors,
double  maxNorm,
vtkDataArray inNormals 
)
protected

◆ GenerateStrips()

void vtkTubeFilter::GenerateStrips ( vtkIdType  offset,
vtkIdType  npts,
const vtkIdType pts,
vtkIdType  inCellId,
vtkCellData cd,
vtkCellData outCD,
vtkCellArray newStrips 
)
protected

◆ GenerateTextureCoords()

void vtkTubeFilter::GenerateTextureCoords ( vtkIdType  offset,
vtkIdType  npts,
const vtkIdType pts,
vtkPoints inPts,
vtkDataArray inScalars,
vtkFloatArray newTCoords 
)
protected

◆ ComputeOffset()

vtkIdType vtkTubeFilter::ComputeOffset ( vtkIdType  offset,
vtkIdType  npts 
)
protected

Member Data Documentation

◆ Radius

double vtkTubeFilter::Radius
protected

Definition at line 245 of file vtkTubeFilter.h.

◆ VaryRadius

int vtkTubeFilter::VaryRadius
protected

Definition at line 246 of file vtkTubeFilter.h.

◆ NumberOfSides

int vtkTubeFilter::NumberOfSides
protected

Definition at line 247 of file vtkTubeFilter.h.

◆ RadiusFactor

double vtkTubeFilter::RadiusFactor
protected

Definition at line 248 of file vtkTubeFilter.h.

◆ DefaultNormal

double vtkTubeFilter::DefaultNormal[3]
protected

Definition at line 249 of file vtkTubeFilter.h.

◆ UseDefaultNormal

vtkTypeBool vtkTubeFilter::UseDefaultNormal
protected

Definition at line 250 of file vtkTubeFilter.h.

◆ SidesShareVertices

vtkTypeBool vtkTubeFilter::SidesShareVertices
protected

Definition at line 251 of file vtkTubeFilter.h.

◆ Capping

vtkTypeBool vtkTubeFilter::Capping
protected

Definition at line 252 of file vtkTubeFilter.h.

◆ OnRatio

int vtkTubeFilter::OnRatio
protected

Definition at line 253 of file vtkTubeFilter.h.

◆ Offset

int vtkTubeFilter::Offset
protected

Definition at line 254 of file vtkTubeFilter.h.

◆ GenerateTCoords

int vtkTubeFilter::GenerateTCoords
protected

Definition at line 255 of file vtkTubeFilter.h.

◆ OutputPointsPrecision

int vtkTubeFilter::OutputPointsPrecision
protected

Definition at line 256 of file vtkTubeFilter.h.

◆ TextureLength

double vtkTubeFilter::TextureLength
protected

Definition at line 257 of file vtkTubeFilter.h.

◆ Theta

double vtkTubeFilter::Theta
protected

Definition at line 276 of file vtkTubeFilter.h.


The documentation for this class was generated from the following file: