X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Feu%2Fsvjatoslav%2Fsixth%2Fe3d%2Fmath%2FTransform.java;h=85a2ddaf4a38560dd69cde77e23fb84bd80f1750;hb=99cc27235b226ba7a6d94bc3c8308601f611daad;hp=48bf284b0de58d1f3234d206c0595278ce5f901e;hpb=a40c9c2a3ef372ea0f2c87af644ca2302315baca;p=sixth-3d.git

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..85a2dda 100755
--- a/src/main/java/eu/svjatoslav/sixth/e3d/math/Transform.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/math/Transform.java
@@ -1,11 +1,15 @@
 /*
- * Sixth 3D engine. Author: Svjatoslav Agejenko. 
+ * 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;
@@ -16,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) {
 
@@ -28,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;