vtkPointSet.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 vtkPointSet_h
#define vtkPointSet_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDataSet.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

#include "vtkCellTypes.h"   // For GetCellType
#include "vtkGenericCell.h" // For GetCell
#include "vtkPoints.h"      // Needed for inline methods

VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractPointLocator;
class vtkAbstractCellLocator;

class VTKCOMMONDATAMODEL_EXPORT VTK_MARSHALAUTO vtkPointSet : public vtkDataSet
{
public:
  static vtkPointSet* New();
  static vtkPointSet* ExtendedNew();


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

  int GetDataObjectType() VTK_FUTURE_CONST override { return VTK_POINT_SET; }


  vtkSetMacro(Editable, bool);
  vtkGetMacro(Editable, bool);
  vtkBooleanMacro(Editable, bool);

  void Initialize() override;

  void CopyStructure(vtkDataSet* pd) override;


  vtkIdType GetNumberOfPoints() override;
  void GetPoint(vtkIdType ptId, double x[3]) override { this->Points->GetPoint(ptId, x); }
  vtkIdType FindPoint(double x[3]) override;
  using Superclass::FindCell;
  vtkIdType FindCell(double x[3], vtkCell* cell, vtkGenericCell* gencell, vtkIdType cellId,
    double tol2, int& subId, double pcoords[3], double* weights) override;


  vtkIdType GetNumberOfCells() override { return 0; }
  int GetMaxCellSize() override { return 0; }

  using Superclass::GetCell;
  vtkCell* GetCell(vtkIdType) override;


  using vtkDataSet::GetCellPoints;
  void GetCellPoints(vtkIdType, vtkIdList* idList) override { idList->Reset(); }
  void GetPointCells(vtkIdType, vtkIdList* idList) override { idList->Reset(); }

  void GetCell(vtkIdType, vtkGenericCell* cell) override { cell->SetCellTypeToEmptyCell(); }

  int GetCellType(vtkIdType) override { return VTK_EMPTY_CELL; }

  vtkIdType GetCellSize(vtkIdType) override { return 1; }

  double* GetPoint(vtkIdType ptId) VTK_SIZEHINT(3) override { return this->Points->GetPoint(ptId); }

  vtkCellIterator* NewCellIterator() override;


  void BuildPointLocator();
  VTK_DEPRECATED_IN_9_7_0("Use BuildPointLocator() instead.")
  void BuildLocator() { this->BuildPointLocator(); }

  void BuildCellLocator();


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  virtual void SetPointLocator(vtkAbstractPointLocator*);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  vtkGetObjectMacro(PointLocator, vtkAbstractPointLocator);


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  virtual void SetCellLocator(vtkAbstractCellLocator*);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  vtkGetObjectMacro(CellLocator, vtkAbstractCellLocator);

  vtkMTimeType GetMTime() override;

  void ComputeBounds() override;

  void Squeeze() override;


  virtual void SetPoints(vtkPoints*);
  vtkPoints* GetPoints() override { return this->Points; }

  unsigned long GetActualMemorySize() override;


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


  bool UsesGarbageCollector() const override { return true; }


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

protected:
  vtkPointSet();
  ~vtkPointSet() override;

  bool Editable;
  vtkPoints* Points;
  vtkAbstractPointLocator* PointLocator;
  vtkAbstractCellLocator* CellLocator;

  void ReportReferences(vtkGarbageCollector*) override;

private:
  void Cleanup();

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

inline vtkIdType vtkPointSet::GetNumberOfPoints()
{
  if (this->Points)
  {
    return this->Points->GetNumberOfPoints();
  }
  else
  {
    return 0;
  }
}

VTK_ABI_NAMESPACE_END
#endif