VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkStreamLine Class Reference

generate streamline in arbitrary dataset More...

#include <vtkStreamLine.h>

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

Public Types

typedef vtkStreamer Superclass
 
- Public Types inherited from vtkStreamer
typedef vtkPolyDataAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkStreamLineNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetStepLength (double)
 
virtual double GetStepLength ()
 
- Public Member Functions inherited from vtkStreamer
vtkStreamerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetStartLocation (vtkIdType cellId, int subId, double pcoords[3])
 
vtkIdType GetStartLocation (int &subId, double pcoords[3])
 
void SetStartPosition (double x[3])
 
void SetStartPosition (double x, double y, double z)
 
double * GetStartPosition ()
 
void SetSourceConnection (vtkAlgorithmOutput *algOutput)
 
virtual void SetNumberOfThreads (int)
 
virtual int GetNumberOfThreads ()
 
virtual void SetSavePointInterval (double)
 
virtual double GetSavePointInterval ()
 
void SetStartLocation (vtkIdType cellId, int subId, double r, double s, double t)
 
void SetSourceData (vtkDataSet *source)
 
vtkDataSet * GetSource ()
 
virtual void SetMaximumPropagationTime (double)
 
virtual double GetMaximumPropagationTime ()
 
virtual void SetIntegrationDirection (int)
 
virtual int GetIntegrationDirection ()
 
void SetIntegrationDirectionToForward ()
 
void SetIntegrationDirectionToBackward ()
 
void SetIntegrationDirectionToIntegrateBothDirections ()
 
const char * GetIntegrationDirectionAsString ()
 
virtual void SetIntegrationStepLength (double)
 
virtual double GetIntegrationStepLength ()
 
virtual void SetSpeedScalars (int)
 
virtual int GetSpeedScalars ()
 
virtual void SpeedScalarsOn ()
 
virtual void SpeedScalarsOff ()
 
virtual void SetOrientationScalars (int)
 
virtual int GetOrientationScalars ()
 
virtual void OrientationScalarsOn ()
 
virtual void OrientationScalarsOff ()
 
virtual void SetTerminalSpeed (double)
 
virtual double GetTerminalSpeed ()
 
virtual void SetVorticity (int)
 
virtual int GetVorticity ()
 
virtual void VorticityOn ()
 
virtual void VorticityOff ()
 
void SetIntegrator (vtkInitialValueProblemSolver *)
 
virtual
vtkInitialValueProblemSolver * 
GetIntegrator ()
 
virtual void SetEpsilon (double)
 
virtual double GetEpsilon ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkStreamLineSafeDownCast (vtkObjectBase *o)
 
static vtkStreamLineNew ()
 
- Static Public Member Functions inherited from vtkStreamer
static int IsTypeOf (const char *type)
 
static vtkStreamerSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkStreamLine ()
 
 ~vtkStreamLine ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkStreamer
void Integrate (vtkDataSet *input, vtkDataSet *source)
 
void InitializeThreadedIntegrate ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
 vtkStreamer ()
 
 ~vtkStreamer ()
 
virtual vtkIdType GetNumberOfStreamers ()
 
StreamArrayGetStreamers ()
 

Protected Attributes

double StepLength
 
- Protected Attributes inherited from vtkStreamer
int StartFrom
 
vtkIdType StartCell
 
int StartSubId
 
double StartPCoords [3]
 
double StartPosition [3]
 
StreamArrayStreamers
 
vtkIdType NumberOfStreamers
 
double MaximumPropagationTime
 
int IntegrationDirection
 
double IntegrationStepLength
 
int Vorticity
 
double TerminalSpeed
 
int SpeedScalars
 
int OrientationScalars
 
vtkInitialValueProblemSolver * Integrator
 
double Epsilon
 
double SavePointInterval
 
vtkMultiThreader * Threader
 
int NumberOfThreads
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkStreamer
static VTK_THREAD_RETURN_TYPE ThreadedIntegrate (void *arg)
 

Detailed Description

generate streamline in arbitrary dataset

vtkStreamLine is a filter that generates a streamline for an arbitrary dataset. A streamline is a line that is everywhere tangent to the vector field. Scalar values also are calculated along the streamline and can be used to color the line. Streamlines are calculated by integrating from a starting point through the vector field. Integration can be performed forward in time (see where the line goes), backward in time (see where the line came from), or in both directions. It also is possible to compute vorticity along the streamline. Vorticity is the projection (i.e., dot product) of the flow rotation on the velocity vector, i.e., the rotation of flow around the streamline.

vtkStreamLine defines the instance variable StepLength. This parameter controls the time increment used to generate individual points along the streamline(s). Smaller values result in more line primitives but smoother streamlines. The StepLength instance variable is defined in terms of time (i.e., the distance that the particle travels in the specified time period). Thus, the line segments will be smaller in areas of low velocity and larger in regions of high velocity. (NOTE: This is different than the IntegrationStepLength defined by the superclass vtkStreamer. IntegrationStepLength is used to control integration step size and is expressed as a fraction of the cell length.) The StepLength instance variable is important because subclasses of vtkStreamLine (e.g., vtkDashedStreamLine) depend on this value to build their representation.

See Also
vtkStreamer vtkDashedStreamLine vtkStreamPoints
Examples:
vtkStreamLine (Examples)
Tests:
vtkStreamLine (Tests)

Definition at line 58 of file vtkStreamLine.h.

Member Typedef Documentation

Definition at line 61 of file vtkStreamLine.h.

Constructor & Destructor Documentation

vtkStreamLine::vtkStreamLine ( )
protected
vtkStreamLine::~vtkStreamLine ( )
inlineprotected

Definition at line 77 of file vtkStreamLine.h.

Member Function Documentation

static int vtkStreamLine::IsTypeOf ( const char *  type)
static
virtual int vtkStreamLine::IsA ( const char *  type)
virtual

Reimplemented from vtkStreamer.

Reimplemented in vtkDashedStreamLine.

static vtkStreamLine* vtkStreamLine::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkStreamLine::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkStreamer.

Reimplemented in vtkDashedStreamLine.

vtkStreamLine* vtkStreamLine::NewInstance ( ) const
void vtkStreamLine::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkStreamLine* vtkStreamLine::New ( )
static

Construct object with step size set to 1.0.

virtual void vtkStreamLine::SetStepLength ( double  )
virtual

Specify the length of a line segment. The length is expressed in terms of elapsed time. Smaller values result in smoother appearing streamlines, but greater numbers of line primitives.

virtual double vtkStreamLine::GetStepLength ( )
virtual

Specify the length of a line segment. The length is expressed in terms of elapsed time. Smaller values result in smoother appearing streamlines, but greater numbers of line primitives.

virtual int vtkStreamLine::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Reimplemented in vtkDashedStreamLine.

Member Data Documentation

double vtkStreamLine::StepLength
protected

Definition at line 83 of file vtkStreamLine.h.


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