vtkDashedStreamLine Class Reference

#include <vtkDashedStreamLine.h>

Inheritance diagram for vtkDashedStreamLine:

Inheritance graph
[legend]
Collaboration diagram for vtkDashedStreamLine:

Collaboration graph
[legend]

List of all members.


Detailed Description

generate constant-time dashed streamline in arbitrary dataset

vtkDashedStreamLine is a filter that generates a "dashed" streamline for an arbitrary dataset. The streamline consists of a series of dashes, each of which represents (approximately) a constant time increment. Thus, in the resulting visual representation, relatively long dashes represent areas of high velocity, and small dashes represent areas of low velocity.

vtkDashedStreamLine introduces the instance variable DashFactor. DashFactor interacts with its superclass' instance variable StepLength to create the dashes. DashFactor is the percentage of the StepLength line segment that is visible. Thus, if the DashFactor=0.75, the dashes will be "three-quarters on" and "one-quarter off".

See also:
vtkStreamer vtkStreamLine vtkStreamPoints
Tests:
vtkDashedStreamLine (Tests)

Definition at line 42 of file vtkDashedStreamLine.h.


Public Types

typedef vtkStreamLine Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetDashFactor (double)
virtual double GetDashFactor ()

Static Public Member Functions

static vtkDashedStreamLineNew ()
static int IsTypeOf (const char *type)
static vtkDashedStreamLineSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkDashedStreamLine ()
 ~vtkDashedStreamLine ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

double DashFactor

Member Typedef Documentation

Reimplemented from vtkStreamLine.

Definition at line 46 of file vtkDashedStreamLine.h.


Constructor & Destructor Documentation

vtkDashedStreamLine::vtkDashedStreamLine (  )  [protected]

vtkDashedStreamLine::~vtkDashedStreamLine (  )  [inline, protected]

Definition at line 59 of file vtkDashedStreamLine.h.


Member Function Documentation

static vtkDashedStreamLine* vtkDashedStreamLine::New (  )  [static]

Construct object with step size set to 1.0.

Reimplemented from vtkStreamLine.

virtual const char* vtkDashedStreamLine::GetClassName (  )  [virtual]

Reimplemented from vtkStreamLine.

static int vtkDashedStreamLine::IsTypeOf ( const char *  name  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkStreamLine.

virtual int vtkDashedStreamLine::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkStreamLine.

static vtkDashedStreamLine* vtkDashedStreamLine::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkStreamLine.

void vtkDashedStreamLine::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 vtkStreamLine.

virtual void vtkDashedStreamLine::SetDashFactor ( double   )  [virtual]

For each dash, specify the fraction of the dash that is "on". A factor of 1.0 will result in a continuous line, a factor of 0.5 will result in dashed that are half on and half off.

virtual double vtkDashedStreamLine::GetDashFactor (  )  [virtual]

For each dash, specify the fraction of the dash that is "on". A factor of 1.0 will result in a continuous line, a factor of 0.5 will result in dashed that are half on and half off.

virtual int vtkDashedStreamLine::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkStreamLine.


Member Data Documentation

double vtkDashedStreamLine::DashFactor [protected]

Definition at line 65 of file vtkDashedStreamLine.h.


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

Generated on Wed Jun 3 18:58:57 2009 for VTK by  doxygen 1.5.6