vtkSMDomain.h

Go to the documentation of this file.

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

#include "vtkClientServerID.h"              // needed for saving animation in batch script
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMSessionObject.h"

class vtkPVDataInformation;
class vtkPVXMLElement;
class vtkSMProperty;
class vtkSMProxyLocator;

struct vtkSMDomainInternals;

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

  enum IsInDomainReturnCodes
  {
    NOT_APPLICABLE = -1,
    NOT_IN_DOMAIN = 0,
    IN_DOMAIN = 1,
  };

  virtual int IsInDomain(vtkSMProperty* vtkNotUsed(property)) { return IN_DOMAIN; }

  virtual void Update(vtkSMProperty* requestingProperty);

  virtual void SetAnimationValue(vtkSMProperty*, int vtkNotUsed(index), double vtkNotUsed(value)) {}

  virtual int SetDefaultValues(vtkSMProperty*, bool vtkNotUsed(use_unchecked_values)) { return 0; };


  vtkGetStringMacro(XMLName);


  vtkGetMacro(IsOptional, bool);

  vtkSMProperty* GetProperty();


  virtual vtkPVDataInformation* GetInputDataInformation(
    const char* function, unsigned int index = 0);
  virtual vtkPVDataInformation* GetInputSubsetDataInformation(
    unsigned int compositeIndex, const char* function, unsigned int index = 0);

  virtual unsigned int GetNumberOfInputConnections(const char* function);

  vtkSMProperty* GetRequiredProperty(const char* function);

protected:
  vtkSMDomain();
  ~vtkSMDomain() override;


  void SaveState(vtkPVXMLElement* parent, const char* uid);
  virtual void ChildSaveState(vtkPVXMLElement* domainElement);

  virtual int LoadState(
    vtkPVXMLElement* vtkNotUsed(domainElement), vtkSMProxyLocator* vtkNotUsed(loader))
  {
    return 1;
  }

  virtual int ReadXMLAttributes(vtkSMProperty* prop, vtkPVXMLElement* elem);

  friend class vtkSMProperty;

  void RemoveRequiredProperty(vtkSMProperty* prop);

  void AddRequiredProperty(vtkSMProperty* prop, const char* function);


  vtkSetMacro(IsOptional, bool);


  vtkSetStringMacro(XMLName);

  void DomainModified();
  void InvokeModified() { this->DomainModified(); }

  unsigned int GetNumberOfRequiredProperties();

  void SetProperty(vtkSMProperty*);

  class VTKREMOTINGSERVERMANAGER_EXPORT DeferDomainModifiedEvents
  {
    vtkSMDomain* Self;

  public:
    DeferDomainModifiedEvents(vtkSMDomain* self);
    ~DeferDomainModifiedEvents();
  };

  char* XMLName;
  bool IsOptional;
  vtkSMDomainInternals* Internals;

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

  friend class DeferDomainModifiedEvents;
  unsigned int DeferDomainModifiedEventsCount;
  bool PendingDomainModifiedEvents;
};

#endif