Improved JavaDoc.

[sixth-3d.git] / src / main / java / eu / svjatoslav / sixth / e3d / geometry / Point2D.java

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/geometry/Point2D.java b/src/main/java/eu/svjatoslav/sixth/e3d/geometry/Point2D.java
index 1cfd39c..a82382f 100755 (executable)
--- a/src/main/java/eu/svjatoslav/sixth/e3d/geometry/Point2D.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/geometry/Point2D.java
@@ -1,12 +1,7 @@
 /*
- * Sixth 3D engine. Copyright ©2012-2018, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of version 3 of the GNU Lesser General Public License
- * or later as published by the Free Software Foundation.
- *
+ * Sixth 3D engine. Author: Svjatoslav Agejenko. 
+ * This project is released under Creative Commons Zero (CC0) license.
  */
-
 package eu.svjatoslav.sixth.e3d.geometry;
 
 import static java.lang.Math.sqrt;
@@ -23,18 +18,23 @@ public class Point2D implements Cloneable {
         this.y = y;
     }
 
-    public Point2D(final Point2D source) {
-        x = source.x;
-        y = source.y;
+    public Point2D(final Point2D parent) {
+        x = parent.x;
+        y = parent.y;
     }
 
-    public Point2D add(final Point2D direction) {
-        x += direction.x;
-        y += direction.y;
+    /**
+     * Add other point to current point.
+     *
+     * @return current point.
+     */
+    public Point2D add(final Point2D otherPoint) {
+        x += otherPoint.x;
+        y += otherPoint.y;
         return this;
     }
 
-    public boolean isZero(){
+    public boolean isZero() {
         return (x == 0) && (y == 0);
     }
 
@@ -43,9 +43,9 @@ public class Point2D implements Cloneable {
         return new Point2D(this);
     }
 
-    public void clone(final Point2D source) {
-        x = source.x;
-        y = source.y;
+    public void clone(final Point2D parent) {
+        x = parent.x;
+        y = parent.y;
     }
 
     public Point2D getMiddle(final Point2D p1, final Point2D p2) {
@@ -83,9 +83,14 @@ public class Point2D implements Cloneable {
         y = (int) y;
     }
 
-    public Point2D subtract(final Point2D point) {
-        x -= point.x;
-        y -= point.y;
+    /**
+     * Subtract other point from current point.
+     *
+     * @return current point.
+     */
+    public Point2D subtract(final Point2D otherPoint) {
+        x -= otherPoint.x;
+        y -= otherPoint.y;
         return this;
     }
 
@@ -99,4 +104,11 @@ public class Point2D implements Cloneable {
         return this;
     }
 
+    @Override
+    public String toString() {
+        return "Point2D{" +
+                "x=" + x +
+                ", y=" + y +
+                '}';
+    }
 }