RhodeCode

 * Permission to use, modify and distribute this software is granted

 * provided that this copyright notice appears in all copies. For

 * precise terms see the accompanying LICENSE file.

 *

 * This software is provided "AS IS" with no warranty of any kind,

 * express or implied, and with no claim as to its suitability for any

 * purpose.

 *

 */

/// \ingroup demos

/// \file

///

/// This demo program shows examples how to  use the function \ref

/// graphToEps(). It takes no input but simply creates  six

/// <tt>.eps</tt> files demonstrating the capability of \ref

/// how to handle parallel egdes, how to change the properties (like

/// color, shape, size, title etc.) of nodes and arcs individually

/// using appropriate \ref maps-page "graph maps".

///

/// \include graph_to_eps_demo.cc

#include<lemon/list_graph.h>

#include<lemon/graph_utils.h>

using namespace std;

using namespace lemon;

int main()

{

  Palette palette;

  Palette paletteW(true);

  ListDigraph g;

  typedef ListDigraph::Node Node;

  typedef ListDigraph::NodeIt NodeIt;

  typedef ListDigraph::Arc Arc;

  typedef dim2::Point<int> Point;

  Node n1=g.addNode();

  Node n2=g.addNode();

  Node n3=g.addNode();

  Node n4=g.addNode();

  Node n5=g.addNode();

  ListDigraph::NodeMap<Point> coords(g);

  ListDigraph::NodeMap<double> sizes(g);

  ListDigraph::NodeMap<int> colors(g);

  ListDigraph::NodeMap<int> shapes(g);

  ListDigraph::ArcMap<int> widths(g);

  coords[n1]=Point(50,50);  sizes[n1]=1; colors[n1]=1; shapes[n1]=0;

  coords[n2]=Point(50,70);  sizes[n2]=2; colors[n2]=2; shapes[n2]=2;

  coords[n3]=Point(70,70);  sizes[n3]=1; colors[n3]=3; shapes[n3]=0;

  coords[n4]=Point(70,50);  sizes[n4]=2; colors[n4]=4; shapes[n4]=1;

  coords[n5]=Point(85,60);  sizes[n5]=3; colors[n5]=5; shapes[n5]=2;

  IdMap<ListDigraph,Node> id(g);

    coords(coords).

    title("Sample .eps figure").

    run();

    coords(coords).

    title("Sample .eps figure").

    absoluteNodeSizes().absoluteArcWidths().

    nodeScale(2).nodeSizes(sizes).

    nodeShapes(shapes).

    nodeColors(composeMap(palette,colors)).

    arcWidthScale(.4).arcWidths(widths).

    nodeTexts(id).nodeTextSize(3).

    run();

    title("Sample .eps figure (with arrowheads)").

    absoluteNodeSizes().absoluteArcWidths().

    nodeColors(composeMap(palette,colors)).

    coords(coords).

    nodeScale(2).nodeSizes(sizes).

    nodeShapes(shapes).

    arcWidthScale(.4).arcWidths(widths).

    nodeTexts(id).nodeTextSize(3).

    run();

  cout << "Create 'graph_to_eps_demo_out_par.eps'" << endl;

  graphToEps(g,"graph_to_eps_demo_out_par.eps").

    //scale(10).

    title("Sample .eps figure (parallel arcs)").

    absoluteNodeSizes().absoluteArcWidths().

    nodeShapes(shapes).

    coords(coords).

    nodeScale(2).nodeSizes(sizes).

    nodeColors(composeMap(palette,colors)).

    arcWidthScale(.4).arcWidths(widths).

    nodeTexts(id).nodeTextSize(3).

    enableParallel().parArcDist(1.5).

    run();

    title("Sample .eps figure (parallel arcs and arrowheads)").

    absoluteNodeSizes().absoluteArcWidths().

    nodeScale(2).nodeSizes(sizes).

    coords(coords).

    nodeShapes(shapes).

    nodeColors(composeMap(palette,colors)).

    arcWidthScale(.3).arcWidths(widths).

    nodeTexts(id).nodeTextSize(3).

    enableParallel().parArcDist(1).

    drawArrows().arrowWidth(1).arrowLength(1).

    run();

    title("Sample .eps figure (fits to A4)").

    absoluteNodeSizes().absoluteArcWidths().

    nodeScale(2).nodeSizes(sizes).

    coords(coords).

    nodeShapes(shapes).

    nodeColors(composeMap(palette,colors)).

    arcWidthScale(.3).arcWidths(widths).

    nodeTexts(id).nodeTextSize(3).

    enableParallel().parArcDist(1).

    drawArrows().arrowWidth(1).arrowLength(1).

    run();

  ListDigraph h;

  ListDigraph::NodeMap<int> hcolors(h);

  ListDigraph::NodeMap<Point> hcoords(h);

  int cols=int(sqrt(double(palette.size())));

  for(int i=0;i<int(paletteW.size());i++) {

    Node n=h.addNode();

    hcolors[n]=i;

  }

    title("Sample .eps figure (Palette demo)").

    coords(hcoords).

    absoluteNodeSizes().absoluteArcWidths().

    nodeScale(.45).

    distantColorNodeTexts().

    nodeTexts(hcolors).nodeTextSize(.6).

    nodeColors(composeMap(paletteW,hcolors)).

    run();

}

  ///their number. The integer range is cyclically mapped to the

  ///provided set of colors.

  ///

  ///This is a true \ref concepts::ReferenceMap "reference map", so

  ///you can also change the actual colors.

  class Palette : public MapBase<int,Color>

  {

    std::vector<Color> colors;

  public:

    ///Constructor

    ///provided initial colors (\c true) or not (\c false). If it is true,

    ///white will be assigned to \c 0.

    ///the default color configuration is set up (26 color plus optionaly the

    ///white).  If \c num is less then 26/27 then the default color

    ///list is cut. Otherwise the color list is filled repeatedly with

    ///the default color list.  (The colors can be changed later on.)

    Palette(bool have_white=false,int num=-1)

    {

      if (num==0) return;

      do {

        if(have_white) colors.push_back(Color(1,1,1));

        colors.push_back(Color(0,0,0));

        colors.push_back(Color(1,0,0));

        colors.push_back(Color(.5,.5,1));

        colors.push_back(Color(1,1,.5));

        colors.push_back(Color(1,.5,1));

        colors.push_back(Color(.5,1,1));

        colors.push_back(Color(1,.5,0));

        colors.push_back(Color(.5,1,0));

        colors.push_back(Color(1,0,.5));

        colors.push_back(Color(0,1,.5));

        colors.push_back(Color(0,.5,1));

        colors.push_back(Color(.5,0,1));

      } while(int(colors.size())<num);

      if(num>=0) colors.resize(num);

    }

    ///\e

    Color &operator[](int i)

    {

      return colors[i%colors.size()];

    }

    ///\e

    const Color &operator[](int i) const

    {

      return colors[i%colors.size()];

    }

    ///\e

    void set(int i,const Color &c)

    {

      colors[i%colors.size()]=c;

    }

    void add(const Color &c) 

    {

      colors.push_back(c);

    }

    void resize(int s) { colors.resize(s);}

    ///Returns the number of the existing colors.

    int size() const { return int(colors.size());}

  };

  ///Returns a visibly distinct \ref Color

  ///Returns a \ref Color which is as different from the given parameter

  ///as it is possible.

  inline Color distantColor(const Color &c) 

  {

    return Color(c.red()<.5?1:0,c.green()<.5?1:0,c.blue()<.5?1:0);

    public:

      typedef typename MT::Key Key;

      typedef typename MT::Value Value;

      const MT ↦

      int yscale;

      _NegY(const MT &m,bool b) : map(m), yscale(1-b*2) {}

      Value operator[](Key n) { return Value(map[n].x,map[n].y*yscale);}

    };

  }

