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 "vtkGenericDataArray.h"   // Parent
#include "vtkAOSDataArrayTemplate.h" // Template

template <class Scalar>
class vtkPeriodicDataArray:
    public vtkGenericDataArray<vtkPeriodicDataArray<Scalar>, Scalar>
{
  typedef vtkGenericDataArray<vtkPeriodicDataArray<Scalar>, Scalar> GenericBase;
public:
  vtkTemplateTypeMacro(vtkPeriodicDataArray<Scalar>, GenericBase)
  typedef typename Superclass::ValueType ValueType;

  void PrintSelf(ostream& os, vtkIndent indent) override;

  void InitializeArray(vtkAOSDataArrayTemplate<Scalar>* inputData);

  void Initialize() override;

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

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

  void Squeeze() override;

  VTK_NEWINSTANCE vtkArrayIterator *NewIterator() override;

  vtkIdType LookupValue(vtkVariant value) override;

  void LookupValue(vtkVariant value, vtkIdList *ids) override;

  vtkVariant GetVariantValue(vtkIdType idx) override;

  void ClearLookup() override;

  double* GetTuple(vtkIdType i) override;

  void GetTuple(vtkIdType i, double *tuple) override;

  vtkIdType LookupTypedValue(Scalar value) override;

  void LookupTypedValue(Scalar value, vtkIdList *ids) override;

  ValueType GetValue(vtkIdType idx) const ;

  ValueType& GetValueReference(vtkIdType idx);

  void GetTypedTuple(vtkIdType idx, Scalar *t) const;

  ValueType GetTypedComponent(vtkIdType tupleIdx, int compIdx) const;

  unsigned long GetActualMemorySize() override;

  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext) override;

  vtkTypeBool Resize(vtkIdType numTuples) override;

  void SetNumberOfTuples(vtkIdType number) override;

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

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

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

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

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

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

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

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

  vtkIdType InsertNextTuple(vtkIdType j, vtkAbstractArray *source) override;

  vtkIdType InsertNextTuple(const float *source) override;

  vtkIdType InsertNextTuple(const double *source) override;

  void DeepCopy(vtkAbstractArray *aa) override;

  void DeepCopy(vtkDataArray *da) override;

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

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

  void SetVariantValue(vtkIdType idx, vtkVariant value) override;

  void InsertVariantValue(vtkIdType idx, vtkVariant value) override;

  void RemoveTuple(vtkIdType id) override;

  void RemoveFirstTuple() override;

  void RemoveLastTuple() override;

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

  void SetTypedComponent(vtkIdType t, int c, Scalar v);

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

  vtkIdType InsertNextTypedTuple(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() override;


  bool AllocateTuples(vtkIdType numTuples);
  bool ReallocateTuples(vtkIdType numTuples);

  virtual void Transform(Scalar* tuple) const = 0;

  bool ComputeScalarRange(double* range) override;

  bool ComputeVectorRange(double range[2]) override;

  virtual void ComputePeriodicRange();

  void InvalidateRange();

  bool Normalize; // If transformed vector must be normalized

private:
  vtkPeriodicDataArray(const vtkPeriodicDataArray &) = delete;
  void operator=(const vtkPeriodicDataArray &) = delete;

  friend class vtkGenericDataArray<vtkPeriodicDataArray<Scalar>, Scalar>;

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

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

#include "vtkPeriodicDataArray.txx"

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