vtkSMArrayListDomain.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMArrayListDomain_h
#define vtkSMArrayListDomain_h

#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMStringListDomain.h"

class vtkPVDataSetAttributesInformation;
class vtkSMInputArrayDomain;
class vtkSMProxyProperty;
class vtkSMSourceProxy;
class vtkPVArrayInformation;

class vtkSMArrayListDomainInternals;

class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMArrayListDomain : public vtkSMStringListDomain
{
public:
  static vtkSMArrayListDomain* New();
  vtkTypeMacro(vtkSMArrayListDomain, vtkSMStringListDomain);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Update(vtkSMProperty* prop) override;

  int IsArrayPartial(unsigned int idx);

  int GetFieldAssociation(unsigned int idx);

  int GetDomainAssociation(unsigned int idx);


  vtkGetMacro(AttributeType, int);

  int SetDefaultValues(vtkSMProperty*, bool use_unchecked_values) override;

  // This enum represents the possible strategies associated
  // with a given InformationKey :
  // NEED_KEY means that if the array will be in the domain only if
  // it does contains the given information key in its information.
  // REJECT_KEY means that if the array will be in the domain only if
  // it does NOT contains the given information key in its information.
  enum InformationKeyStrategy
  {
    NEED_KEY,
    REJECT_KEY
  };


  virtual unsigned int AddInformationKey(const char* location, const char* name, int strategy);
  virtual unsigned int AddInformationKey(const char* location, const char* name)
  {
    return this->AddInformationKey(location, name, vtkSMArrayListDomain::NEED_KEY);
  }

  unsigned int RemoveInformationKey(const char* location, const char* name);

  unsigned int GetNumberOfInformationKeys();

  void RemoveAllInformationKeys();


  const char* GetInformationKeyLocation(unsigned int);
  const char* GetInformationKeyName(unsigned int);
  int GetInformationKeyStrategy(unsigned int);

  static std::string CreateMangledName(vtkPVArrayInformation* arrayInfo, int component);


  static std::string ArrayNameFromMangledName(const char* name);
  static int ComponentIndexFromMangledName(vtkPVArrayInformation* info, const char* name);

protected:
  vtkSMArrayListDomain();
  ~vtkSMArrayListDomain() override;

  int ReadXMLAttributes(vtkSMProperty* prop, vtkPVXMLElement* element) override;

  virtual vtkPVDataInformation* GetExtraDataInformation() { return nullptr; }

  virtual bool IsFilteredArray(vtkPVDataInformation* info, int association, const char* arrayName);


  vtkSetMacro(AttributeType, int);
  int AttributeType;


  vtkGetStringMacro(InputDomainName);
  vtkSetStringMacro(InputDomainName);

  char* InputDomainName;

  // Currently, used by vtkSMRepresentedArrayListDomain to avoid picking just an
  // arbitrary array for scalar coloring. Need to rethink how this should be
  // done cleanly.
  bool PickFirstAvailableArrayByDefault;

private:
  vtkSMArrayListDomain(const vtkSMArrayListDomain&) = delete;
  void operator=(const vtkSMArrayListDomain&) = delete;

  friend class vtkSMArrayListDomainInternals;
  vtkSMArrayListDomainInternals* ALDInternals;
};

#endif