vtkSMLink.h

Go to the documentation of this file.

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

#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMMessageMinimal.h"            // Needed
#include "vtkSMRemoteObject.h"

class vtkCommand;
class vtkPVXMLElement;
class vtkSMProxy;
class vtkSMProxyLocator;

class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMLink : public vtkSMRemoteObject
{
public:
  vtkTypeMacro(vtkSMLink, vtkSMRemoteObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  enum UpdateDirections
  {
    NONE = 0,
    INPUT = 1,
    OUTPUT = 2
  };


  vtkSetMacro(PropagateUpdateVTKObjects, int);
  vtkGetMacro(PropagateUpdateVTKObjects, int);
  vtkBooleanMacro(PropagateUpdateVTKObjects, int);


  vtkSetMacro(Enabled, bool);
  vtkGetMacro(Enabled, bool);

  virtual void RemoveAllLinks() = 0;

  const vtkSMMessage* GetFullState() override;

  void LoadState(const vtkSMMessage* msg, vtkSMProxyLocator* locator) override;

  virtual void UpdateState() = 0;

  virtual unsigned int GetNumberOfLinkedObjects() = 0;

  virtual int GetLinkedObjectDirection(int index) = 0;

  virtual vtkSMProxy* GetLinkedProxy(int index) = 0;

protected:
  vtkSMLink();
  ~vtkSMLink() override;

  void PushStateToSession();

  virtual void UpdateVTKObjects(vtkSMProxy* proxy) = 0;

  virtual void PropertyModified(vtkSMProxy* proxy, const char* pname) = 0;

  virtual void UpdateProperty(vtkSMProxy* caller, const char* pname) = 0;

  void ObserveProxyUpdates(vtkSMProxy* proxy);

  virtual void SaveXMLState(const char* linkname, vtkPVXMLElement* parent) = 0;

  virtual int LoadXMLState(vtkPVXMLElement* linkElement, vtkSMProxyLocator* locator) = 0;

  friend class vtkSMLinkObserver;
  friend class vtkSMStateLoader;
  friend class vtkSMSessionProxyManager;

  vtkCommand* Observer;
  // Set by default. In a link P1->P2, if this flag is set, when ever Proxy with P1
  // is updated i.e. UpdateVTKObjects() is called, this class calls
  // UpdateVTKObjects on Proxy with P2.
  int PropagateUpdateVTKObjects;

  bool Enabled;

  // Cached version of State
  vtkSMMessage* State;

private:
  vtkSMLink(const vtkSMLink&) = delete;
  void operator=(const vtkSMLink&) = delete;
};

#endif