vtkRectilinearGrid.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 vtkRectilinearGrid_h
#define vtkRectilinearGrid_h

#include "vtkCartesianGrid.h"
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDeprecation.h"           // for VTK_DEPRECATED_IN_9_6_0
#include "vtkSmartPointer.h"          // For vtkSmartPointer
#include "vtkStructuredData.h"        // For inline methods
#include "vtkWrappingHints.h"         // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkDataArray;
class vtkStructuredCellArray;
class vtkPoints;

class VTKCOMMONDATAMODEL_EXPORT VTK_MARSHALAUTO vtkRectilinearGrid : public vtkCartesianGrid
{
public:
  static vtkRectilinearGrid* New();
  static vtkRectilinearGrid* ExtendedNew();

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

  int GetDataObjectType() VTK_FUTURE_CONST override { return VTK_RECTILINEAR_GRID; }


  void ShallowCopy(vtkDataObject* src) override;
  void DeepCopy(vtkDataObject* src) override;

  void CopyStructure(vtkDataSet* ds) override;

  void Initialize() override;

  using Superclass::FindCell;
  using Superclass::GetCell;

  void GetCell(vtkIdType cellId, vtkGenericCell* cell) override;
  void GetCellBounds(vtkIdType cellId, double bounds[6]) override;
  vtkIdType FindPoint(double x[3]) override;
  vtkIdType FindCell(double x[3], vtkCell* cell, vtkGenericCell* genCell, vtkIdType cellId,
    double tol2, int& subId, double pcoords[3], double* weights) override;
  void ComputeBounds() override;

  int ComputeStructuredCoordinates(const double x[3], int ijk[3], double pcoords[3]) override;

  VTK_DEPRECATED_IN_9_6_0("Use the const version instead")
  int ComputeStructuredCoordinates(double x[3], int ijk[3], double pcoords[3])
  {
    const double* pt = x;
    return this->ComputeStructuredCoordinates(pt, ijk, pcoords);
  };

  vtkIdType ComputePointId(int ijk[3]) override;

  vtkIdType ComputeCellId(int ijk[3]) override;

  using Superclass::GetPoint;
  void GetPoint(int i, int j, int k, double p[3]);


  virtual void SetXCoordinates(vtkDataArray*);
  vtkGetObjectMacro(XCoordinates, vtkDataArray);


  virtual void SetYCoordinates(vtkDataArray*);
  vtkGetObjectMacro(YCoordinates, vtkDataArray);


  virtual void SetZCoordinates(vtkDataArray*);
  vtkGetObjectMacro(ZCoordinates, vtkDataArray);

  unsigned long GetActualMemorySize() override;

  void Crop(const int updateExtent[6]) override;


  static vtkRectilinearGrid* GetData(vtkInformation* info);
  static vtkRectilinearGrid* GetData(vtkInformationVector* v, int i = 0);

protected:
  vtkRectilinearGrid();
  ~vtkRectilinearGrid() override;

  vtkDataArray* XCoordinates;
  vtkDataArray* YCoordinates;
  vtkDataArray* ZCoordinates;

  void BuildPoints() override;

private:
  void Cleanup();

  vtkRectilinearGrid(const vtkRectilinearGrid&) = delete;
  void operator=(const vtkRectilinearGrid&) = delete;
};

//----------------------------------------------------------------------------
inline vtkIdType vtkRectilinearGrid::ComputePointId(int ijk[3])
{
  return vtkStructuredData::ComputePointId(this->GetDimensions(), ijk);
}

//----------------------------------------------------------------------------
inline vtkIdType vtkRectilinearGrid::ComputeCellId(int ijk[3])
{
  return vtkStructuredData::ComputeCellId(this->GetDimensions(), ijk);
}

VTK_ABI_NAMESPACE_END
#endif