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
vtkDashedStreamLine Class Reference

generate constant-time dashed streamline in arbitrary dataset More...

#include <vtkDashedStreamLine.h>

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

Public Types

typedef vtkStreamLine Superclass
 
- Public Types inherited from vtkStreamLine
typedef vtkStreamer Superclass
 
- Public Types inherited from vtkStreamer
typedef vtkPolyDataAlgorithm Superclass
 
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkDashedStreamLineNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetDashFactor (double)
 
virtual double GetDashFactor ()
 
- Public Member Functions inherited from vtkStreamLine
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 ()
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformation * GetInputPortInformation (int port)
 
vtkInformation * GetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformation * GetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
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)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformation * GetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int extent[6])
 
int * GetUpdateExtent ()
 
int * GetUpdateExtent (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 ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 

Static Public Member Functions

static vtkDashedStreamLineNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDashedStreamLineSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkStreamLine
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)
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey * 
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKey * INPUT_PORT ()
 
static vtkInformationIntegerKey * INPUT_CONNECTION ()
 
static vtkInformationIntegerKey * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkDashedStreamLine ()
 
 ~vtkDashedStreamLine ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkStreamLine
 vtkStreamLine ()
 
 ~vtkStreamLine ()
 
- 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 Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutiveCreateDefaultExecutive ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformation * GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
virtual void SetErrorCode (unsigned long)
 

Protected Attributes

double DashFactor
 
- Protected Attributes inherited from vtkStreamLine
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
 
vtkInitialValueProblemSolverIntegrator
 
double Epsilon
 
double SavePointInterval
 
vtkMultiThreader * Threader
 
int NumberOfThreads
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkStreamer
static VTK_THREAD_RETURN_TYPE ThreadedIntegrate (void *arg)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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 43 of file vtkDashedStreamLine.h.

Member Typedef Documentation

Definition at line 47 of file vtkDashedStreamLine.h.

Constructor & Destructor Documentation

vtkDashedStreamLine::vtkDashedStreamLine ( )
protected
vtkDashedStreamLine::~vtkDashedStreamLine ( )
inlineprotected

Definition at line 60 of file vtkDashedStreamLine.h.

Member Function Documentation

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

Reimplemented from vtkStreamLine.

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

Reimplemented from vtkStreamLine.

vtkDashedStreamLine* vtkDashedStreamLine::NewInstance ( ) const
void vtkDashedStreamLine::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 
)
protectedvirtual

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 66 of file vtkDashedStreamLine.h.


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