shape.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-2011  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_SHAPE_H
#define AVOID_SHAPE_H

#include <list>
#include <set>

#include <cstdio>

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

namespace topology {
    class LayoutObstacle;
}

namespace Avoid {

class VertInf;
class Router;
class ShapeRef;
class ConnEnd;
class ShapeConnectionPin;
class ConnRef;
typedef std::list<ShapeRef *> ShapeRefList;

enum ShapeTransformationType 
{
    TransformationType_CW90       = 0,
    TransformationType_CW180      = 1,
    TransformationType_CW270      = 2,
    TransformationType_FlipX      = 3,
    TransformationType_FlipY      = 4
};


class AVOID_EXPORT ShapeRef : public Obstacle
{
    public:
        ShapeRef(Router *router, Polygon& poly, const unsigned int id = 0);

// To prevent C++ objects from being destroyed in garbage collected languages
// when the libraries are called from SWIG, we hide the declarations of the
// destructors and prevent generation of default destructors.
#ifndef SWIG
        virtual ~ShapeRef();
#endif

        const Polygon& polygon(void) const;
        
        void transformConnectionPinPositions(ShapeTransformationType transform);
 
        Point position(void) const;
    private:
        friend class Router;
        friend class ConnEnd;
        friend class ShapeConnectionPin;
        friend class topology::LayoutObstacle;

        void outputCode(FILE *fp) const;
        void moveAttachedConns(const Polygon& newPoly);
        void assignPinVisibilityTo(const unsigned int pinClassId,
                VertInf *dummyConnectionVert);
        void setCentrePos(const Point& newCentre);
};


}


#endif