projects
/
sixth-3d.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Improved JavaDoc.
[sixth-3d.git]
/
src
/
main
/
java
/
eu
/
svjatoslav
/
sixth
/
e3d
/
geometry
/
Point3D.java
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
54fbd35
..
e2c9868
100755
(executable)
--- a/
src/main/java/eu/svjatoslav/sixth/e3d/geometry/Point3D.java
+++ b/
src/main/java/eu/svjatoslav/sixth/e3d/geometry/Point3D.java
@@
-35,16
+35,24
@@
public class Point3D implements Cloneable {
this.z = z;
}
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.
+ *
+ * @return current point.
+ */
+ public Point3D add(final Point3D otherPoint) {
+ x += otherPoint.x;
+ y += otherPoint.y;
+ z += otherPoint.z;
return this;
}
return this;
}
@@
-52,10
+60,10
@@
public class Point3D implements Cloneable {
return new Point3D(this);
}
return new Point3D(this);
}
- public Point3D clone(final Point3D
source
) {
- x =
source
.x;
- y =
source
.y;
- z =
source
.z;
+ public Point3D clone(final Point3D
parent
) {
+ x =
parent
.x;
+ y =
parent
.y;
+ z =
parent
.z;
return this;
}
return this;
}
@@
-153,10
+161,15
@@
public class Point3D implements Cloneable {
this.z = z;
}
this.z = z;
}
- public Point3D subtract(final Point3D direction) {
- x -= direction.x;
- y -= direction.y;
- z -= direction.z;
+ /**
+ * Subtract other point from current point.
+ *
+ * @return current point.
+ */
+ public Point3D subtract(final Point3D otherPoint) {
+ x -= otherPoint.x;
+ y -= otherPoint.y;
+ z -= otherPoint.z;
return this;
}
return this;
}
@@
-165,33
+178,45
@@
public class Point3D implements Cloneable {
return "x:" + x + " y:" + y + " z:" + z;
}
return "x:" + x + " y:" + y + " z:" + z;
}
+ /**
+ * @return current point.
+ */
public Point3D translateX(final double xIncrement) {
x += xIncrement;
return this;
}
public Point3D translateX(final double xIncrement) {
x += xIncrement;
return this;
}
+ /**
+ * @return current point.
+ */
public Point3D translateY(final double yIncrement) {
y += yIncrement;
return this;
}
public Point3D translateY(final double yIncrement) {
y += yIncrement;
return this;
}
+ /**
+ * @return current point.
+ */
public Point3D translateZ(final double zIncrement) {
z += zIncrement;
return this;
}
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() {
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 to 0 coordinate in X, Y and Z axis.
+ *
+ * @return current point.
+ */
public Point3D zero() {
x = 0;
y = 0;
public Point3D zero() {
x = 0;
y = 0;