scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2025-01-20 22:39:50 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Point documentation: add examples to Point.min, Point.max and Point.random.

Browse source
This commit is contained in:
Jonathan Puckey 2011-05-31 01:19:33 +02:00
parent 5341cc0855
commit 7eb35bf6fb
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
src/basic/Point.js
View file

@ -783,6 +783,12 @@ var Point = this.Point = Base.extend({
* @param {Point} point1
* @param {Point} point2
* @returns {Point} The newly created point object
*
* @example
* var point1 = new Point(10, 100);
* var point2 = new Point(200, 5);
* var minPoint = Point.min(point1, point2);
* console.log(minPoint); // { x: 10.0, y: 5.0 }
*/
min: function(point1, point2) {
point1 = Point.read(arguments, 0, 1);
@ -801,6 +807,12 @@ var Point = this.Point = Base.extend({
* @param {Point} point1
* @param {Point} point2
* @returns {Point} The newly created point object
*
* @example
* var point1 = new Point(10, 100);
* var point2 = new Point(200, 5);
* var maxPoint = Point.max(point1, point2);
* console.log(maxPoint); // { x: 200.0, y: 100.0 }
*/
max: function(point1, point2) {
point1 = Point.read(arguments, 0, 1);
@ -817,6 +829,13 @@ var Point = this.Point = Base.extend({
*
* @returns {Point} The newly created point object
* @static
*
* @example
* var maxPoint = new Point(100, 100);
* var randomPoint = Point.random();
*
* // A point between {x:0, y:0} and {x:100, y:100}:
* var point = maxPoint * randomPoint;
*/
random: function() {
return Point.create(Math.random(), Math.random());