diff options
| author | Julien Gouesse <[email protected]> | 2019-06-14 18:53:05 +0200 |
|---|---|---|
| committer | Julien Gouesse <[email protected]> | 2019-06-14 18:53:05 +0200 |
| commit | 0c004991f138849cfbeac48fcb6b240f6785a86e (patch) | |
| tree | 256879ca0b14734e9a60eab5a86ff8bb0863fe1a /ardor3d-core/src | |
| parent | 84bf6ce230382e5df8fffc95122ed0427ebc7d4d (diff) | |
Fixes some errors in the Java documentation of ardor3d-core
Diffstat (limited to 'ardor3d-core/src')
29 files changed, 320 insertions, 257 deletions
diff --git a/ardor3d-core/src/main/java/com/ardor3d/bounding/BoundingBox.java b/ardor3d-core/src/main/java/com/ardor3d/bounding/BoundingBox.java index 2ad7d96..1505a51 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/bounding/BoundingBox.java +++ b/ardor3d-core/src/main/java/com/ardor3d/bounding/BoundingBox.java @@ -46,7 +46,8 @@ public class BoundingBox extends BoundingVolume { /** * Default constructor instantiates a new <code>BoundingBox</code> object. */ - public BoundingBox() {} + public BoundingBox() { + } /** * Constructor instantiates a new <code>BoundingBox</code> object with given values. @@ -621,8 +622,8 @@ public class BoundingBox extends BoundingVolume { } /** - * <code>toString</code> returns the string representation of this object. The form is: - * "Radius: RRR.SSSS Center: <Vector>". + * <code>toString</code> returns the string representation of this object. The form is: "Radius: RRR.SSSS Center: + * <Vector>". * * @return the string representation of this. */ @@ -826,7 +827,7 @@ public class BoundingBox extends BoundingVolume { * An optional store. Must be at least length of 8. If null, one will be created for you. * @return array filled with our corners. * @throws ArrayIndexOutOfBoundsException - * if our store is length < 8. + * if our store is length < 8. */ public Vector3[] getCorners(Vector3[] store) { if (store == null) { diff --git a/ardor3d-core/src/main/java/com/ardor3d/bounding/BoundingSphere.java b/ardor3d-core/src/main/java/com/ardor3d/bounding/BoundingSphere.java index 1f8b3e9..cc01b30 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/bounding/BoundingSphere.java +++ b/ardor3d-core/src/main/java/com/ardor3d/bounding/BoundingSphere.java @@ -52,7 +52,8 @@ public class BoundingSphere extends BoundingVolume { /** * Default constructor instantiates a new <code>BoundingSphere</code> object. */ - public BoundingSphere() {} + public BoundingSphere() { + } /** * Constructor instantiates a new <code>BoundingSphere</code> object. diff --git a/ardor3d-core/src/main/java/com/ardor3d/image/util/ImageLoader.java b/ardor3d-core/src/main/java/com/ardor3d/image/util/ImageLoader.java index e179341..bdc56e4 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/image/util/ImageLoader.java +++ b/ardor3d-core/src/main/java/com/ardor3d/image/util/ImageLoader.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -18,17 +18,19 @@ import com.ardor3d.image.Image; /** * Interface for image loaders. Implementing classes can be registered with the TextureManager to decode image formats * with a certain file extension. - * + * * @see com.ardor3d.util.TextureManager#addHandler(String, ImageLoader) - * + * */ public interface ImageLoader { /** * Decodes image data from an InputStream. - * + * * @param is * The InputStream to create the image from. The inputstream should be closed before this method returns. + * @param flipped + * <code>true</code> if the image is vertically flipped * @return The decoded Image. * @throws IOException */ diff --git a/ardor3d-core/src/main/java/com/ardor3d/input/MouseState.java b/ardor3d-core/src/main/java/com/ardor3d/input/MouseState.java index e6c90eb..8296fb3 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/input/MouseState.java +++ b/ardor3d-core/src/main/java/com/ardor3d/input/MouseState.java @@ -213,7 +213,7 @@ public class MouseState { /** * Returns the click count of a mouse button as of this frame. Click counts are non-zero only for frames when the * mouse button is released. A double-click sequence, for instance, could show up like this: - * <nl> + * <ul> * <li>Frame 1, mouse button pressed - click count == 0</li> * <li>Frame 2, mouse button down - click count == 0</li> * <li>Frame 3, mouse button released - click count == 1</li> @@ -221,7 +221,7 @@ public class MouseState { * <li>Frame 5, mouse button pressed - click count == 0</li> * <li>Frame 6, mouse button down - click count == 0</li> * <li>Frame 7, mouse button released - click count == 2</li> - * </nl> + * </ul> * * Whether or not a mouse press/release sequence counts as a click (or double-click) depends on the time passed * between them. See {@link #CLICK_TIME_MS}. diff --git a/ardor3d-core/src/main/java/com/ardor3d/input/logical/TriggerAction.java b/ardor3d-core/src/main/java/com/ardor3d/input/logical/TriggerAction.java index 407aa41..6520815 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/input/logical/TriggerAction.java +++ b/ardor3d-core/src/main/java/com/ardor3d/input/logical/TriggerAction.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -20,10 +20,10 @@ public interface TriggerAction { /** * Implementing classes should implementing this method to take whatever action is desired. This method will always * be called on the main GL thread. - * + * * @param source * the Canvas that was the source of the current input - * @param inputState + * @param inputStates * the current and previous states of the input system when the action was triggered * @param tpf * the time per frame in seconds diff --git a/ardor3d-core/src/main/java/com/ardor3d/intersection/BoundingCollisionResults.java b/ardor3d-core/src/main/java/com/ardor3d/intersection/BoundingCollisionResults.java index f9b73ba..d193ffa 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/intersection/BoundingCollisionResults.java +++ b/ardor3d-core/src/main/java/com/ardor3d/intersection/BoundingCollisionResults.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -23,9 +23,6 @@ public class BoundingCollisionResults extends CollisionResults { /** * adds a CollisionData object to this results list, the objects only refer to the collision meshes, not the * triangles. - * - * @see com.ardor3d.intersection.CollisionResults#addCollision(com.ardor3d.scene.Geometry, - * com.ardor3d.scene.Geometry) */ @Override public void addCollision(final Mesh s, final Mesh t) { @@ -35,8 +32,6 @@ public class BoundingCollisionResults extends CollisionResults { /** * empty implementation, it is highly recommended that you override this method to handle any collisions as needed. - * - * @see com.ardor3d.intersection.CollisionResults#processCollisions() */ @Override public void processCollisions() { diff --git a/ardor3d-core/src/main/java/com/ardor3d/intersection/IntersectionRecord.java b/ardor3d-core/src/main/java/com/ardor3d/intersection/IntersectionRecord.java index 11e1360..93ffe00 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/intersection/IntersectionRecord.java +++ b/ardor3d-core/src/main/java/com/ardor3d/intersection/IntersectionRecord.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -44,7 +44,7 @@ public class IntersectionRecord { /** * Instantiates a new IntersectionRecord defining the distances and points. - * + * * @param distances * the distances of this intersection. * @param points @@ -58,7 +58,7 @@ public class IntersectionRecord { /** * Instantiates a new IntersectionRecord defining the distances and points. - * + * * @param distances * the distances of this intersection. * @param points @@ -75,12 +75,12 @@ public class IntersectionRecord { /** * Instantiates a new IntersectionRecord defining the distances and points. - * + * * @param distances * the distances of this intersection. * @param points * the points of this intersection. - * @param points + * @param normals * the normals of this intersection. * @param primitives * the primitives at each index. May be null. @@ -121,7 +121,7 @@ public class IntersectionRecord { /** * Returns an intersection point at a provided index. - * + * * @param index * the index of the point to obtain. * @return the point at the index of the array. @@ -132,7 +132,7 @@ public class IntersectionRecord { /** * Returns an intersection normal at a provided index. - * + * * @param index * the index of the point to obtain. * @return the normal at the index of the array. @@ -143,7 +143,7 @@ public class IntersectionRecord { /** * Returns an intersection distance at a provided index. - * + * * @param index * the index of the distance to obtain. * @return the distance at the index of the array. diff --git a/ardor3d-core/src/main/java/com/ardor3d/intersection/PickData.java b/ardor3d-core/src/main/java/com/ardor3d/intersection/PickData.java index f250dd3..c1302f6 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/intersection/PickData.java +++ b/ardor3d-core/src/main/java/com/ardor3d/intersection/PickData.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -25,6 +25,13 @@ public class PickData { /** * instantiates a new PickData object. Note: subclasses may want to make calc points false to prevent this extra * work. + * + * @param ray + * the ray + * @param target + * the target + * @param calcPoints + * <code>true</code> if the intersection points must be computed now */ public PickData(final Ray3 ray, final Pickable target, final boolean calcPoints) { _ray = ray; diff --git a/ardor3d-core/src/main/java/com/ardor3d/intersection/PickingUtil.java b/ardor3d-core/src/main/java/com/ardor3d/intersection/PickingUtil.java index d657eeb..e73b843 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/intersection/PickingUtil.java +++ b/ardor3d-core/src/main/java/com/ardor3d/intersection/PickingUtil.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -26,12 +26,15 @@ public abstract class PickingUtil { /** * Finds a pick using the given ray starting at the scenegraph given as spatial. Results are stored in the given * results value. - * + * * NB: Spatials with CullHint ALWAYS will be skipped. - * + * * @param spatial + * the spatial * @param ray + * the ray * @param results + * the results */ public static void findPick(final Spatial spatial, final Ray3 ray, final PickResults results) { findPick(spatial, ray, results, true); @@ -40,10 +43,13 @@ public abstract class PickingUtil { /** * Finds a pick using the given ray starting at the scenegraph given as spatial. Results are stored in the given * results value. - * + * * @param spatial + * the spatial * @param ray + * the ray * @param results + * the results * @param ignoreCulled * if true, Spatials with CullHint ALWAYS will be skipped. */ @@ -100,10 +106,12 @@ public abstract class PickingUtil { /** * This function checks for intersection between this mesh and the given one. On the first intersection, true is * returned. - * + * + * @param testMesh + * The mesh * @param toCheck * The intersection testing mesh. - * @return True if they intersect. + * @return true if they intersect. */ public static boolean hasPrimitiveCollision(final Mesh testMesh, final Mesh toCheck) { if (!testMesh.getSceneHints().isPickingHintEnabled(PickingHint.Collidable) @@ -127,6 +135,8 @@ public abstract class PickingUtil { * This function finds all intersections between this mesh and the checking one. The intersections are stored as * PrimitiveKeys. * + * @param testMesh + * The mesh * @param toCheck * The Mesh to check. * @param testIndex diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/Camera.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/Camera.java index a70212b..5951a65 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/renderer/Camera.java +++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/Camera.java @@ -529,8 +529,12 @@ public class Camera implements Savable, Externalizable { } /** - * @param location - * the new location or position of the camera. + * @param x + * the new x location or position of the camera. + * @param y + * the new y location or position of the camera. + * @param z + * the new z location or position of the camera. */ public void setLocation(final double x, final double y, final double z) { _location.set(x, y, z); diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/queue/RenderBucketType.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/queue/RenderBucketType.java index a5547dd..270d7a4 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/renderer/queue/RenderBucketType.java +++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/queue/RenderBucketType.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -23,7 +23,7 @@ public final class RenderBucketType { RenderBucketType bucketType = bucketTypeMap.get(name); if (bucketType == null) { bucketType = new RenderBucketType(name); - bucketTypeMap.put(name, bucketType); + bucketTypeMap.put(name, bucketType); } return bucketType; } @@ -67,9 +67,9 @@ public final class RenderBucketType { /** * Used for surfaces that are partially transparent or translucent - can be seen through. Drawn from back to front. - * See also the flag {@link com.ardor3d.renderer.queue.TransparentRenderBucket#setTwoPassTransparency(boolean) - * TransparentRenderBucket.setTwoPassTransparency(boolean)} allowing you to enable two pass transparency for more - * accurate results. + * See also the flag {@link com.ardor3d.scenegraph.hint.TransparencyType#TwoPass} and + * {@link com.ardor3d.scenegraph.hint.SceneHints#setTransparencyType(com.ardor3d.scenegraph.hint.TransparencyType)} + * allowing you to enable two pass transparency for more accurate results. */ public static final RenderBucketType Transparent = getRenderBucketType("Transparent"); diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/state/GLSLShaderDataLogic.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/state/GLSLShaderDataLogic.java index e514e63..6d6bf76 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/renderer/state/GLSLShaderDataLogic.java +++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/state/GLSLShaderDataLogic.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -19,11 +19,11 @@ import com.ardor3d.scenegraph.Mesh; public interface GLSLShaderDataLogic { /** * Responsible for transferring data from a Mesh object to a shader before rendering - * + * * @param shader * Shader to update with new data(setUniform/setAttribute) - * @param meshData - * MeshData to retrieve data from + * @param mesh + * Mesh to retrieve data from * @param renderer * Current renderer */ diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/state/GLSLShaderObjectsState.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/state/GLSLShaderObjectsState.java index d9ababd..fda1334 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/renderer/state/GLSLShaderObjectsState.java +++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/state/GLSLShaderObjectsState.java @@ -572,7 +572,8 @@ public class GLSLShaderObjectsState extends RenderState { /** * Retrieves a shader attribute by name. * - * @param uniformName + * @param attributeName + * the attribute name * @return */ public ShaderVariable getAttributeByName(final String attributeName) { @@ -587,7 +588,8 @@ public class GLSLShaderObjectsState extends RenderState { /** * - * @param meshData + * @param mesh + * the mesh */ public void setMesh(final Mesh mesh) { _mesh = mesh; @@ -1074,8 +1076,8 @@ public class GLSLShaderObjectsState extends RenderState { * * @param name * uniform variable to change - * @param value - * the new value + * @param values + * the new values * @param rowMajor * true if is this in row major order */ diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/state/StencilState.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/state/StencilState.java index 586243f..d3c9cde 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/renderer/state/StencilState.java +++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/state/StencilState.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -30,17 +30,17 @@ public class StencilState extends RenderState { public enum StencilFunction { /** A stencil function that never passes. */ Never, - /** A stencil function that passes if (ref & mask) < (stencil & mask). */ + /** A stencil function that passes if (ref & mask) < (stencil & mask). */ LessThan, - /** A stencil function that passes if (ref & mask) <= (stencil & mask). */ + /** A stencil function that passes if (ref & mask) <= (stencil & mask). */ LessThanOrEqualTo, - /** A stencil function that passes if (ref & mask) > (stencil & mask). */ + /** A stencil function that passes if (ref & mask) > (stencil & mask). */ GreaterThan, - /** A stencil function that passes if (ref & mask) >= (stencil & mask). */ + /** A stencil function that passes if (ref & mask) >= (stencil & mask). */ GreaterThanOrEqualTo, - /** A stencil function that passes if (ref & mask) == (stencil & mask). */ + /** A stencil function that passes if (ref & mask) == (stencil & mask). */ EqualTo, - /** A stencil function that passes if (ref & mask) != (stencil & mask). */ + /** A stencil function that passes if (ref & mask) != (stencil & mask). */ NotEqualTo, /** A stencil function that always passes. (Default) */ Always; @@ -112,7 +112,7 @@ public class StencilState extends RenderState { /** * Sets the function that defines if a stencil test passes or not for both faces. - * + * * @param function * The new stencil function for both faces. * @throws IllegalArgumentException @@ -125,7 +125,7 @@ public class StencilState extends RenderState { /** * Sets the stencil reference to be used during the stencil function for both faces. - * + * * @param reference * The new stencil reference for both faces. */ @@ -136,7 +136,7 @@ public class StencilState extends RenderState { /** * Convienence method for setting both types of stencil masks at once for both faces. - * + * * @param mask * The new stencil write and func mask for both faces. */ @@ -147,7 +147,7 @@ public class StencilState extends RenderState { /** * Controls which stencil bitplanes are written for both faces. - * + * * @param mask * The new stencil write mask for both faces. */ @@ -158,7 +158,7 @@ public class StencilState extends RenderState { /** * Sets the stencil mask to be used during stencil functions for both faces. - * + * * @param mask * The new stencil function mask for both faces. */ @@ -169,7 +169,7 @@ public class StencilState extends RenderState { /** * Specifies the aciton to take when the stencil test fails for both faces. - * + * * @param operation * The new stencil operation for both faces. * @throws IllegalArgumentException @@ -182,7 +182,7 @@ public class StencilState extends RenderState { /** * Specifies stencil action when the stencil test passes, but the depth test fails for both faces. - * + * * @param operation * The Z test operation to set for both faces. * @throws IllegalArgumentException @@ -196,7 +196,7 @@ public class StencilState extends RenderState { /** * Specifies stencil action when both the stencil test and the depth test pass, or when the stencil test passes and * either there is no depth buffer or depth testing is not enabled. - * + * * @param operation * The new Z test pass operation to set for both faces. * @throws IllegalArgumentException @@ -209,7 +209,7 @@ public class StencilState extends RenderState { /** * Sets the function that defines if a stencil test passes or not for front faces. - * + * * @param function * The new stencil function for front faces. * @throws IllegalArgumentException @@ -232,7 +232,7 @@ public class StencilState extends RenderState { /** * Sets the stencil reference to be used during the stencil function for front faces. - * + * * @param reference * The new stencil reference for front faces. */ @@ -250,7 +250,7 @@ public class StencilState extends RenderState { /** * Convienence method for setting both types of stencil masks at once for front faces. - * + * * @param mask * The new stencil write and func mask for front faces. */ @@ -261,7 +261,7 @@ public class StencilState extends RenderState { /** * Controls which stencil bitplanes are written for front faces. - * + * * @param mask * The new stencil write mask for front faces. */ @@ -279,7 +279,7 @@ public class StencilState extends RenderState { /** * Sets the stencil mask to be used during stencil functions for front faces. - * + * * @param mask * The new stencil function mask for front faces. */ @@ -297,7 +297,7 @@ public class StencilState extends RenderState { /** * Specifies the aciton to take when the stencil test fails for front faces. - * + * * @param operation * The new stencil operation for front faces. * @throws IllegalArgumentException @@ -320,7 +320,7 @@ public class StencilState extends RenderState { /** * Specifies stencil action when the stencil test passes, but the depth test fails for front faces. - * + * * @param operation * The Z test operation to set for front faces. * @throws IllegalArgumentException @@ -344,7 +344,7 @@ public class StencilState extends RenderState { /** * Specifies stencil action when both the stencil test and the depth test pass, or when the stencil test passes and * either there is no depth buffer or depth testing is not enabled. - * + * * @param operation * The new Z test pass operation to set for front faces. * @throws IllegalArgumentException @@ -367,7 +367,7 @@ public class StencilState extends RenderState { /** * Sets the function that defines if a stencil test passes or not for back faces. - * + * * @param function * The new stencil function for back faces. * @throws IllegalArgumentException @@ -390,7 +390,7 @@ public class StencilState extends RenderState { /** * Sets the stencil reference to be used during the stencil function for back faces. - * + * * @param reference * The new stencil reference for back faces. */ @@ -408,7 +408,7 @@ public class StencilState extends RenderState { /** * Convienence method for setting both types of stencil masks at once for back faces. - * + * * @param mask * The new stencil write and func mask for back faces. */ @@ -419,7 +419,7 @@ public class StencilState extends RenderState { /** * Controls which stencil bitplanes are written for back faces. - * + * * @param mask * The new stencil write mask for back faces. */ @@ -437,7 +437,7 @@ public class StencilState extends RenderState { /** * Sets the stencil mask to be used during stencil functions for back faces. - * + * * @param mask * The new stencil function mask for back faces. */ @@ -455,7 +455,7 @@ public class StencilState extends RenderState { /** * Specifies the aciton to take when the stencil test fails for back faces. - * + * * @param operation * The new stencil operation for back faces. * @throws IllegalArgumentException @@ -478,7 +478,7 @@ public class StencilState extends RenderState { /** * Specifies stencil action when the stencil test passes, but the depth test fails. - * + * * @param operation * The Z test operation to set for back faces. * @throws IllegalArgumentException @@ -502,7 +502,7 @@ public class StencilState extends RenderState { /** * Specifies stencil action when both the stencil test and the depth test pass, or when the stencil test passes and * either there is no depth buffer or depth testing is not enabled. - * + * * @param operation * The new Z test pass operation to set for back faces. * @throws IllegalArgumentException diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/FloatBufferData.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/FloatBufferData.java index a354372..2f6244b 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/FloatBufferData.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/FloatBufferData.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -30,7 +30,8 @@ public class FloatBufferData extends AbstractBufferData<FloatBuffer> implements /** * Instantiates a new FloatBufferData. */ - public FloatBufferData() {} + public FloatBufferData() { + } /** * Instantiates a new FloatBufferData with a buffer of the given size. @@ -41,11 +42,11 @@ public class FloatBufferData extends AbstractBufferData<FloatBuffer> implements /** * Creates a new FloatBufferData. - * + * * @param buffer * Buffer holding the data. Must not be null. * @param valuesPerTuple - * Specifies the number of values per tuple. Can not be < 1. + * Specifies the number of values per tuple. Can not be < 1. */ public FloatBufferData(final FloatBuffer buffer, final int valuesPerTuple) { if (buffer == null) { @@ -78,7 +79,7 @@ public class FloatBufferData extends AbstractBufferData<FloatBuffer> implements /** * Set number of values per tuple. This method should only be used internally. - * + * * @param valuesPerTuple * number of values per tuple */ @@ -88,7 +89,7 @@ public class FloatBufferData extends AbstractBufferData<FloatBuffer> implements /** * Scale the data in this buffer by the given value(s) - * + * * @param scales * the scale values to use. The Nth buffer element is scaled by the (N % scales.length) scales element. */ @@ -103,7 +104,7 @@ public class FloatBufferData extends AbstractBufferData<FloatBuffer> implements /** * Translate the data in this buffer by the given value(s) - * + * * @param translates * the translation values to use. The Nth buffer element is translated by the (N % translates.length) * translates element. diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/FloatBufferDataUtil.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/FloatBufferDataUtil.java index 25a74dd..7619c65 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/FloatBufferDataUtil.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/FloatBufferDataUtil.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -41,13 +41,17 @@ public class FloatBufferDataUtil { /** * Check an incoming TexCoords object for null and correct size. - * + * * @param tc + * the buffer data * @param vertexCount - * @param perVert + * the vertex count + * @param coordsPerVertex + * the number of coordinates per vertex * @return tc if it is not null and the right size, otherwise it will be a new TexCoords object. */ - public static FloatBufferData ensureSize(final FloatBufferData tc, final int vertexCount, final int coordsPerVertex) { + public static FloatBufferData ensureSize(final FloatBufferData tc, final int vertexCount, + final int coordsPerVertex) { if (tc == null) { return new FloatBufferData(BufferUtils.createFloatBuffer(vertexCount * coordsPerVertex), coordsPerVertex); } diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Extrusion.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Extrusion.java index ea6e3ee..4fbc73b 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Extrusion.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Extrusion.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -25,42 +25,34 @@ import com.ardor3d.util.geom.BufferUtils; /** * An extrusion of a 2D object ({@link Line}) along a path (List of Vector3). Either a convenience constructor can be - * used or the {@link #updateGeometry} method. It is also capable of doing a cubic spline interpolation for a list of - * supporting points + * used or the {@link #updateGeometry(Line, List, ReadOnlyVector3) updateGeometry} method. It is also capable of doing a + * cubic spline interpolation for a list of supporting points */ public class Extrusion extends Mesh { /** * Default Constructor. Creates an empty Extrusion. - * - * @see #updateGeometry(Line, List, Vector3) - * @see #updateGeometry(Line, List, boolean, Vector3) - * @see #updateGeometry(Line, List, int, Vector3) - * @see #updateGeometry(Line, List, int, boolean, Vector3) */ - public Extrusion() {} + public Extrusion() { + } /** * Creates an empty named Extrusion. - * + * * @param name * name - * @see #updateGeometry(Line, List, Vector3) - * @see #updateGeometry(Line, List, boolean, Vector3) - * @see #updateGeometry(Line, List, int, Vector3) - * @see #updateGeometry(Line, List, int, boolean, Vector3) */ public Extrusion(final String name) { super(name); } /** - * Convenience constructor. Calls {@link #updateGeometry(Line, List, Vector3)}. - * + * Convenience constructor. Calls {@link #updateGeometry(Line, List, ReadOnlyVector3) updateGeometry}. + * * @param shape - * see {@link #updateGeometry(Line, List, Vector3)} + * see {@link Extrusion#updateGeometry(Line, List, ReadOnlyVector3) updateGeometry} * @param path - * see {@link #updateGeometry(Line, List, Vector3)} + * see {@link Extrusion#updateGeometry(Line, List, ReadOnlyVector3) updateGeometry} * @param up * up vector */ @@ -69,14 +61,15 @@ public class Extrusion extends Mesh { } /** - * Convenience constructor. Sets the name and calls {@link #updateGeometry(Line, List, Vector3)}. - * + * Convenience constructor. Sets the name and calls {@link #updateGeometry(Line, List, ReadOnlyVector3) + * updateGeometry}. + * * @param name * name * @param shape - * see {@link #updateGeometry(Line, List, Vector3)} + * see {@link #updateGeometry(Line, List, ReadOnlyVector3) updateGeometry} * @param path - * see {@link #updateGeometry(Line, List, Vector3)} + * see {@link #updateGeometry(Line, List, ReadOnlyVector3) updateGeometry} * @param up * up vector */ @@ -87,7 +80,7 @@ public class Extrusion extends Mesh { /** * Update vertex, color, index and texture buffers (0) to contain an extrusion of shape along path. - * + * * @param shape * an instance of Line that describes the 2D shape * @param path @@ -101,7 +94,7 @@ public class Extrusion extends Mesh { /** * Update vertex, color, index and texture buffers (0) to contain an extrusion of shape along path. - * + * * @param shape * an instance of Line that describes the 2D shape * @param path @@ -226,8 +219,8 @@ public class Extrusion extends Mesh { /** * Performs cubic spline interpolation to find a path through the supporting points where the second derivative is - * zero. Then calls {@link #updateGeometry(Line, List, Vector3)} with this path. - * + * zero. Then calls {@link #updateGeometry(Line, List, ReadOnlyVector3)} with this path. + * * @param shape * an instance of Line that describes the 2D shape * @param points @@ -244,8 +237,8 @@ public class Extrusion extends Mesh { /** * Performs cubic spline interpolation to find a path through the supporting points where the second derivative is - * zero. Then calls {@link #updateGeometry(Line, List, boolean, Vector3)} with this path. - * + * zero. Then calls {@link Extrusion#updateGeometry(Line, List, boolean, ReadOnlyVector3)} with this path. + * * @param shape * an instance of Line that describes the 2D shape * @param points @@ -323,10 +316,8 @@ public class Extrusion extends Mesh { for (int dim = 0; dim < 3; dim++) { final double t1 = (h[i] * j) / segments; final double t2 = h[i] - t1; - final double v = ((-a[dim][i - 1] / 6 * (t2 + h[i]) * t1 + d[dim][i - 1]) * t2 + (-a[dim][i] - / 6 * (t1 + h[i]) * t2 + d[dim][i]) - * t1) - / h[i]; + final double v = ((-a[dim][i - 1] / 6 * (t2 + h[i]) * t1 + d[dim][i - 1]) * t2 + + (-a[dim][i] / 6 * (t1 + h[i]) * t2 + d[dim][i]) * t1) / h[i]; // float t = x[i - 1] + t1; point[dim] = v; } diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/GeoSphere.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/GeoSphere.java index d5b3be8..e4a5c09 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/GeoSphere.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/GeoSphere.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -22,9 +22,9 @@ import com.ardor3d.util.geom.BufferUtils; /** * GeoSphere - generate a polygon mesh approximating a sphere by recursive subdivision. First approximation is an * octahedron; each level of refinement increases the number of polygons by a factor of 4. - * <p/> + * * Shared vertices are not retained, so numerical errors may produce cracks between polygons at high subdivision levels. - * <p/> + * * Initial idea and text from C-Sourcecode by Jon Leech 3/24/89 */ @@ -47,7 +47,7 @@ public class GeoSphere extends Mesh { * @param radius * the radius of this sphere * @param maxlevels - * an integer >= 1 setting the recursion level + * an integer >= 1 setting the recursion level * @param textureMode * the texture mode to use when generating texture coordinates */ @@ -65,7 +65,8 @@ public class GeoSphere extends Mesh { /** * Default Constructor for Savable use. */ - public GeoSphere() {} + public GeoSphere() { + } public double getRadius() { return _radius; @@ -103,9 +104,9 @@ public class GeoSphere extends Mesh { _meshData.setVertexBuffer(vertBuf = BufferUtils.createVector3Buffer(vertBuf, verts)); _meshData.setNormalBuffer(BufferUtils.createVector3Buffer(_meshData.getNormalBuffer(), verts)); final FloatBufferData textureCoords = _meshData.getTextureCoords(0); - _meshData.setTextureCoords( - new FloatBufferData(BufferUtils.createVector2Buffer(textureCoords != null ? textureCoords.getBuffer() - : null, verts), 2), 0); + _meshData.setTextureCoords(new FloatBufferData( + BufferUtils.createVector2Buffer(textureCoords != null ? textureCoords.getBuffer() : null, verts), 2), + 0); int pos = 0; @@ -179,9 +180,9 @@ public class GeoSphere extends Mesh { put(ZMIN); final Triangle[] octahedron = new Triangle[] { new Triangle(yplus, zplus, xplus), - new Triangle(xmin, zplus, yplus), new Triangle(ymin, zplus, xmin), - new Triangle(xplus, zplus, ymin), new Triangle(zmin, yplus, xplus), - new Triangle(zmin, xmin, yplus), new Triangle(zmin, ymin, xmin), new Triangle(zmin, xplus, ymin) }; + new Triangle(xmin, zplus, yplus), new Triangle(ymin, zplus, xmin), new Triangle(xplus, zplus, ymin), + new Triangle(zmin, yplus, xplus), new Triangle(zmin, xmin, yplus), new Triangle(zmin, ymin, xmin), + new Triangle(zmin, xplus, ymin) }; old = octahedron; } @@ -202,20 +203,20 @@ public class GeoSphere extends Mesh { * Subdivide each polygon in the old approximation and normalize the next points thus generated to lie on * the surface of the unit sphere. Each input triangle with vertBuf labeled [0,1,2] as shown below will be * turned into four next triangles: - * + * * <pre> * Make next points * a = (0+2)/2 * b = (0+1)/2 * c = (1+2)/2 - * + * * 1 /\ Normalize a, b, c * / \ * b /____\ c - * + * * Construct next triangles - * - * /\ /\ [0,b,a] + * + * /\ /\ [0,b,a] * / \ / \ [b,1,c] * /____\/____\ [a,b,c] * 0 a 2 [a,c,2] @@ -274,8 +275,8 @@ public class GeoSphere extends Mesh { if (point.getX() > 0 && point.getY() == 0) { // Find out which 'y' side the triangle is on final double yCenter = (_meshData.getVertexBuffer().get(triangle.pt[0] * 3 + 1) - + _meshData.getVertexBuffer().get(triangle.pt[1] * 3 + 1) + _meshData.getVertexBuffer() - .get(triangle.pt[2] * 3 + 1)) / 3.0; + + _meshData.getVertexBuffer().get(triangle.pt[1] * 3 + 1) + + _meshData.getVertexBuffer().get(triangle.pt[2] * 3 + 1)) / 3.0; if (yCenter > 0.0) { put(point, true); indexBuffer.put(carryIntIndex++); @@ -341,7 +342,7 @@ public class GeoSphere extends Mesh { /** * Compute the average of two vectors. - * + * * @param a * first vector * @param b @@ -355,7 +356,8 @@ public class GeoSphere extends Mesh { static class Triangle { int[] pt = new int[3]; /* Vertices of triangle */ - public Triangle() {} + public Triangle() { + } public Triangle(final int pt0, final int pt1, final int pt2) { pt[0] = pt0; diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Sphere.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Sphere.java index 8c9ff84..91f4627 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Sphere.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Sphere.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -43,11 +43,12 @@ public class Sphere extends Mesh { protected boolean _viewInside = false; - public Sphere() {} + public Sphere() { + } /** * Constructs a sphere. By default the Sphere has not geometry data or center. - * + * * @param name * The name of the sphere. */ @@ -56,8 +57,8 @@ public class Sphere extends Mesh { } /** - * Constructs a sphere with center at the origin. For details, see the other constructor. - * + * Constructs a sphere with center at the origin + * * @param name * Name of sphere. * @param zSamples @@ -66,7 +67,6 @@ public class Sphere extends Mesh { * The samples along the radial. * @param radius * Radius of the sphere. - * @see #Sphere(java.lang.String, com.ardor3d.math.Vector3, int, int, double) */ public Sphere(final String name, final int zSamples, final int radialSamples, final double radius) { this(name, new Vector3(0, 0, 0), zSamples, radialSamples, radius); @@ -75,7 +75,7 @@ public class Sphere extends Mesh { /** * Constructs a sphere. All geometry data buffers are updated automatically. Both zSamples and radialSamples * increase the quality of the generated sphere. - * + * * @param name * Name of the sphere. * @param center @@ -96,7 +96,7 @@ public class Sphere extends Mesh { /** * Constructs a sphere. All geometry data buffers are updated automatically. Both zSamples and radialSamples * increase the quality of the generated sphere. - * + * * @param name * Name of the sphere. * @param center @@ -119,7 +119,7 @@ public class Sphere extends Mesh { /** * Changes the information of the sphere into the given values. - * + * * @param center * The new center of the sphere. * @param zSamples @@ -129,7 +129,8 @@ public class Sphere extends Mesh { * @param radius * The new radius of the sphere. */ - public void setData(final ReadOnlyVector3 center, final int zSamples, final int radialSamples, final double radius) { + public void setData(final ReadOnlyVector3 center, final int zSamples, final int radialSamples, + final double radius) { _center.set(center); _zSamples = zSamples; _radialSamples = radialSamples; @@ -361,7 +362,7 @@ public class Sphere extends Mesh { /** * Returns the center of this sphere. - * + * * @return The sphere's center. */ public Vector3 getCenter() { @@ -369,7 +370,7 @@ public class Sphere extends Mesh { } /** - * + * * @return true if the normals are inverted to point into the sphere so that the face is oriented for a viewer * inside the sphere. false (the default) for exterior viewing. */ @@ -378,7 +379,7 @@ public class Sphere extends Mesh { } /** - * + * * @param viewInside * if true, the normals are inverted to point into the sphere so that the face is oriented for a viewer * inside the sphere. Default is false (for outside viewing) diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/StripBox.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/StripBox.java index 4d5f2c9..a6b274f 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/StripBox.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/StripBox.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -38,7 +38,7 @@ public class StripBox extends Mesh { /** * Constructor instantiates a new <code>StripBox</code> object. Center and vertex information must be supplied * later. - * + * * @param name * the name of the scene element. This is required for identification and comparison purposes. */ @@ -50,7 +50,7 @@ public class StripBox extends Mesh { * Constructor instantiates a new <code>StripBox</code> object. The minimum and maximum point are provided. These * two points define the shape and size of the box, but not it's orientation or position. You should use the * <code>setTranslation</code> and <code>setLocalRotation</code> for those attributes. - * + * * @param name * the name of the scene element. This is required for identification and comparison purposes. * @param min @@ -66,7 +66,7 @@ public class StripBox extends Mesh { /** * Constructs a new box. The box has the given center and extends in the x, y, and z out from the center (+ and -) * by the given amounts. So, for example, a box with extent of .5 would be the unit cube. - * + * * @param name * Name of the box. * @param center @@ -88,7 +88,7 @@ public class StripBox extends Mesh { * Changes the data of the box so that the two opposite corners are minPoint and maxPoint. The other corners are * created from those two poitns. If update buffers is flagged as true, the vertex/normal/texture/color/index * buffers are updated when the data is changed. - * + * * @param minPoint * The new minPoint of the box. * @param maxPoint @@ -106,8 +106,8 @@ public class StripBox extends Mesh { /** * Changes the data of the box so that its center is <code>center</code> and it extends in the x, y, and z * directions by the given extent. Note that the actual sides will be 2x the given extent values because the box - * extends in + & - from the center for each extent. - * + * extends in + & - from the center for each extent. + * * @param center * The center of the box. * @param xExtent @@ -134,10 +134,10 @@ public class StripBox extends Mesh { } /** - * + * * <code>setVertexData</code> sets the vertex positions that define the box. These eight points are determined from * the minimum and maximum point. - * + * */ private void setVertexData() { _meshData.setVertexBuffer(BufferUtils.createVector3Buffer(_meshData.getVertexBuffer(), 8)); @@ -154,10 +154,10 @@ public class StripBox extends Mesh { } /** - * + * * <code>setNormalData</code> sets the normals of each of the box's planes. - * - * + * + * */ private void setNormalData() { final Vector3[] vert = computeVertices(); // returns 8 @@ -172,11 +172,11 @@ public class StripBox extends Mesh { } /** - * + * * <code>setTextureData</code> sets the points that define the texture of the box. It's a one-to-one ratio, where * each plane of the box has it's own copy of the texture. That is, the texture is repeated one time for each six * faces. - * + * */ private void setTextureData() { if (_meshData.getTextureCoords(0) == null) { @@ -194,10 +194,10 @@ public class StripBox extends Mesh { } /** - * + * * <code>setIndexData</code> sets the indices into the list of vertices, defining all triangles that constitute the * box. - * + * */ private void setIndexData() { _meshData.setIndexMode(IndexMode.TriangleStrip); @@ -212,7 +212,7 @@ public class StripBox extends Mesh { /** * <code>clone</code> creates a new StripBox object containing the same data as this one. - * + * * @return the new StripBox */ @Override @@ -221,7 +221,7 @@ public class StripBox extends Mesh { } /** - * + * * @return a size 8 array of Vectors representing the 8 points of the box. */ public Vector3[] computeVertices() { @@ -247,7 +247,7 @@ public class StripBox extends Mesh { /** * Returns the current center of the box. - * + * * @return The box's center. */ public Vector3 getCenter() { diff --git a/ardor3d-core/src/main/java/com/ardor3d/spline/CatmullRomSpline.java b/ardor3d-core/src/main/java/com/ardor3d/spline/CatmullRomSpline.java index 020c89a..f2772c1 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/spline/CatmullRomSpline.java +++ b/ardor3d-core/src/main/java/com/ardor3d/spline/CatmullRomSpline.java @@ -3,13 +3,13 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ /** - * + * */ package com.ardor3d.spline; @@ -19,11 +19,11 @@ import com.ardor3d.math.type.ReadOnlyVector3; /** * CatmullRomSpline class is an implementation of spline that uses the Catmull-Rom equation: - * + * * <pre> * q(t) = 0.5 * ((2 * P1) + (-P0 + P2) * t + (2 * P0 - 5 * P1 + 4 * P2 - P3) * t2 + (-P0 + 3 * P1 - 3 * P2 + P3) * t3) * </pre> - * + * * @see <a href="http://en.wikipedia.org/wiki/Cubic_Hermite_spline#Catmull.E2.80.93Rom_spline">Cubic Hermite spline - * Wikipedia, the free encyclopedia</a> */ @@ -41,7 +41,7 @@ public class CatmullRomSpline implements Spline { /** * If any vector is <code>null</code> then the result is just returned unchanged. - * + * * @param p0 * The start control point. * @param p1 @@ -51,8 +51,8 @@ public class CatmullRomSpline implements Spline { * @param p3 * The end control point. * @param t - * <code>0.0 <= t <= 1.0</code>, if t <= 0.0 then result will be contain exact same values as p1 and if - * its >= 1.0 it will contain the exact same values as p2. + * <code>0.0 <= t <= 1.0</code>, if t <= 0.0 then result will be contain exact same values as p1 + * and if its >= 1.0 it will contain the exact same values as p2. * @param result * The results from the interpolation will be stored in this vector. * @return The result vector as a convenience. @@ -73,19 +73,16 @@ public class CatmullRomSpline implements Spline { final double t3 = t2 * t; result.setX(0.5 * ((2.0 * p1.getX()) + (-p0.getX() + p2.getX()) * t - + (2.0 * p0.getX() - 5.0 * p1.getX() + 4.0 * p2.getX() - p3.getX()) * t2 + (-p0.getX() + 3.0 - * p1.getX() - 3.0 * p2.getX() + p3.getX()) - * t3)); + + (2.0 * p0.getX() - 5.0 * p1.getX() + 4.0 * p2.getX() - p3.getX()) * t2 + + (-p0.getX() + 3.0 * p1.getX() - 3.0 * p2.getX() + p3.getX()) * t3)); result.setY(0.5 * ((2.0 * p1.getY()) + (-p0.getY() + p2.getY()) * t - + (2.0 * p0.getY() - 5.0 * p1.getY() + 4.0 * p2.getY() - p3.getY()) * t2 + (-p0.getY() + 3.0 - * p1.getY() - 3.0 * p2.getY() + p3.getY()) - * t3)); + + (2.0 * p0.getY() - 5.0 * p1.getY() + 4.0 * p2.getY() - p3.getY()) * t2 + + (-p0.getY() + 3.0 * p1.getY() - 3.0 * p2.getY() + p3.getY()) * t3)); result.setZ(0.5 * ((2.0 * p1.getZ()) + (-p0.getZ() + p2.getZ()) * t - + (2.0 * p0.getZ() - 5.0 * p1.getZ() + 4.0 * p2.getZ() - p3.getZ()) * t2 + (-p0.getZ() + 3.0 - * p1.getZ() - 3.0 * p2.getZ() + p3.getZ()) - * t3)); + + (2.0 * p0.getZ() - 5.0 * p1.getZ() + 4.0 * p2.getZ() - p3.getZ()) * t2 + + (-p0.getZ() + 3.0 * p1.getZ() - 3.0 * p2.getZ() + p3.getZ()) * t3)); } } diff --git a/ardor3d-core/src/main/java/com/ardor3d/ui/text/BMFont.java b/ardor3d-core/src/main/java/com/ardor3d/ui/text/BMFont.java index 8aeda6a..8799064 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/ui/text/BMFont.java +++ b/ardor3d-core/src/main/java/com/ardor3d/ui/text/BMFont.java @@ -45,7 +45,7 @@ import com.ardor3d.util.export.Savable; import com.ardor3d.util.resource.ResourceSource; /** - * Loads a font generated by BMFont ({@link http://www.angelcode.com/products/bmfont/}). + * Loads a font generated by BMFont ( @link http://www.angelcode.com/products/bmfont/ ). * <ul> * <li>Font info file *must* be in XML format. * <li>The texture should be saved in 32 bit PNG format - TGA does not appear to work. @@ -73,7 +73,8 @@ public class BMFont implements Savable { /** * This constructor should be used when loading as Savable */ - public BMFont() {} + public BMFont() { + } /** * Reads an XML BMFont description file and loads corresponding texture. Note that the TGA written by BMFont does @@ -442,7 +443,8 @@ public class BMFont implements Savable { /** * - * @param fontUrl + * @param source + * the resource of the font file * @throws IOException */ protected void parseFontFile(final ResourceSource source) throws IOException { @@ -789,7 +791,8 @@ public class BMFont implements Savable { public int second; public int amount; - public Kerning() {} + public Kerning() { + } public Kerning(final int first, final int second, final int amount) { this.first = first; diff --git a/ardor3d-core/src/main/java/com/ardor3d/util/GameTaskQueue.java b/ardor3d-core/src/main/java/com/ardor3d/util/GameTaskQueue.java index 130f6b1..779defc 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/util/GameTaskQueue.java +++ b/ardor3d-core/src/main/java/com/ardor3d/util/GameTaskQueue.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -25,7 +25,7 @@ import com.ardor3d.renderer.RendererCallable; * <code>GameTaskQueue</code> is a simple queuing system to enqueue tasks that need to be accomplished in a specific * thread or phase of the application execution (for example, the OpenGL rendering thread.) Upon sending in a task, the * caller gets back a Future object useful for retrieving a return from the Callable that was passed in. - * + * * @see Future * @see Callable */ @@ -56,7 +56,7 @@ public class GameTaskQueue { /** * The state of this <code>GameTaskQueue</code> if it will execute all enqueued Callables on an execute invokation. - * + * * @return boolean */ public boolean isExecuteAll() { @@ -80,7 +80,7 @@ public class GameTaskQueue { * Sets the minimum amount of time the queue will execute tasks per frame. If this is set, executeMultiple is * automatically set to true and the execute() loop will execute as many tasks as it can before the execution window * threshold is passed. Any remaining tasks will be executed in the following frame. - * + * * @param msecs * the maximum number of milliseconds to start tasks. Note that this does not guarantee the tasks will * finish under this time, only start. @@ -92,7 +92,7 @@ public class GameTaskQueue { /** * min time queue is permitted to execute tasks per frame - * + * * @return -1 if executeAll is false, else min time allocated for task execution per frame */ public long getExecutionTime() { @@ -105,10 +105,12 @@ public class GameTaskQueue { /** * Adds the Callable to the internal queue to invoked and returns a Future that wraps the return. This is useful for * checking the status of the task as well as being able to retrieve the return object from Callable asynchronously. - * + * * @param <V> + * the return type of the callable * @param callable - * @return + * the callable to enqueue + * @return the task */ public <V> Future<V> enqueue(final Callable<V> callable) { final GameTask<V> task = new GameTask<>(callable); @@ -118,9 +120,11 @@ public class GameTaskQueue { /** * Adds the given task to the internal queue to be invoked later. - * + * * @param <V> + * the return type of the task * @param task + * the task */ public <V> void enqueue(final GameTask<V> task) { _queue.add(task); @@ -137,6 +141,9 @@ public class GameTaskQueue { /** * Execute the tasks from this queue. Note that depending on the queue type, tasks may expect to be run in a certain * context (for example, the Render queue expects to be run from the Thread owning a GL context.) + * + * @param renderer + * the renderer */ public void execute(final Renderer renderer) { final long beginTime = System.currentTimeMillis(); @@ -180,8 +187,9 @@ public class GameTaskQueue { /** * Move the tasks from the given queue to this one. - * - * @param gameTaskQueue + * + * @param queue + * the queue containing the tasks to move */ public void enqueueAll(final GameTaskQueue queue) { _queue.addAll(queue._queue); diff --git a/ardor3d-core/src/main/java/com/ardor3d/util/GameTaskQueueManager.java b/ardor3d-core/src/main/java/com/ardor3d/util/GameTaskQueueManager.java index f442186..d4857f0 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/util/GameTaskQueueManager.java +++ b/ardor3d-core/src/main/java/com/ardor3d/util/GameTaskQueueManager.java @@ -80,8 +80,11 @@ public final class GameTaskQueueManager { * This method adds <code>callable</code> to the queue to be invoked in the update() method in the OpenGL thread. * The Future returned may be utilized to cancel the task or wait for the return object. * + * @param <V> + * the return type of the callable * @param callable - * @return Future<V> + * the callable + * @return Future */ public <V> Future<V> update(final Callable<V> callable) { @@ -92,8 +95,11 @@ public final class GameTaskQueueManager { * This method adds <code>callable</code> to the queue to be invoked in the render() method in the OpenGL thread. * The Future returned may be utilized to cancel the task or wait for the return object. * + * @param <V> + * the return type of the callable * @param callable - * @return Future<V> + * the callable + * @return Future */ public <V> Future<V> render(final Callable<V> callable) { diff --git a/ardor3d-core/src/main/java/com/ardor3d/util/LittleEndianDataInput.java b/ardor3d-core/src/main/java/com/ardor3d/util/LittleEndianDataInput.java index 4f32a19..579c94e 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/util/LittleEndianDataInput.java +++ b/ardor3d-core/src/main/java/com/ardor3d/util/LittleEndianDataInput.java @@ -48,6 +48,11 @@ public class LittleEndianDataInput implements DataInput, AutoCloseable { /** * read an unsigned int as a long + * + * @return an unsigned int as a long + * + * @throws IOException + * if something wrong occurs while reading */ public final long readUnsignedInt() throws IOException { return ((_stream.read() & 0xff) | ((_stream.read() & 0xff) << 8) | ((_stream.read() & 0xff) << 16) diff --git a/ardor3d-core/src/main/java/com/ardor3d/util/LittleEndianRandomAccessDataInput.java b/ardor3d-core/src/main/java/com/ardor3d/util/LittleEndianRandomAccessDataInput.java index a53312e..bd7ae6c 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/util/LittleEndianRandomAccessDataInput.java +++ b/ardor3d-core/src/main/java/com/ardor3d/util/LittleEndianRandomAccessDataInput.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -23,7 +23,7 @@ import com.ardor3d.util.export.ByteUtils; /** * Utility class useful for reading little-endian stored data in a random access fashion. All functions work as defined * in DataInput, but assume they come from a LittleEndian input stream. - * + * * <p> * Note: random access is implemented by reading the entire stream into memory. * </p> @@ -40,9 +40,11 @@ public class LittleEndianRandomAccessDataInput implements DataInput { /** * Creates a new LittleEndian reader from the given input stream. Note that this stream is loaded completely into * memory. - * + * * @param in * The stream to read from. + * @throws IOException + * if something wrong occurs while reading */ public LittleEndianRandomAccessDataInput(final InputStream in) throws IOException { _contents = ByteBuffer.wrap(ByteUtils.getByteContent(in)); @@ -51,9 +53,11 @@ public class LittleEndianRandomAccessDataInput implements DataInput { /** * Creates a new LittleEndian reader from the given byte buffer. Note that this byte buffer is not cloned or copied, * so take care not to alter it during read. This constructor is useful for working with memory-mapped files. - * + * * @param contents * The contents to read from. + * @throws IOException + * if something wrong occurs while reading */ public LittleEndianRandomAccessDataInput(final ByteBuffer contents) throws IOException { _contents = contents; @@ -65,7 +69,8 @@ public class LittleEndianRandomAccessDataInput implements DataInput { } public final long readUnsignedInt() throws IOException { - return ((readByte() & 0xff) | ((readByte() & 0xff) << 8) | ((readByte() & 0xff) << 16) | (((long) (readByte() & 0xff)) << 24)); + return ((readByte() & 0xff) | ((readByte() & 0xff) << 8) | ((readByte() & 0xff) << 16) + | (((long) (readByte() & 0xff)) << 24)); } @Override @@ -95,14 +100,16 @@ public class LittleEndianRandomAccessDataInput implements DataInput { @Override public final int readInt() throws IOException { - return ((readByte() & 0xff) | ((readByte() & 0xff) << 8) | ((readByte() & 0xff) << 16) | ((readByte() & 0xff) << 24)); + return ((readByte() & 0xff) | ((readByte() & 0xff) << 8) | ((readByte() & 0xff) << 16) + | ((readByte() & 0xff) << 24)); } @Override public final long readLong() throws IOException { return ((readByte() & 0xff) | ((long) (readByte() & 0xff) << 8) | ((long) (readByte() & 0xff) << 16) | ((long) (readByte() & 0xff) << 24) | ((long) (readByte() & 0xff) << 32) - | ((long) (readByte() & 0xff) << 40) | ((long) (readByte() & 0xff) << 48) | ((long) (readByte() & 0xff) << 56)); + | ((long) (readByte() & 0xff) << 40) | ((long) (readByte() & 0xff) << 48) + | ((long) (readByte() & 0xff) << 56)); } @Override @@ -142,7 +149,7 @@ public class LittleEndianRandomAccessDataInput implements DataInput { /** * Sets a mark at the current position in the underlying buffer. This position can be returned to by calling reset. - * + * * @return this object */ public final LittleEndianRandomAccessDataInput mark() { @@ -152,7 +159,7 @@ public class LittleEndianRandomAccessDataInput implements DataInput { /** * Seeks to the position of the last mark. The mark is not changed or discarded. - * + * * @return this object * @throws InvalidMarkException * if mark was not previously called. @@ -164,7 +171,7 @@ public class LittleEndianRandomAccessDataInput implements DataInput { /** * Unsupported. - * + * * @throws IOException * if this method is called. */ @@ -175,7 +182,7 @@ public class LittleEndianRandomAccessDataInput implements DataInput { /** * Unsupported. - * + * * @throws IOException * if this method is called. */ @@ -187,7 +194,7 @@ public class LittleEndianRandomAccessDataInput implements DataInput { /** * Reads a specified number of bytes to form a string. The length of the string (number of characters) is required * to notify when reading should stop. The index is increased the number of characters read. - * + * * @param size * the length of the string to read. * @param charset @@ -217,7 +224,7 @@ public class LittleEndianRandomAccessDataInput implements DataInput { * Reads a specified number of bytes to form a string. The length of the string (number of characters) is required * to notify when reading should stop. The index is increased the number of characters read. Will use the platform's * default Charset to convert the bytes to string. - * + * * @param size * the length of the string to read. * @return the string read. diff --git a/ardor3d-core/src/main/java/com/ardor3d/util/SortUtil.java b/ardor3d-core/src/main/java/com/ardor3d/util/SortUtil.java index d669ea1..ef1d761 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/util/SortUtil.java +++ b/ardor3d-core/src/main/java/com/ardor3d/util/SortUtil.java @@ -3,7 +3,7 @@ * * This file is part of Ardor3D. * - * Ardor3D is free software: you can redistribute it and/or modify it + * Ardor3D is free software: you can redistribute it and/or modify it * under the terms of its license which may be found in the accompanying * LICENSE file or at <http://www.ardor3d.com/LICENSE>. */ @@ -23,13 +23,13 @@ public abstract class SortUtil { public static int SHELL_SORT_THRESHOLD = 17; /** - * <p> * Merge sorts the supplied data, in the given range, using the given comparator. - * </p> - * <p> + * * <b>Note: this internally creates a temporary copy of the array to use as work space during sort.</b> - * </p> - * + * + * @param <T> + * the type of data to sort + * * @param source * the array to sort. Will hold the sorted array on completion. * @param left @@ -47,13 +47,13 @@ public abstract class SortUtil { } /** - * <p> * Merge sorts the supplied data, in the given range, using the given comparator. - * </p> - * - * @param sourceCopy + * + * @param <T> + * the type of data to sort + * @param source * contains the elements to be sorted and acts as a work space for the sort. - * @param destinationCopy + * @param copy * contains the elements to be sorted and will hold the fully sorted array when complete. * @param left * the left-most index of our sort range. @@ -85,14 +85,19 @@ public abstract class SortUtil { /** * Performs a merge on two sets of data stored in source, represented by the ranges formed by [left, mid] and * [mid+1, right]. Stores the result in destination. - * + * + * @param <T> + * the type of data to sort * @param source * our source data * @param destination * the array to store our result in * @param left + * the left index of the range to sort * @param mid + * the middle index of the range to sort * @param right + * the right index of the range to sort * @param comp * our object Comparator */ @@ -115,7 +120,9 @@ public abstract class SortUtil { /** * Performs an in-place shell sort (extension of insertion sort) of the provided data. - * + * + * @param <T> + * the type of data to sort * @param array * our source data * @param left @@ -125,7 +132,8 @@ public abstract class SortUtil { * @param comp * our object Comparator */ - public static <T> void shellSort(final T[] array, final int left, final int right, final Comparator<? super T> comp) { + public static <T> void shellSort(final T[] array, final int left, final int right, + final Comparator<? super T> comp) { int h; for (h = 1; h <= (right - 1) / 9; h = 3 * h + 1) { ; @@ -145,7 +153,9 @@ public abstract class SortUtil { /** * Performs an in-place shell sort (extension of insertion sort) of the provided data. - * + * + * @param <T> + * the type of data to sort * @param array * our source data * @param left diff --git a/ardor3d-core/src/main/java/com/ardor3d/util/TextureKey.java b/ardor3d-core/src/main/java/com/ardor3d/util/TextureKey.java index ce08108..9cca85b 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/util/TextureKey.java +++ b/ardor3d-core/src/main/java/com/ardor3d/util/TextureKey.java @@ -91,7 +91,11 @@ final public class TextureKey implements Savable { } } - /** DO NOT USE. FOR INTERNAL USE ONLY */ + /** + * DO NOT USE. FOR INTERNAL USE ONLY + * + * @return the texture key + */ public static TextureKey initSavable() { return new TextureKey(); } diff --git a/ardor3d-core/src/main/java/com/ardor3d/util/geom/BufferUtils.java b/ardor3d-core/src/main/java/com/ardor3d/util/geom/BufferUtils.java index 17f7c2c..f9294ce 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/util/geom/BufferUtils.java +++ b/ardor3d-core/src/main/java/com/ardor3d/util/geom/BufferUtils.java @@ -227,11 +227,7 @@ public final class BufferUtils { /** * Generate a new FloatBuffer using the given array of Vector4 objects. The FloatBuffer will be 4 * data.length long * and contain the vector data as data[0].x, data[0].y, data[0].z, data[0].w, data[1].x... etc. - * - * @param offset - * the starting index to read from in our data array - * @param length - * the number of vectors to read + * * @param data * array of Vector4 objects to place into a new FloatBuffer */ @@ -245,7 +241,11 @@ public final class BufferUtils { /** * Generate a new FloatBuffer using the given array of Vector4 objects. The FloatBuffer will be 4 * data.length long * and contain the vector data as data[0].x, data[0].y, data[0].z, data[0].w, data[1].x... etc. - * + * + * @param offset + * the starting index to read from in our data array + * @param length + * the number of vectors to read * @param data * array of Vector4 objects to place into a new FloatBuffer */ @@ -613,7 +613,7 @@ public final class BufferUtils { /** * Generates a Vector3 array from the given FloatBufferData. * - * @param buff + * @param data * the FloatBufferData to read from * @param defaults * a default value to set each color to, used when the tuple size of the given {@link FloatBufferData} is @@ -1193,7 +1193,8 @@ public final class BufferUtils { * @param data * array of Vector2 objects to place into a new FloatBuffer */ - public static FloatBuffer createFloatBufferOnHeap(final int offset, final int length, final ReadOnlyVector2... data) { + public static FloatBuffer createFloatBufferOnHeap(final int offset, final int length, + final ReadOnlyVector2... data) { if (data == null) { return null; } @@ -1220,7 +1221,8 @@ public final class BufferUtils { * @param data * array of Vector3 objects to place into a new FloatBuffer */ - public static FloatBuffer createFloatBufferOnHeap(final int offset, final int length, final ReadOnlyVector3... data) { + public static FloatBuffer createFloatBufferOnHeap(final int offset, final int length, + final ReadOnlyVector3... data) { if (data == null) { return null; } @@ -1295,8 +1297,8 @@ public final class BufferUtils { * @param length * the number of floats to copy */ - public static void copy(final FloatBuffer source, final int fromPos, final FloatBuffer destination, - final int toPos, final int length) { + public static void copy(final FloatBuffer source, final int fromPos, final FloatBuffer destination, final int toPos, + final int length) { final int oldLimit = source.limit(); source.position(fromPos); source.limit(fromPos + length); @@ -1619,8 +1621,8 @@ public final class BufferUtils { * @param size * required number of values to store. * @param maxValue - * the largest value you will need to store in your buffer. Often this is equal to - * ("size of vertex buffer" - 1). + * the largest value you will need to store in your buffer. Often this is equal to ("size of vertex + * buffer" - 1). * @return the new IndexBufferData */ public static IndexBufferData<?> createIndexBufferData(final int size, final int maxValue) { @@ -1641,8 +1643,8 @@ public final class BufferUtils { * @param size * required number of values to store. * @param maxValue - * the largest value you will need to store in your buffer. Often this is equal to - * ("size of vertex buffer" - 1). + * the largest value you will need to store in your buffer. Often this is equal to ("size of vertex + * buffer" - 1). * @return the new IndexBufferData */ public static IndexBufferData<?> createIndexBufferDataOnHeap(final int size, final int maxValue) { @@ -1663,8 +1665,8 @@ public final class BufferUtils { * @param contents * an array of index values to store in your newly created IndexBufferData. * @param maxValue - * the largest value you will need to store in your buffer. Often this is equal to - * ("size of vertex buffer" - 1). + * the largest value you will need to store in your buffer. Often this is equal to ("size of vertex + * buffer" - 1). * @return the new IndexBufferData */ public static IndexBufferData<?> createIndexBufferData(final int[] contents, final int maxValue) { @@ -1814,11 +1816,11 @@ public final class BufferUtils { } store.append("Existing buffers: ").append(bufs.size()).append('\n'); store.append("(b: ").append(bBufs).append(" f: ").append(fBufs).append(" i: ").append(iBufs).append(" s: ") - .append(sBufs).append(" d: ").append(dBufs).append(')').append('\n'); + .append(sBufs).append(" d: ").append(dBufs).append(')').append('\n'); store.append("Total direct memory held: ").append(totalHeld / 1024).append("kb\n"); store.append("(b: ").append(bBufsM / 1024).append("kb f: ").append(fBufsM / 1024).append("kb i: ") - .append(iBufsM / 1024).append("kb s: ").append(sBufsM / 1024).append("kb d: ").append(dBufsM / 1024) - .append("kb)").append('\n'); + .append(iBufsM / 1024).append("kb s: ").append(sBufsM / 1024).append("kb d: ").append(dBufsM / 1024) + .append("kb)").append('\n'); if (printStout) { System.out.println(store.toString()); } |