vtkUniformHyperTreeGrid.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkUniformHyperTreeGrid_h
#define vtkUniformHyperTreeGrid_h

#include <algorithm> // std::min/std::max
#include <cmath>     // std::round
#include <limits>    // std::numeric_limits
#include <memory>    // std::shared_ptr

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkHyperTreeGrid.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkDoubleArray;
class vtkHyperTreeGridScales;

class VTKCOMMONDATAMODEL_EXPORT vtkUniformHyperTreeGrid : public vtkHyperTreeGrid
{
public:
  static vtkUniformHyperTreeGrid* New();
  vtkTypeMacro(vtkUniformHyperTreeGrid, vtkHyperTreeGrid);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  int GetDataObjectType() VTK_FUTURE_CONST override { return VTK_UNIFORM_HYPER_TREE_GRID; }

  void CopyStructure(vtkDataObject*) override;

  void Initialize() override;


  vtkSetVector3Macro(Origin, double);
  vtkGetVector3Macro(Origin, double);


  void SetGridScale(double, double, double);
  void SetGridScale(double*);
  vtkGetVector3Macro(GridScale, double);

  void SetGridScale(double);

  void GetGridBounds(double bounds[6]) override;


  void SetXCoordinates(vtkDataArray* XCoordinates) override;
  vtkDataArray* GetXCoordinates() override;


  void SetYCoordinates(vtkDataArray* YCoordinates) override;
  vtkDataArray* GetYCoordinates() override;


  void SetZCoordinates(vtkDataArray* ZCoordinates) override;
  vtkDataArray* GetZCoordinates() override;


  void CopyCoordinates(const vtkHyperTreeGrid* output) override;
  void SetFixedCoordinates(unsigned int axis, double value) override;

  void GetLevelZeroOriginAndSizeFromIndex(vtkIdType, double*, double*) override;

  void GetLevelZeroOriginFromIndex(vtkIdType, double*) override;

  void ShallowCopy(vtkDataObject*) override;

  void DeepCopy(vtkDataObject*) override;

  unsigned long GetActualMemorySizeBytes() override;

  vtkHyperTree* GetTree(vtkIdType, bool create = false) override;

protected:
  vtkUniformHyperTreeGrid();

  ~vtkUniformHyperTreeGrid() override;

  double Origin[3];

  double GridScale[3];


  bool ComputedXCoordinates;
  bool ComputedYCoordinates;
  bool ComputedZCoordinates;

  unsigned int FindDichotomic(double value, unsigned char dim, double tol) const
  {
    unsigned int maxIdx = this->GetDimensions()[dim] - 1;
    if (value < (this->Origin[dim] - tol) ||
      value > (this->Origin[dim] + tol + this->GridScale[dim] * maxIdx))
    {
      return std::numeric_limits<unsigned int>::max();
    }

    long idx = std::round((value - this->Origin[dim]) / this->GridScale[dim]);
    return std::min(std::max(idx, 0l), static_cast<long>(maxIdx));
  }

  unsigned int FindDichotomicX(double value, double tolerance = 0.0) const override
  {
    return this->FindDichotomic(value, 0, tolerance);
  }
  unsigned int FindDichotomicY(double value, double tolerance = 0.0) const override
  {
    return this->FindDichotomic(value, 1, tolerance);
  }
  unsigned int FindDichotomicZ(double value, double tolerance = 0.0) const override
  {
    return this->FindDichotomic(value, 2, tolerance);
  }

  std::shared_ptr<vtkHyperTreeGridScales> Scales;

private:
  vtkUniformHyperTreeGrid(const vtkUniformHyperTreeGrid&) = delete;
  void operator=(const vtkUniformHyperTreeGrid&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif