ClusterGraphAttributes.h

Go to the documentation of this file.

/*
 * $Revision: 2056 $
 * 
 * last checkin:
 *   $Author: klein $ 
 *   $Date: 2010-10-16 16:27:46 +0200 (Sat, 16 Oct 2010) $ 
 ***************************************************************/
 
#ifdef _MSC_VER
#pragma once
#endif

#ifndef OGDF_ATTRIBUTED_CLUSTER_GRAPH_H
#define OGDF_ATTRIBUTED_CLUSTER_GRAPH_H

#include <ogdf/basic/HashArray.h>
#include <ogdf/cluster/ClusterArray.h>

#include <ogdf/cluster/ClusterGraph.h>
#include <ogdf/basic/GraphAttributes.h>

//#include <ogdf/GmlParser.h>


namespace ogdf {

    class OGDF_EXPORT GmlParser;

    class OGDF_EXPORT ClusterInfo
    {
        public:
            ClusterInfo() 
            {
                //&m_fillPattern = GraphAttributes::bpNone; //NoBrush
                m_lineStyle = GraphAttributes::esSolid;
            }

            double m_x, m_y; //position of lower left corner 
            double m_w, m_h; //width and height

            double m_lineWidth; //width of rectangle border line

            String m_color;  //color of rectangle
            String m_fillColor;  //color of fill area
            String m_backColor;  //background color
            GraphAttributes::EdgeStyle m_lineStyle;  //rectangle line style
            GraphAttributes::BrushPattern m_fillPattern; //brush pattern of fill area
            String m_label;  //name label

            int m_clusterID; //the ID of the cluster of which the info is stored
    };


    class OGDF_EXPORT ClusterGraphAttributes : public GraphAttributes
    {
        private:
            ClusterArray<String> m_clusterTemplate; 

        public:
            ClusterGraphAttributes() : GraphAttributes(), m_pClusterGraph(0) {}
            ClusterGraphAttributes(ClusterGraph& cg, long initAttributes = 0);

            virtual ~ClusterGraphAttributes() {}

            virtual void init(ClusterGraph &cg, long initAttributes = 0);
            virtual void initAtt(long initAttributes = 0)
            {GraphAttributes::initAttributes(initAttributes);}

//          operator const ClusterGraph& () const {return *m_pClusterGraph;}
//          operator const Graph& () const {return m_pClusterGraph->getGraph();}

            const ClusterGraph& constClusterGraph() const {return *m_pClusterGraph;}

            int clusterID(node v) {return m_pClusterGraph->clusterOf(v)->index();}
            cluster clusterOf(node v) {return m_pClusterGraph->clusterOf(v);}
            int maxClusterID() const {return m_pClusterGraph->clusterIdCount()-1;}

            void updateClusterPositions(double boundaryDist = 1.0);

            //*****************************************************************
            //data access by ID
            double clusterXPos(int clusterID) const {return m_clusterInfo[clusterID].m_x;}
            double& clusterXPos(int clusterID) {return m_clusterInfo[clusterID].m_x;} 
            double clusterYPos(int clusterID) const {return m_clusterInfo[clusterID].m_y;}
            double& clusterYPos(int clusterID) {return m_clusterInfo[clusterID].m_y;} 
            double clusterHeight(int clusterID) const {return m_clusterInfo[clusterID].m_h;}
            double& clusterHeight(int clusterID) {return m_clusterInfo[clusterID].m_h;}
            double clusterWidth(int clusterID) const {return m_clusterInfo[clusterID].m_w;}
            double& clusterWidth(int clusterID) {return m_clusterInfo[clusterID].m_w;}
            double clusterLineWidth(int clusterID) const 
                {return m_clusterInfo[clusterID].m_lineWidth;}
            double& clusterLineWidth(int clusterID) 
                {return m_clusterInfo[clusterID].m_lineWidth;}
            String clusterFillColor(int clusterID) const 
                {return m_clusterInfo[clusterID].m_fillColor;}
            String& clusterFillColor(int clusterID) 
                {return m_clusterInfo[clusterID].m_fillColor;}
            GraphAttributes::BrushPattern clusterFillPattern(int clusterID) const 
                {return m_clusterInfo[clusterID].m_fillPattern;}
            GraphAttributes::BrushPattern& clusterFillPattern(int clusterID) 
                {return m_clusterInfo[clusterID].m_fillPattern;}
            
            const String &clusterLabel(int clusterID) const 
                {return m_clusterInfo[clusterID].m_label;}
            String &clusterLabel(int clusterID) 
                {return m_clusterInfo[clusterID].m_label;}
            const ClusterInfo& clusterInfo(int clusterID) const {return m_clusterInfo[clusterID];}
            ClusterInfo& clusterInfo(int clusterID) {return m_clusterInfo[clusterID];}
            
