viscluster.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-2008  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_CLUSTER_H
#define AVOID_CLUSTER_H

#include <list>

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

namespace Avoid {

class Router;
class ClusterRef;
typedef std::list<ClusterRef *> ClusterRefList;


class AVOID_EXPORT ClusterRef
{
    public:
        ClusterRef(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
        ~ClusterRef();
#endif
        void setNewPoly(Polygon& poly);
        unsigned int id(void) const;
        ReferencingPolygon& polygon(void);
        Polygon& rectangularPolygon(void);
        Router *router(void) const;
        
        void makeActive(void);
        void makeInactive(void);

    private:
        Router *m_router;
        unsigned int m_id;
        ReferencingPolygon m_polygon;
        Polygon m_rectangular_polygon;
        bool m_active;
        ClusterRefList::iterator m_clusterrefs_pos;
};


}


#endif