Port.h

Go to the documentation of this file.

/*
   For more information, please see: http://software.sci.utah.edu

   The MIT License

   Copyright (c) 2012 Scientific Computing and Imaging Institute,
   University of Utah.

   License for the specific language governing rights and limitations under
   Permission is hereby granted, free of charge, to any person obtaining a
   copy of this software and associated documentation files (the "Software"),
   to deal in the Software without restriction, including without limitation
   the rights to use, copy, modify, merge, publish, distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included
   in all copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
   DEALINGS IN THE SOFTWARE.
*/

#ifndef INTERFACE_APPLICATION_PORTWIDGET_H
#define INTERFACE_APPLICATION_PORTWIDGET_H

#include <boost/shared_ptr.hpp>
#include <boost/tuple/tuple.hpp>
#include <boost/tuple/tuple_comparison.hpp>
#include <QGraphicsWidget>
#include <QPushButton>
#include <QColor>
#include <set>
#include <Interface/Application/PositionProvider.h>
#include <Dataflow/Network/PortInterface.h>
#include <Dataflow/Network/ConnectionId.h>

class QGraphicsScene;

namespace SCIRun {
namespace Gui {

class ConnectionLine;
class PositionProvider;
class ConnectionInProgress;
class ConnectionFactory;
class ClosestPortFinder;
class PortActionsMenu;

class PortWidget : public QPushButton, public NeedsScenePositionProvider, public SCIRun::Dataflow::Networks::PortDescriptionInterface
{
  Q_OBJECT
public:
  PortWidget(const QString& name, const QColor& color, const std::string& datatype, const SCIRun::Dataflow::Networks::ModuleId& moduleId, const SCIRun::Dataflow::Networks::PortId& portId, size_t index, bool isInput, bool isDynamic,
    boost::shared_ptr<ConnectionFactory> connectionFactory,
    boost::shared_ptr<ClosestPortFinder> closestPortFinder, QWidget* parent = 0);
  virtual ~PortWidget();

  QString name() const { return name_; }
  QColor color() const { return color_; }
  virtual bool isInput() const { return isInput_; }
  virtual bool isDynamic() const { return isDynamic_; }
  bool isConnected() const { return isConnected_; }
  void setConnected(bool connected) { isConnected_ = connected; }

  virtual size_t nconnections() const;
  virtual std::string get_typename() const;
  virtual std::string get_portname() const;
  virtual Dataflow::Networks::ModuleId getUnderlyingModuleId() const;
  virtual size_t getIndex() const;
  void setIndex(size_t i);

  virtual SCIRun::Dataflow::Networks::PortId id() const;

  void toggleLight();
  void turn_on_light();
  void turn_off_light();
  bool isLightOn() const { return lightOn_; }

  QSize sizeHint() const;

  void addConnection(ConnectionLine* c);
  void removeConnection(ConnectionLine* c);

  void trackConnections();
  void deleteConnections();

  QPointF position() const;

  bool sharesParentModule(const PortWidget& other) const;
  bool isFullInputPort() const;

  void doMousePress(Qt::MouseButton button, const QPointF& pos);
  void doMouseMove(Qt::MouseButtons buttons, const QPointF& pos);
  void doMouseRelease(Qt::MouseButton button, const QPointF& pos);

  static const int WIDTH = 11;

protected:
  virtual void moveEvent(QMoveEvent * event);

public Q_SLOTS:
  void MakeTheConnection(const SCIRun::Dataflow::Networks::ConnectionDescription& cd);
  void cancelConnectionsInProgress();
  void portCachingChanged(bool checked);
  void connectNewModule();
Q_SIGNALS:
  void requestConnection(const SCIRun::Dataflow::Networks::PortDescriptionInterface* from, const SCIRun::Dataflow::Networks::PortDescriptionInterface* to);
  void connectionDeleted(const SCIRun::Dataflow::Networks::ConnectionId& id);
  void connectNewModule(const SCIRun::Dataflow::Networks::PortDescriptionInterface* portToConnect, const std::string& newModuleName);
  void portMoved();
protected:
  void mousePressEvent(QMouseEvent* event);
  void mouseReleaseEvent(QMouseEvent* event);
  void mouseMoveEvent(QMouseEvent* event);
  void paintEvent(QPaintEvent* event);
private:
  void performDrag(const QPointF& endPos);
  void makeConnection(const QPointF& pos);
  void tryConnectPort(const QPointF& pos, PortWidget* port);
  bool matches(const SCIRun::Dataflow::Networks::ConnectionDescription& cd) const;

  const QString name_;
  const SCIRun::Dataflow::Networks::ModuleId moduleId_; 
  const SCIRun::Dataflow::Networks::PortId portId_;
  size_t index_;
  const QColor color_;
  const std::string typename_;
  const bool isInput_;
  const bool isDynamic_;
  bool isConnected_;
  bool lightOn_;
  QPointF startPos_;
  ConnectionInProgress* currentConnection_;
  friend struct DeleteCurrentConnectionAtEndOfBlock;
  std::set<ConnectionLine*> connections_;
  boost::shared_ptr<ConnectionFactory> connectionFactory_;
  boost::shared_ptr<ClosestPortFinder> closestPortFinder_;
  PortActionsMenu* menu_;
  //TODO
  typedef std::map<std::string, std::map<bool, std::map<SCIRun::Dataflow::Networks::PortId, PortWidget*>>> PortWidgetMap;
  static PortWidgetMap portWidgetMap_;
};

class InputPortWidget : public PortWidget 
{
public:
  InputPortWidget(const QString& name, const QColor& color, const std::string& datatype, const SCIRun::Dataflow::Networks::ModuleId& moduleId,
    const SCIRun::Dataflow::Networks::PortId& portId, size_t index, bool isDynamic,
    boost::shared_ptr<ConnectionFactory> connectionFactory, 
    boost::shared_ptr<ClosestPortFinder> closestPortFinder, 
    QWidget* parent = 0);
};

class OutputPortWidget : public PortWidget 
{
public:
  OutputPortWidget(const QString& name, const QColor& color, const std::string& datatype, const SCIRun::Dataflow::Networks::ModuleId& moduleId,
    const SCIRun::Dataflow::Networks::PortId& portId, size_t index, bool isDynamic, 
    boost::shared_ptr<ConnectionFactory> connectionFactory, 
    boost::shared_ptr<ClosestPortFinder> closestPortFinder, 
    QWidget* parent = 0);
};

}
}

#endif