ConnectionRequest.H

Go to the documentation of this file.

/*! @file
    @author Unknown
    @copyright GNU Public License (GPL v3)
    @section License
    @verbatim
    // ////////////////////////////////////////////////////////////////////////
    //              The iLab Neuromorphic Robotics Toolkit (NRT)             //
    // Copyright 2010-2012 by the University of Southern California (USC)    //
    //                          and the iLab at USC.                         //
    //                                                                       //
    //                iLab - University of Southern California               //
    //                Hedco Neurociences Building, Room HNB-10               //
    //                    Los Angeles, Ca 90089-2520 - USA                   //
    //                                                                       //
    //      See http://ilab.usc.edu for information about this project.      //
    // ////////////////////////////////////////////////////////////////////////
    // This file is part of The iLab Neuromorphic Robotics Toolkit.          //
    //                                                                       //
    // The iLab Neuromorphic Robotics Toolkit is free software: you can      //
    // redistribute it and/or modify it under the terms of the GNU General   //
    // Public License as published by the Free Software Foundation, either   //
    // version 3 of the License, or (at your option) any later version.      //
    //                                                                       //
    // The iLab Neuromorphic Robotics Toolkit is distributed in the hope     //
    // that it will be useful, but WITHOUT ANY WARRANTY; without even the    //
    // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR       //
    // PURPOSE.  See the GNU General Public License for more details.        //
    //                                                                       //
    // You should have received a copy of the GNU General Public License     //
    // along with The iLab Neuromorphic Robotics Toolkit.  If not, see       //
    // <http://www.gnu.org/licenses/>.                                       //
    // ////////////////////////////////////////////////////////////////////////
    @endverbatim */
#ifndef SRC_APPS_NRTDESIGNER_CONNECTIONREQUEST_H
#define SRC_APPS_NRTDESIGNER_CONNECTIONREQUEST_H

#include "Common.H"

#include <nrt/Core/Util/CompilerUtil.H>
NRT_BEGIN_UNCHECKED_INCLUDES
#include <QGraphicsLineItem>
NRT_END_UNCHECKED_INCLUDES

class Port;
class QGraphicsDropShadowEffect;

//! Graphical representation for a request for connection
/*! Shows all possible connections and which one would be selected as the user moves the mouse around */
class ConnectionRequest : public QObject, public QGraphicsPathItem
{
  Q_OBJECT

  public:
    ConnectionRequest(Port * sourcePort_, Port * sinkPort_);
    ~ConnectionRequest();
    void recalculateLine();
    void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget);

    //! Set the free end position as the user is dragging the connection request around
    void setFreeEndPos(QPointF pos);

    Port * sourcePort() const { return itsSourcePort; }
    Port * sinkPort() const { return itsSinkPort; }
    Port * originPort() const { return itsOriginPort; }

  private:
    QGraphicsDropShadowEffect * makeGlowEffect() const;
    QList<Port*> getPotentialPorts(Port * origPort);
    Port * itsSourcePort;
    Port * itsSinkPort;
    Port * itsOriginPort;
    QPainterPath itsShape;
    QMap<Port *, QPainterPath> itsPotentialPortPaths;
    QPainterPath itsBestPath;
};

#endif // SRC_APPS_NRTDESIGNER_CONNECTIONREQUEST_H