///Default traits class of \ref GraphToEps

///

///\c G is the type of the underlying graph.

template<class G>

struct DefaultGraphToEpsTraits

{

  typedef G Graph;

  typedef typename Graph::Node Node;

  typedef typename Graph::NodeIt NodeIt;

  typedef typename Graph::Arc Arc;

  typedef typename Graph::ArcIt ArcIt;

  typedef typename Graph::InArcIt InArcIt;

  typedef typename Graph::OutArcIt OutArcIt;

  bool _autoNodeScale;

  bool _autoArcWidthScale;

  bool _absoluteNodeSizes;

  bool _absoluteArcWidths;

  bool _negY;

  bool _preScale;

  ///Constructor

  ///Constructor

  ///\param _pros If it is \c true, then the \c ostream referenced by \c _os

  ///will be explicitly deallocated by the destructor.

  DefaultGraphToEpsTraits(const G &_g,std::ostream& _os=std::cout,

			  bool _pros=false) :

    g(_g), os(_os),

    _coords(dim2::Point<double>(1,1)), _nodeSizes(1), _nodeShapes(0),

    _nodeColors(WHITE), _arcColors(BLACK),

    _arcWidths(1.0), _arcWidthScale(0.003),

    _nodeScale(.01), _xBorder(10), _yBorder(10), _scale(1.0),

