vtkSMInputArrayDomain.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMInputArrayDomain_h
#define vtkSMInputArrayDomain_h
 
#include "vtkDataObject.h"                  // needed for vtkDataObject::AttributeTypes
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMDomain.h"
 
#include <vector> // Needed for vector
 
// Needed to get around some header defining ANY as a macro
#ifdef ANY
#undef ANY
#endif
 
class vtkPVArrayInformation;
class vtkPVDataSetAttributesInformation;
class vtkSMSourceProxy;
 
class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMInputArrayDomain : public vtkSMDomain
{
public:
  static vtkSMInputArrayDomain* New();
  vtkTypeMacro(vtkSMInputArrayDomain, vtkSMDomain);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  int IsInDomain(vtkSMProperty* property) override;
 
  int IsInDomain(vtkSMSourceProxy* proxy, unsigned int outputport = 0);
 
 
  vtkGetMacro(AttributeType, int);
  const char* GetAttributeTypeAsString();
 
  std::vector<int> GetAcceptableNumbersOfComponents() const;
 
  static void SetAutomaticPropertyConversion(bool);
  static bool GetAutomaticPropertyConversion();
 
  enum AttributeTypes
  {
    POINT = vtkDataObject::POINT,
    CELL = vtkDataObject::CELL,
    FIELD = vtkDataObject::FIELD,
    ANY_EXCEPT_FIELD = vtkDataObject::POINT_THEN_CELL,
    VERTEX = vtkDataObject::VERTEX,
    EDGE = vtkDataObject::EDGE,
    ROW = vtkDataObject::ROW,
    ANY = vtkDataObject::NUMBER_OF_ATTRIBUTE_TYPES,
    NUMBER_OF_ATTRIBUTE_TYPES = ANY + 1,
  };
 
  static bool IsAttributeTypeAcceptable(
    int required_type, int attribute_type, int* acceptable_as_type = nullptr);
 
  int IsArrayAcceptable(vtkPVArrayInformation* arrayInfo);
 
  static vtkSMInputArrayDomain* FindApplicableDomain(vtkSMProperty* property);
 
protected:
  vtkSMInputArrayDomain();
  ~vtkSMInputArrayDomain() override;
 
  vtkSetMacro(AttributeType, int);
  void SetAttributeType(const char* type);
 
  int ReadXMLAttributes(vtkSMProperty* prop, vtkPVXMLElement* element) override;
 
  bool IsAttributeTypeAcceptable(int attributeType);
 
  bool HasAcceptableArray(vtkPVDataSetAttributesInformation* attrInfo);
 
  int AttributeType;
  std::vector<int> AcceptableNumbersOfComponents;
  std::string DataType;
 
private:
  static bool AutomaticPropertyConversion;
  vtkSMInputArrayDomain(const vtkSMInputArrayDomain&) = delete;
  void operator=(const vtkSMInputArrayDomain&) = delete;
};
 
#endif