lemon-1.0: comparison lemon/graph_to

equal deleted inserted replaced

-:0f7ff5844085
+:9692f170d0be
 #include<lemon/bits/bezier.h>
 ///\ingroup eps_io
 ///\file
-///\brief Simple graph drawer
+///\brief A well configurable tool for visualizing graphs
-///
-///\author Alpar Juttner
 namespace lemon {
 namespace _graph_to_eps_bits {
 template<class MT>
 _negY(false),
 _preScale(true)
 {}
 };
-///Helper class to implement the named parameters of \ref graphToEps()
+///Auxiliary class to implement the named parameters of \ref graphToEps()
-///Helper class to implement the named parameters of \ref graphToEps()
+///Auxiliary class to implement the named parameters of \ref graphToEps()
-///\todo Is 'helper class' a good name for this?
-///
-///\todo Follow PostScript's DSC.
-/// Use own dictionary.
-///\todo Useful new features.
-/// - Linestyles: dotted, dashed etc.
-/// - A second color and percent value for the lines.
 template<class T> class GraphToEps : public T
 {
 // Can't believe it is required by the C++ standard
 using T::g;
 using T::os;
 NodeShapesTraits(const T &t,const X &x) : T(t), _nodeShapes(x) {}
 };
 ///Sets the map of the node shapes
 ///Sets the map of the node shapes.
-///The availabe shape values
+///The available shape values
 ///can be found in \ref NodeShapes "enum NodeShapes".
 ///\param x must be a node map with \c int (or convertible) values.
 ///\sa NodeShapes
 template<class X> GraphToEps<NodeShapesTraits<X> > nodeShapes(const X &x)
 {
 ///
 ///\param x must be a node map with type that can be pushed to a standard
 ///ostream.
 ///
 ///\sa nodePsTextsPreamble()
-///\todo Offer the choise not to move to the centre but pass the coordinates
-///to the Postscript block inserted.
 template<class X> GraphToEps<NodePsTextsTraits<X> > nodePsTexts(const X &x)
 {
 dontPrint=true;
 _showNodePsText=true;
 return GraphToEps<NodePsTextsTraits<X> >(NodePsTextsTraits<X>(*this,x));
 ///Negates the Y coordinates.
 ///Negates the Y coordinates.
 ///
-///\todo More docs.
-///
 GraphToEps<T> &negateY(bool b=true) {
 _negY=b;return *this;
 }
-///Turn on/off prescaling
+///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> &scale(double d) {_scale=d;return *this;}
 ///Sets the width of the border around the picture
 ///Sets the width of the border around the picture
 ///
-GraphToEps<T> &border(double b) {_xBorder=_yBorder=b;return *this;}
+GraphToEps<T> &border(double b=10) {_xBorder=_yBorder=b;return *this;}
 ///Sets the width of the border around the picture
 ///Sets the width of the border around the picture
 ///
 GraphToEps<T> &border(double x, double y) {
 GraphToEps<T> &drawArrows(bool b=true) {_drawArrows=b;return *this;}
 ///Sets the length of the arrowheads
 ///Sets the length of the arrowheads
 ///
-GraphToEps<T> &arrowLength(double d) {_arrowLength*=d;return *this;}
+GraphToEps<T> &arrowLength(double d=1.0) {_arrowLength*=d;return *this;}
 ///Sets the width of the arrowheads
 ///Sets the width of the arrowheads
 ///
-GraphToEps<T> &arrowWidth(double d) {_arrowWidth*=d;return *this;}
+GraphToEps<T> &arrowWidth(double d=.3) {_arrowWidth*=d;return *this;}
 ///Scales the drawing to fit to A4 page
 ///Scales the drawing to fit to A4 page
 ///
 GraphToEps<T> & nodePsTextsPreamble(const char *str) {
 _nodePsTextsPreamble=str ;return *this;
 }
 ///Sets whether the the graph is undirected
-///Sets whether the the graph is undirected
+///Sets whether the the graph is undirected.
 ///
-GraphToEps<T> &undirected(bool b=true) {_undirected=b;return *this;}
+///This setting is the default for undirected graphs.
+///
+///\sa directed()
+GraphToEps<T> &undirected(bool b=true) {_undirected=b;return *this;}
 ///Sets whether the the graph is directed
 ///Sets whether the the graph is directed.
 ///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.
 ///Sets the copyright statement.
 ///Sets the copyright statement of the generated image,
 ///namely it inserts a <tt>%%Copyright:</tt> DSC field to the header of
 ///the EPS file.
-///\todo Multiline copyright notice could be supported.
 GraphToEps<T> &copyright(const std::string &t) {_copyright=t;return *this;}
 protected:
 bool isInsideNode(dim2::Point<double> p, double r,int t)
 {
 ///Draws the graph.
 ///Like other functions using
 ///\ref named-templ-func-param "named template parameters",
-///this function calles the algorithm itself, i.e. in this case
+///this function calls the algorithm itself, i.e. in this case
 ///it draws the graph.
 void run() {
-///\todo better 'epsilon' would be nice here.
+//\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);
 	  sw-=_parArcDist;
 	  sw/=-2.0;
 	  dim2::Point<double>
 	    dvec(mycoords[g.target(*i)]-mycoords[g.source(*i)]);
 	  double l=std::sqrt(dvec.normSquare());
-	  ///\todo better 'epsilon' would be nice here.
+	  //\todo better 'epsilon' would be nice here.
 	  dim2::Point<double> d(dvec/std::max(l,EPSILON));
 	  dim2::Point<double> m;
 // 	  m=dim2::Point<double>(mycoords[g.target(*i)]+mycoords[g.source(*i)])/2.0;
 //  	  m=dim2::Point<double>(mycoords[g.source(*i)])+

changeset 133	d76e2ff9c70d
parent 132	50ff949140fa
child 134	0775d2ba2afb