OSDN Git Service

[non-technical] committed documentation fixes for com.jme.scene.shape package as...
authorskye.book <skye.book@75d07b2b-3a1a-0410-a2c5-0572b91ccdca>
Sat, 29 Aug 2009 00:34:05 +0000 (00:34 +0000)
committerskye.book <skye.book@75d07b2b-3a1a-0410-a2c5-0572b91ccdca>
Sat, 29 Aug 2009 00:34:05 +0000 (00:34 +0000)
git-svn-id: http://jmonkeyengine.googlecode.com/svn/trunk@4639 75d07b2b-3a1a-0410-a2c5-0572b91ccdca

src/com/jme/input/action/InputAction.java
src/com/jme/scene/lod/AreaClodMesh.java
src/com/jme/scene/shadow/MeshShadows.java
src/com/jme/scene/shape/Dodecahedron.java
src/com/jme/scene/shape/Dome.java
src/com/jme/scene/shape/Octahedron.java
src/com/jme/scene/shape/OrientedBox.java
src/com/jme/scene/shape/Sphere.java
src/com/jme/scene/shape/Teapot.java
src/com/jme/scene/shape/Torus.java
src/com/jme/scene/shape/Tube.java

index 93c88a4..d1b9087 100644 (file)
@@ -33,7 +33,7 @@
 package com.jme.input.action;
 
 /**
- * An <code>InputAction</code> can be subscribed at an {@link com.jme.input.InputHandler} to get its
+ * An <code>InputAction</code> can be subscribed as an {@link com.jme.input.InputHandler} to get its
  * {@link InputActionInterface#performAction(InputActionEvent)} method called on specific event triggers.
  * It also defines an interface that sets the criteria for
  * input actions, e.g. the speed of the action.
index 4006786..99500bd 100644 (file)
@@ -51,7 +51,7 @@ import com.jme.util.export.OutputCapsule;
  * modifications and enhancements made from there.<br>
  * <br>
  * This class is an automatically updating ClodMesh that updates records
- * acording to how much area the bounding volume takes up on the screen. Use it
+ * according to how much area the bounding volume takes up on the screen. Use it
  * just like a normal ClodMesh, but allow it to update itself.
  * 
  * @author Joshua Slack
@@ -78,7 +78,7 @@ public class AreaClodMesh extends ClodMesh {
 
        /**
         * Creates a new AreaClodMesh with the given name.  This should only be used if
-        * the users is going to call reconstruct and create on the clod mesh.
+        * the user is going to call reconstruct and create on the clod mesh.
         * @param name The mesh's name.
         * @see #reconstruct(com.jme.math.Vector3f[], com.jme.math.Vector3f[], com.jme.renderer.ColorRGBA[], com.jme.math.Vector2f[], int[])
         * @see #create(com.jme.scene.lod.CollapseRecord[])
@@ -88,7 +88,7 @@ public class AreaClodMesh extends ClodMesh {
        }
 
        /**
-        * Creates a clod mesh that mimics the given TriMesh's geometry information.  More specificly,
+        * Creates a clod mesh that mimics the given TriMesh's geometry information.  More specifically,
         * RenderState and Controller information is <b>not</b> absorbed by this AreaClodMesh.  A null
         * for records causes the AreaClodMesh to generate its own records information.
         * @param name The name of this new mesh.
@@ -123,7 +123,7 @@ public class AreaClodMesh extends ClodMesh {
 
        /**
         * This function is used during rendering to choose the correct target record for the
-        * AreaClodMesh acording to the information in the renderer.  This should not be called
+        * AreaClodMesh according to the information in the renderer.  This should not be called
         * manually.  Instead, allow it to be called automatically during rendering.
         * @param r The Renderer to use.
         * @return the target record this AreaClodMesh will use to collapse vertexes.
index 84348be..5cdd10a 100644 (file)
@@ -110,7 +110,7 @@ public class MeshShadows {
      * <code>createGeometry</code> creates or updates the ShadowVolume
      * geometries for the target TriMesh - one for each applicable Light in the
      * given LightState. Only Directional and Point lights are currently
-     * supported. ShadowVolume geometry is only regen'd when light or occluder
+     * supported. ShadowVolume geometry is only regenerated when light or occluder
      * aspects change.
      * 
      * @param lightState
index 601339b..14efaf2 100644 (file)
@@ -63,7 +63,6 @@ public class Dodecahedron extends RegularPolyhedron {
     public Dodecahedron() {}
 
     /**
-     * Creates an Dodecahedron (think of 12-sided dice) with center at the
      * origin. The length of the sides will be as specified in sideLength.
      * 
      * @param name
index 06b97ef..579c449 100644 (file)
@@ -79,7 +79,7 @@ public class Dome extends TriMesh {
     public Dome() {}
 
     /**
-     * Constructs a dome. By default the dome has not geometry data or center.
+     * Constructs a dome. By default the dome has no geometry data or center.
      * 
      * @param name
      *            The name of the dome.
@@ -89,7 +89,7 @@ public class Dome extends TriMesh {
     }
 
     /**
-     * Constructs a dome with center at the origin. For details, see the other
+     * Constructs a dome with it's center at the origin. For details, see the other
      * constructor.
      * 
      * @param name
@@ -171,7 +171,8 @@ public class Dome extends TriMesh {
     }
 
     /**
-     * Are the triangles connected in such a way as to present aview out from the dome or not.
+     * Are the triangles connected in such a way as to present a view out from the
+     * dome or not.
      * 
      * @return
      */
