vtkPoints.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 vtkPoints_h
#define vtkPoints_h

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkDeprecation.h"      // For VTK_DEPRECATED_IN_9_7_0
#include "vtkObject.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

#include "vtkDataArray.h" // Needed for inline methods

VTK_ABI_NAMESPACE_BEGIN
class vtkIdList;

class VTKCOMMONCORE_EXPORT VTK_MARSHALAUTO vtkPoints : public vtkObject
{
public:
  static vtkPoints* New(int dataType);

  static vtkPoints* New();

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

  VTK_DEPRECATED_IN_9_7_0("Use Reserve() to allocate or Initialize() to deallocate.")
  virtual vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000);

  virtual void Initialize();

  virtual void SetData(vtkDataArray*);
  vtkDataArray* GetData() { return this->Data; }

  virtual int GetDataType() const;

  virtual void SetDataType(int dataType);
  void SetDataTypeToBit() { this->SetDataType(VTK_BIT); }
  void SetDataTypeToChar() { this->SetDataType(VTK_CHAR); }
  void SetDataTypeToUnsignedChar() { this->SetDataType(VTK_UNSIGNED_CHAR); }
  void SetDataTypeToShort() { this->SetDataType(VTK_SHORT); }
  void SetDataTypeToUnsignedShort() { this->SetDataType(VTK_UNSIGNED_SHORT); }
  void SetDataTypeToInt() { this->SetDataType(VTK_INT); }
  void SetDataTypeToUnsignedInt() { this->SetDataType(VTK_UNSIGNED_INT); }
  void SetDataTypeToLong() { this->SetDataType(VTK_LONG); }
  void SetDataTypeToUnsignedLong() { this->SetDataType(VTK_UNSIGNED_LONG); }
  void SetDataTypeToFloat() { this->SetDataType(VTK_FLOAT); }
  void SetDataTypeToDouble() { this->SetDataType(VTK_DOUBLE); }

  VTK_DEPRECATED_IN_9_7_0("Use vtkArrayDispatch")
  void* GetVoidPointer(const int id)
  {
    return this->Data->GetVoidPointer(id); // NOLINT(bugprone-unsafe-functions)
  }

  virtual void Squeeze() { this->Data->Squeeze(); }

  virtual void Reset();


  virtual void DeepCopy(vtkPoints* ad);
  virtual void ShallowCopy(vtkPoints* ad);

  unsigned long GetActualMemorySize();

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  vtkIdType GetNumberOfPoints() const { return this->Data->GetNumberOfTuples(); }

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  double* GetPoint(vtkIdType id) VTK_EXPECTS(0 <= id && id < GetNumberOfPoints()) VTK_SIZEHINT(3)
  {
    return this->Data->GetTuple(id);
  }

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void GetPoint(vtkIdType id, double x[3]) VTK_EXPECTS(0 <= id && id < GetNumberOfPoints())
    VTK_SIZEHINT(3)
  {
    this->Data->GetTuple(id, x);
  }

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetPoint(vtkIdType id, const float x[3]) VTK_EXPECTS(0 <= id && id < GetNumberOfPoints())
  {
    this->Data->SetTuple(id, x);
  }
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetPoint(vtkIdType id, const double x[3]) VTK_EXPECTS(0 <= id && id < GetNumberOfPoints())
  {
    this->Data->SetTuple(id, x);
  }
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetPoint(vtkIdType id, double x, double y, double z)
    VTK_EXPECTS(0 <= id && id < GetNumberOfPoints());


  void InsertPoint(vtkIdType id, const float x[3]) VTK_EXPECTS(0 <= id)
  {
    this->Data->InsertTuple(id, x);
  }
  void InsertPoint(vtkIdType id, const double x[3]) VTK_EXPECTS(0 <= id)
  {
    this->Data->InsertTuple(id, x);
  }
  void InsertPoint(vtkIdType id, double x, double y, double z) VTK_EXPECTS(0 <= id);

  void InsertPoints(vtkIdList* dstIds, vtkIdList* srcIds, vtkPoints* source)
  {
    this->Data->InsertTuples(dstIds, srcIds, source->Data);
  }

  void InsertPoints(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkPoints* source)
  {
    this->Data->InsertTuples(dstStart, n, srcStart, source->Data);
  }

  vtkIdType InsertNextPoint(const float x[3]) { return this->Data->InsertNextTuple(x); }
  vtkIdType InsertNextPoint(const double x[3]) { return this->Data->InsertNextTuple(x); }
  vtkIdType InsertNextPoint(double x, double y, double z);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetNumberOfPoints(vtkIdType numPoints);

  VTK_DEPRECATED_IN_9_7_0("Use Reserve, Squeeze or Initialize")
  vtkTypeBool Resize(vtkIdType numPoints);

  vtkTypeBool Reserve(vtkIdType numPoints);

  void GetPoints(vtkIdList* ptId, vtkPoints* outPoints);

  virtual void ComputeBounds();

  double* GetBounds() VTK_SIZEHINT(6);

  void GetBounds(double bounds[6]);

  vtkMTimeType GetMTime() override;

  void Modified() override;

protected:
  vtkPoints(int dataType = VTK_FLOAT);
  ~vtkPoints() override;

  double Bounds[6];
  vtkTimeStamp ComputeTime; // Time at which bounds computed
  vtkDataArray* Data;       // Array which represents data

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

inline void vtkPoints::Reset()
{
  this->Data->Reset();
  this->Modified();
}

inline void vtkPoints::SetNumberOfPoints(vtkIdType numPoints)
{
  if (numPoints != this->Data->GetNumberOfTuples())
  {
    this->Data->SetNumberOfComponents(3);
    this->Data->SetNumberOfTuples(numPoints);
    this->Modified();
  }
}

inline vtkTypeBool vtkPoints::Reserve(vtkIdType numPoints)
{
  if (numPoints != this->Data->GetNumberOfTuples())
  {
    this->Data->SetNumberOfComponents(3);
    this->Modified();
    return this->Data->ReserveTuples(numPoints);
  }
  return 1;
}

inline void vtkPoints::SetPoint(vtkIdType id, double x, double y, double z)
{
  double p[3] = { x, y, z };
  this->Data->SetTuple(id, p);
}

inline void vtkPoints::InsertPoint(vtkIdType id, double x, double y, double z)
{
  double p[3] = { x, y, z };
  this->Data->InsertTuple(id, p);
}

inline vtkIdType vtkPoints::InsertNextPoint(double x, double y, double z)
{
  double p[3] = { x, y, z };
  return this->Data->InsertNextTuple(p);
}

VTK_ABI_NAMESPACE_END
#endif