connend.h

Go to the documentation of this file.

/*
 * vim: ts=4 sw=4 et tw=0 wm=0
 *
 * libavoid - Fast, Incremental, Object-avoiding Line Router
 *
 * Copyright (C) 2004-2014  Monash University
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * See the file LICENSE.LGPL distributed with the library.
 *
 * Licensees holding a valid commercial license may use this file in
 * accordance with the commercial license agreement provided with the 
 * library.
 *
 * This library 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.  
 *
 * Author(s):   Michael Wybrow
*/



#ifndef AVOID_CONNEND_H
#define AVOID_CONNEND_H


#include <cstdio>
#include <list>
#include <vector>
#include <utility>

#include "libavoid/dllexport.h"
#include "libavoid/geometry.h"


namespace Avoid {

class Obstacle;
class ShapeRef;
class JunctionRef;
class Router;
class ConnRef;
class ShapeConnectionPin;
typedef std::list<ConnRef *> ConnRefList;
class VertInf;


enum ConnDirFlag {
    ConnDirNone  = 0,
    ConnDirUp    = 1,
    ConnDirDown  = 2,
    ConnDirLeft  = 4,
    ConnDirRight = 8,
    ConnDirAll   = 15
};
typedef unsigned int ConnDirFlags;


enum ConnEndType {
    ConnEndPoint,
    ConnEndShapePin,
    ConnEndJunction,
    ConnEndEmpty
};


class AVOID_EXPORT ConnEnd 
{
    public:
        ConnEnd(const Point& point);

        ConnEnd(const Point& point, const ConnDirFlags visDirs);

        ConnEnd(ShapeRef *shapeRef, const unsigned int connectionPinClassID);

        ConnEnd(JunctionRef *junctionRef);


        ConnEndType type(void) const;

        const Point position(void) const;

        ConnDirFlags directions(void) const;

        ShapeRef *shape(void) const;

        JunctionRef *junction(void) const;

        unsigned int pinClassId(void) const;

        ConnEnd();
        ~ConnEnd();
    private:
        friend class Obstacle;
        friend class JunctionRef;
        friend class ShapeRef;
        friend class ConnRef;
        friend class Router;
        friend class HyperedgeRerouter;
        friend class ShapeConnectionPin;
        friend class HyperedgeImprover;
        friend class CrossingConnectorsInfo;

        void connect(ConnRef *conn);
        void disconnect(const bool shapeDeleted = false);
        void usePin(ShapeConnectionPin *pin);
        void usePinVertex(VertInf *pinVert);
        void freeActivePin(void);
        unsigned int endpointType(void) const;
        bool isPinConnection(void) const;
        std::vector<Point> possiblePinPoints(void) const;
        void assignPinVisibilityTo(VertInf *dummyConnectionVert, 
                VertInf *targetVert);
        void outputCode(FILE *fp, const char *srcDst) const;
        std::pair<bool, VertInf *> getHyperedgeVertex(Router *router) const;

        ConnEndType m_type;
        Point m_point;
        ConnDirFlags m_directions;
        unsigned int m_connection_pin_class_id;
        
        // For referencing ConnEnds
        Obstacle *m_anchor_obj;  // The shape/junction this is attached to.
        ConnRef *m_conn_ref;    // The parent connector.
        
        // The pin to which the ConnEnd is attached.
        ShapeConnectionPin *m_active_pin;  
};


}


#endif