Updated readability of the code.

[sixth-3d.git] / src / main / java / eu / svjatoslav / sixth / e3d / math / Transform.java

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/math/Transform.java b/src/main/java/eu/svjatoslav/sixth/e3d/math/Transform.java
index 48bf284..f7f64db 100755 (executable)
--- a/src/main/java/eu/svjatoslav/sixth/e3d/math/Transform.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/math/Transform.java
@@ -6,6 +6,10 @@ package eu.svjatoslav.sixth.e3d.math;
 
 import eu.svjatoslav.sixth.e3d.geometry.Point3D;
 
+/**
+ * Used to represent transformation in a 3D space.
+ * Transformations are represented as a translation and an orientation.
+ */
 public class Transform implements Cloneable {
 
     private final Point3D translation;
@@ -16,11 +20,27 @@ public class Transform implements Cloneable {
         orientation = new Orientation();
     }
 
+    /**
+     * Creates a new transform with the specified translation.
+     *
+     * @param translation
+     *            the translation
+     */
     public Transform(final Point3D translation) {
         this.translation = translation;
         orientation = new Orientation();
     }
 
+    /**
+     * Creates a new transform with the specified translation and orientation.
+     *
+     * @param translation
+     *            the translation
+     * @param angleXZ
+     *            the angle around the XZ axis
+     * @param angleYZ
+     *            the angle around the YZ axis
+     */
     public Transform(final Point3D translation, final double angleXZ,
                      final double angleYZ) {
 
@@ -28,6 +48,14 @@ public class Transform implements Cloneable {
         orientation = new Orientation(angleXZ, angleYZ);
     }
 
+    /**
+     * Creates a new transform with the specified translation and orientation.
+     *
+     * @param translation
+     *            the translation
+     * @param orientation
+     *            the orientation
+     */
     public Transform(final Point3D translation, final Orientation orientation) {
         this.translation = translation;
         this.orientation = orientation;