diff options
Diffstat (limited to 'ardor3d-core')
32 files changed, 329 insertions, 154 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 1505a51..e516d3f 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/bounding/BoundingBox.java +++ b/ardor3d-core/src/main/java/com/ardor3d/bounding/BoundingBox.java @@ -51,6 +51,9 @@ public class BoundingBox extends BoundingVolume { /** * Constructor instantiates a new <code>BoundingBox</code> object with given values. + * + * @param other + * the other bounding box */ public BoundingBox(final BoundingBox other) { this(other.getCenter(), other.getXExtent(), other.getYExtent(), other.getZExtent()); @@ -58,6 +61,15 @@ public class BoundingBox extends BoundingVolume { /** * Constructor instantiates a new <code>BoundingBox</code> object with given values. + * + * @param c + * the center + * @param x + * the x value + * @param y + * the y value + * @param z + * the z value */ public BoundingBox(final ReadOnlyVector3 c, final double x, final double y, final double z) { _center.set(c); diff --git a/ardor3d-core/src/main/java/com/ardor3d/bounding/BoundingVolume.java b/ardor3d-core/src/main/java/com/ardor3d/bounding/BoundingVolume.java index e660675..6919b19 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/bounding/BoundingVolume.java +++ b/ardor3d-core/src/main/java/com/ardor3d/bounding/BoundingVolume.java @@ -40,7 +40,8 @@ public abstract class BoundingVolume implements Serializable, Savable { protected final Vector3 _compVect1 = new Vector3(); protected final Vector3 _compVect2 = new Vector3(); - public BoundingVolume() {} + public BoundingVolume() { + } public BoundingVolume(final Vector3 center) { _center.set(center); @@ -69,6 +70,7 @@ public abstract class BoundingVolume implements Serializable, Savable { /** * Grabs the checkplane we should check first. * + * @return the index of the plane that should be first checked during rendering */ public int getCheckPlane() { return _checkPlane; @@ -78,6 +80,7 @@ public abstract class BoundingVolume implements Serializable, Savable { * Sets the index of the plane that should be first checked during rendering. * * @param value + * the index of the plane that should be first checked during rendering */ public final void setCheckPlane(final int value) { _checkPlane = value; @@ -85,6 +88,8 @@ public abstract class BoundingVolume implements Serializable, Savable { /** * getType returns the type of bounding volume this is. + * + * @return the type of bounding volume */ public abstract Type getType(); @@ -93,8 +98,10 @@ public abstract class BoundingVolume implements Serializable, Savable { * <code>transform</code> alters the location of the bounding volume by a transform. * * @param transform + * the transform * @param store - * @return + * the bounding volume used as a store + * @return the transformed bounding volume */ public abstract BoundingVolume transform(final ReadOnlyTransform transform, final BoundingVolume store); diff --git a/ardor3d-core/src/main/java/com/ardor3d/bounding/CollisionTree.java b/ardor3d-core/src/main/java/com/ardor3d/bounding/CollisionTree.java index 297616e..16d294b 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/bounding/CollisionTree.java +++ b/ardor3d-core/src/main/java/com/ardor3d/bounding/CollisionTree.java @@ -101,6 +101,8 @@ public class CollisionTree implements Serializable { * * @param childIndex * the index of the child to generate the tree for. + * @param section + * the section * @param parent * The Node that this tree should represent. * @param doSort @@ -200,6 +202,9 @@ public class CollisionTree implements Serializable { * Creates a Collision Tree by recursively creating children nodes, splitting the primitives this node is * responsible for in half until the desired primitive count is reached. * + * @param section + * the section + * * @param start * The start index of the primitivesArray, inclusive. * @param end diff --git a/ardor3d-core/src/main/java/com/ardor3d/bounding/CollisionTreeManager.java b/ardor3d-core/src/main/java/com/ardor3d/bounding/CollisionTreeManager.java index 8ab1688..d2f7e53 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/bounding/CollisionTreeManager.java +++ b/ardor3d-core/src/main/java/com/ardor3d/bounding/CollisionTreeManager.java @@ -394,6 +394,7 @@ public enum CollisionTreeManager { * Removes the supplied mesh from the "protected" list. * * @param mesh + * the mesh to remove from the "protected" list */ public void removeProtected(final Mesh mesh) { _protectedList.remove(mesh); diff --git a/ardor3d-core/src/main/java/com/ardor3d/framework/CanvasRenderer.java b/ardor3d-core/src/main/java/com/ardor3d/framework/CanvasRenderer.java index 62f35a2..52fca52 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/framework/CanvasRenderer.java +++ b/ardor3d-core/src/main/java/com/ardor3d/framework/CanvasRenderer.java @@ -24,6 +24,8 @@ public interface CanvasRenderer { /** * Draw the current state of the scene. + * + * @return <code>true</code> if it has been drawn */ @MainThread boolean draw(); @@ -31,14 +33,14 @@ public interface CanvasRenderer { /** * Returns the camera being used by this canvas renderer. Modifying the returned {@link Camera} instance effects the * view being rendered, so this method can be used to move the camera, etc. - * + * * @return the camera used by this canvas renderer */ Camera getCamera(); /** * Replaces the camera being used by this canvas renderer. - * + * * @param camera * the camera to use */ @@ -46,14 +48,14 @@ public interface CanvasRenderer { /** * Returns the scene being used by this canvas renderer. - * + * * @return the camera used by this canvas renderer */ Scene getScene(); /** * Replaces the scene being used by this canvas renderer. - * + * * @param scene * the scene to use */ @@ -61,21 +63,21 @@ public interface CanvasRenderer { /** * Creates a new renderer for this canvas renderer - * + * * @return a new renderer */ Renderer createRenderer(); /** * Returns the renderer being used by this canvas renderer. - * + * * @return the renderer used by this canvas renderer */ Renderer getRenderer(); /** * Have the CanvasRenderer claim the graphics context. - * + * * @throws Ardor3dException * if we can not claim the context. */ diff --git a/ardor3d-core/src/main/java/com/ardor3d/framework/NativeCanvas.java b/ardor3d-core/src/main/java/com/ardor3d/framework/NativeCanvas.java index d593ea4..6de9905 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/framework/NativeCanvas.java +++ b/ardor3d-core/src/main/java/com/ardor3d/framework/NativeCanvas.java @@ -74,7 +74,9 @@ public interface NativeCanvas extends Canvas { * If running in windowed mode, move the window's position to the given display coordinates in window units. * * @param locX + * the x value of the location * @param locY + * the y value of the location */ void moveWindowTo(int locX, int locY); } diff --git a/ardor3d-core/src/main/java/com/ardor3d/image/Image.java b/ardor3d-core/src/main/java/com/ardor3d/image/Image.java index b7e2783..ccfdf16 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/image/Image.java +++ b/ardor3d-core/src/main/java/com/ardor3d/image/Image.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.util.export.Savable; * <code>Image</code> defines a data format for a graphical image. The image is defined by a format, a height and width, * and the image data. The width and height must be greater than 0. The data is contained in a byte buffer, and should * be packed before creation of the image object. - * + * */ public class Image implements Serializable, Savable { @@ -48,7 +48,7 @@ public class Image implements Serializable, Savable { /** * Constructor instantiates a new <code>Image</code> object. The attributes of the image are defined during * construction. - * + * * @param format * the data format of the image. Must not be null. * @param type @@ -81,7 +81,7 @@ public class Image implements Serializable, Savable { /** * Constructor instantiates a new <code>Image</code> object. The attributes of the image are defined during * construction. - * + * * @param format * the data format of the image. Must not be null. * @param type @@ -103,7 +103,7 @@ public class Image implements Serializable, Savable { /** * <code>setData</code> sets the data that makes up the image. This data is packed into an array of * <code>ByteBuffer</code> objects. - * + * * @param data * the data that contains the image information. Must not be null. */ @@ -117,7 +117,7 @@ public class Image implements Serializable, Savable { /** * <code>setData</code> sets the data that makes up the image. This data is packed into a single * <code>ByteBuffer</code>. - * + * * @param data * the data that contains the image information. */ @@ -127,7 +127,7 @@ public class Image implements Serializable, Savable { /** * Adds the given buffer onto the current list of image data - * + * * @param data * the data that contains the image information. */ @@ -152,7 +152,7 @@ public class Image implements Serializable, Savable { /** * Sets the mipmap data sizes stored in this image's data buffer. Mipmaps are stored sequentially, and the first * mipmap is the main image data. To specify no mipmaps, pass null. - * + * * @param mipMapSizes * the mipmap sizes array, or null to indicate no mip maps. */ @@ -167,7 +167,7 @@ public class Image implements Serializable, Savable { /** * <code>setHeight</code> sets the height value of the image. It is typically a good idea to try to keep this as a * multiple of 2. - * + * * @param height * the height of the image. */ @@ -178,7 +178,7 @@ public class Image implements Serializable, Savable { /** * <code>setDepth</code> sets the depth value of the image. It is typically a good idea to try to keep this as a * multiple of 2. This is used for 3d images. - * + * * @param depth * the depth of the image. */ @@ -189,7 +189,7 @@ public class Image implements Serializable, Savable { /** * <code>setWidth</code> sets the width value of the image. It is typically a good idea to try to keep this as a * multiple of 2. - * + * * @param width * the width of the image. */ @@ -266,7 +266,7 @@ public class Image implements Serializable, Savable { /** * <code>getData</code> returns the data for this image. If the data is undefined, null will be returned. - * + * * @return the data for this image. */ public List<ByteBuffer> getData() { @@ -287,7 +287,10 @@ public class Image implements Serializable, Savable { /** * <code>getData</code> returns the data for this image at a given index. If the data is undefined, null will be * returned. - * + * + * @param index + * the index of the image + * * @return the data for this image. */ public ByteBuffer getData(final int index) { @@ -300,7 +303,7 @@ public class Image implements Serializable, Savable { /** * Returns whether the image data contains mipmaps. - * + * * @return true if the image data contains mipmaps, false if not. */ public boolean hasMipmaps() { @@ -309,7 +312,7 @@ public class Image implements Serializable, Savable { /** * Returns the mipmap sizes for this image. - * + * * @return the mipmap sizes for this image. */ public int[] getMipMapByteSizes() { diff --git a/ardor3d-core/src/main/java/com/ardor3d/input/control/FirstPersonControl.java b/ardor3d-core/src/main/java/com/ardor3d/input/control/FirstPersonControl.java index 28be041..a0d1ab1 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/input/control/FirstPersonControl.java +++ b/ardor3d-core/src/main/java/com/ardor3d/input/control/FirstPersonControl.java @@ -203,10 +203,12 @@ public class FirstPersonControl { } /** - * Deregister the triggers of the given FirstPersonControl from the given LogicalLayer. + * Unregister the triggers of the given FirstPersonControl from the given LogicalLayer. * * @param layer + * the logical layer * @param control + * the first person control */ public static void removeTriggers(final LogicalLayer layer, final FirstPersonControl control) { if (control._mouseTrigger != null) { diff --git a/ardor3d-core/src/main/java/com/ardor3d/input/control/OrbitCamControl.java b/ardor3d-core/src/main/java/com/ardor3d/input/control/OrbitCamControl.java index 125af23..251fdbe 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/input/control/OrbitCamControl.java +++ b/ardor3d-core/src/main/java/com/ardor3d/input/control/OrbitCamControl.java @@ -169,6 +169,7 @@ public class OrbitCamControl { * Sets a specific world location for the camera to point at and circle around. * * @param point + * the point to look at */ public void setLookAtPoint(final Vector3 point) { _dirty = !point.equals(_lookAtPoint); @@ -184,6 +185,7 @@ public class OrbitCamControl { * Sets a spatial to look at. We'll use the world transform of the spatial, so its transform needs to be up to date. * * @param spatial + * the spatial to look at */ public void setLookAtSpatial(final Spatial spatial) { _dirty = spatial != _lookAtSpatial; // identity equality diff --git a/ardor3d-core/src/main/java/com/ardor3d/input/logical/TriggerConditions.java b/ardor3d-core/src/main/java/com/ardor3d/input/logical/TriggerConditions.java index 21c0294..48b9b27 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/input/logical/TriggerConditions.java +++ b/ardor3d-core/src/main/java/com/ardor3d/input/logical/TriggerConditions.java @@ -155,7 +155,12 @@ public final class TriggerConditions { } /** - * @return a condition that is always false. + * + * @param throttleTime + * the throttle time + * @param timer + * the timer + * @return the condition */ public static Predicate<TwoInputStates> passedThrottle(final double throttleTime, final Timer timer) { return new Predicate<TwoInputStates>() { 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 5951a65..20d716a 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/renderer/Camera.java +++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/Camera.java @@ -260,7 +260,9 @@ public class Camera implements Savable, Externalizable { * Construct a new Camera with the given frame width and height. * * @param width + * the width * @param height + * the height */ public Camera(final int width, final int height) { _width = width; @@ -310,6 +312,7 @@ public class Camera implements Savable, Externalizable { * Construct a new camera, using the given source camera's values. * * @param source + * the source camera to copy from */ public Camera(final Camera source) { diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/ContextManager.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/ContextManager.java index 658f4a2..3665cb4 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/renderer/ContextManager.java +++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/ContextManager.java @@ -54,7 +54,8 @@ public class ContextManager { * Find the first context we manage that uses the given shared opengl context. * * @param glref - * @return + * the GL context + * @return the render context */ public static RenderContext getContextForRef(final Object glref) { if (glref == null) { diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/IndexMode.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/IndexMode.java index cef4761..09a965e 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/renderer/IndexMode.java +++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/IndexMode.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>. */ @@ -92,7 +92,9 @@ public enum IndexMode { /** * @param indexMode + * the index mode * @param size + * the size * @return the number of primitives you would have if you connected an array of points of the given size using the * given index mode. */ diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/RenderContext.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/RenderContext.java index 7676e67..3882624 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/renderer/RenderContext.java +++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/RenderContext.java @@ -115,6 +115,9 @@ public class RenderContext { /** * Enforces the states referenced in the given EnumMap. + * + * @param states + * the render states */ public void enforceStates(final EnumMap<StateType, RenderState> states) { _enforcedStates.putAll(states); diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/Renderer.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/Renderer.java index 7831d2c..92e18e9 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/renderer/Renderer.java +++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/Renderer.java @@ -249,6 +249,7 @@ public interface Renderer { * Attempts to delete the VBOs with the given id. Ignores null ids or ids < 1. * * @param ids + * the identifiers */ void deleteVBOs(Collection<Integer> ids); @@ -390,6 +391,7 @@ public interface Renderer { * * @param transform * transform to apply. + * @return <code>true</code> if the transform has been applied */ boolean doTransforms(ReadOnlyTransform transform); @@ -447,19 +449,19 @@ public interface Renderer { * @param store * The buffer to store in. If null or remaining is < 16, a new FloatBuffer will be created and * returned. - * @return + * @return the projection matrix */ FloatBuffer getProjectionMatrix(FloatBuffer store); void setModelViewMatrix(FloatBuffer matrix); /** - * Gets the current modelview matrix in row major order + * Gets the current model-view matrix in row major order * * @param store * The buffer to store in. If null or remaining is < 16, a new FloatBuffer will be created and * returned. - * @return + * @return the model-view matrix */ FloatBuffer getModelViewMatrix(FloatBuffer store); @@ -471,6 +473,7 @@ public interface Renderer { * Specify which color buffers are to be drawn into. * * @param target + * the target */ void setDrawBuffer(DrawBufferTarget target); @@ -479,9 +482,13 @@ public interface Renderer { * jogl. * * @param lineWidth + * the line width * @param stippleFactor + * the stipple factor * @param stipplePattern + * the stipple pattern * @param antialiased + * <code>true</code> if anti-aliased */ void setupLineParameters(float lineWidth, int stippleFactor, short stipplePattern, boolean antialiased); @@ -490,12 +497,19 @@ public interface Renderer { * jogl. * * @param pointSize + * the point size * @param antialiased + * <code>true</code> if anti-aliased * @param isSprite + * <code>true</code> if it is a sprite * @param useDistanceAttenuation + * <code>true</code> if the distance attenuation is enabled * @param attenuationCoefficients + * the attenuation coefficients * @param minPointSize + * the points minimum size * @param maxPointSize + * the points maximum size */ void setupPointParameters(float pointSize, boolean antialiased, boolean isSprite, boolean useDistanceAttenuation, FloatBuffer attenuationCoefficients, float minPointSize, float maxPointSize); @@ -527,7 +541,7 @@ public interface Renderer { * Loads a texture onto the card for the current OpenGL context. * * @param texture - * the texture obejct to load. + * the texture object to load. * @param unit * the texture unit to load into */ @@ -564,6 +578,7 @@ public interface Renderer { * any existing scissor entries. Enable clipping if this is the first rectangle in the stack. * * @param rectangle + * the rectangle */ void pushClip(ReadOnlyRectangle2 rectangle); @@ -598,6 +613,9 @@ public interface Renderer { /** * @param type * the state type to grab + * + * @param current + * the current render state * @return the appropriate render state for the current context for the current type. This is the enforced state if * one exists or the given current state if not null. Otherwise, the Renderer's default state is returned. */ diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/queue/OpaqueRenderBucket.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/queue/OpaqueRenderBucket.java index 2f1483c..ba2da4c 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/renderer/queue/OpaqueRenderBucket.java +++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/queue/OpaqueRenderBucket.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>. */ @@ -47,6 +47,14 @@ public class OpaqueRenderBucket extends AbstractRenderBucket { /** * Compare opaque items by their texture states - generally the most expensive switch. Later this might expand * to comparisons by other states as well, such as lighting or material. + * + * @param mesh1 + * the first item + * + * @param mesh2 + * the second item + * + * @return the result of the comparison */ private int compareByStates(final Mesh mesh1, final Mesh mesh2) { final TextureState ts1 = (TextureState) mesh1.getWorldRenderState(RenderState.StateType.Texture); @@ -67,7 +75,8 @@ public class OpaqueRenderBucket extends AbstractRenderBucket { } } - for (int x = 0, maxIndex = Math.min(ts1.getMaxTextureIndexUsed(), ts2.getMaxTextureIndexUsed()); x <= maxIndex; x++) { + for (int x = 0, maxIndex = Math.min(ts1.getMaxTextureIndexUsed(), + ts2.getMaxTextureIndexUsed()); x <= maxIndex; x++) { final TextureKey key1 = ts1.getTextureKey(x); final TextureKey key2 = ts2.getTextureKey(x); diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/ByteBufferData.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/ByteBufferData.java index 15120e0..1f521b5 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/ByteBufferData.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/ByteBufferData.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>. */ @@ -27,10 +27,14 @@ public class ByteBufferData extends IndexBufferData<ByteBuffer> implements Savab /** * Instantiates a new ByteBufferData. */ - public ByteBufferData() {} + public ByteBufferData() { + } /** * Instantiates a new ByteBufferData with a buffer of the given size. + * + * @param size + * the size */ public ByteBufferData(final int size) { this(BufferUtils.createByteBuffer(size)); @@ -38,7 +42,7 @@ public class ByteBufferData extends IndexBufferData<ByteBuffer> implements Savab /** * Creates a new ByteBufferData. - * + * * @param buffer * Buffer holding the data. Must not be null. */ 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 2f6244b..5b19228 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/FloatBufferData.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/FloatBufferData.java @@ -35,6 +35,11 @@ public class FloatBufferData extends AbstractBufferData<FloatBuffer> implements /** * Instantiates a new FloatBufferData with a buffer of the given size. + * + * @param size + * the size + * @param valuesPerTuple + * Specifies the number of values per tuple. Can not be < 1. */ public FloatBufferData(final int size, final int valuesPerTuple) { this(BufferUtils.createFloatBuffer(size), valuesPerTuple); diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/IndexBufferData.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/IndexBufferData.java index bc0c609..966418e 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/IndexBufferData.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/IndexBufferData.java @@ -52,7 +52,7 @@ public abstract class IndexBufferData<T extends Buffer> extends AbstractBufferDa * ShortBuffer, 2 would be the 3rd short from the beginning, etc. * @param value * the value to place into this object - * @return + * @return this object, for chaining. */ public abstract IndexBufferData<T> put(int index, int value); @@ -81,7 +81,9 @@ public abstract class IndexBufferData<T extends Buffer> extends AbstractBufferDa * @param array * the source int array. * @param offset + * the offset * @param length + * the length */ public abstract void put(int[] array, int offset, int length); @@ -93,6 +95,8 @@ public abstract class IndexBufferData<T extends Buffer> extends AbstractBufferDa /** * @see Buffer#remaining() + * + * @return The number of elements remaining in this buffer */ public int remaining() { return getBuffer().remaining(); @@ -100,6 +104,8 @@ public abstract class IndexBufferData<T extends Buffer> extends AbstractBufferDa /** * @see Buffer#position() + * + * @return The position of this buffer */ public int position() { return getBuffer().position(); @@ -107,6 +113,9 @@ public abstract class IndexBufferData<T extends Buffer> extends AbstractBufferDa /** * @see Buffer#position(int) + * + * @param position + * The new position value; must be non-negative and no larger than the current limit */ public void position(final int position) { getBuffer().position(position); @@ -114,6 +123,8 @@ public abstract class IndexBufferData<T extends Buffer> extends AbstractBufferDa /** * @see Buffer#limit() + * + * @return The limit of this buffer */ public int limit() { return getBuffer().limit(); @@ -121,6 +132,9 @@ public abstract class IndexBufferData<T extends Buffer> extends AbstractBufferDa /** * @see Buffer#limit(int) + * + * @param limit + * The new limit value; must be non-negative and no larger than this buffer's capacity */ public void limit(final int limit) { getBuffer().limit(limit); @@ -128,6 +142,8 @@ public abstract class IndexBufferData<T extends Buffer> extends AbstractBufferDa /** * @see Buffer#capacity() + * + * @return The capacity of this buffer */ public int capacity() { return getBuffer().capacity(); diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/InstancingManager.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/InstancingManager.java index e788161..0df59ed 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/InstancingManager.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/InstancingManager.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>. */ @@ -33,8 +33,9 @@ public class InstancingManager { /** * Register a mesh for instancing for this current frame (internal use only) - * + * * @param mesh + * the mesh to register */ public void registerMesh(final Mesh mesh) { _visibleMeshes.add(mesh); @@ -43,6 +44,8 @@ public class InstancingManager { /** * Fill the buffer with the transforms and return it + * + * @return the transform buffer */ protected FloatBuffer fillTransformBuffer() { @@ -73,8 +76,10 @@ public class InstancingManager { } /** - * Returns the number of meshes to be drawn this batch. This function is only valid after the apply call (internal - * use only) + * Returns the number of meshes to be drawn in this batch. This function is only valid after the apply call + * (internal use only) + * + * @return the number of meshes to be drawn in this batch */ public int getPrimitiveCount() { return _primCount; @@ -83,7 +88,7 @@ public class InstancingManager { /** * Split the batch in multiple batches if number of visible meshes exceeds this amount. Using larger batches will * lead to better performance, although you might overflow the uniform space of the shader/videocard (crashes) - * + * * @return maximum batch size */ public int getMaxBatchSize() { @@ -93,7 +98,7 @@ public class InstancingManager { /** * Split the batch in multiple batches if number of visible meshes exceeds this amount. Using larger batches will * lead to better performance, although you might overflow the uniform space of the shader/videocard (crashes) - * + * * @param maxBatchSize * maximum batch size */ @@ -107,10 +112,13 @@ public class InstancingManager { /** * Applies all instancing info to the mesh and returns if the current render call is allowed to continue - * + * * @param mesh + * the mesh * @param renderer + * the renderer * @param shader + * the shader * @return continue rendering or skip rendering all together */ public boolean apply(final Mesh mesh, final Renderer renderer, final GLSLShaderObjectsState shader) { diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/IntBufferData.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/IntBufferData.java index 3cb43d3..39c2789 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/IntBufferData.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/IntBufferData.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,10 +26,14 @@ public class IntBufferData extends IndexBufferData<IntBuffer> implements Savable /** * Instantiates a new IntBufferData. */ - public IntBufferData() {} + public IntBufferData() { + } /** * Instantiates a new IntBufferData with a buffer of the given size. + * + * @param size + * the size */ public IntBufferData(final int size) { this(BufferUtils.createIntBuffer(size)); @@ -37,7 +41,7 @@ public class IntBufferData extends IndexBufferData<IntBuffer> implements Savable /** * Creates a new IntBufferData. - * + * * @param buffer * Buffer holding the data. Must not be null. */ diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Line.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Line.java index 7267232..3e87c4b 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Line.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Line.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>. */ @@ -36,7 +36,7 @@ public class Line extends Mesh { /** * Constructs a new line with the given name. By default, the line has no information. - * + * * @param name * The name of the line. */ @@ -49,7 +49,7 @@ public class Line extends Mesh { /** * Constructor instantiates a new <code>Line</code> object with a given set of data. Any data can be null except for * the vertex list. If vertices are null an exception will be thrown. - * + * * @param name * the name of the scene element. This is required for identification and comparison purposes. * @param vertex @@ -71,7 +71,7 @@ public class Line extends Mesh { /** * Constructor instantiates a new <code>Line</code> object with a given set of data. Any data can be null except for * the vertex list. If vertices are null an exception will be thrown. - * + * * @param name * the name of the scene element. This is required for identification and comparison purposes. * @param vertex @@ -93,11 +93,15 @@ public class Line extends Mesh { /** * Initialize the meshdata object with data. - * + * * @param vertices + * the vertices * @param normals + * the normals * @param colors + * the colors * @param coords + * the texture coordinates */ private void setupData(final FloatBuffer vertices, final FloatBuffer normals, final FloatBuffer colors, final FloatBufferData coords) { @@ -111,7 +115,7 @@ public class Line extends Mesh { /** * Puts a circle into vertex and normal buffer at the current buffer position. The buffers are enlarged and copied * if they are too small. - * + * * @param radius * radius of the circle * @param x @@ -158,7 +162,7 @@ public class Line extends Mesh { * Sets whether the point should be antialiased. May decrease performance. If you want to enabled antialiasing, you * should also use an alphastate with a source of SourceFunction.SourceAlpha and a destination of * DB_ONE_MINUS_SRC_ALPHA or DB_ONE. - * + * * @param antialiased * true if the line should be antialiased. */ @@ -176,7 +180,7 @@ public class Line extends Mesh { /** * Sets the width of the line when drawn. Non anti-aliased line widths are rounded to the nearest whole number by * opengl. - * + * * @param lineWidth * The lineWidth to set. */ @@ -193,7 +197,7 @@ public class Line extends Mesh { /** * The stipple or pattern to use when drawing this line. 0xFFFF is a solid line. - * + * * @param stipplePattern * a 16bit short whose bits describe the pattern to use when drawing this line */ diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Point.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Point.java index a4fcfd7..36c7c04 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Point.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Point.java @@ -105,9 +105,13 @@ public class Point extends Mesh { * Initialize the meshdata object with data. * * @param vertices + * the vertices * @param normals + * the normals * @param colors + * the colors * @param coords + * the texture coordinates */ private void setupData(final FloatBuffer vertices, final FloatBuffer normals, final FloatBuffer colors, final FloatBufferData coords) { @@ -125,6 +129,7 @@ public class Point extends Mesh { * Default attenuation coefficient is calculated to work best with pointSize = 1. * * @param bool + * <code>true</code> to enable the distance attenuation */ public void enableDistanceAttenuation(final boolean bool) { _useDistanceAttenuation = bool; @@ -207,6 +212,7 @@ public class Point extends Mesh { * When DistanceAttenuation is enabled, the points maximum size will get clamped to this value. * * @param maxSize + * the points maximum size to set */ public void setMaxPointSize(final float maxSize) { _maxPointSize = maxSize; @@ -223,6 +229,7 @@ public class Point extends Mesh { * When DistanceAttenuation is enabled, the points minimum size will get clamped to this value. * * @param minSize + * the points minimum size to set */ public void setMinPointSize(final float minSize) { _minPointSize = minSize; @@ -239,7 +246,9 @@ public class Point extends Mesh { * Used with Serialization. Do not call this directly. * * @param s + * the output stream * @throws IOException + * if something wrong occurs while writing * @see java.io.Serializable */ private void writeObject(final java.io.ObjectOutputStream s) throws IOException { @@ -250,8 +259,11 @@ public class Point extends Mesh { * Used with Serialization. Do not call this directly. * * @param s + * the input stream * @throws IOException + * if something wrong occurs while reading * @throws ClassNotFoundException + * if a class is not found * @see java.io.Serializable */ private void readObject(final java.io.ObjectInputStream s) throws IOException, ClassNotFoundException { diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/ShortBufferData.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/ShortBufferData.java index 92f9cda..010f348 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/ShortBufferData.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/ShortBufferData.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>. */ @@ -27,10 +27,14 @@ public class ShortBufferData extends IndexBufferData<ShortBuffer> implements Sav /** * Instantiates a new ShortBufferData. */ - public ShortBufferData() {} + public ShortBufferData() { + } /** * Instantiates a new ShortBufferData with a buffer of the given size. + * + * @param size + * the size */ public ShortBufferData(final int size) { this(BufferUtils.createShortBuffer(size)); @@ -38,7 +42,7 @@ public class ShortBufferData extends IndexBufferData<ShortBuffer> implements Sav /** * Creates a new ShortBufferData. - * + * * @param buffer * Buffer holding the data. Must not be null. */ diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/event/DirtyEventListener.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/event/DirtyEventListener.java index da56324..4a32901 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/event/DirtyEventListener.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/event/DirtyEventListener.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,7 +20,13 @@ public interface DirtyEventListener { /** * spatialDirty is called when a spatial is changed in respect to transform, bounding, attach/dettach or renderstate - * + * + * @param spatial + * the spatial + * + * @param dirtyType + * the dirty type + * * @return true if the event should be consumed and not continue up the scenegraph. */ boolean spatialDirty(Spatial spatial, DirtyType dirtyType); @@ -28,6 +34,11 @@ public interface DirtyEventListener { /** * spatialClean is called when a spatial is changed in respect to transform, bounding, attach/dettach or renderstate * + * @param spatial + * the spatial + * + * @param dirtyType + * the dirty type * @return true if the event should be consumed and not continue up the scenegraph. */ boolean spatialClean(Spatial spatial, DirtyType dirtyType); diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/extension/BillboardNode.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/extension/BillboardNode.java index 2abb417..b89f7fc 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/extension/BillboardNode.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/extension/BillboardNode.java @@ -88,7 +88,8 @@ public class BillboardNode extends Node { private BillboardAlignment _alignment; - public BillboardNode() { /**/} + public BillboardNode() { + /**/} /** * Constructor instantiates a new <code>BillboardNode</code>. The name of the node is supplied during construction. @@ -136,7 +137,7 @@ public class BillboardNode extends Node { return _updateBounds; } - public void setLocalRotation(Matrix3 rot) { + public void setLocalRotation(final Matrix3 rot) { _localRot = rot; } @@ -193,7 +194,7 @@ public class BillboardNode extends Node { } private void rotateNone() { - if(_localRot != null) { + if (_localRot != null) { _orient.set(getRotation()); _orient.multiplyLocal(_localRot); _worldTransform.setRotation(_orient); @@ -210,8 +211,9 @@ public class BillboardNode extends Node { final Vector3 up = Vector3.fetchTempInstance(); up.set(_look).crossLocal(_left); _orient.fromAxes(_left, up, _look); - if(_localRot != null) + if (_localRot != null) { _orient.multiplyLocal(_localRot); + } _worldTransform.setRotation(_orient); Vector3.releaseTempInstance(up); } @@ -224,13 +226,17 @@ public class BillboardNode extends Node { _look.set(camera.getDirection()).negateLocal(); _left.set(camera.getLeft()).negateLocal(); _orient.fromAxes(_left, camera.getUp(), _look); - if(_localRot != null) + if (_localRot != null) { _orient.multiplyLocal(_localRot); + } _worldTransform.setRotation(_orient); } /** * Rotate the billboard towards the current camera, but keeping a given axis fixed. + * + * @param axis + * the axis */ private void rotateAxial(final ReadOnlyVector3 axis) { final Camera camera = Camera.getCurrentCamera(); @@ -305,8 +311,9 @@ public class BillboardNode extends Node { // The billboard must be oriented to face the camera before it is // transformed into the world. - if(_localRot != null) + if (_localRot != null) { _orient.multiplyLocal(_localRot); + } worldMatrix.multiplyLocal(_orient); _worldTransform.setRotation(worldMatrix); Matrix3.releaseTempInstance(worldMatrix); @@ -324,6 +331,9 @@ public class BillboardNode extends Node { /** * Sets the type of rotation this BillboardNode will have. The alignment can be ScreenAligned, CameraAligned, AxialY * or AxialZ. Invalid alignments will assume no billboard rotation. + * + * @param alignment + * The alignment of rotation */ public void setAlignment(final BillboardAlignment alignment) { _alignment = alignment; diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/extension/PassNodeState.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/extension/PassNodeState.java index 8bcd95f..ad70c53 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/extension/PassNodeState.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/extension/PassNodeState.java @@ -40,6 +40,7 @@ public class PassNodeState implements Savable, Serializable { * Applies all currently set renderstates to the supplied context * * @param context + * the render context */ public void applyPassNodeStates(final RenderContext context) { context.pushEnforcedStates(); diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/extension/Skybox.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/extension/Skybox.java index 3567b54..135ecd4 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/extension/Skybox.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/extension/Skybox.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>. */ @@ -59,11 +59,12 @@ public class Skybox extends Node { private Quad[] _skyboxQuads; - public Skybox() {} + public Skybox() { + } /** * Creates a new skybox. The size of the skybox and name is specified here. By default, no textures are set. - * + * * @param name * The name of the skybox. * @param xExtent @@ -85,7 +86,7 @@ public class Skybox extends Node { /** * Set the texture to be displayed on the given face of the skybox. Replaces any existing texture on that face. - * + * * @param face * the face to set * @param texture @@ -105,7 +106,7 @@ public class Skybox extends Node { /** * Set the texture to be displayed on the given side of the skybox. Only replaces the texture at the index specified * by textureUnit. - * + * * @param face * the face to set * @param texture @@ -167,8 +168,8 @@ public class Skybox extends Node { .setRotation(new Matrix3().fromAngles(Math.toRadians(90), Math.toRadians(270), 0)); _skyboxQuads[Face.Up.ordinal()].setTranslation(new Vector3(0, _yExtent, 0)); _skyboxQuads[Face.Down.ordinal()] = new Quad("down", _xExtent * 2, _zExtent * 2); - _skyboxQuads[Face.Down.ordinal()].setRotation(new Matrix3().fromAngles(Math.toRadians(270), - Math.toRadians(270), 0)); + _skyboxQuads[Face.Down.ordinal()] + .setRotation(new Matrix3().fromAngles(Math.toRadians(270), Math.toRadians(270), 0)); _skyboxQuads[Face.Down.ordinal()].setTranslation(new Vector3(0, -_yExtent, 0)); // We don't want the light to effect our skybox @@ -207,7 +208,7 @@ public class Skybox extends Node { /** * Retrieve the quad indicated by the given side. - * + * * @param face * One of Skybox.Face.North, Skybox.Face.South, and so on... * @return The Quad that makes up that side of the Skybox. @@ -226,6 +227,9 @@ public class Skybox extends Node { /** * Force all of the textures to load. This prevents pauses later during the application as you pan around the world. + * + * @param r + * the renderer */ public void preloadTextures(final Renderer r) { for (int x = 0; x < 6; x++) { diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Capsule.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Capsule.java index ccffa38..641f632 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Capsule.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Capsule.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 Capsule extends Mesh { private int axisSamples, radialSamples, sphereSamples; private double radius, height; - public Capsule() {} + public Capsule() { + } /** * Creates a new Cylinder. By default its center is the origin. Usually, a higher sample number creates a better @@ -38,13 +39,15 @@ public class Capsule extends Mesh { * If the cylinder is closed the texture is split into axisSamples parts: top most and bottom most part is used for * top and bottom of the cylinder, rest of the texture for the cylinder wall. The middle of the top is mapped to * texture coordinates (0.5, 1), bottom to (0.5, 0). Thus you need a suited distorted texture. - * + * * @param name * The name of this Cylinder. * @param axisSamples * Number of triangle samples along the axis. * @param radialSamples * Number of triangle samples along the radial. + * @param sphereSamples + * Number of triangle samples along the sphere. * @param radius * The radius of the cylinder. * @param height @@ -89,7 +92,7 @@ public class Capsule extends Mesh { /** * Change the radius of this cylinder. - * + * * @param radius * The radius to set. */ diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Dome.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Dome.java index a7031de..b04a64b 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Dome.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/Dome.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>. */ @@ -31,11 +31,12 @@ public class Dome extends Mesh { /** The radius of the dome */ private double _radius; - public Dome() {} + public Dome() { + } /** * Constructs a dome. By default the dome has not geometry data or center. - * + * * @param name * The name of the dome. */ @@ -45,7 +46,7 @@ public class Dome extends Mesh { /** * Constructs a dome with center at the origin. For details, see the other constructor. - * + * * @param name * Name of dome. * @param planes @@ -63,7 +64,7 @@ public class Dome extends Mesh { /** * Constructs a dome. All geometry data buffers are updated automatically. Both planes and radialSamples increase * the quality of the generated dome. - * + * * @param name * Name of the dome. * @param center @@ -75,7 +76,8 @@ public class Dome extends Mesh { * @param radius * The radius of the dome. */ - public Dome(final String name, final Vector3 center, final int planes, final int radialSamples, final double radius) { + public Dome(final String name, final Vector3 center, final int planes, final int radialSamples, + final double radius) { super(name); setData(center, planes, radialSamples, radius, true, true); @@ -84,7 +86,7 @@ public class Dome extends Mesh { /** * Constructs a dome. All geometry data buffers are updated automatically. Both planes and radialSamples increase * the quality of the generated dome. - * + * * @param name * Name of the dome. * @param center @@ -98,8 +100,8 @@ public class Dome extends Mesh { * @param outsideView * If true, the triangles will be connected for a view outside of the dome. */ - public Dome(final String name, final Vector3 center, final int planes, final int radialSamples, - final double radius, final boolean outsideView) { + public Dome(final String name, final Vector3 center, final int planes, final int radialSamples, final double radius, + final boolean outsideView) { super(name); setData(center, planes, radialSamples, radius, true, outsideView); } @@ -107,7 +109,7 @@ public class Dome extends Mesh { /** * Changes the information of the dome into the given values. The boolean at the end signals if buffer data should * be updated as well. If the dome is to be rendered, then that value should be true. - * + * * @param center * The new center of the dome. * @param planes @@ -135,10 +137,11 @@ public class Dome extends Mesh { /** * Generates the vertices of the dome - * + * * @param outsideView * If the dome should be viewed from the outside (if not zbuffer is used) * @param center + * the center */ private void setGeometryData(final boolean outsideView, final Vector3 center) { final Vector3 tempVa = Vector3.fetchTempInstance(); diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/RoundedBox.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/RoundedBox.java index 267cbfc..4e0e053 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/RoundedBox.java +++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/shape/RoundedBox.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,7 +26,12 @@ public class RoundedBox extends Mesh { private final Vector3 _border = new Vector3(0.05, 0.05, 0.05); private final Vector3 _slope = new Vector3(0.02, 0.02, 0.02); - /** Creates a new instance of RoundedBox */ + /** + * Creates a new instance of RoundedBox + * + * @param name + * the name + */ public RoundedBox(final String name) { super(name); setData(); @@ -162,8 +167,8 @@ public class RoundedBox extends Mesh { private void setIndexData() { if (_meshData.getIndices() == null) { final IndexBufferData<?> buff = BufferUtils.createIndexBufferData(180, 48 - 1); - final int[] data = new int[] { 0, 4, 1, 1, 4, 5, 1, 5, 3, 3, 5, 7, 3, 7, 2, 2, 7, 6, 2, 6, 0, 0, 6, 4, 4, - 6, 5, 5, 6, 7 }; + final int[] data = new int[] { 0, 4, 1, 1, 4, 5, 1, 5, 3, 3, 5, 7, 3, 7, 2, 2, 7, 6, 2, 6, 0, 0, 6, 4, 4, 6, + 5, 5, 6, 7 }; for (int i = 0; i < 6; i++) { for (int n = 0; n < 30; n++) { buff.put(30 * i + n, 8 * i + data[n]); @@ -185,101 +190,101 @@ public class RoundedBox extends Mesh { new Vector3(-_extent.getX(), _extent.getY(), -_extent.getZ()), // 6 new Vector3(_extent.getX(), _extent.getY(), -_extent.getZ()), // 7 // bottom - new Vector3(-_extent.getX() + _border.getX(), -_extent.getY() - _slope.getY(), _extent.getZ() - - _border.getZ()), // 8 (0) - new Vector3(_extent.getX() - _border.getX(), -_extent.getY() - _slope.getY(), _extent.getZ() - - _border.getZ()), // 9 + new Vector3(-_extent.getX() + _border.getX(), -_extent.getY() - _slope.getY(), + _extent.getZ() - _border.getZ()), // 8 (0) + new Vector3(_extent.getX() - _border.getX(), -_extent.getY() - _slope.getY(), + _extent.getZ() - _border.getZ()), // 9 // ( // 1 // ) - new Vector3(-_extent.getX() + _border.getX(), -_extent.getY() - _slope.getY(), -_extent.getZ() - + _border.getZ()), // 10 (2) - new Vector3(_extent.getX() - _border.getX(), -_extent.getY() - _slope.getY(), -_extent.getZ() - + _border.getZ()), // 11 (3) + new Vector3(-_extent.getX() + _border.getX(), -_extent.getY() - _slope.getY(), + -_extent.getZ() + _border.getZ()), // 10 (2) + new Vector3(_extent.getX() - _border.getX(), -_extent.getY() - _slope.getY(), + -_extent.getZ() + _border.getZ()), // 11 (3) // front - new Vector3(-_extent.getX() + _border.getX(), -_extent.getY() + _border.getY(), _extent.getZ() - + _slope.getZ()), // 12 (0) - new Vector3(_extent.getX() - _border.getX(), -_extent.getY() + _border.getY(), _extent.getZ() - + _slope.getZ()), // 13 + new Vector3(-_extent.getX() + _border.getX(), -_extent.getY() + _border.getY(), + _extent.getZ() + _slope.getZ()), // 12 (0) + new Vector3(_extent.getX() - _border.getX(), -_extent.getY() + _border.getY(), + _extent.getZ() + _slope.getZ()), // 13 // ( // 1 // ) - new Vector3(-_extent.getX() + _border.getX(), _extent.getY() - _border.getY(), _extent.getZ() - + _slope.getZ()), // 14 + new Vector3(-_extent.getX() + _border.getX(), _extent.getY() - _border.getY(), + _extent.getZ() + _slope.getZ()), // 14 // ( // 4 // ) - new Vector3(_extent.getX() - _border.getX(), _extent.getY() - _border.getY(), _extent.getZ() - + _slope.getZ()), // 15 + new Vector3(_extent.getX() - _border.getX(), _extent.getY() - _border.getY(), + _extent.getZ() + _slope.getZ()), // 15 // ( // 5 // ) // right - new Vector3(_extent.getX() + _slope.getX(), -_extent.getY() + _border.getY(), _extent.getZ() - - _border.getZ()), // 16 + new Vector3(_extent.getX() + _slope.getX(), -_extent.getY() + _border.getY(), + _extent.getZ() - _border.getZ()), // 16 // ( // 1 // ) - new Vector3(_extent.getX() + _slope.getX(), -_extent.getY() + _border.getY(), -_extent.getZ() - + _border.getZ()), // 17 (3) - new Vector3(_extent.getX() + _slope.getX(), _extent.getY() - _border.getY(), _extent.getZ() - - _border.getZ()), // 18 + new Vector3(_extent.getX() + _slope.getX(), -_extent.getY() + _border.getY(), + -_extent.getZ() + _border.getZ()), // 17 (3) + new Vector3(_extent.getX() + _slope.getX(), _extent.getY() - _border.getY(), + _extent.getZ() - _border.getZ()), // 18 // ( // 5 // ) - new Vector3(_extent.getX() + _slope.getX(), _extent.getY() - _border.getY(), -_extent.getZ() - + _border.getZ()), // 19 + new Vector3(_extent.getX() + _slope.getX(), _extent.getY() - _border.getY(), + -_extent.getZ() + _border.getZ()), // 19 // ( // 7 // ) // back - new Vector3(-_extent.getX() + _border.getX(), -_extent.getY() + _border.getY(), -_extent.getZ() - - _slope.getZ()), // 20 (2) - new Vector3(_extent.getX() - _border.getX(), -_extent.getY() + _border.getY(), -_extent.getZ() - - _slope.getZ()), // 21 (3) - new Vector3(-_extent.getX() + _border.getX(), _extent.getY() - _border.getY(), -_extent.getZ() - - _slope.getZ()), // 22 (6) - new Vector3(_extent.getX() - _border.getX(), _extent.getY() - _border.getY(), -_extent.getZ() - - _slope.getZ()), // 23 + new Vector3(-_extent.getX() + _border.getX(), -_extent.getY() + _border.getY(), + -_extent.getZ() - _slope.getZ()), // 20 (2) + new Vector3(_extent.getX() - _border.getX(), -_extent.getY() + _border.getY(), + -_extent.getZ() - _slope.getZ()), // 21 (3) + new Vector3(-_extent.getX() + _border.getX(), _extent.getY() - _border.getY(), + -_extent.getZ() - _slope.getZ()), // 22 (6) + new Vector3(_extent.getX() - _border.getX(), _extent.getY() - _border.getY(), + -_extent.getZ() - _slope.getZ()), // 23 // ( // 7 // ) // left - new Vector3(-_extent.getX() - _slope.getX(), -_extent.getY() + _border.getY(), _extent.getZ() - - _border.getZ()), // 24 (0) - new Vector3(-_extent.getX() - _slope.getX(), -_extent.getY() + _border.getY(), -_extent.getZ() - + _border.getZ()), // 25 (2) - new Vector3(-_extent.getX() - _slope.getX(), _extent.getY() - _border.getY(), _extent.getZ() - - _border.getZ()), // 26 + new Vector3(-_extent.getX() - _slope.getX(), -_extent.getY() + _border.getY(), + _extent.getZ() - _border.getZ()), // 24 (0) + new Vector3(-_extent.getX() - _slope.getX(), -_extent.getY() + _border.getY(), + -_extent.getZ() + _border.getZ()), // 25 (2) + new Vector3(-_extent.getX() - _slope.getX(), _extent.getY() - _border.getY(), + _extent.getZ() - _border.getZ()), // 26 // ( // 4 // ) - new Vector3(-_extent.getX() - _slope.getX(), _extent.getY() - _border.getY(), -_extent.getZ() - + _border.getZ()), // 27 (6) + new Vector3(-_extent.getX() - _slope.getX(), _extent.getY() - _border.getY(), + -_extent.getZ() + _border.getZ()), // 27 (6) // top - new Vector3(-_extent.getX() + _border.getX(), _extent.getY() + _slope.getY(), _extent.getZ() - - _border.getZ()), // 28 + new Vector3(-_extent.getX() + _border.getX(), _extent.getY() + _slope.getY(), + _extent.getZ() - _border.getZ()), // 28 // ( // 4 // ) - new Vector3(_extent.getX() - _border.getX(), _extent.getY() + _slope.getY(), _extent.getZ() - - _border.getZ()), // 29 + new Vector3(_extent.getX() - _border.getX(), _extent.getY() + _slope.getY(), + _extent.getZ() - _border.getZ()), // 29 // ( // 5 // ) - new Vector3(-_extent.getX() + _border.getX(), _extent.getY() + _slope.getY(), -_extent.getZ() - + _border.getZ()), // 30 (6) - new Vector3(_extent.getX() - _border.getX(), _extent.getY() + _slope.getY(), -_extent.getZ() - + _border.getZ()), // 31 - // ( - // 7 - // ) + new Vector3(-_extent.getX() + _border.getX(), _extent.getY() + _slope.getY(), + -_extent.getZ() + _border.getZ()), // 30 (6) + new Vector3(_extent.getX() - _border.getX(), _extent.getY() + _slope.getY(), + -_extent.getZ() + _border.getZ()), // 31 + // ( + // 7 + // ) }; } /** * <code>clone</code> creates a new RoundedBox object containing the same data as this one. - * + * * @return the new Box */ @Override diff --git a/ardor3d-core/src/main/java/com/ardor3d/util/stat/StatCollector.java b/ardor3d-core/src/main/java/com/ardor3d/util/stat/StatCollector.java index 52af43a..5200c22 100644 --- a/ardor3d-core/src/main/java/com/ardor3d/util/stat/StatCollector.java +++ b/ardor3d-core/src/main/java/com/ardor3d/util/stat/StatCollector.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>. */ @@ -70,9 +70,11 @@ public abstract class StatCollector { /** * Construct a new StatCollector. - * + * * @param sampleRateMS * The amount of time between aggregated samples in milliseconds. + * @param maxHistorical + * the maximum sample count */ public static void init(final long sampleRateMS, final int maxHistorical) { StatCollector.sampleRateMS = sampleRateMS; @@ -224,7 +226,7 @@ public abstract class StatCollector { /** * Add a listener to the pool of listeners that are notified when a new stats aggregate is created (at the end of * each time sample). - * + * * @param listener * the listener to add */ @@ -235,9 +237,10 @@ public abstract class StatCollector { /** * Removes a listener from the pool of listeners that are notified when a new stats aggregate is created (at the end * of each time sample). - * + * * @param listener * the listener to remove + * @return <code>true</code> if the listener has been successfully removed */ public static boolean removeStatListener(final StatListener listener) { return listeners.remove(listener); @@ -252,7 +255,7 @@ public abstract class StatCollector { /** * Add a type to the set of stat types that are paid attention to when doing timed stat checking. - * + * * @param type * the listener to add */ @@ -262,9 +265,10 @@ public abstract class StatCollector { /** * Removes a type from the set of stat types that are paid attention to when doing timed stat checking. - * + * * @param type * the listener to remove + * @return <code>true</code> if the timed stat of this type has been successfully removed */ public static boolean removeTimedStat(final StatType type) { return timedStats.remove(type); @@ -336,7 +340,7 @@ public abstract class StatCollector { /** * Call this if you've caught an error, etc and you need to reset timed stats collecting. - * + * * NOTE: You must ensure you are not inside a START/END timed block, (or you recreate any necessary start calls) * otherwise when endStat is called a stack exception will occur. */ |