pqLinksModel.h

Go to the documentation of this file.

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

   Program: ParaView
   Module:    pqLinksModel.h

   Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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

#ifndef _pqLinksModel_h
#define _pqLinksModel_h

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

class vtkCollection;
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,
    Property,
    Selection
  };

public:
  pqLinksModel(QObject* parent = 0);

  ~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);

  bool hasInteractiveViewLink(const QString& name);

  pqInteractiveViewLink* getInteractiveViewLink(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 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:
  class pqInternal;
  pqInternal* Internal;

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

#endif