Author: Kore Nordmann
Date: 2007-01-25 10:57:29 +0100 (Thu, 25 Jan 2007)
New Revision: 4571
Log:
- Added documentation to ezcGraphDriver::reducePolygonSize
Modified:
trunk/Graph/src/interfaces/driver.php
Modified: trunk/Graph/src/interfaces/driver.php
===================================================================
--- trunk/Graph/src/interfaces/driver.php 2007-01-25 09:11:25 UTC (rev
4570)
+++ trunk/Graph/src/interfaces/driver.php 2007-01-25 09:57:29 UTC (rev
4571)
@@ -80,6 +80,23 @@
}
}
+ /**
+ * Reduces the size of a polygon
+ *
+ * The method takes a polygon defined by a list of points and reduces its
+ * size by moving all lines to the middle by the given $size value.
+ *
+ * The detection of the inner side of the polygon depends on the angle at
+ * each edge point. This method will always work for 3 edged polygones,
+ * because the smaller angle will always be on the inner side. For
+ * polygons with more then 3 edges this method may fail. For ezcGraph this
+ * is a valid simplification, because we do not have any polygones which
+ * have an inner angle >= 180 degrees.
+ *
+ * @param array( ezcGraphCoordinate ) $points
+ * @param float $size
+ * @return array( ezcGraphCoordinate )
+ */
protected function reducePolygonSize( array $points, $size )
{
$pointCount = count( $points );
--
svn-components mailing list
svn-components@lists.ez.no
http://lists.ez.no/mailman/listinfo/svn-components
