vtkPackLabels.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 vtkPackLabels_h
#define vtkPackLabels_h
 
#include "vtkDataArray.h" // For returning list of labels
#include "vtkDataSetAlgorithm.h"
#include "vtkFiltersCoreModule.h" // For export macro
#include "vtkIdTypeArray.h"       // For returning count of labels
#include "vtkSmartPointer.h"      // For returning list of labels
#include "vtkWrappingHints.h"     // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
struct vtkLabelMap;
 
class VTKFILTERSCORE_EXPORT VTK_MARSHALAUTO vtkPackLabels : public vtkDataSetAlgorithm
{
public:

  static vtkPackLabels* New();
  vtkTypeMacro(vtkPackLabels, vtkDataSetAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkDataArray* GetLabels() { return this->LabelsArray; }
  vtkIdType GetNumberOfLabels()
  {
    return (this->LabelsArray ? this->LabelsArray->GetNumberOfTuples() : 0);
  }


  vtkIdTypeArray* GetLabelsCount() { return this->LabelsCount; }

  enum SortBy
  {
    SORT_BY_LABEL_VALUE = 0,
    SORT_BY_LABEL_COUNT
  };


  vtkSetClampMacro(SortBy, int, SORT_BY_LABEL_VALUE, SORT_BY_LABEL_COUNT);
  vtkGetMacro(SortBy, int);
  void SortByLabelValue() { this->SetSortBy(SORT_BY_LABEL_VALUE); }
  void SortByLabelCount() { this->SetSortBy(SORT_BY_LABEL_COUNT); }


  enum DefaultScalarType
  {
    VTK_DEFAULT_TYPE = -1
  };
  vtkSetMacro(OutputScalarType, int);
  vtkGetMacro(OutputScalarType, int);
  void SetOutputScalarTypeToDefault() { this->SetOutputScalarType(VTK_DEFAULT_TYPE); }
  void SetOutputScalarTypeToUnsignedChar() { this->SetOutputScalarType(VTK_UNSIGNED_CHAR); }
  void SetOutputScalarTypeToUnsignedShort() { this->SetOutputScalarType(VTK_UNSIGNED_SHORT); }
  void SetOutputScalarTypeToUnsignedInt() { this->SetOutputScalarType(VTK_UNSIGNED_INT); }
  void SetOutputScalarTypeToUnsignedLong() { this->SetOutputScalarType(VTK_UNSIGNED_LONG); }


  vtkSetMacro(BackgroundValue, unsigned long);
  vtkGetMacro(BackgroundValue, unsigned long);


  vtkSetMacro(PassPointData, bool);
  vtkGetMacro(PassPointData, bool);
  vtkBooleanMacro(PassPointData, bool);
  vtkSetMacro(PassCellData, bool);
  vtkGetMacro(PassCellData, bool);
  vtkBooleanMacro(PassCellData, bool);
  vtkSetMacro(PassFieldData, bool);
  vtkGetMacro(PassFieldData, bool);
  vtkBooleanMacro(PassFieldData, bool);
 
protected:
  vtkPackLabels();
  ~vtkPackLabels() override = default;
 
  vtkSmartPointer<vtkDataArray> LabelsArray;
  vtkSmartPointer<vtkIdTypeArray> LabelsCount;
  int SortBy;
  int OutputScalarType;
  unsigned long BackgroundValue;
  bool PassPointData;
  bool PassCellData;
  bool PassFieldData;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
private:
  vtkPackLabels(const vtkPackLabels&) = delete;
  void operator=(const vtkPackLabels&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif