dox/Filtering/vtkAbstractInterpolatedVelocityField.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkAbstractInterpolatedVelocityField.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkAbstractInterpolatedVelocityField_h
#define __vtkAbstractInterpolatedVelocityField_h

#include "vtkFunctionSet.h"
//BTX
#include <vector> // STL Header; Required for vector
//ETX

class vtkDataSet;
//BTX
class vtkDataArray;
//ETX
class vtkPointData;
class vtkGenericCell;
class vtkAbstractInterpolatedVelocityFieldDataSetsType;

class VTK_FILTERING_EXPORT vtkAbstractInterpolatedVelocityField : public vtkFunctionSet
{
public:
  vtkTypeMacro( vtkAbstractInterpolatedVelocityField, vtkFunctionSet );
  void PrintSelf( ostream & os, vtkIndent indent );
  

  vtkSetMacro( Caching, bool );
  vtkGetMacro( Caching, bool );


  vtkGetMacro( CacheHit, int );
  vtkGetMacro( CacheMiss, int );
  

  vtkGetMacro( LastDataSetIndex, int );
  vtkGetObjectMacro( LastDataSet, vtkDataSet );


  vtkGetMacro( LastCellId, vtkIdType );
  virtual void SetLastCellId( vtkIdType c ) { this->LastCellId = c; }
  
  virtual void SetLastCellId( vtkIdType c, int dataindex ) = 0;
  

  vtkGetStringMacro( VectorsSelection );
  void SelectVectors( const char * fieldName )
    { this->SetVectorsSelection( fieldName ); }
    

  vtkSetMacro( NormalizeVector, bool );
  vtkGetMacro( NormalizeVector, bool );
  

  virtual void CopyParameters( vtkAbstractInterpolatedVelocityField * from )
    { this->Caching = from->Caching; }
  
  virtual void AddDataSet( vtkDataSet * dataset ) = 0;
  
  virtual int FunctionValues( double * x, double * f ) = 0;

  void ClearLastCellId() { this->LastCellId = -1; }


  int GetLastWeights( double * w );
  int GetLastLocalCoordinates( double pcoords[3] );

protected:
  vtkAbstractInterpolatedVelocityField();
  ~vtkAbstractInterpolatedVelocityField();
  
  static const double TOLERANCE_SCALE;

  int       CacheHit;
  int       CacheMiss;
  int       WeightsSize;
  int       LastDataSetIndex;
  bool      Caching;
  bool      NormalizeVector;
  char *    VectorsSelection;
  double *  Weights;
  double    LastPCoords[3];
  vtkIdType LastCellId;
  vtkDataSet *     LastDataSet;
  vtkGenericCell * Cell;
  vtkGenericCell * GenCell; // the current cell
  vtkAbstractInterpolatedVelocityFieldDataSetsType * DataSets;
  

  vtkSetStringMacro( VectorsSelection );
  
  virtual int FunctionValues( vtkDataSet * ds, double * x, double * f );
  
//BTX
  friend class vtkTemporalInterpolatedVelocityField;

  void FastCompute( vtkDataArray * vectors, double f[3] );
  bool InterpolatePoint( vtkPointData * outPD, vtkIdType outIndex );
  vtkGenericCell * GetLastCell()
    { return ( this->LastCellId != -1 ) ? this->GenCell : NULL; }
//ETX

private:
  vtkAbstractInterpolatedVelocityField
    ( const vtkAbstractInterpolatedVelocityField & );  // Not implemented.
  void operator = ( const vtkAbstractInterpolatedVelocityField & );  // Not implemented.
};

//BTX
typedef std::vector< vtkDataSet * > DataSetsTypeBase;
class   vtkAbstractInterpolatedVelocityFieldDataSetsType: public DataSetsTypeBase { };
//ETX

#endif