index 3e801cd..acecdee 100644 (file)
@@ -66,8 +66,8 @@ public class Octahedron extends RegularPolyhedron {
     }
 
     /**
-     * Creates an octahedron with center at the origin. The lenght sides are
-     * given.
+     * Creates an octahedron with center at the origin. The length of the
+     * sides are given.
      * 
      * @param name
      *            The name of the octahedron.
index 949daab..8199def 100644 (file)
@@ -48,7 +48,7 @@ import com.jme.util.geom.BufferUtils;
 /**
  * Started Date: Aug 22, 2004 <br>
  * <br>
- * This primitive represents a box that has options to orient it acording to its
+ * This primitive represents a box that has options to orient it according to its
  * X/Y/Z axis. It is used to create an OrientedBoundingBox mostly.
  * 
  * @author Jack Lindamood
@@ -74,10 +74,10 @@ public class OrientedBox extends TriMesh {
     /** Extents of the box along the x,y,z axis. */
     protected Vector3f extent = new Vector3f(0, 0, 0);
 
-    /** Texture coordintae values for the corners of the box. */
+    /** Texture coordinate values for the corners of the box. */
     protected Vector2f texTopRight, texTopLeft, texBotRight, texBotLeft;
 
-    /** Vector array used to store the array of 8 corners the box has. */
+    /** Vector array used to store the array of the 8 corners the box has. */
     public Vector3f[] vectorStore;
 
     /** X axis of the Oriented Box. */
index bfd457b..11a1d28 100644 (file)
@@ -45,7 +45,7 @@ import com.jme.util.export.OutputCapsule;
 import com.jme.util.geom.BufferUtils;
 
 /**
- * <code>Sphere</code> represents a 3D object with all points equidistance
+ * <code>Sphere</code> represents a 3D object with all points equidistant
  * from a center point.
  * 
  * @author Joshua Slack
@@ -65,7 +65,7 @@ public class Sphere extends TriMesh {
     public enum TextureMode {
         /** Wrap texture radially and along z-axis */
         Original,
-        /** Wrap texure radially, but spherically project along z-axis */
+        /** Wrap texture radially, but spherically project along z-axis */
         Projected,
         /** Apply texture to each pole.  Eliminates polar distortion,
          * but mirrors the texture across the equator 
@@ -96,7 +96,7 @@ public class Sphere extends TriMesh {
     }
 
     /**
-     * Constructs a sphere. By default the Sphere has not geometry data or
+     * Constructs a sphere. By default the Sphere has no geometry data or
      * center.
      * 
      * @param name
@@ -146,7 +146,8 @@ public class Sphere extends TriMesh {
     }
 
     /**
-     * Constructs a sphere. Additional arg to evenly space latitudinal slices
+     * Constructs a sphere. Additional arguments to evenly space
+     * latitudinal slices
      * 
      * @param name
      *            Name of the sphere.
index 0f005d9..14fa15b 100644 (file)
@@ -50,7 +50,7 @@ public class Teapot extends TriMesh implements Savable {
 
     /**
      * Instantiates a new <code>Teapot</code> object. All information must be
-     * applies later. For internal usage only
+     * applied later. For internal usage only
      */
     public Teapot() {
         super("teapot");
index 6df8962..7b44bc6 100644 (file)
@@ -45,7 +45,8 @@ import com.jme.util.export.OutputCapsule;
 import com.jme.util.geom.BufferUtils;
 
 /**
- * An ordinary (single holed) torus.
+ * An ordinary (single holed) torus.  Similar
+ * in shape to a donut.
  * <p>
  * The center is by default the origin.
  * 
index 1422786..2057c19 100644 (file)
@@ -45,7 +45,8 @@ import com.jme.util.export.Savable;
 import com.jme.util.geom.BufferUtils;
 
 /**
- * 
+ * A hollow cylindrical shape (the cylinder wall can have
+ * width).
  * @author Landei
  */
 public class Tube extends TriMesh implements Savable {