vtkSMProxyProperty.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMProxyProperty_h
#define vtkSMProxyProperty_h
 
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMProperty.h"
 
class vtkSMProxy;
class vtkSMStateLocator;
 
class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMProxyProperty : public vtkSMProperty
{
public:
 
  static void EnableProxyCreation();
  static void DisableProxyCreation();
  static bool CanCreateProxy();
 
  static vtkSMProxyProperty* New();
  vtkTypeMacro(vtkSMProxyProperty, vtkSMProperty);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  virtual void AddProxy(vtkSMProxy* proxy);
  virtual void SetProxy(unsigned int idx, vtkSMProxy* proxy);
  virtual void RemoveProxy(vtkSMProxy* proxy);
  virtual void RemoveAllProxies();
 
  virtual void SetProxies(unsigned int numElements, vtkSMProxy* proxies[]);
 
  bool IsProxyAdded(vtkSMProxy* proxy);
 
 
  virtual void AddUncheckedProxy(vtkSMProxy* proxy);
  virtual void SetUncheckedProxy(unsigned int idx, vtkSMProxy* proxy);
 
  virtual void RemoveAllUncheckedProxies();
  void ClearUncheckedElements() override { this->RemoveAllUncheckedProxies(); }
 
  unsigned int GetNumberOfProxies();
 
  unsigned int GetNumberOfUncheckedProxies();
 
 
  void SetNumberOfProxies(unsigned int count);
  void SetNumberOfUncheckedProxies(unsigned int count);
 
  vtkSMProxy* GetProxy(unsigned int idx);
 
  vtkSMProxy* GetUncheckedProxy(unsigned int idx);
 
  void Copy(vtkSMProperty* src) override;
 
  void UpdateAllInputs() override;
 
  bool IsValueDefault() override;
 
  void ResetToXMLDefaults() override;
 
protected:
  vtkSMProxyProperty();
  ~vtkSMProxyProperty() override;
 
  void WriteTo(vtkSMMessage* msg) override;
 
  void ReadFrom(const vtkSMMessage* msg, int msg_offset, vtkSMProxyLocator*) override;
 
  friend class vtkSMProxy;
 
  int ReadXMLAttributes(vtkSMProxy* parent, vtkPVXMLElement* element) override;
 
  void SaveStateValues(vtkPVXMLElement* propertyElement) override;
 
  virtual vtkPVXMLElement* AddProxyElementState(vtkPVXMLElement* prop, unsigned int idx);
  int LoadState(vtkPVXMLElement* element, vtkSMProxyLocator* loader) override;
 
  void OnUpdateDataEvent() { this->UpdateDomains(); }
 
  // Static flag used to know if the locator should be used to create proxy
  // or if the session should be used to find only the existing ones
  static bool CreateProxyAllowed;
 
  class vtkPPInternals;
  friend class vtkPPInternals;
  vtkPPInternals* PPInternals;
 
private:
  vtkSMProxyProperty(const vtkSMProxyProperty&) = delete;
  void operator=(const vtkSMProxyProperty&) = delete;
};
 
#endif