vtkSMPropertyLink.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    vtkSMPropertyLink.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkSMPropertyLink_h
#define vtkSMPropertyLink_h

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

class vtkSMProperty;
class vtkSMPropertyLinkInternals;
class vtkSMPropertyLinkObserver;

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


  void AddLinkedProperty(vtkSMProxy* proxy, const char* propertyname, int updateDir);
  void RemoveLinkedProperty(vtkSMProxy* proxy, const char* propertyname);


  unsigned int GetNumberOfLinkedObjects() override;
  unsigned int GetNumberOfLinkedProperties();

  vtkSMProxy* GetLinkedProxy(int index) override;

  const char* GetLinkedPropertyName(int index);


  int GetLinkedObjectDirection(int index) override;
  int GetLinkedPropertyDirection(int index);

  void RemoveAllLinks() override;

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

protected:
  vtkSMPropertyLink();
  ~vtkSMPropertyLink() override;

  void Synchronize();

  friend class vtkSMPropertyLinkInternals;
  friend class vtkSMPropertyLinkObserver;

  int LoadXMLState(vtkPVXMLElement* linkElement, vtkSMProxyLocator* locator) override;

  void SaveXMLState(const char* linkname, vtkPVXMLElement* parent) override;

  void UpdateVTKObjects(vtkSMProxy* caller) override;
  void PropertyModified(vtkSMProxy* caller, const char* pname) override;
  void UpdateProperty(vtkSMProxy* caller, const char* pname) override;

  void UpdateState() override;

private:
  vtkSMPropertyLinkInternals* Internals;
  bool ModifyingProperty;

  vtkSMPropertyLink(const vtkSMPropertyLink&) = delete;
  void operator=(const vtkSMPropertyLink&) = delete;
};

#endif