Updated readability of the code.

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

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/math/Orientation.java b/src/main/java/eu/svjatoslav/sixth/e3d/math/Orientation.java
index 0a2bf0c..9cc6dcd 100644 (file)
--- a/src/main/java/eu/svjatoslav/sixth/e3d/math/Orientation.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/math/Orientation.java
@@ -1,20 +1,27 @@
 /*
- * 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.
+ */
 public class Orientation implements Cloneable {
 
+
     private double s1, c1, s2, c2;
 
+    /**
+     * The angle of rotation around the XZ axis.
+     */
     private double angleXZ = 0;
+
+    /**
+     * The angle of rotation around the YZ axis.
+     */
     private double angleYZ = 0;
 
     public Orientation() {
@@ -32,6 +39,9 @@ public class Orientation implements Cloneable {
         return new Orientation(angleXZ, angleYZ);
     }
 
+    /**
+     * Computes the sine and cosine of the angles.
+     */
     private void computeMultipliers() {
         s1 = Math.sin(angleXZ);
         c1 = Math.cos(angleXZ);