aboutsummaryrefslogtreecommitdiff
path: root/engine/src/core/com/jme3/math/package.html
diff options
context:
space:
mode:
Diffstat (limited to 'engine/src/core/com/jme3/math/package.html')
-rw-r--r--engine/src/core/com/jme3/math/package.html53
1 files changed, 53 insertions, 0 deletions
diff --git a/engine/src/core/com/jme3/math/package.html b/engine/src/core/com/jme3/math/package.html
new file mode 100644
index 0000000..64da8aa
--- /dev/null
+++ b/engine/src/core/com/jme3/math/package.html
@@ -0,0 +1,53 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+
+<head>
+<title></title>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+<body>
+
+The <code>com.jme3.math</code> package provides mathematic data structures
+and utilities which are used by the rest of the engine.
+The math package provides the following classes:<br>
+<h3>General purpose vectors</h3>
+<ul>
+ <li>{@link com.jme3.math.Vector2f} - 2D general purpose vector</li>
+ <li>{@link com.jme3.math.Vector3f} - 3D general purpose vector</li>
+ <li>{@link com.jme3.math.Vector4f} - 4D general purpose vector</li>
+</ul>
+<h3>Special purpose vectors</h3>
+<ul>
+ <li>{@link com.jme3.math.ColorRGBA} - Floating-point RGB color with alpha</li>
+ <li>{@link com.jme3.math.Quaternion} - Specialized 4D data structure to represent rotation</li>
+</ul>
+<h3>Matrices</h3>
+<ul>
+ <li>{@link com.jme3.math.Matrix3f} - 3x3 matrix, usually used to represent rotation</li>
+ <li>{@link com.jme3.math.Matrix4f} - 4x4 matrix, used as an efficient transform representation</li>
+</ul>
+<h3>Shapes</h3>
+<ul>
+ <li>{@link com.jme3.math.AbstractTriangle} - Abstract triangle. Data to be provided by implementation</li>
+ <li>{@link com.jme3.math.Triangle} - Concrete implementation of AbstractTriangle with center and normal vectors</li>
+ <li>{@link com.jme3.math.Line} - Infinite 3D line</li>
+ <li>{@link com.jme3.math.LineSegment} - 3D line with start and end point</li>
+ <li>{@link com.jme3.math.Plane} - 3D plane</li>
+ <li>{@link com.jme3.math.Ray} - 3D ray</li>
+ <li>{@link com.jme3.math.Rectangle} - 3D rectangle</li>
+ <li>{@link com.jme3.math.Ring} - 3D ring</li>
+</ul>
+<h3>Curves</h3>
+<ul>
+ <li>{@link com.jme3.math.Spline} - 3D curve defined by control points and a function</li>
+</ul>
+<h3>Utility classes</h3>
+<ul>
+ <li>{@link com.jme3.math.Transform} - Representation of a transform with translation, rotation, and scale</li>
+ <li>{@link com.jme3.math.FastMath} - Contains static methods for floating-point math</li>
+ <li>{@link com.jme3.math.CurveAndSurfaceMath} - Contains static methods specific to curve and surface math</li>
+ <li>{@link com.jme3.math.Eigen3f} - Provides computation of eigenvectors given a matrix</li>
+</ul>
+
+</body>
+</html>