    _nodeBorderQuotient(.1),

    _drawArrows(false), _arrowLength(1), _arrowWidth(0.3),

    _showNodes(true), _showArcs(true),

    _enableParallel(false), _parArcDist(1),

    _showNodeText(false), _nodeTexts(false), _nodeTextSize(1),

    _nodeTextColorType(SAME_COL), _nodeTextColors(BLACK),

    _autoNodeScale(false),

    _autoArcWidthScale(false),

    _absoluteNodeSizes(false),

    _absoluteArcWidths(false),

    _negY(false),

    _preScale(true)

  {}

};

///Auxiliary class to implement the named parameters of \ref graphToEps()

template<class T> class GraphToEps : public T 

{

  // Can't believe it is required by the C++ standard

  using T::g;

  using T::os;

  using T::_coords;

  using T::_nodeSizes;

  using T::_nodeShapes;

  using T::_nodeColors;

  using T::_arcColors;

  using T::_arcWidths;

  typedef typename Graph::OutArcIt OutArcIt;

  static const int INTERPOL_PREC;

  static const double A4HEIGHT;

  static const double A4WIDTH;

  static const double A4BORDER;

  bool dontPrint;

public:

  ///Node shapes

  ///

  enum NodeShapes { 

    /// = 0

    ///\image html nodeshape_0.png

    ///\image latex nodeshape_0.eps "CIRCLE shape (0)" width=2cm

    CIRCLE=0, 

    /// = 1

    ///\image html nodeshape_1.png

    ///\image latex nodeshape_1.eps "SQUARE shape (1)" width=2cm

    ///

    SQUARE=1, 

    /// = 2

public:

  GraphToEps(const T &t) : T(t), dontPrint(false) {};

  template<class X> struct CoordsTraits : public T {

  typedef X CoordsMapType;

    const X &_coords;

    CoordsTraits(const T &t,const X &x) : T(t), _coords(x) {}

  };

  ///Sets the map of the node coordinates

  ///Sets the map of the node coordinates.

  ///\ref dim2::Point "dim2::Point<int>" values. 

  template<class X> GraphToEps<CoordsTraits<X> > coords(const X &x) {

    dontPrint=true;

    return GraphToEps<CoordsTraits<X> >(CoordsTraits<X>(*this,x));

  }

  template<class X> struct NodeSizesTraits : public T {

    const X &_nodeSizes;

    NodeSizesTraits(const T &t,const X &x) : T(t), _nodeSizes(x) {}

  };

  ///Sets the map of the node sizes

  ///\param x must be a node map with \c double (or convertible) values. 

  template<class X> GraphToEps<NodeSizesTraits<X> > nodeSizes(const X &x)

  {

    dontPrint=true;

    return GraphToEps<NodeSizesTraits<X> >(NodeSizesTraits<X>(*this,x));

  }

  template<class X> struct NodeShapesTraits : public T {

    const X &_nodeShapes;

    NodeShapesTraits(const T &t,const X &x) : T(t), _nodeShapes(x) {}

  };

  ///Sets the map of the node shapes

  ///\sa NodeShapes

  template<class X> GraphToEps<NodeShapesTraits<X> > nodeShapes(const X &x)

  {

    dontPrint=true;

    return GraphToEps<NodeShapesTraits<X> >(NodeShapesTraits<X>(*this,x));

  }

  template<class X> struct NodeTextsTraits : public T {

    const X &_nodeTexts;

    NodeTextsTraits(const T &t,const X &x) : T(t), _nodeTexts(x) {}

  };

  ///Sets the text printed on the nodes

  ///\param x must be a node map with type that can be pushed to a standard

  template<class X> GraphToEps<NodeTextsTraits<X> > nodeTexts(const X &x)

  {

    dontPrint=true;

    _showNodeText=true;

    return GraphToEps<NodeTextsTraits<X> >(NodeTextsTraits<X>(*this,x));

  }

  template<class X> struct NodePsTextsTraits : public T {

    const X &_nodePsTexts;

    NodePsTextsTraits(const T &t,const X &x) : T(t), _nodePsTexts(x) {}

  };

  ///Inserts a PostScript block to the nodes

  ///With this command it is possible to insert a verbatim PostScript

  ///block to the nodes.

  ///the PostScript block inserted.

  ///

  ///Before and after the block a newline character is inserted so you

  ///don't have to bother with the separators.

  ///

  ///\param x must be a node map with type that can be pushed to a standard

  ///

  ///\sa nodePsTextsPreamble()

  template<class X> GraphToEps<NodePsTextsTraits<X> > nodePsTexts(const X &x)

  {

    dontPrint=true;

    _showNodePsText=true;

    return GraphToEps<NodePsTextsTraits<X> >(NodePsTextsTraits<X>(*this,x));

  }

  template<class X> struct ArcWidthsTraits : public T {

    const X &_arcWidths;

    ArcWidthsTraits(const T &t,const X &x) : T(t), _arcWidths(x) {}

  };

  ///Sets the map of the arc widths

  ///\param x must be an arc map with \c double (or convertible) values. 

  template<class X> GraphToEps<ArcWidthsTraits<X> > arcWidths(const X &x)

  {

    dontPrint=true;

    return GraphToEps<ArcWidthsTraits<X> >(ArcWidthsTraits<X>(*this,x));

  }

  template<class X> struct NodeColorsTraits : public T {

    const X &_nodeColors;

    NodeColorsTraits(const T &t,const X &x) : T(t), _nodeColors(x) {}

  };

  ///Sets the map of the node colors

  ///\param x must be a node map with \ref Color values.

  ///

  ///\sa Palette

  template<class X> GraphToEps<NodeColorsTraits<X> >

  nodeColors(const X &x)

  {

    dontPrint=true;

    return GraphToEps<NodeColorsTraits<X> >(NodeColorsTraits<X>(*this,x));

  }

  template<class X> struct NodeTextColorsTraits : public T {

    const X &_nodeTextColors;

    NodeTextColorsTraits(const T &t,const X &x) : T(t), _nodeTextColors(x) {}

  };

  ///Sets the map of the node text colors

  ///\param x must be a node map with \ref Color values. 

  ///

  ///\sa Palette

  template<class X> GraphToEps<NodeTextColorsTraits<X> >

  nodeTextColors(const X &x)

  {

    dontPrint=true;

    _nodeTextColorType=CUST_COL;

    return GraphToEps<NodeTextColorsTraits<X> >

      (NodeTextColorsTraits<X>(*this,x));

  }

  template<class X> struct ArcColorsTraits : public T {

    const X &_arcColors;

    ArcColorsTraits(const T &t,const X &x) : T(t), _arcColors(x) {}

  };

  ///Sets the map of the arc colors

  ///\param x must be an arc map with \ref Color values. 

  ///

  ///\sa Palette

  template<class X> GraphToEps<ArcColorsTraits<X> >

  arcColors(const X &x)

  {

    dontPrint=true;

    return GraphToEps<ArcColorsTraits<X> >(ArcColorsTraits<X>(*this,x));

  }

  ///Sets a global scale factor for node sizes

  ///Sets a global scale factor for node sizes.

  /// 

  /// If nodeSizes() is not given, this function simply sets the node

  /// sizes to \c d.  If nodeSizes() is given, but

  /// autoNodeScale() is not, then the node size given by

  /// nodeSizes() will be multiplied by the value \c d.

  /// If both nodeSizes() and autoNodeScale() are used, then the

  /// node sizes will be scaled in such a way that the greatest size will be

  /// equal to \c d.

  /// \sa nodeSizes()

  /// \sa autoNodeScale()

  GraphToEps<T> &nodeScale(double d=.01) {_nodeScale=d;return *this;}

  ///

  ///\sa nodeScale()

  ///

  GraphToEps<T> &autoNodeScale(bool b=true) {

    _autoNodeScale=b;return *this;

  }

  ///

  ///\sa nodeScale()

  ///

  GraphToEps<T> &absoluteNodeSizes(bool b=true) {

    _absoluteNodeSizes=b;return *this;

  }

  ///Negates the Y coordinates.

  GraphToEps<T> &negateY(bool b=true) {

    _negY=b;return *this;

  }

  ///Turn on/off pre-scaling

  ///By default graphToEps() rescales the whole image in order to avoid

  ///very big or very small bounding boxes.

  ///

  ///This (p)rescaling can be turned off with this function.

  ///

  GraphToEps<T> &preScale(bool b=true) {

    _autoArcWidthScale=b;return *this;

  }

  ///Turns on/off the absolutematic arc width scaling.

  ///Turns on/off the absolutematic arc width scaling.

  ///

  ///\sa arcWidthScale()

  ///

  GraphToEps<T> &absoluteArcWidths(bool b=true) {

    _absoluteArcWidths=b;return *this;

  }

  ///Sets a global scale factor for the whole picture

  GraphToEps<T> &scale(double d) {_scale=d;return *this;}

  ///Sets the width of the border around the picture

  GraphToEps<T> &border(double b=10) {_xBorder=_yBorder=b;return *this;}

  ///Sets the width of the border around the picture

  GraphToEps<T> &border(double x, double y) {

    _xBorder=x;_yBorder=y;return *this;

  }

  ///Sets whether to draw arrows

  GraphToEps<T> &drawArrows(bool b=true) {_drawArrows=b;return *this;}

  ///Sets the length of the arrowheads

  GraphToEps<T> &arrowLength(double d=1.0) {_arrowLength*=d;return *this;}

  ///Sets the width of the arrowheads

  GraphToEps<T> &arrowWidth(double d=.3) {_arrowWidth*=d;return *this;}

  ///Scales the drawing to fit to A4 page

  GraphToEps<T> &scaleToA4() {_scaleToA4=true;return *this;}

  ///Enables parallel arcs

  GraphToEps<T> &enableParallel(bool b=true) {_enableParallel=b;return *this;}

  GraphToEps<T> &parArcDist(double d) {_parArcDist*=d;return *this;}

  ///Hides the arcs

  GraphToEps<T> &hideArcs(bool b=true) {_showArcs=!b;return *this;}

  ///Hides the nodes

  GraphToEps<T> &hideNodes(bool b=true) {_showNodes=!b;return *this;}

  ///Sets the size of the node texts

  GraphToEps<T> &nodeTextSize(double d) {_nodeTextSize=d;return *this;}

  ///Sets the color of the node texts to be different from the node color

  ///Sets the color of the node texts to be as different from the node color

  GraphToEps<T> &distantColorNodeTexts()

  {_nodeTextColorType=DIST_COL;return *this;}

  ///Sets the color of the node texts to be black or white and always visible.

  ///Sets the color of the node texts to be black or white according to

  GraphToEps<T> &distantBWNodeTexts()

  {_nodeTextColorType=DIST_BW;return *this;}

  ///Gives a preamble block for node Postscript block.

  ///Gives a preamble block for node Postscript block.

  ///

  ///\sa nodePsTexts()

  GraphToEps<T> & nodePsTextsPreamble(const char *str) {

    _nodePsTextsPreamble=str ;return *this;

  }

  ///

  ///This setting is the default for undirected graphs.

  ///

  ///\sa directed()

   GraphToEps<T> &undirected(bool b=true) {_undirected=b;return *this;}

  ///Use it to show the edges as a pair of directed ones.

  ///

  ///This setting is the default for digraphs.

  ///

  ///\sa undirected()

  GraphToEps<T> &directed(bool b=true) {_undirected=!b;return *this;}

  ///Sets the title.

  ///Sets the title of the generated image,

  ///namely it inserts a <tt>%%Title:</tt> DSC field to the header of

  ///the EPS file.

  ///it draws the graph.

  void run() {

    //\todo better 'epsilon' would be nice here.

    const double EPSILON=1e-9;

    if(dontPrint) return;

    _graph_to_eps_bits::_NegY<typename T::CoordsMapType>

      mycoords(_coords,_negY);

    os << "%!PS-Adobe-2.0 EPSF-2.0\n";

    if(_title.size()>0) os << "%%Title: " << _title << '\n';

     if(_copyright.size()>0) os << "%%Copyright: " << _copyright << '\n';

    os << "%%Creator: LEMON, graphToEps()\n";

    {    

#ifndef WIN32 

      timeval tv;

      gettimeofday(&tv, 0);

      char cbuf[26];

      ctime_r(&tv.tv_sec,cbuf);

      os << "%%CreationDate: " << cbuf;

#else

      SYSTEMTIME time;

	  GetDateFormat(LOCALE_USER_DEFAULT, 0, &time, 

				"yyyy", buf3, 5)) {

	os << "%%CreationDate: " << buf1 << ' ' 

	   << buf2 << ' ' << buf3 << std::endl;

      }	  

#endif

    }

    if (_autoArcWidthScale) {

      double max_w=0;

      for(ArcIt e(g);e!=INVALID;++e)

	max_w=std::max(double(_arcWidths[e]),max_w);

      if(max_w>EPSILON) {

	_arcWidthScale/=max_w;

      }

    }

    if (_autoNodeScale) {

      double max_s=0;

      for(NodeIt n(g);n!=INVALID;++n)

	max_s=std::max(double(_nodeSizes[n]),max_s);

      if(max_s>EPSILON) {

	_nodeScale/=max_s;

      }

    }

    double diag_len = 1;

    if(!(_absoluteNodeSizes&&_absoluteArcWidths)) {

      dim2::BoundingBox<double> bb;

      for(NodeIt n(g);n!=INVALID;++n) bb.add(mycoords[n]);

      if (bb.empty()) {

	bb = dim2::BoundingBox<double>(dim2::Point<double>(0,0));

      }

    os << "grestore\nshowpage\n";

    //CleanUp:

    if(_pleaseRemoveOsStream) {delete &os;}

  }

  ///\name Aliases

  ///These are just some aliases to other parameter setting functions.

  ///@{

  ///An alias for arcWidths()

  template<class X> GraphToEps<ArcWidthsTraits<X> > edgeWidths(const X &x)

  {

    return arcWidths(x);

  }

  ///An alias for arcColors()

  template<class X> GraphToEps<ArcColorsTraits<X> >

  edgeColors(const X &x)

  {

    return arcColors(x);

  }

  ///An alias for arcWidthScale()

  GraphToEps<T> &edgeWidthScale(double d) {return arcWidthScale(d);}

  ///An alias for autoArcWidthScale()

  GraphToEps<T> &autoEdgeWidthScale(bool b=true)

  {

    return autoArcWidthScale(b);

  }

  ///An alias for absoluteArcWidths()

  GraphToEps<T> &absoluteEdgeWidths(bool b=true)

  {

    return absoluteArcWidths(b);

  }

  ///An alias for parArcDist()

  GraphToEps<T> &parEdgeDist(double d) {return parArcDist(d);}

  ///An alias for hideArcs()

  GraphToEps<T> &hideEdges(bool b=true) {return hideArcs(b);}

  ///@}

};

template<class T>

const int GraphToEps<T>::INTERPOL_PREC = 20;

template<class T>

const double GraphToEps<T>::A4HEIGHT = 841.8897637795276;

template<class T>

const double GraphToEps<T>::A4WIDTH  = 595.275590551181;

template<class T>

const double GraphToEps<T>::A4BORDER = 15;

///Generates an EPS file from a graph

///\ingroup eps_io

///Generates an EPS file from a graph.

///

///This function also has a lot of

///\ref named-templ-func-param "named parameters",

///they are declared as the members of class \ref GraphToEps. The following

///example shows how to use these parameters.

///\code

/// graphToEps(g,os).scale(10).coords(coords)

///              .nodeScale(2).nodeSizes(sizes)

///              .arcWidthScale(.4).run();

///\endcode

///\warning Don't forget to put the \ref GraphToEps::run() "run()"

///to the end of the parameter list.

///\sa GraphToEps

///\sa graphToEps(G &g, const char *file_name)

template<class G>

GraphToEps<DefaultGraphToEpsTraits<G> > 

graphToEps(G &g, std::ostream& os=std::cout)

{

  return 

    GraphToEps<DefaultGraphToEpsTraits<G> >(DefaultGraphToEpsTraits<G>(g,os));

}