vtkUniformGrid.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 vtkUniformGrid_h
#define vtkUniformGrid_h

#include "vtkAMRBox.h"                // Fox vtkAMRBox
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDeprecation.h"           // For VTK_DEPRECATED_IN_9_6_0
#include "vtkImageData.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkEmptyCell;
class vtkUnsignedCharArray;

class VTKCOMMONDATAMODEL_EXPORT VTK_MARSHALAUTO vtkUniformGrid : public vtkImageData
{
public:

  static vtkUniformGrid* New();
  vtkTypeMacro(vtkUniformGrid, vtkImageData);

  int GetDataObjectType() VTK_FUTURE_CONST override { return VTK_UNIFORM_GRID; }

  using Superclass::Initialize;

  VTK_DEPRECATED_IN_9_6_0("Use vtkAMRBox::InitializeGrid instead")
  int Initialize(const vtkAMRBox* def, double* origin, double* spacing)
  {
    return def->InitializeGrid(this, origin, spacing);
  };

  VTK_DEPRECATED_IN_9_6_0("Use vtkAMRBox::InitializeGrid instead")
  int Initialize(const vtkAMRBox* def, double* origin, double* spacing, int nGhosts)
  {
    return def->InitializeGrid(this, origin, spacing, nGhosts);
  };

  VTK_DEPRECATED_IN_9_6_0("Use vtkAMRBox::InitializeGrid instead")
  int Initialize(const vtkAMRBox* def, double* origin, double* spacing, const int nGhosts[3])
  {
    return def->InitializeGrid(this, origin, spacing, nGhosts);
  };

  VTK_DEPRECATED_IN_9_6_0("Use vtkAMRBox::InitializeGrid instead")
  int Initialize(
    const vtkAMRBox* def, double* origin, double* spacing, int nGhostsI, int nGhostsJ, int nGhostsK)
  {
    return def->InitializeGrid(this, origin, spacing, nGhostsI, nGhostsJ, nGhostsK);
  };

  VTK_DEPRECATED_IN_9_6_0("Will be removed, create a vtkImageData manually if needed")
  virtual VTK_NEWINSTANCE vtkImageData* NewImageDataCopy();


  VTK_DEPRECATED_IN_9_6_0("Use vtkImageData::GetData instead")
  static vtkUniformGrid* GetData(vtkInformation* info);
  VTK_DEPRECATED_IN_9_6_0("Use vtkImageData::GetData instead")
  static vtkUniformGrid* GetData(vtkInformationVector* v, int i = 0);

protected:
  vtkUniformGrid();
  ~vtkUniformGrid() override;

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

VTK_ABI_NAMESPACE_END
#endif