vtkMergeFields.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 vtkMergeFields_h
#define vtkMergeFields_h
 
#include "vtkDataSetAlgorithm.h"
#include "vtkFiltersCoreModule.h" // For export macro
#include "vtkWrappingHints.h"     // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDataArray;
class vtkFieldData;
 
class VTKFILTERSCORE_EXPORT VTK_MARSHALAUTO vtkMergeFields : public vtkDataSetAlgorithm
{
public:
  vtkTypeMacro(vtkMergeFields, vtkDataSetAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkMergeFields* New();
 
  void SetOutputField(const char* name, int fieldLoc);
 
  void SetOutputField(const char* name, const char* fieldLoc);
 
  void Merge(int component, const char* arrayName, int sourceComp);
 
 
  vtkSetMacro(NumberOfComponents, int);
  vtkGetMacro(NumberOfComponents, int);
 
  enum FieldLocations
  {
    DATA_OBJECT = 0,
    POINT_DATA = 1,
    CELL_DATA = 2
  };
 
  struct Component
  {
    int Index;
    int SourceIndex;
    char* FieldName;
    Component* Next; // linked list
    void SetName(const char* name)
    {
      delete[] this->FieldName;
      this->FieldName = nullptr;
      if (name)
      {
        size_t len = strlen(name) + 1;
        this->FieldName = new char[len];
#ifdef _MSC_VER
        strncpy_s(this->FieldName, len, name, len - 1);
#else
        strncpy(this->FieldName, name, len);
#endif
      }
    }
    Component() { FieldName = nullptr; }
    ~Component() { delete[] FieldName; }
  };
 
protected:
  enum FieldType
  {
    NAME,
    ATTRIBUTE
  };
 
  vtkMergeFields();
  ~vtkMergeFields() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  char* FieldName;
  int FieldLocation;
  int NumberOfComponents;
  int OutputDataType;
 
  static char FieldLocationNames[3][12];
 
  int MergeArray(vtkDataArray* in, vtkDataArray* out, int inComp, int outComp);
 
  // Components are stored as a linked list.
  Component* Head;
  Component* Tail;
 
  // Methods to browse/modify the linked list.
  Component* GetNextComponent(Component* op) { return op->Next; }
  Component* GetFirst() { return this->Head; }
  void AddComponent(Component* op);
  Component* FindComponent(int index);
  void DeleteAllComponents();
 
  void PrintComponent(Component* op, ostream& os, vtkIndent indent);
  void PrintAllComponents(ostream& os, vtkIndent indent);
 
private:
  vtkMergeFields(const vtkMergeFields&) = delete;
  void operator=(const vtkMergeFields&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif