vtkVoidArray.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 vtkVoidArray_h
#define vtkVoidArray_h

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

VTK_ABI_NAMESPACE_BEGIN
class VTK_DEPRECATED_IN_9_7_0("No longer needed") VTKCOMMONCORE_EXPORT vtkVoidArray
  : public vtkObject
{
public:
  static vtkVoidArray* New();
  static vtkVoidArray* ExtendedNew();

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

  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000);

  void Initialize();

  int GetDataType() const { return VTK_VOID; }

  int GetDataTypeSize() { return sizeof(void*); }

  void SetNumberOfPointers(vtkIdType number)
  {
    this->Allocate(number);
    this->NumberOfPointers = number;
  }

  vtkIdType GetNumberOfPointers() { return this->NumberOfPointers; }

  void* GetVoidPointer(vtkIdType id) { return this->Array[id]; }

  void SetVoidPointer(vtkIdType id, void* ptr) { this->Array[id] = ptr; }

  void InsertVoidPointer(vtkIdType i, void* ptr);

  vtkIdType InsertNextVoidPointer(void* tuple);

  void Reset() { this->NumberOfPointers = 0; }

  void Squeeze() { this->ResizeAndExtend(this->NumberOfPointers); }

  void** GetPointer(vtkIdType id) { return this->Array + id; }

  void** WritePointer(vtkIdType id, vtkIdType number);

  void DeepCopy(vtkVoidArray* va);

protected:
  vtkVoidArray();
  ~vtkVoidArray() override;

  vtkIdType NumberOfPointers;
  vtkIdType Size;
  void** Array; // pointer to data

  void** ResizeAndExtend(vtkIdType sz); // function to resize data

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

VTK_ABI_NAMESPACE_END
#endif