            //*****************************************************************
            //data access by cluster
            double clusterXPos(cluster c) const {return m_clusterInfo[c->index()].m_x;}
            double& clusterXPos(cluster c) {return m_clusterInfo[c->index()].m_x;} 
            double clusterYPos(cluster c) const {return m_clusterInfo[c->index()].m_y;} 
            double& clusterYPos(cluster c)  {return m_clusterInfo[c->index()].m_y;} 
            double clusterHeight(cluster c) const {return m_clusterInfo[c->index()].m_h;}
            double& clusterHeight(cluster c) {return m_clusterInfo[c->index()].m_h;}
            double clusterWidth(cluster c) const {return m_clusterInfo[c->index()].m_w;}
            double& clusterWidth(cluster c) {return m_clusterInfo[c->index()].m_w;}
            
            const String &clusterLabel(cluster c) const 
                {return m_clusterInfo[c->index()].m_label;}
            String &clusterLabel(cluster c) 
                {return m_clusterInfo[c->index()].m_label;}

            const String &templateCluster(cluster c) const { return m_clusterTemplate[c]; }
            String &templateCluster(cluster c) { return m_clusterTemplate[c]; }

            const ClusterInfo& clusterInfo(cluster c) const {return m_clusterInfo[c->index()];}
            ClusterInfo& clusterInfo(cluster c) {return m_clusterInfo[c->index()];}

            const String &clusterColor(cluster c) const 
                {return  m_clusterInfo[c->index()].m_color;}
            String &clusterColor(cluster c) 
                {return  m_clusterInfo[c->index()].m_color;}

            //Returns const reference to fill color of cluster \a c.
            const String &clusterFillColor(cluster c) const 
                {return  m_clusterInfo[c->index()].m_fillColor;}
            //Returns reference to fill color of cluster \a c.
            String &clusterFillColor(cluster c) 
                {return  m_clusterInfo[c->index()].m_fillColor;}
            //Returns const reference to background color of cluster \a c.
            const String &clusterBackColor(cluster c) const 
                {return  m_clusterInfo[c->index()].m_backColor;}
            //Returns reference to background color of cluster \a c.
            String &clusterBackColor(cluster c) 
                {return  m_clusterInfo[c->index()].m_backColor;}

            //pen and brush styles
            const GraphAttributes::EdgeStyle &clusterLineStyle(cluster c) const 
                {return  m_clusterInfo[c->index()].m_lineStyle;}
            GraphAttributes::EdgeStyle &clusterLineStyle(cluster c) 
                {return  m_clusterInfo[c->index()].m_lineStyle;}
            const GraphAttributes::BrushPattern &clusterFillPattern(cluster c) const 
                {return  m_clusterInfo[c->index()].m_fillPattern;}
            GraphAttributes::BrushPattern &clusterFillPattern(cluster c) 
                {return  m_clusterInfo[c->index()].m_fillPattern;}

            const double &clusterLineWidth(cluster c) const 
                {return  m_clusterInfo[c->index()].m_lineWidth;}
            double &clusterLineWidth(cluster c) 
                {return  m_clusterInfo[c->index()].m_lineWidth;}

            void setClusterFillPattern(cluster c, int i)
            {
                m_clusterInfo[c->index()].m_fillPattern = intToPattern(i);
            }//setclusterfillpattern
            void setClusterLineStyle(cluster c, int i)
            {
                m_clusterInfo[c->index()].m_lineStyle = intToStyle(i);
            }//setclusterlinestyle

            const DRect boundingBox() const;

            void writeGML(const char *fileName);
            void writeGML(ostream& os);
            //we don't have GraphConstraints yet
            void writeOGML(const char * fileName);//, GraphConstraints & GC);
            void writeOGML(ostream & os);//, GraphConstraints & GC);
            
            bool readClusterGML(const char* fileName, 
                                ClusterGraph& CG, 
                                Graph& G);
            bool readClusterGML(istream& is, 
                                ClusterGraph& CG, 
                                Graph& G);

            //will be private
            bool readClusterGraphGML(const char* fileName, 
                                     ClusterGraph& CG, 
                                     Graph& G,
                                     GmlParser& gml);
            bool readClusterGraphGML( 
                 ClusterGraph& CG, 
                 Graph& G,
                 GmlParser& gml);
            bool readClusterGraphOGML(const char* fileName, 
                                                 ClusterGraph& CG, 
                                                 Graph& G);

        protected:
            const ClusterGraph* m_pClusterGraph;

        private:
            HashArray<int, ClusterInfo> m_clusterInfo;

            void writeCluster(ostream &os,
                          NodeArray<int> &nId,
                          ClusterArray<int> & cId,
                          int &nextId,
                          cluster c,
                          String indent);

            void writeGraphWinCluster(ostream &os,
                          NodeArray<int> &nId,
                          int &nextId,
                          cluster c,
                          String indent);
            void writeClusterOGML(ostream &os, 
                                std::ostringstream & osS, // string stream for styles block
                                NodeArray<int> & nodeIds, 
                                int & nextNodeId, 
                                int & nextLabelId, 
                                cluster cluster,
                                int & indentDepth, // indent depth for structure block
                                int indentDepthS); // indent depth for styles block

    }; //AttributedCluster


} // end namespace ogdf


#endif