VuoRendererPort.hh

Go to the documentation of this file.

 
#pragma once
 
#include "VuoRendererItem.hh"
 
#include "VuoBaseDetail.hh"
#include "VuoType.hh"
#include "VuoPortClass.hh"
#include "VuoRendererInputDrawer.hh"
#include "VuoRendererColors.hh"
 
class VuoCompilerNodeClass;
class VuoCompilerNode;
class VuoRendererNode;
class VuoRendererInputListDrawer;
class VuoCable;
class VuoPort;
class VuoRendererPublishedPort;
class VuoRendererSignaler;
 
class VuoRendererPort : public VuoRendererItem, public VuoBaseDetail<VuoPort>
{
public:
    VuoRendererPort(VuoPort *basePort, VuoRendererSignaler *signaler,
                    bool isOutput, bool isRefreshPort, bool isFunctionPort);
    ~VuoRendererPort();
 
    QRectF boundingRect(void) const;
    QRectF getNameRect(void) const;
    bool hasPortAction(void) const;
    QRectF getActionIndicatorRect(void) const;
    QPainterPath shape(void) const;
    void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget);
 
    bool getEligibleForSelection(void);
    bool isEligibleForConnection(void);
    void setEligibilityHighlight(VuoRendererColors::HighlightType eligibility);
    VuoRendererColors::HighlightType eligibilityHighlight(void);
    void extendedHoverEnterEvent(bool cableDragUnderway=false, bool disableConnectedCableHighlight=false);
    void extendedHoverMoveEvent(bool cableDragUnderway=false, bool disableConnectedCableHighlight=false);
    void extendedHoverLeaveEvent();
    bool canConnectDirectlyWithoutSpecializationTo(VuoRendererPort *toPort, bool eventOnlyConnection);
    bool canConnectDirectlyWithSpecializationTo(VuoRendererPort *toPort, bool eventOnlyConnection);
    bool canConnectDirectlyWithSpecializationTo(VuoRendererPort *toPort, bool eventOnlyConnection, VuoRendererPort **portToSpecialize, string &specializedTypeName);
    VuoCable * getCableConnectedTo(VuoRendererPort *toPort, bool includePublishedCables);
    bool getInput(void) const;
    bool getOutput(void) const;
    bool getRefreshPort(void) const;
    bool getFunctionPort(void) const;
    void updateNameRect(void);
    void updateGeometry();
    QVariant itemChange(GraphicsItemChange change, const QVariant &value);
    QPainterPath getPortPath() const;
    static QRectF getPortRect(void);
    VuoRendererInputDrawer * getAttachedInputDrawer(void) const;
    virtual QRectF getPortConstantTextRect(void) const;
    static int getTextWidth(QString text);
    VuoType * getDataType(void) const;
    bool hasURLType(void) const;
    bool hasRelativeReadURLConstantValue(void) const;
    bool isConstant(void) const;
    bool effectivelyHasConnectedDataCable(bool includePublishedCables) const;
    static string format(const char *format, ...);
    static string stringAndFree(char *strz);
    string getConstantAsString(void) const;
    string getConstantAsTruncatedStringToRender(void) const;
    string getConstantAsStringToRender(void) const;
    string getStringForRealValue(double value) const;
    string getStringForRealValue(float value) const;
    void setConstant(string constantValue);
    string getPortNameToRender() const;
    string getPortNameToRenderWhenDisplayed() const;
    static QString getPortNameRegExp();
    static QString sanitizePortName(QString portName);
    void setPortNameToRender(string name);
    bool getPublishable() const;
    vector<VuoRendererPublishedPort *> getPublishedPorts() const;
    vector<VuoRendererPublishedPort *> getPublishedPortsConnectedByDataCarryingCables(void) const;
    VuoNode::TintColor getPortTint() const;
 
    VuoRendererNode * getUnderlyingParentNode(void) const;
    VuoRendererNode * getRenderedParentNode(void) const;
    set<VuoRendererInputAttachment *> getAllUnderlyingUpstreamInputAttachments(void) const;
    set<VuoRendererPort *> getPortsConnectedWirelessly(bool includePublishedCables) const;
 
    VuoRendererPort * getTypecastParentPort() const;
    void setTypecastParentPort(VuoRendererPort *typecastParentPort);
    bool supportsDisconnectionByDragging(void);
 
    void resetTimeLastEventFired();
    void setFiredEvent();
    void setFadePercentageSinceEventFired(qreal percentage);
    void setCacheModeForPortAndChildren(QGraphicsItem::CacheMode mode);
 
    vector<QGraphicsItemAnimation *> getAnimations();
    void setAnimated(bool animated);
 
    bool isHiddenRefreshPort(void);
 
    bool carriesData(void) const;
 
    // Drawing configuration
    static const qreal portRadius; 
    static const qreal portSpacing; 
    static const qreal portContainerMargin; 
    static const qreal portInset; 
    static const qreal portBarrierWidth; 
    static const qreal portConstantTextPadding; 
 
protected:
    void mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event);
    void keyPressEvent(QKeyEvent *event);
 
private:
 
    QFont getPortNameFont(void) const;
    static void addRoundedTriangle(QPainterPath &p, QPointF center, qreal radius, qreal cornerRadius);
    void updateToolTip();
 
    // Port attributes affecting drawing
    bool isOutput;
    bool isFunctionPort;
    VuoRendererColors::HighlightType _eligibilityHighlight;
    bool isEligibleForSelection;
    bool isAnimated;
    VuoRendererPort *typecastParentPort;
    qint64 timeLastEventFired;
    vector<QGraphicsItemAnimation *> animations;
 
    friend class VuoRendererPublishedPort;  
    friend class TestVuoRenderer;
 
protected:
    bool isRefreshPort; 
 
    QRectF cachedBoundingRect; 
    void updateCachedBoundingRect();
 
    QRectF nameRect; 
    string customizedPortName; 
 
    bool portNameRenderingEnabled(void) const;
    void updateEnabledStatus();
    VuoRendererInputDrawer * getAttachedInputDrawerRenderedWithHostPort(const VuoRendererPort *port) const;
    VuoRendererInputAttachment * getUnderlyingInputAttachment(void) const;
 
    QPainterPath cachedPortPath; 
    void updateCachedPortPath();
 
    static QRectF getPortConstantTextRectForText(QString text);
    static QPainterPath getPortPath(qreal inset, VuoPortClass::PortType portType, QString constantText, bool isInputPort, bool carriesData);
    QRectF getEventBarrierRect(void) const;
    virtual QPainterPath getWirelessAntennaPath() const;
    bool hasConnectedWirelessDataCable(bool includePublishedCables) const;
    bool hasConnectedWirelessEventCable(bool includePublishedCables) const;
    VuoNode::TintColor getWirelessAntennaTint() const;
    qint64 getTimeOfLastActivity();
 
    void paintPortName(QPainter *painter, VuoRendererColors *colors);
    void paintEventBarrier(QPainter *painter, VuoRendererColors *colors);
    void paintActionIndicator(QPainter *painter, VuoRendererColors *colors);
    void paintWirelessAntenna(QPainter *painter, VuoRendererColors *colors);
    string getDefaultPortNameToRender();
    string getPointStringForCoords(QList<float>) const;
 
    VuoRendererSignaler *signaler; 
};