X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Feu%2Fsvjatoslav%2Fsixth%2Fe3d%2Fgeometry%2FPoint3D.java;h=6bf2dd3f45b4ea08191cf70167ef85a5c7a99086;hb=6b9b5a6b70397f3cea7b965a54aaacc03cdae4f7;hp=f0f23905a9171ee280ccfae6124487b0e27bfd5c;hpb=2ba2ce636354885e669e9e3fbb97226025e5af45;p=sixth-3d.git diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/geometry/Point3D.java b/src/main/java/eu/svjatoslav/sixth/e3d/geometry/Point3D.java index f0f2390..6bf2dd3 100755 --- a/src/main/java/eu/svjatoslav/sixth/e3d/geometry/Point3D.java +++ b/src/main/java/eu/svjatoslav/sixth/e3d/geometry/Point3D.java @@ -1,12 +1,7 @@ /* - * Sixth 3D engine. Copyright ©2012-2020, 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.*; @@ -17,6 +12,7 @@ import static java.lang.Math.*; public class Point3D implements Cloneable { + // coordinates public double x, y, z; public Point3D() { @@ -40,30 +36,63 @@ public class Point3D implements Cloneable { this.z = z; } - public Point3D(final Point3D parentPoint) { - x = parentPoint.x; - y = parentPoint.y; - z = parentPoint.z; + /** + * Creates new current point by cloning coordinates from parent point. + */ + public Point3D(final Point3D parent) { + x = parent.x; + y = parent.y; + z = parent.z; } - public Point3D add(final Point3D direction) { - x += direction.x; - y += direction.y; - z += direction.z; + /** + * Add other point to current point. Value of other point will not be changed. + * + * @param otherPoint point to add. + * @return current point. + */ + public Point3D add(final Point3D otherPoint) { + x += otherPoint.x; + y += otherPoint.y; + z += otherPoint.z; return this; } + /** + * Add coordinates of current point to other point. Value of current point will not be changed. + * @return current point. + */ + public Point3D addTo(final Point3D ... otherPoints) { + for (final Point3D otherPoint : otherPoints) otherPoint.add(this); + return this; + } + + /** + * Create new point by cloning position of current point. + * + * @return newly created clone. + */ public Point3D clone() { return new Point3D(this); } - public Point3D clone(final Point3D source) { - x = source.x; - y = source.y; - z = source.z; + /** + * Copy coordinates from other point to current point. Value of other point will not be changed. + */ + public Point3D clone(final Point3D otherPoint) { + x = otherPoint.x; + y = otherPoint.y; + z = otherPoint.z; return this; } + /** + * Set current point coordinates to the middle point between two other points. + * + * @param p1 first point. + * @param p2 second point. + * @return current point. + */ public Point3D computeMiddlePoint(final Point3D p1, final Point3D p2) { x = (p1.x + p2.x) / 2d; y = (p1.y + p2.y) / 2d; @@ -71,6 +100,9 @@ public class Point3D implements Cloneable { return this; } + /** + * @return true if current point coordinates are equal to zero. + */ public boolean isZero() { return (x == 0) && (y == 0) && (z == 0); } @@ -89,6 +121,9 @@ public class Point3D implements Cloneable { /** * Compute distance to another point. + * + * @param anotherPoint point to compute distance to. + * @return distance to another point. */ public double getDistanceTo(final Point3D anotherPoint) { final double xDelta = x - anotherPoint.x; @@ -98,10 +133,18 @@ public class Point3D implements Cloneable { return sqrt(((xDelta * xDelta) + (yDelta * yDelta) + (zDelta * zDelta))); } + /** + * @return length of current vector. + */ public double getVectorLength() { return sqrt(((x * x) + (y * y) + (z * z))); } + /** + * Invert current point coordinates. + * + * @return current point. + */ public Point3D invert() { x = -x; y = -y; @@ -109,7 +152,16 @@ public class Point3D implements Cloneable { return this; } - public void rotate(final Point3D center, final double angleXZ, + /** + * Rotate current point around center point by angleXZ and angleYZ. + *

+ * See also: Let's remove Quaternions from every 3D Engine + * + * @param center center point. + * @param angleXZ angle around XZ axis. + * @param angleYZ angle around YZ axis. + */ + public Point3D rotate(final Point3D center, final double angleXZ, final double angleYZ) { final double s1 = sin(angleXZ); final double c1 = cos(angleXZ); @@ -130,14 +182,30 @@ public class Point3D implements Cloneable { x = x1 + center.x; y = y1 + center.y; z = z2 + center.z; + + return this; } + public Point3D rotate(final double angleXZ, final double angleYZ) { + return rotate(new Point3D(0, 0, 0), angleXZ, angleYZ); + } + + /** + * Round current point coordinates to integer values. + */ public void roundToInteger() { x = (int) x; y = (int) y; z = (int) z; } + /** + * Scale down current point by factor. + * All coordinates will be divided by factor. + * + * @param factor factor to scale by. + * @return current point. + */ public Point3D scaleDown(final double factor) { x /= factor; y /= factor; @@ -145,6 +213,13 @@ public class Point3D implements Cloneable { return this; } + /** + * Scale up current point by factor. + * All coordinates will be multiplied by factor. + * + * @param factor factor to scale by. + * @return current point. + */ public Point3D scaleUp(final double factor) { x *= factor; y *= factor; @@ -152,16 +227,27 @@ public class Point3D implements Cloneable { return this; } + /** + * Set current point coordinates to given values. + * @param x X coordinate. + * @param y Y coordinate. + * @param z Z coordinate. + */ public void setValues(final double x, final double y, final double z) { this.x = x; this.y = y; this.z = z; } - public Point3D subtract(final Point3D direction) { - x -= direction.x; - y -= direction.y; - z -= direction.z; + /** + * Subtract other point from current point. Value of other point will not be changed. + * + * @return current point. + */ + public Point3D subtract(final Point3D otherPoint) { + x -= otherPoint.x; + y -= otherPoint.y; + z -= otherPoint.z; return this; } @@ -170,33 +256,51 @@ public class Point3D implements Cloneable { return "x:" + x + " y:" + y + " z:" + z; } + /** + * Translate current point along X axis by given increment. + * + * @return current point. + */ public Point3D translateX(final double xIncrement) { x += xIncrement; return this; } + /** + * Translate current point along Y axis by given increment. + * + * @return current point. + */ public Point3D translateY(final double yIncrement) { y += yIncrement; return this; } + /** + * Translate current point along Z axis by given increment. + * + * @return current point. + */ public Point3D translateZ(final double zIncrement) { z += zIncrement; return this; } + /** + * Here we assume that Z coordinate is distance to the viewer. + * If Z is positive, then point is in front of the viewer, and therefore it is visible. + * + * @return point visibility status. + */ public boolean isVisible() { - - if (z > 0) - return true; - - // if ((z > 0) && (x > -1000) && (y > -1000) && (x < 2000) && (y < - // 2000)) - // return true; - - return false; + return z > 0; } + /** + * Resets point coordinates to zero along all axes. + * + * @return current point. + */ public Point3D zero() { x = 0; y = 0;