UNI_Port.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UNI_Port.h ( UNI Library, C++)
 *
 * COMMENTS:
 *      
 */

#ifndef __UNI_Port_h__
#define __UNI_Port_h__

#include "UNI_API.h"
#include "UNI_Item.h"

// ============================================================================
class UNI_ConstPort : public UNI_ConstItem<UNI_PortID>
{
public:
    /// Expose base class constructors.
    using UNI_ConstItem::UNI_ConstItem;

    /// Returns the UNI_Node that owns this port.
    UNI_NodeID node() const
    {
        return graph() ? graph()->ownerNode(id()) : UNI_NodeID();
    }

    /// Returns what kind of a port this is: input or output.
    UNI_PortKind portKind() const
    {
        return graph() ? graph()->portKind(id()) : UNI_PortKind::Invalid; 
    }

    /// Returns the label for the port.
    UT_StringHolder label() const
    {
        return graph() ? graph()->label(id()) : UT_StringHolder();
    }

    /// Returns the name of the port.
    UT_StringHolder name() const
    {
        return graph() ? graph()->name(id()) : UT_StringHolder(); 
    }

    /// Return true if the port name can be changed.
    bool canSetName() const
    {
        return graph() ? graph()->canSetName(id()) : false;
    }

    /// Returns the name of the data type for the given port.
    UT_StringHolder typeName() const
    {
        return graph() ? graph()->typeName(id()) : UT_StringHolder();
    }

    /// Returns the name of the UI color for the given port.
    /// The color name adheres to the UIgetMiscColor() conventions.
    UT_StringHolder colorName() const
    {
        return graph() ? graph()->colorName(id()) : UT_StringHolder(); 
    }

    /// Returns the UI shape of the port socket.
    UNI_PortShape shape() const
    {
        return graph() ? graph()->shape(id()) : UNI_PortShape::Default; 
    }

    /// Return wires that are sources to this port (where this port is the
    /// destination of the wire).
    UNI_WireIDList srcWires() const
    {
        return graph() ? graph()->srcWires(id()) : UNI_WireIDList();
    }

    /// Return wires that are destinations from this port (where this port is
    /// the source of the wire).
    UNI_WireIDList dstWires() const
    {
        return graph() ? graph()->dstWires(id()) : UNI_WireIDList();
    }
};


// ============================================================================
class UNI_API UNI_Port : public UNI_Item<UNI_PortID,
                                         UNI_SessionPortID,
                                         UNI_ConstPort>
{
public:
    /// Expose base class constructors.
    using UNI_Item::UNI_Item;

    /// Set the name of a port, if allowed.
    void setName(const UT_StringHolder &name);

    /// Connect a new source to this port (which is the destination).
    UNI_WireID addSrc(UNI_PortID src);

    /// Ensures the node signatures and port types are up-to-date for 
    /// all the nodes downstream of the given port.
    /// If @p update_port is true, the given port is updated too.
    void updateDownstreamPortTypes( bool update_port ) const;
};

#endif