/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkIdFilter.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
/**
 * @class   vtkIdFilter
 * @brief   generate scalars or field data from point and cell ids
 *
 * vtkIdFilter is a filter to that generates scalars or field data
 * using cell and point ids. That is, the point attribute data scalars
 * or field data are generated from the point ids, and the cell
 * attribute data scalars or field data are generated from the
 * cell ids.
 *
 * Typically this filter is used with vtkLabeledDataMapper (and possibly
 * vtkSelectVisiblePoints) to create labels for points and cells, or labels
 * for the point or cell data scalar values.
 */

#ifndef vtkIdFilter_h
#define vtkIdFilter_h

#include "vtkDataSetAlgorithm.h"
#include "vtkFiltersCoreModule.h" // For export macro

class VTKFILTERSCORE_EXPORT vtkIdFilter : public vtkDataSetAlgorithm
{
public:
  vtkTypeMacro(vtkIdFilter, vtkDataSetAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  /**
   * Construct object with PointIds and CellIds on; and ids being generated
   * as scalars.
   */
  static vtkIdFilter* New();

  //@{
  /**
   * Enable/disable the generation of point ids. Default is on.
   */
  vtkSetMacro(PointIds, vtkTypeBool);
  vtkGetMacro(PointIds, vtkTypeBool);
  vtkBooleanMacro(PointIds, vtkTypeBool);
  //@}

  //@{
  /**
   * Enable/disable the generation of point ids. Default is on.
   */
  vtkSetMacro(CellIds, vtkTypeBool);
  vtkGetMacro(CellIds, vtkTypeBool);
  vtkBooleanMacro(CellIds, vtkTypeBool);
  //@}

  //@{
  /**
   * Set/Get the flag which controls whether to generate scalar data
   * or field data. If this flag is off, scalar data is generated.
   * Otherwise, field data is generated. Default is off.
   */
  vtkSetMacro(FieldData, vtkTypeBool);
  vtkGetMacro(FieldData, vtkTypeBool);
  vtkBooleanMacro(FieldData, vtkTypeBool);
  //@}

  //@{
  /**
   * @deprecated use SetPointIdsArrayName/GetPointIdsArrayName or
   * SetCellIdsArrayName/GetCellIdsArrayName.
   */
  VTK_LEGACY(void SetIdsArrayName(const char*));
  VTK_LEGACY(const char* GetIdsArrayName());
  //@}

  //@{
  /**
   * Set/Get the name of the Ids array for points, if generated. By default,
   * set to "vtkIdFilter_Ids" for backwards compatibility.
   */
  vtkSetStringMacro(PointIdsArrayName);
  vtkGetStringMacro(PointIdsArrayName);
  //@}

  //@{
  /**
   * Set/Get the name of the Ids array for points, if generated. By default,
   * set to "vtkIdFilter_Ids" for backwards compatibility.
   */
  vtkSetStringMacro(CellIdsArrayName);
  vtkGetStringMacro(CellIdsArrayName);
  //@}
protected:
  vtkIdFilter();
  ~vtkIdFilter() override;

  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  vtkTypeBool PointIds;
  vtkTypeBool CellIds;
  vtkTypeBool FieldData;
  char* PointIdsArrayName;
  char* CellIdsArrayName;

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

#endif
