ALPHALINUX5/util/ALPHALINUX5/include/vtk/vtkStreamLine.h

   1 /*=========================================================================
   2
   3   Program:   Visualization Toolkit
   4   Module:    $RCSfile: vtkStreamLine.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002/02/01 06:35:50 $
   7   Version:   $Revision: 1.1.1.1 $
   8
   9
  10 Copyright (c) 1993-1998 Ken Martin, Will Schroeder, Bill Lorensen.
  11
  12 This software is copyrighted by Ken Martin, Will Schroeder and Bill Lorensen.
  13 The following terms apply to all files associated with the software unless
  14 explicitly disclaimed in individual files. This copyright specifically does
  15 not apply to the related textbook "The Visualization Toolkit" ISBN
  16 013199837-4 published by Prentice Hall which is covered by its own copyright.
  17
  18 The authors hereby grant permission to use, copy, and distribute this
  19 software and its documentation for any purpose, provided that existing
  20 copyright notices are retained in all copies and that this notice is included
  21 verbatim in any distributions. Additionally, the authors grant permission to
  22 modify this software and its documentation for any purpose, provided that
  23 such modifications are not distributed without the explicit consent of the
  24 authors and that existing copyright notices are retained in all copies. Some
  25 of the algorithms implemented by this software are patented, observe all
  26 applicable patent law.
  27
  28 IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY FOR
  29 DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
  30 OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY DERIVATIVES THEREOF,
  31 EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32
  33 THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
  34 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  35 PARTICULAR PURPOSE, AND NON-INFRINGEMENT.  THIS SOFTWARE IS PROVIDED ON AN
  36 "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE
  37 MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  38
  39
  40 =========================================================================*/
  41 // .NAME vtkStreamLine - generate streamline in arbitrary dataset
  42 // .SECTION Description
  43 // vtkStreamLine is a filter that generates a streamline for an arbitrary
  44 // dataset. A streamline is a line that is everywhere tangent to the vector
  45 // field. Scalar values also are calculated along the streamline and can be
  46 // used to color the line. Streamlines are calculated by integrating from
  47 // a starting point through the vector field. Integration can be performed
  48 // forward in time (see where the line goes), backward in time (see where the
  49 // line came from), or in both directions. It also is possible to compute
  50 // vorticity along the streamline. Vorticity is the projection (i.e., dot
  51 // product) of the flow rotation on the velocity vector, i.e., the rotation
  52 // of flow around the streamline.
  53 //
  54 // vtkStreamLine defines the instance variable StepLength. This parameter
  55 // controls the length of the line segments used to define the streamline.
  56 // The streamline(s) will consist of one (or more) polylines with line
  57 // segment lengths of size StepLength. Smaller values reduce in more line
  58 // primitives but smoother streamlines. The StepLength instance variable is
  59 // defined in terms of time (i.e., the distance that the particle travels in
  60 // the specified time period). Thus, the line segments will be smaller in areas
  61 // of low velocity and larger in regions of high velocity. (NOTE: This is
  62 // different than the IntegrationStepLength defined by the superclass
  63 // vtkStreamer. IntegrationStepLength is used to control integration step
  64 // size and is expressed as a fraction of the cell length.) The StepLength
  65 // instance variable is important because subclasses of vtkStreamLine (e.g.,
  66 // vtkDashedStreamLine) depend on this value to build their representation.
  67 // .SECTION See Also
  68 // vtkStreamer vtkDashedStreamLine vtkStreamPoints
  69
  70 #ifndef __vtkStreamLine_h
  71 #define __vtkStreamLine_h
  72
  73 #include "vtkStreamer.h"
  74
  75 class VTK_EXPORT vtkStreamLine : public vtkStreamer
  76 {
  77 public:
  78   vtkStreamLine();
  79   static vtkStreamLine *New() {return new vtkStreamLine;};
  80   const char *GetClassName() {return "vtkStreamLine";};
  81   void PrintSelf(ostream& os, vtkIndent indent);
  82
  83   // Description:
  84   // Specify the length of a line segment. The length is expressed in terms of
  85   // elapsed time. Smaller values result in smoother appearing streamlines, but
  86   // greater numbers of line primitives.
  87   vtkSetClampMacro(StepLength,float,0.000001,VTK_LARGE_FLOAT);
  88   vtkGetMacro(StepLength,float);
  89
  90 protected:
  91   // Convert streamer array into vtkPolyData
  92   void Execute();
  93
  94   // the length of line primitives
  95   float StepLength;
  96
  97 };
  98
  99 #endif
 100
 101