vtkPeriodicDataArray.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkPeriodicDataArray.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 vtkPeriodicDataArray_h
#define vtkPeriodicDataArray_h

#include "vtkMappedDataArray.h"   // Parent
#include "vtkDataArrayTemplate.h" // Template

template <class Scalar>
class vtkPeriodicDataArray:
public vtkTypeTemplate <vtkPeriodicDataArray <Scalar>, vtkMappedDataArray <Scalar> >
{
public:
  virtual void PrintSelf(ostream &os, vtkIndent indent);

  void InitializeArray(vtkDataArrayTemplate<Scalar>* inputData);

  void Initialize();

  void GetTuples(vtkIdList *ptIds, vtkAbstractArray *output);

  void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray *output);

  void Squeeze();

  vtkArrayIterator *NewIterator();

  vtkIdType LookupValue(vtkVariant value);

  void LookupValue(vtkVariant value, vtkIdList *ids);

  vtkVariant GetVariantValue(vtkIdType idx);

  void ClearLookup();

  double* GetTuple(vtkIdType i);

  void GetTuple(vtkIdType i, double *tuple);

  vtkIdType LookupTypedValue(Scalar value);

  void LookupTypedValue(Scalar value, vtkIdList *ids);

  Scalar GetValue(vtkIdType idx);

  Scalar& GetValueReference(vtkIdType idx);

  void GetTupleValue(vtkIdType idx, Scalar *t);

  unsigned long GetActualMemorySize();

  int Allocate(vtkIdType sz, vtkIdType ext);

  int Resize(vtkIdType numTuples);

  void SetNumberOfTuples(vtkIdType number);

  void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source);

  void SetTuple(vtkIdType i, const float *source);

  void SetTuple(vtkIdType i, const double *source);

  void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source);

  void InsertTuple(vtkIdType i, const float *source);

  void InsertTuple(vtkIdType i, const double *source);


  void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds,
                    vtkAbstractArray *source);


  void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
                    vtkAbstractArray* source);

  vtkIdType InsertNextTuple(vtkIdType j, vtkAbstractArray *source);

  vtkIdType InsertNextTuple(const float *source);

  vtkIdType InsertNextTuple(const double *source);

  void DeepCopy(vtkAbstractArray *aa);

  void DeepCopy(vtkDataArray *da);


  void InterpolateTuple(vtkIdType i, vtkIdList *ptIndices,
                        vtkAbstractArray* source, double* weights);


  void InterpolateTuple(vtkIdType i, vtkIdType id1, vtkAbstractArray *source1,
                        vtkIdType id2, vtkAbstractArray *source2, double t);

  void SetVariantValue(vtkIdType idx, vtkVariant value);

  void RemoveTuple(vtkIdType id);

  void RemoveFirstTuple();

  void RemoveLastTuple();

  void SetTupleValue(vtkIdType i, const Scalar *t);

  void InsertTupleValue(vtkIdType i, const Scalar *t);

  vtkIdType InsertNextTupleValue(const Scalar *t);

  void SetValue(vtkIdType idx, Scalar value);

  vtkIdType InsertNextValue(Scalar v);

  void InsertValue(vtkIdType idx, Scalar v);


  vtkSetMacro(Normalize, bool);
  vtkGetMacro(Normalize, bool);

protected:
  vtkPeriodicDataArray();
  ~vtkPeriodicDataArray();

  virtual void Transform(Scalar* tuple) = 0;

  virtual bool ComputeScalarRange(double* range);

  virtual bool ComputeVectorRange(double range[2]);

  virtual void ComputePeriodicRange();

  void InvalidateRange();

  bool Normalize; // If transformed vector must be normalized

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

  Scalar* TempScalarArray; // Temporary array used by GetTupleValue methods
  double* TempDoubleArray; // Temporary array used by GetTuple vethods
  vtkIdType TempTupleIdx;  // Location of currently stored Temp Tuple to use as cache
  vtkDataArrayTemplate<Scalar>* Data; // Original data

  bool InvalidRange;
  double PeriodicRange[6]; // Transformed periodic range
};

#include "vtkPeriodicDataArray.txx"

#endif //vtkPeriodicDataArray_h
// VTK-HeaderTest-Exclude: vtkPeriodicDataArray.h