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 68eeae5..85a2dda 100755 (executable)
--- a/src/main/java/eu/svjatoslav/sixth/e3d/math/Transform.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/math/Transform.java
@@ -1,16 +1,15 @@
 /*
- * Sixth 3D engine. Copyright ©2012-2019, 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.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;
@@ -21,11 +20,23 @@ 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) {
 
@@ -33,6 +44,12 @@ 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;