vtkSMProxyLink.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMProxyLink_h
#define vtkSMProxyLink_h
 
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMLink.h"
 
#include <memory> // for unique_ptr
 
struct vtkSMProxyLinkInternals;
 
class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMProxyLink : public vtkSMLink
{
public:
  static vtkSMProxyLink* New();
  vtkTypeMacro(vtkSMProxyLink, vtkSMLink);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  enum ExceptionListBehavior : int
  {
    BLACKLIST = 0,
    WHITELIST
  };
 
  virtual void AddLinkedProxy(vtkSMProxy* proxy, int updateDir);
 
  virtual void LinkProxies(vtkSMProxy* proxy1, vtkSMProxy* proxy2);
 
  virtual void LinkProxyPropertyProxies(vtkSMProxy* proxy1, vtkSMProxy* proxy2, const char* pname);
 
  virtual void RemoveLinkedProxy(vtkSMProxy* proxy);
 
 
  unsigned int GetNumberOfLinkedObjects() override;
  unsigned int GetNumberOfLinkedProxies();
 
  vtkSMProxy* GetLinkedProxy(int index) override;
 
 
  int GetLinkedObjectDirection(int index) override;
  int GetLinkedProxyDirection(int index);
 
 
  void AddException(const char* propertyname);
  void RemoveException(const char* propertyname);
  void ClearExceptions();
 
  void RemoveAllLinks() override;
 
  void LoadState(const vtkSMMessage* msg, vtkSMProxyLocator* locator) override;
 
 
  vtkSetMacro(ExceptionBehavior, int);
  vtkGetMacro(ExceptionBehavior, int);
  void SetExceptionBehaviorToBlacklist() { this->SetExceptionBehavior(BLACKLIST); }
  void SetExceptionBehaviorToWhitelist() { this->SetExceptionBehavior(WHITELIST); }
 
protected:
  vtkSMProxyLink();
  ~vtkSMProxyLink() override;
 
  void UpdateVTKObjects(vtkSMProxy* proxy) override;
 
  void PropertyModified(vtkSMProxy* proxy, const char* pname) override;
 
  void UpdateProperty(vtkSMProxy* caller, const char* pname) override;
 
  virtual std::string GetXMLTagName() { return "ProxyLink"; }
 
  void SaveXMLState(const char* linkname, vtkPVXMLElement* parent) override;
 
  int LoadXMLState(vtkPVXMLElement* linkElement, vtkSMProxyLocator* locator) override;
 
  void UpdateState() override;
 
private:
  vtkSMProxyLink(const vtkSMProxyLink&) = delete;
  void operator=(const vtkSMProxyLink&) = delete;
 
  bool isPropertyLinked(const char* pname);
 
  std::unique_ptr<vtkSMProxyLinkInternals> Internals;
  int ExceptionBehavior = BLACKLIST;
};
 
#endif