pqLinksModel.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause

#ifndef pqLinksModel_h
#define pqLinksModel_h

#include "pqCoreModule.h"
#include <QAbstractItemModel>

class vtkCollection;
class pqCameraWidgetViewLink;
class pqInteractiveViewLink;
class pqProxy;
class pqRenderView;
class pqServer;
class pqServerManagerModelItem;
class vtkSMLink;
class vtkSMProxy;
class vtkSMProxyListDomain;
class vtkSMProxyLocator;
class vtkPVXMLElement;

class PQCORE_EXPORT pqLinksModel : public QAbstractTableModel
{
  Q_OBJECT
  typedef QAbstractTableModel Superclass;

public:
  enum ItemType
  {
    Unknown,
    Proxy,
    Camera,
    CameraWidget,
    Property,
    Selection
  };

  pqLinksModel(QObject* parent = nullptr);

  ~pqLinksModel() override;

  // implementation to satisfy api
  int rowCount(const QModelIndex& parent = QModelIndex()) const override;
  int columnCount(const QModelIndex& parent = QModelIndex()) const override;
  QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override;
  QVariant headerData(
    int section, Qt::Orientation orient, int role = Qt::DisplayRole) const override;

  // subclass specific implementation
  ItemType getLinkType(const QModelIndex& idx) const;
  vtkSMLink* getLink(const QModelIndex& idx) const;
  QModelIndex findLink(vtkSMLink* link) const;

  int FindLinksFromProxy(vtkSMProxy* inputProxy, int direction, vtkCollection* links) const;

  vtkSMProxy* getProxy1(const QModelIndex& idx) const;
  vtkSMProxy* getProxy2(const QModelIndex& idx) const;

  QString getProperty1(const QModelIndex& idx) const;
  QString getProperty2(const QModelIndex& idx) const;

  QString getLinkName(const QModelIndex& idx) const;
  vtkSMLink* getLink(const QString& name) const;

  void addProxyLink(const QString& name, vtkSMProxy* proxy1, vtkSMProxy* proxy2);

  void addCameraLink(
    const QString& name, vtkSMProxy* proxy1, vtkSMProxy* proxy2, bool interactiveViewLink = false);

  void addCameraWidgetLink(const QString& name, vtkSMProxy* proxy1, vtkSMProxy* proxy2);

  bool hasInteractiveViewLink(const QString& name);

  pqInteractiveViewLink* getInteractiveViewLink(const QString& name);

  bool hasCameraWidgetViewLink(const QString& name);

  pqCameraWidgetViewLink* getCameraWidgetViewLink(const QString& name);

  void addPropertyLink(const QString& name, vtkSMProxy* proxy1, const QString& prop1,
    vtkSMProxy* proxy2, const QString& prop2);

  void addSelectionLink(
    const QString& name, vtkSMProxy* proxy1, vtkSMProxy* proxy2, bool convertToIndices = true);

  void removeLink(const QModelIndex& idx);
  void removeLink(const QString& name);

  static pqProxy* representativeProxy(vtkSMProxy* proxy);

  static vtkSMProxyListDomain* proxyListDomain(vtkSMProxy* proxy);

Q_SIGNALS:
  void linkAdded(int linkType);

  void linkRemoved(const QString& name);

protected Q_SLOTS:
  void onSessionCreated(pqServer*);
  void onSessionRemoved(pqServer*);

  void onStateLoaded(vtkPVXMLElement* root, vtkSMProxyLocator* locator);

  void onStateSaved(vtkPVXMLElement* root);

  void createInteractiveViewLink(const QString& name, vtkSMProxy* displayView,
    vtkSMProxy* linkedView, double xPos = 0.375, double yPos = 0.375, double xSize = 0.25,
    double ySize = 0.25);

  void createCameraWidgetViewLink(
    const QString& name, vtkSMProxy* displayView, vtkSMProxy* linkedView);

  void emitLinkRemoved(const QString& name);

private:
  ItemType getLinkType(vtkSMLink* link) const;
  vtkSMProxy* getProxyFromIndex(const QModelIndex& idx, int dir) const;
  QString getPropertyFromIndex(const QModelIndex& idx, int dir) const;

  class pqInternal;
  pqInternal* Internal;
};

// internal class here for moc'ing reasons
class pqLinksModelObject : public QObject
{
  Q_OBJECT
public:
  pqLinksModelObject(QString name, pqLinksModel* p, pqServer*);
  ~pqLinksModelObject() override;

  QString name() const;
  vtkSMLink* link() const;

Q_SIGNALS:
  void linkRemoved();

private Q_SLOTS:
  void proxyModified(pqServerManagerModelItem*);
  void refresh();
  void remove();

private: // NOLINT(readability-redundant-access-specifiers)
  class pqInternal;
  pqInternal* Internal;

  void linkUndoStacks();
  void unlinkUndoStacks(pqRenderView*);
};

#endif