aboutsummaryrefslogtreecommitdiffstats
path: root/ardor3d-core/src
diff options
context:
space:
mode:
authorJulien Gouesse <[email protected]>2019-06-14 16:43:00 +0200
committerJulien Gouesse <[email protected]>2019-06-14 16:43:00 +0200
commit84bf6ce230382e5df8fffc95122ed0427ebc7d4d (patch)
tree3d6935f62f78e255bf0a51483f61a9f48e414094 /ardor3d-core/src
parenta73fa0f459ec63b8e2af29001d3c469a3a7b6297 (diff)
Fixes some errors in the Java documentation of ardor3d-core
Diffstat (limited to 'ardor3d-core/src')
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/framework/NativeCanvas.java6
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/renderer/Camera.java102
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/renderer/DrawBufferTarget.java10
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/renderer/Renderer.java108
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/renderer/StereoCamera.java7
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/renderer/TextureRenderer.java34
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/scenegraph/IndexBufferData.java32
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/scenegraph/Mesh.java31
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/scenegraph/MeshData.java15
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/scenegraph/Point.java38
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/scenegraph/Renderable.java5
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/scenegraph/Spatial.java24
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/scenegraph/extension/PassNodeState.java12
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/spline/Curve.java40
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/ui/text/BMText.java5
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/util/AbstractIterator.java5
-rw-r--r--ardor3d-core/src/main/java/com/ardor3d/util/DrawableCamera.java14
17 files changed, 259 insertions, 229 deletions
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 21ef3c7..d593ea4 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/framework/NativeCanvas.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/framework/NativeCanvas.java
@@ -54,18 +54,16 @@ public interface NativeCanvas extends Canvas {
/**
* Sets one or more icons for the Canvas.
- * <p>
+ *
* As a reference for usual platforms on number of icons and their sizes:
* <ul>
* <li>On Windows you should supply at least one 16x16 image and one 32x32.</li>
* <li>Linux (and similar platforms) expect one 32x32 image.</li>
* <li>Mac OS X should be supplied one 128x128 image.</li>
* </ul>
- * </p>
- * <p>
+ *
* Images should be in format RGBA8888. If they are not ardor3d will try to convert them using ImageUtils. If that
* fails a <code>Ardor3dException</code> could be thrown.
- * </p>
*
* @param iconImages
* Array of Images to be used as icons.
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 3012d90..a70212b 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/renderer/Camera.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/Camera.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>.
*/
@@ -258,7 +258,7 @@ public class Camera implements Savable, Externalizable {
/**
* Construct a new Camera with the given frame width and height.
- *
+ *
* @param width
* @param height
*/
@@ -308,7 +308,7 @@ public class Camera implements Savable, Externalizable {
/**
* Construct a new camera, using the given source camera's values.
- *
+ *
* @param source
*/
public Camera(final Camera source) {
@@ -330,7 +330,7 @@ public class Camera implements Savable, Externalizable {
/**
* Copy the source camera's fields to this camera
- *
+ *
* @param source
* the camera to copy from
*/
@@ -374,7 +374,7 @@ public class Camera implements Savable, Externalizable {
}
/**
- * @param depthRangeNear
+ * @param depthRangeFar
* the far clipping plane for window coordinates. Should be in the range [0, 1]. Default is 1.
*/
public void setDepthRangeFar(final double depthRangeFar) {
@@ -412,7 +412,7 @@ public class Camera implements Savable, Externalizable {
}
/**
- * = * @return the value of the far frustum plane.
+ * @return the value of the far frustum plane.
*/
public double getFrustumFar() {
return _frustumFar;
@@ -540,7 +540,7 @@ public class Camera implements Savable, Externalizable {
/**
* Sets the new direction this camera is facing. This does not change left or up axes, so make sure those vectors
* are properly set as well.
- *
+ *
* @param direction
* the new direction this camera is facing.
*/
@@ -552,7 +552,7 @@ public class Camera implements Savable, Externalizable {
/**
* Sets the new left axis of this camera. This does not change direction or up axis, so make sure those vectors are
* properly set as well.
- *
+ *
* @param left
* the new left axis of this camera.
*/
@@ -564,7 +564,7 @@ public class Camera implements Savable, Externalizable {
/**
* Sets the new up axis of this camera. This does not change direction or left axis, so make sure those vectors are
* properly set as well.
- *
+ *
* @param up
* the new up axis of this camera.
*/
@@ -590,7 +590,7 @@ public class Camera implements Savable, Externalizable {
/**
* Sets our left, up and direction values from the given rotation matrix.
- *
+ *
* @param axes
* the matrix that defines the orientation of the camera.
*/
@@ -613,16 +613,22 @@ public class Camera implements Savable, Externalizable {
/**
* Sets the frustum plane values of this camera using the given values.
- *
+ *
* @param near
+ * our near plane value
* @param far
+ * our far plane value
* @param left
+ * our left plane value
* @param right
+ * our right plane value
* @param top
+ * our top plane value
* @param bottom
+ * our bottom plane value
*/
- public void setFrustum(final double near, final double far, final double left, final double right,
- final double top, final double bottom) {
+ public void setFrustum(final double near, final double far, final double left, final double right, final double top,
+ final double bottom) {
_frustumNear = near;
_frustumFar = far;
_frustumLeft = left;
@@ -634,7 +640,7 @@ public class Camera implements Savable, Externalizable {
/**
* Sets the frustum plane values of this camera using those of a given source camera
- *
+ *
* @param source
* a source camera.
*/
@@ -650,7 +656,7 @@ public class Camera implements Savable, Externalizable {
/**
* Sets the frustum plane values of this camera using the given perspective values.
- *
+ *
* @param fovY
* the full angle of view on the Y axis, in degrees.
* @param aspect
@@ -680,7 +686,7 @@ public class Camera implements Savable, Externalizable {
/**
* Accessor for the fovY value. Note that this value is only present if setFrustumPerspective was previously called.
- *
+ *
* @return the fovY value
*/
public double getFovY() {
@@ -690,11 +696,15 @@ public class Camera implements Savable, Externalizable {
/**
* Sets the axes and location of the camera. Similar to
* {@link #setAxes(ReadOnlyVector3, ReadOnlyVector3, ReadOnlyVector3)}, but sets camera location as well.
- *
+ *
* @param location
+ * the point position of the camera
* @param left
+ * the left vector of the camera's orientation
* @param up
+ * the up vector of the camera's orientation
* @param direction
+ * the direction vector of the camera's orientation
*/
public void setFrame(final ReadOnlyVector3 location, final ReadOnlyVector3 left, final ReadOnlyVector3 up,
final ReadOnlyVector3 direction) {
@@ -708,7 +718,7 @@ public class Camera implements Savable, Externalizable {
/**
* Sets the axes and location of the camera. Similar to {@link #setAxes(ReadOnlyMatrix3)}, but sets camera location
* as well.
- *
+ *
* @param location
* the point position of the camera.
* @param axes
@@ -724,7 +734,7 @@ public class Camera implements Savable, Externalizable {
/**
* Sets the axes and location of the camera using those of a given source camera
- *
+ *
* @param source
* a source camera.
*/
@@ -740,7 +750,7 @@ public class Camera implements Savable, Externalizable {
* A convenience method for auto-setting the frame based on a world position the user desires the camera to look at.
* It points the camera towards the given position using the difference between that position and the current camera
* location as a direction vector and the general worldUpVector to compute up and left camera vectors.
- *
+ *
* @param pos
* where to look at in terms of world coordinates
* @param worldUpVector
@@ -755,7 +765,7 @@ public class Camera implements Savable, Externalizable {
* A convenience method for auto-setting the frame based on a world position the user desires the camera to look at.
* It points the camera towards the given position using the difference between that position and the current camera
* location as a direction vector and the general worldUpVector to compute up and left camera vectors.
- *
+ *
* @param x
* where to look at in terms of world coordinates (x)
* @param y
@@ -885,11 +895,15 @@ public class Camera implements Savable, Externalizable {
/**
* Sets the boundaries of this camera's viewport to the given values
- *
+ *
* @param left
+ * the new left boundary of the viewport
* @param right
+ * the new right boundary of the viewport
* @param bottom
+ * the new bottom boundary of the viewport
* @param top
+ * the new top boundary of the viewport
*/
public void setViewPort(final double left, final double right, final double bottom, final double top) {
setViewPortLeft(left);
@@ -901,7 +915,7 @@ public class Camera implements Savable, Externalizable {
/**
* Checks a bounding volume against the planes of this camera's frustum and returns if it is completely inside of,
* outside of, or intersecting.
- *
+ *
* @param bound
* the bound to check for culling
* @return intersection type
@@ -944,7 +958,7 @@ public class Camera implements Savable, Externalizable {
/**
* Resizes this camera's view with the given width and height.
- *
+ *
* @param width
* the view width
* @param height
@@ -1031,8 +1045,8 @@ public class Camera implements Savable, Externalizable {
planeNormal.setX(_left.getX() * _coeffLeft[0]);
planeNormal.setY(_left.getY() * _coeffLeft[0]);
planeNormal.setZ(_left.getZ() * _coeffLeft[0]);
- planeNormal.addLocal(_direction.getX() * _coeffLeft[1], _direction.getY() * _coeffLeft[1], _direction.getZ()
- * _coeffLeft[1]);
+ planeNormal.addLocal(_direction.getX() * _coeffLeft[1], _direction.getY() * _coeffLeft[1],
+ _direction.getZ() * _coeffLeft[1]);
_worldPlane[LEFT_PLANE].setNormal(planeNormal);
_worldPlane[LEFT_PLANE].setConstant(_location.dot(planeNormal));
@@ -1040,8 +1054,8 @@ public class Camera implements Savable, Externalizable {
planeNormal.setX(_left.getX() * _coeffRight[0]);
planeNormal.setY(_left.getY() * _coeffRight[0]);
planeNormal.setZ(_left.getZ() * _coeffRight[0]);
- planeNormal.addLocal(_direction.getX() * _coeffRight[1], _direction.getY() * _coeffRight[1], _direction.getZ()
- * _coeffRight[1]);
+ planeNormal.addLocal(_direction.getX() * _coeffRight[1], _direction.getY() * _coeffRight[1],
+ _direction.getZ() * _coeffRight[1]);
_worldPlane[RIGHT_PLANE].setNormal(planeNormal);
_worldPlane[RIGHT_PLANE].setConstant(_location.dot(planeNormal));
@@ -1058,8 +1072,8 @@ public class Camera implements Savable, Externalizable {
planeNormal.setX(_up.getX() * _coeffTop[0]);
planeNormal.setY(_up.getY() * _coeffTop[0]);
planeNormal.setZ(_up.getZ() * _coeffTop[0]);
- planeNormal.addLocal(_direction.getX() * _coeffTop[1], _direction.getY() * _coeffTop[1], _direction.getZ()
- * _coeffTop[1]);
+ planeNormal.addLocal(_direction.getX() * _coeffTop[1], _direction.getY() * _coeffTop[1],
+ _direction.getZ() * _coeffTop[1]);
_worldPlane[TOP_PLANE].setNormal(planeNormal);
_worldPlane[TOP_PLANE].setConstant(_location.dot(planeNormal));
@@ -1192,7 +1206,7 @@ public class Camera implements Savable, Externalizable {
/**
* Calculate a Pick Ray using the given screen position at the near plane of this camera and the camera's position
* in space.
- *
+ *
* @param screenPosition
* the x, y position on the near space to pass the ray through.
* @param flipVertical
@@ -1227,7 +1241,7 @@ public class Camera implements Savable, Externalizable {
/**
* Converts a local x,y screen position and depth value to world coordinates based on the current settings of this
* camera.
- *
+ *
* @param screenPosition
* the x,y coordinates of the screen position
* @param zDepth
@@ -1242,7 +1256,7 @@ public class Camera implements Savable, Externalizable {
/**
* Converts a local x,y screen position and depth value to world coordinates based on the current settings of this
* camera.
- *
+ *
* @param screenPosition
* the x,y coordinates of the screen position
* @param zDepth
@@ -1275,7 +1289,7 @@ public class Camera implements Savable, Externalizable {
/**
* Converts a position in world coordinate space to an x,y screen position and depth value using the current
* settings of this camera.
- *
+ *
* @param worldPos
* the position in space to retrieve screen coordinates for.
* @return a new vector containing the screen coordinates as x and y and the distance as a percent between near and
@@ -1288,8 +1302,8 @@ public class Camera implements Savable, Externalizable {
/**
* Converts a position in world coordinate space to an x,y screen position and depth value using the current
* settings of this camera.
- *
- * @param worldPos
+ *
+ * @param worldPosition
* the position in space to retrieve screen coordinates for.
* @param store
* Use to avoid object creation. if not null, the results are stored in the given vector and returned.
@@ -1310,7 +1324,7 @@ public class Camera implements Savable, Externalizable {
/**
* Converts a position in world coordinate space to a x,y,z frustum position using the current settings of this
* camera.
- *
+ *
* @param worldPos
* the position in space to retrieve frustum coordinates for.
* @return a new vector containing the x,y,z frustum position
@@ -1322,8 +1336,8 @@ public class Camera implements Savable, Externalizable {
/**
* Converts a position in world coordinate space to a x,y,z frustum position using the current settings of this
* camera.
- *
- * @param worldPos
+ *
+ * @param worldPosition
* the position in space to retrieve frustum coordinates for.
* @param store
* Use to avoid object creation. if not null, the results are stored in the given vector and returned.
@@ -1427,7 +1441,7 @@ public class Camera implements Savable, Externalizable {
/**
* Apply this camera's values to the given Renderer. Only values determined to be dirty (via updates, setters, etc.)
* will be applied. This method must be run in the same thread as a valid OpenGL context.
- *
+ *
* @param renderer
* the Renderer to use.
*/
@@ -1460,7 +1474,7 @@ public class Camera implements Savable, Externalizable {
/**
* Apply the camera's projection matrix using the given Renderer.
- *
+ *
* @param renderer
* the Renderer to use.
*/
@@ -1473,7 +1487,7 @@ public class Camera implements Savable, Externalizable {
/**
* Apply the camera's viewport using the given Renderer.
- *
+ *
* @param renderer
* the Renderer to use.
*/
@@ -1487,7 +1501,7 @@ public class Camera implements Savable, Externalizable {
/**
* Apply the camera's modelview matrix using the given Renderer.
- *
+ *
* @param renderer
* the Renderer to use.
*/
@@ -1621,7 +1635,7 @@ public class Camera implements Savable, Externalizable {
/**
* Convenience method for retrieving the Camera set on the current RenderContext. Similar to
* ContextManager.getCurrentContext().getCurrentCamera() but with null checks for current context.
- *
+ *
* @return the Camera on the current RenderContext.
*/
public static Camera getCurrentCamera() {
diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/DrawBufferTarget.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/DrawBufferTarget.java
index 5818377..f093019 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/renderer/DrawBufferTarget.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/DrawBufferTarget.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>.
*/
@@ -64,25 +64,25 @@ public enum DrawBufferTarget {
/**
* Auxiliary color buffer 0. Should check first that {@link ContextCapabilities#getNumberOfAuxiliaryDrawBuffers()}
- * >= 1.
+ * &gt;= 1.
*/
Aux0,
/**
* Auxiliary color buffer 1. Should check first that {@link ContextCapabilities#getNumberOfAuxiliaryDrawBuffers()}
- * >= 2.
+ * &gt;= 2.
*/
Aux1,
/**
* Auxiliary color buffer 2. Should check first that {@link ContextCapabilities#getNumberOfAuxiliaryDrawBuffers()}
- * >= 3.
+ * &gt;= 3.
*/
Aux2,
/**
* Auxiliary color buffer 3. Should check first that {@link ContextCapabilities#getNumberOfAuxiliaryDrawBuffers()}
- * >= 4.
+ * &gt;= 4.
*/
Aux3;
}
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 bad2af3..7831d2c 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/renderer/Renderer.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/Renderer.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 @@ import com.ardor3d.util.Ardor3dException;
/**
* <code>Renderer</code> defines an interface for classes that handle displaying of graphics data to a render context.
- *
+ *
* All rendering state and tasks should be handled through this class.
*/
public interface Renderer {
@@ -72,7 +72,7 @@ public interface Renderer {
/**
* <code>setBackgroundColor</code> sets the color of window. This color will be shown for any pixel that is not set
* via typical rendering operations.
- *
+ *
* @param c
* the color to set the background to.
*/
@@ -80,14 +80,14 @@ public interface Renderer {
/**
* <code>getBackgroundColor</code> retrieves the clear color of the current OpenGL context.
- *
+ *
* @return the current clear color.
*/
ReadOnlyColorRGBA getBackgroundColor();
/**
- * <code>clearBuffers</code> clears the given buffers (specified as a bitwise &).
- *
+ * <code>clearBuffers</code> clears the given buffers (specified as a bitwise &amp;).
+ *
* @param buffers
* the buffers to clear.
* @see #BUFFER_COLOR
@@ -98,8 +98,8 @@ public interface Renderer {
void clearBuffers(int buffers);
/**
- * <code>clearBuffers</code> clears the given buffers (specified as a bitwise &).
- *
+ * <code>clearBuffers</code> clears the given buffers (specified as a bitwise &amp;).
+ *
* @param buffers
* the buffers to clear.
* @param strict
@@ -114,7 +114,7 @@ public interface Renderer {
/**
* <code>flushFrame</code> handles rendering any items still remaining in the render buckets and optionally swaps
* the back buffer with the currently displayed buffer.
- *
+ *
* @param doSwap
* if true, will ask the underlying implementation to blit the back buffer contents to the display
* buffer. Usually this will be true, unless you are in a windowing toolkit that handles doing this for
@@ -123,19 +123,19 @@ public interface Renderer {
void flushFrame(boolean doSwap);
/**
- *
+ *
* <code>setOrtho</code> sets the display system to be in orthographic mode. If the system has already been set to
* orthographic mode a <code>Ardor3dException</code> is thrown. The origin (0,0) is the bottom left of the screen.
- *
+ *
*/
void setOrtho();
/**
- *
+ *
* <code>unsetOrhto</code> unsets the display system from orthographic mode back into regular projection mode. If
* the system is not in orthographic mode a <code>Ardor3dException</code> is thrown.
- *
- *
+ *
+ *
*/
void unsetOrtho();
@@ -151,7 +151,7 @@ public interface Renderer {
/**
* render queues
- *
+ *
* @param doSort
* if true, the queues will be sorted prior to rendering.
* @param doClear
@@ -167,7 +167,7 @@ public interface Renderer {
/**
* <code>grabScreenContents</code> reads a block of data as bytes from the current framebuffer. The format
* determines how many bytes per pixel are read and thus how big the buffer must be that you pass in.
- *
+ *
* @param store
* a buffer to store contents in.
* @param format
@@ -183,12 +183,12 @@ public interface Renderer {
*/
void grabScreenContents(ByteBuffer store, ImageDataFormat format, int x, int y, int w, int h);
- void grabScreenContents(final ByteBuffer store, final ImageDataFormat format, final PixelDataType type,
- final int x, final int y, final int w, final int h);
+ void grabScreenContents(final ByteBuffer store, final ImageDataFormat format, final PixelDataType type, final int x,
+ final int y, final int w, final int h);
/**
* Gets the expected size (in bytes) of the buffer used to call <code>grabScreenContents</code>
- *
+ *
* @param format
* the format to read in data for.
* @param type
@@ -205,7 +205,7 @@ public interface Renderer {
/**
* <code>draw</code> renders a scene. As it receives a base class of <code>Spatial</code> the renderer hands off
* management of the scene to spatial for it to determine when a <code>Geometry</code> leaf is reached.
- *
+ *
* @param s
* the scene to render.
*/
@@ -224,21 +224,21 @@ public interface Renderer {
/**
* Get the render queue associated with this Renderer.
- *
+ *
* @return RenderQueue
*/
RenderQueue getQueue();
/**
* Return true if this renderer is in the middle of processing its RenderQueue.
- *
+ *
* @return boolean
*/
boolean isProcessingQueue();
/**
* Check a given Spatial to see if it should be queued. return true if it was queued.
- *
+ *
* @param s
* Spatial to check
* @return true if it was queued.
@@ -246,16 +246,17 @@ public interface Renderer {
boolean checkAndAdd(Spatial s);
/**
- * Attempts to delete the VBOs with the given id. Ignores null ids or ids < 1.
- *
+ * Attempts to delete the VBOs with the given id. Ignores null ids or ids &lt; 1.
+ *
* @param ids
*/
void deleteVBOs(Collection<Integer> ids);
/**
* Attempts to delete any VBOs associated with this buffer that are relevant to the current RenderContext.
- *
- * @param ids
+ *
+ * @param buffer
+ * the buffer data
*/
void deleteVBOs(AbstractBufferData<?> buffer);
@@ -266,7 +267,7 @@ public interface Renderer {
/**
* Update all or a portion of an existing one dimensional texture object.
- *
+ *
* @param destination
* the texture to update. Should already have been sent to the card (have a valid texture id.)
* @param dstOffsetX
@@ -278,11 +279,12 @@ public interface Renderer {
* @param srcOffsetX
* the optional offset into our source data.
*/
- void updateTexture1DSubImage(Texture1D destination, int dstOffsetX, int dstWidth, ByteBuffer source, int srcOffsetX);
+ void updateTexture1DSubImage(Texture1D destination, int dstOffsetX, int dstWidth, ByteBuffer source,
+ int srcOffsetX);
/**
* Update all or a portion of an existing two dimensional texture object.
- *
+ *
* @param destination
* the texture to update. Should already have been sent to the card (have a valid texture id.)
* @param dstOffsetX
@@ -307,7 +309,7 @@ public interface Renderer {
/**
* Update all or a portion of an existing one dimensional texture object.
- *
+ *
* @param destination
* the texture to update. Should already have been sent to the card (have a valid texture id.)
* @param dstOffsetX
@@ -341,7 +343,7 @@ public interface Renderer {
/**
* Update all or a portion of a single two dimensional face on an existing cubemap texture object.
- *
+ *
* @param destination
* the texture to update. Should already have been sent to the card (have a valid texture id.)
* @param dstFace
@@ -369,7 +371,7 @@ public interface Renderer {
/**
* Check the underlying rendering system (opengl, etc.) for exceptions.
- *
+ *
* @throws Ardor3dException
* if an error is found.
*/
@@ -377,7 +379,7 @@ public interface Renderer {
/**
* <code>draw</code> renders the renderable to the back buffer.
- *
+ *
* @param renderable
* the text object to be rendered.
*/
@@ -385,7 +387,7 @@ public interface Renderer {
/**
* <code>doTransforms</code> sets the current transform.
- *
+ *
* @param transform
* transform to apply.
*/
@@ -393,7 +395,7 @@ public interface Renderer {
/**
* <code>undoTransforms</code> reverts the latest transform.
- *
+ *
* @param transform
* transform to revert.
*/
@@ -441,9 +443,10 @@ public interface Renderer {
/**
* Gets the current projection 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.
+ * The buffer to store in. If null or remaining is &lt; 16, a new FloatBuffer will be created and
+ * returned.
* @return
*/
FloatBuffer getProjectionMatrix(FloatBuffer store);
@@ -452,9 +455,10 @@ public interface Renderer {
/**
* Gets the current modelview 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.
+ * The buffer to store in. If null or remaining is &lt; 16, a new FloatBuffer will be created and
+ * returned.
* @return
*/
FloatBuffer getModelViewMatrix(FloatBuffer store);
@@ -465,7 +469,7 @@ public interface Renderer {
/**
* Specify which color buffers are to be drawn into.
- *
+ *
* @param target
*/
void setDrawBuffer(DrawBufferTarget target);
@@ -473,7 +477,7 @@ public interface Renderer {
/**
* This is a workaround until we make shared Record classes, or open up lower level opengl calls abstracted from
* jogl.
- *
+ *
* @param lineWidth
* @param stippleFactor
* @param stipplePattern
@@ -484,7 +488,7 @@ public interface Renderer {
/**
* This is a workaround until we make shared Record classes, or open up lower level opengl calls abstracted from
* jogl.
- *
+ *
* @param pointSize
* @param antialiased
* @param isSprite
@@ -498,7 +502,7 @@ public interface Renderer {
/**
* Apply the given state to the current RenderContext using this Renderer.
- *
+ *
* @param type
* the state type
* @param state
@@ -509,7 +513,7 @@ public interface Renderer {
/**
* Start a new display list. All further renderer commands that can be stored in a display list are part of this new
* list until {@link #endDisplayList()} is called.
- *
+ *
* @return id of new display list
*/
int startDisplayList();
@@ -521,7 +525,7 @@ public interface Renderer {
/**
* Loads a texture onto the card for the current OpenGL context.
- *
+ *
* @param texture
* the texture obejct to load.
* @param unit
@@ -533,7 +537,7 @@ public interface Renderer {
* Explicitly remove this Texture from the graphics card. Note, the texture is only removed for the current context.
* If the texture is used in other contexts, those uses are not touched. If the texture is not used in this context,
* this is a no-op.
- *
+ *
* @param texture
* the Texture object to remove.
*/
@@ -541,7 +545,7 @@ public interface Renderer {
/**
* Removes the given texture ids from the current OpenGL context.
- *
+ *
* @param ids
* a list/set of ids to remove.
*/
@@ -549,8 +553,8 @@ public interface Renderer {
/**
* Removes the given display lists by id from the current OpenGL context.
- *
- * @param ids
+ *
+ * @param collection
* a list/set of ids to remove.
*/
void deleteDisplayLists(Collection<Integer> collection);
@@ -558,7 +562,7 @@ public interface Renderer {
/**
* Add the given rectangle to the clip stack, clipping the rendering area by the given rectangle intersected with
* any existing scissor entries. Enable clipping if this is the first rectangle in the stack.
- *
+ *
* @param rectangle
*/
void pushClip(ReadOnlyRectangle2 rectangle);
@@ -601,7 +605,7 @@ public interface Renderer {
/**
* Set rendering logic that will be called during drawing of renderables
- *
+ *
* @param logic
* logic to use in rendering. call with null to reset rendering.
* @see RenderLogic
diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/StereoCamera.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/StereoCamera.java
index fa4d2ba..ef0da6b 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/renderer/StereoCamera.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/StereoCamera.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>.
*/
@@ -34,10 +34,11 @@ public class StereoCamera extends Camera {
}
/**
- *
+ *
* @param width
+ * the width
* @param height
- * @param sideBySideMode
+ * the height
*/
public StereoCamera(final int width, final int height) {
super(width, height);
diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/TextureRenderer.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/TextureRenderer.java
index 41b334b..5bf36b3 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/renderer/TextureRenderer.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/TextureRenderer.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>.
*/
@@ -29,13 +29,13 @@ public interface TextureRenderer {
/**
* <code>getCamera</code> retrieves the camera this renderer is using.
- *
+ *
* @return the camera this renderer is using.
*/
Camera getCamera();
/**
- *
+ *
* @param scene
* the scene to render.
* @param tex
@@ -50,7 +50,7 @@ public interface TextureRenderer {
/**
* NOTE: If more than one texture is given, copy-texture is used regardless of card capabilities to decrease render
* time.
- *
+ *
* @param scene
* the scene to render.
* @param texs
@@ -63,7 +63,7 @@ public interface TextureRenderer {
void render(Scene scene, List<Texture> texs, int clear);
/**
- *
+ *
* @param spat
* the scene to render.
* @param tex
@@ -78,7 +78,7 @@ public interface TextureRenderer {
/**
* NOTE: If more than one texture is given, copy-texture is used regardless of card capabilities to decrease render
* time.
- *
+ *
* @param spat
* the scene to render.
* @param texs
@@ -93,7 +93,7 @@ public interface TextureRenderer {
/**
* NOTE: If more than one texture is given, copy-texture is used regardless of card capabilities to decrease render
* time.
- *
+ *
* @param spats
* an array of Spatials to render.
* @param tex
@@ -108,7 +108,7 @@ public interface TextureRenderer {
/**
* NOTE: If more than one texture is given, copy-texture is used regardless of card capabilities to decrease render
* time.
- *
+ *
* @param spats
* an array of Spatials to render.
* @param texs
@@ -123,7 +123,7 @@ public interface TextureRenderer {
/**
* <code>setBackgroundColor</code> sets the color of window. This color will be shown for any pixel that is not set
* via typical rendering operations.
- *
+ *
* @param c
* the color to set the background to.
*/
@@ -131,7 +131,7 @@ public interface TextureRenderer {
/**
* <code>getBackgroundColor</code> retrieves the color used for the window background.
- *
+ *
* @return the background color that is currently set to the background.
*/
ReadOnlyColorRGBA getBackgroundColor();
@@ -139,9 +139,9 @@ public interface TextureRenderer {
/**
* <code>setupTexture</code> initializes a Texture object for use with TextureRenderer. Generates a valid gl texture
* id for this texture and sets up data storage for it. The texture will be equal to the texture renderer's size.
- *
+ *
* Note that the texture renderer's size is not necessarily what is specified in the constructor.
- *
+ *
* @param tex
* The texture to setup for use in Texture Rendering. This should be of type Texture2D or TextureCubeMap.
*/
@@ -150,9 +150,9 @@ public interface TextureRenderer {
/**
* <code>copyToTexture</code> copies the current frame buffer contents to the given Texture. What is copied is based
* on the rttFormat of the texture object when it was setup. Note that the contents are copied with no scaling
- * applied, so the texture must be big enough such that xoffset + width <= texture's width and yoffset + height <=
- * texture's height.
- *
+ * applied, so the texture must be big enough such that xoffset + width &lt;= texture's width and yoffset + height
+ * &lt;= texture's height.
+ *
* @param tex
* The Texture to copy into. This should be a Texture2D or TextureCubeMap. If the latter, its
* currentRTTFace will determine which cube face is drawn to.
@@ -179,7 +179,7 @@ public interface TextureRenderer {
/**
* Set up this textureRenderer for use with multiple targets. If you are going to use this texture renderer to
* render to more than one texture, call this with true.
- *
+ *
* @param multi
* true if you plan to use this texture renderer to render different content to more than one texture.
*/
@@ -192,7 +192,7 @@ public interface TextureRenderer {
/**
* Enforce a particular state whenever this texture renderer is used. In other words, the given state will override
* any state of the same type set on a scene object rendered with this texture renderer.
- *
+ *
* @param state
* state to enforce
*/
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 1b4654e..bc0c609 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/IndexBufferData.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/IndexBufferData.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>.
*/
@@ -37,7 +37,7 @@ public abstract class IndexBufferData<T extends Buffer> extends AbstractBufferDa
/**
* Sets the value of this buffer at the current position, incrementing our position by 1 entry.
- *
+ *
* @param value
* the value to place into this object at the current position.
* @return this object, for chaining.
@@ -46,7 +46,7 @@ public abstract class IndexBufferData<T extends Buffer> extends AbstractBufferDa
/**
* Sets the value of this buffer at the given index.
- *
+ *
* @param index
* the absolute position to put our value at. This is in entries, not bytes, and is 0 based. So for a
* ShortBuffer, 2 would be the 3rd short from the beginning, etc.
@@ -59,7 +59,7 @@ public abstract class IndexBufferData<T extends Buffer> extends AbstractBufferDa
/**
* Write the contents of the given IndexBufferData into this one. Note that data conversion is handled using the
* get/put methods in IndexBufferData.
- *
+ *
* @param buf
* the source buffer object.
*/
@@ -68,7 +68,7 @@ public abstract class IndexBufferData<T extends Buffer> extends AbstractBufferDa
/**
* Write the contents of the given int array into this IndexBufferData. Note that data conversion is handled using
* the get/put methods in IndexBufferData.
- *
+ *
* @param array
* the source int array.
*/
@@ -77,7 +77,7 @@ public abstract class IndexBufferData<T extends Buffer> extends AbstractBufferDa
/**
* Write the contents of the given int array into this IndexBufferData. Note that data conversion is handled using
* the get/put methods in IndexBufferData.
- *
+ *
* @param array
* the source int array.
* @param offset
@@ -92,70 +92,70 @@ public abstract class IndexBufferData<T extends Buffer> extends AbstractBufferDa
public abstract T getBuffer();
/**
- * @see Buffer#remaining();
+ * @see Buffer#remaining()
*/
public int remaining() {
return getBuffer().remaining();
}
/**
- * @see Buffer#position();
+ * @see Buffer#position()
*/
public int position() {
return getBuffer().position();
}
/**
- * @see Buffer#position(int);
+ * @see Buffer#position(int)
*/
public void position(final int position) {
getBuffer().position(position);
}
/**
- * @see Buffer#limit();
+ * @see Buffer#limit()
*/
public int limit() {
return getBuffer().limit();
}
/**
- * @see Buffer#limit(int);
+ * @see Buffer#limit(int)
*/
public void limit(final int limit) {
getBuffer().limit(limit);
}
/**
- * @see Buffer#capacity();
+ * @see Buffer#capacity()
*/
public int capacity() {
return getBuffer().capacity();
}
/**
- * @see Buffer#rewind();
+ * @see Buffer#rewind()
*/
public void rewind() {
getBuffer().rewind();
}
/**
- * @see Buffer#flip();
+ * @see Buffer#flip()
*/
public void flip() {
getBuffer().flip();
}
/**
- * @see Buffer#clear();
+ * @see Buffer#clear()
*/
public void clear() {
getBuffer().clear();
}
/**
- * @see Buffer#reset();
+ * @see Buffer#reset()
*/
public void reset() {
getBuffer().reset();
diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Mesh.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Mesh.java
index 18a6086..bb67fac 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Mesh.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Mesh.java
@@ -66,8 +66,7 @@ public class Mesh extends Spatial implements Renderable, Pickable {
* The compiled list of renderstates for this mesh, taking into account ancestors states - updated with
* updateRenderStates()
*/
- protected final EnumMap<RenderState.StateType, RenderState> _states = new EnumMap<>(
- RenderState.StateType.class);
+ protected final EnumMap<RenderState.StateType, RenderState> _states = new EnumMap<>(RenderState.StateType.class);
/** The compiled lightState for this mesh */
protected transient LightState _lightState;
@@ -119,8 +118,7 @@ public class Mesh extends Spatial implements Renderable, Pickable {
/**
* Retrieves the local bounding volume for this mesh.
*
- * @param store
- * the bounding volume
+ * @return the local bounding volume for this mesh
*/
public BoundingVolume getModelBound() {
return _modelBound;
@@ -131,6 +129,7 @@ public class Mesh extends Spatial implements Renderable, Pickable {
*
* @param store
* the bounding volume
+ * @return a copy of the local bounding volume for this mesh
*/
public BoundingVolume getModelBound(final BoundingVolume store) {
if (_modelBound == null) {
@@ -248,8 +247,8 @@ public class Mesh extends Spatial implements Renderable, Pickable {
public void render(final Renderer renderer, final MeshData meshData) {
// Set up MeshData in GLSLShaderObjectsState if necessary
// XXX: considered a hack until we settle on our shader model.
- final GLSLShaderObjectsState glsl = (GLSLShaderObjectsState) renderer.getProperRenderState(
- RenderState.StateType.GLSLShader, _states.get(RenderState.StateType.GLSLShader));
+ final GLSLShaderObjectsState glsl = (GLSLShaderObjectsState) renderer
+ .getProperRenderState(RenderState.StateType.GLSLShader, _states.get(RenderState.StateType.GLSLShader));
if (glsl != null && glsl.getShaderDataLogic() != null) {
glsl.setMesh(this);
@@ -268,8 +267,8 @@ public class Mesh extends Spatial implements Renderable, Pickable {
}
}
- final boolean useVBO = (getSceneHints().getDataMode() == DataMode.VBO || getSceneHints().getDataMode() == DataMode.VBOInterleaved)
- && caps.isVBOSupported();
+ final boolean useVBO = (getSceneHints().getDataMode() == DataMode.VBO
+ || getSceneHints().getDataMode() == DataMode.VBOInterleaved) && caps.isVBOSupported();
if (instancing == null) {
final boolean transformed = renderer.doTransforms(_worldTransform);
@@ -464,6 +463,7 @@ public class Mesh extends Spatial implements Renderable, Pickable {
* <code>setDefaultColor</code> sets the color to be used if no per vertex color buffer is set.
*
* @param color
+ * the default color to set
*/
public void setDefaultColor(final ReadOnlyColorRGBA color) {
_defaultColor.set(color);
@@ -473,9 +473,13 @@ public class Mesh extends Spatial implements Renderable, Pickable {
* <code>setDefaultColor</code> sets the color to be used if no per vertex color buffer is set.
*
* @param r
+ * the red component of the default color to set
* @param g
+ * the green component of the default color to set
* @param b
+ * the blue component of the default color to set
* @param a
+ * the alpha component of the default color to set
*/
public void setDefaultColor(final float r, final float g, final float b, final float a) {
_defaultColor.set(r, g, b, a);
@@ -483,8 +487,7 @@ public class Mesh extends Spatial implements Renderable, Pickable {
/**
*
- * @param store
- * @return
+ * @return the default color
*/
public ReadOnlyColorRGBA getDefaultColor() {
return _defaultColor;
@@ -727,12 +730,12 @@ public class Mesh extends Spatial implements Renderable, Pickable {
BufferUtils.copy(meshData.getVertexBuffer(), i * verts.getValuesPerTuple(), verts.getBuffer(),
vert * verts.getValuesPerTuple(), verts.getValuesPerTuple());
if (norms != null) {
- BufferUtils.copy(meshData.getNormalBuffer(), i * norms.getValuesPerTuple(), norms.getBuffer(), vert
- * norms.getValuesPerTuple(), norms.getValuesPerTuple());
+ BufferUtils.copy(meshData.getNormalBuffer(), i * norms.getValuesPerTuple(), norms.getBuffer(),
+ vert * norms.getValuesPerTuple(), norms.getValuesPerTuple());
}
if (colors != null) {
- BufferUtils.copy(meshData.getColorBuffer(), i * colors.getValuesPerTuple(), colors.getBuffer(), vert
- * colors.getValuesPerTuple(), colors.getValuesPerTuple());
+ BufferUtils.copy(meshData.getColorBuffer(), i * colors.getValuesPerTuple(), colors.getBuffer(),
+ vert * colors.getValuesPerTuple(), colors.getValuesPerTuple());
}
if (fogs != null) {
BufferUtils.copy(meshData.getFogBuffer(), i * fogs.getValuesPerTuple(), fogs.getBuffer(),
diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/MeshData.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/MeshData.java
index 7a86fb3..c195339 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/MeshData.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/MeshData.java
@@ -514,7 +514,8 @@ public class MeshData implements Savable {
* @param factorT
* a multiple to apply to the T channel when copying
*/
- public void copyTextureCoordinates(final int fromIndex, final int toIndex, final float factorS, final float factorT) {
+ public void copyTextureCoordinates(final int fromIndex, final int toIndex, final float factorS,
+ final float factorT) {
if (_textureCoords == null) {
return;
}
@@ -768,8 +769,8 @@ public class MeshData implements Savable {
* @param section
* which section to pull from (corresponds to array position in indexmodes and lengths)
* @param store
- * an int array to store the results in. if null, or the length < the size of the primitive, a new array
- * is created and returned.
+ * an int array to store the results in. if null, or the length &lt; the size of the primitive, a new
+ * array is created and returned.
*
* @return the primitive's vertex indices as an array
*
@@ -839,8 +840,8 @@ public class MeshData implements Savable {
getIndices().get(getVertexIndex(primitiveIndex, i, section)));
} else {
// non-indexed geometry
- BufferUtils
- .populateFromBuffer(result[i], getVertexBuffer(), getVertexIndex(primitiveIndex, i, section));
+ BufferUtils.populateFromBuffer(result[i], getVertexBuffer(),
+ getVertexIndex(primitiveIndex, i, section));
}
}
@@ -867,8 +868,8 @@ public class MeshData implements Savable {
if (getTextureBuffer(textureIndex) != null) {
final int count = getPrimitiveCount(section);
if (primitiveIndex >= count || primitiveIndex < 0) {
- throw new IndexOutOfBoundsException("Invalid primitiveIndex '" + primitiveIndex + "'. Count is "
- + count);
+ throw new IndexOutOfBoundsException(
+ "Invalid primitiveIndex '" + primitiveIndex + "'. Count is " + count);
}
final IndexMode mode = getIndexMode(section);
final int rSize = mode.getVertexCount();
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 6fac9d2..a4fcfd7 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Point.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Point.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,8 +41,8 @@ public class Point extends Mesh {
* Distance Attenuation fields.
*/
// JOGL works fine with 3.
- private final FloatBuffer _attenuationCoefficients = BufferUtils.createFloatBuffer(new float[] { 0.0f, 0f,
- 0.000004f, 0f });
+ private final FloatBuffer _attenuationCoefficients = BufferUtils
+ .createFloatBuffer(new float[] { 0.0f, 0f, 0.000004f, 0f });
private float _minPointSize = 1.0f;
private float _maxPointSize = 64.0f;
private boolean _useDistanceAttenuation = false;
@@ -59,7 +59,7 @@ public class Point extends Mesh {
/**
* Constructor instantiates a new <code>Point</code> object with a given set of data. Any data may be null, except
* the vertex array. If this is null an exception is thrown.
- *
+ *
* @param name
* the name of the scene element. This is required for identification and comparison purposes.
* @param vertex
@@ -82,7 +82,7 @@ public class Point extends Mesh {
/**
* Constructor instantiates a new <code>Point</code> object with a given set of data. Any data may be null, except
* the vertex array. If this is null an exception is thrown.
- *
+ *
* @param name
* the name of the scene element. This is required for identification and comparison purposes.
* @param vertex
@@ -103,7 +103,7 @@ public class Point extends Mesh {
/**
* Initialize the meshdata object with data.
- *
+ *
* @param vertices
* @param normals
* @param colors
@@ -123,7 +123,7 @@ public class Point extends Mesh {
/**
* Default attenuation coefficient is calculated to work best with pointSize = 1.
- *
+ *
* @param bool
*/
public void enableDistanceAttenuation(final boolean bool) {
@@ -143,7 +143,7 @@ public class Point extends Mesh {
* Derived Size = 1/(0.000004*500^2) = 1<br>
* 2. A size of 25 pixel at distance of 100 units.<br>
* 3. A size of 2500 at a distance of 10 units.<br>
- *
+ *
* @see <a href="http://www.opengl.org/registry/specs/ARB/point_parameters.txt">OpenGL specification</a>
* @param a
* constant term in the attenuation equation
@@ -169,7 +169,7 @@ public class Point 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.
*/
@@ -195,7 +195,7 @@ public class Point extends Mesh {
/**
* Sets the pixel width of the point when drawn. Non anti-aliased point sizes are rounded to the nearest whole
* number by opengl.
- *
+ *
* @param size
* The size to set.
*/
@@ -205,7 +205,7 @@ public class Point extends Mesh {
/**
* When DistanceAttenuation is enabled, the points maximum size will get clamped to this value.
- *
+ *
* @param maxSize
*/
public void setMaxPointSize(final float maxSize) {
@@ -213,9 +213,7 @@ public class Point extends Mesh {
}
/**
- * When DistanceAttenuation is enabled, the points maximum size will get clamped to this value.
- *
- * @param maxSize
+ * @return the points maximum size
*/
public float getMaxPointSize() {
return _maxPointSize;
@@ -223,17 +221,15 @@ public class Point extends Mesh {
/**
* When DistanceAttenuation is enabled, the points minimum size will get clamped to this value.
- *
- * @param maxSize
+ *
+ * @param minSize
*/
public void setMinPointSize(final float minSize) {
_minPointSize = minSize;
}
/**
- * When DistanceAttenuation is enabled, the points minimum size will get clamped to this value.
- *
- * @param maxSize
+ * @return the points minimum size
*/
public float getMinPointSize() {
return _minPointSize;
@@ -241,7 +237,7 @@ public class Point extends Mesh {
/**
* Used with Serialization. Do not call this directly.
- *
+ *
* @param s
* @throws IOException
* @see java.io.Serializable
@@ -252,7 +248,7 @@ public class Point extends Mesh {
/**
* Used with Serialization. Do not call this directly.
- *
+ *
* @param s
* @throws IOException
* @throws ClassNotFoundException
diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Renderable.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Renderable.java
index e8b77ea..3236610 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Renderable.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Renderable.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,8 +18,9 @@ import com.ardor3d.renderer.Renderer;
public interface Renderable {
/**
* Render the object using the supplied renderer instance.
- *
+ *
* @param renderer
+ * the renderer
*/
void render(Renderer renderer);
}
diff --git a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Spatial.java b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Spatial.java
index 0aab2e2..0b3f5ce 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Spatial.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/scenegraph/Spatial.java
@@ -23,8 +23,6 @@ import java.util.logging.Logger;
import com.ardor3d.annotation.SavableFactory;
import com.ardor3d.bounding.BoundingVolume;
-import com.ardor3d.math.Matrix3;
-import com.ardor3d.math.Quaternion;
import com.ardor3d.math.Transform;
import com.ardor3d.math.ValidatingTransform;
import com.ardor3d.math.Vector3;
@@ -79,15 +77,14 @@ public abstract class Spatial implements Savable, Hintable {
protected List<SpatialController<?>> _controllers;
/** The render states of this spatial. */
- protected EnumMap<RenderState.StateType, RenderState> _renderStateList = new EnumMap<>(
- RenderState.StateType.class);
+ protected EnumMap<RenderState.StateType, RenderState> _renderStateList = new EnumMap<>(RenderState.StateType.class);
/** Listener for dirty events. */
protected DirtyEventListener _listener;
/** Field for accumulating dirty marks. */
- protected EnumSet<DirtyType> _dirtyMark = EnumSet
- .of(DirtyType.Bounding, DirtyType.RenderState, DirtyType.Transform);
+ protected EnumSet<DirtyType> _dirtyMark = EnumSet.of(DirtyType.Bounding, DirtyType.RenderState,
+ DirtyType.Transform);
/** Field for user data. Note: If this object is not explicitly of type Savable, it will be ignored during save. */
protected Object _userData = null;
@@ -110,8 +107,8 @@ public abstract class Spatial implements Savable, Hintable {
protected static final EnumSet<DirtyType> ON_DIRTY_TRANSFORM = EnumSet.of(DirtyType.Bounding, DirtyType.Transform);
protected static final EnumSet<DirtyType> ON_DIRTY_RENDERSTATE = EnumSet.of(DirtyType.RenderState);
protected static final EnumSet<DirtyType> ON_DIRTY_BOUNDING = EnumSet.of(DirtyType.Bounding);
- protected static final EnumSet<DirtyType> ON_DIRTY_ATTACHED = EnumSet.of(DirtyType.Transform,
- DirtyType.RenderState, DirtyType.Bounding);
+ protected static final EnumSet<DirtyType> ON_DIRTY_ATTACHED = EnumSet.of(DirtyType.Transform, DirtyType.RenderState,
+ DirtyType.Bounding);
/**
* Constructs a new Spatial. Initializes the transform fields.
@@ -570,7 +567,6 @@ public abstract class Spatial implements Savable, Hintable {
*
* @param rotation
* the new rotation of this spatial
- * @see Transform#setRotation(Matrix3)
*/
public void setRotation(final ReadOnlyMatrix3 rotation) {
_localTransform.setRotation(rotation);
@@ -582,7 +578,6 @@ public abstract class Spatial implements Savable, Hintable {
*
* @param rotation
* the new rotation of this spatial
- * @see Transform#setRotation(Quaternion)
*/
public void setRotation(final ReadOnlyQuaternion rotation) {
_localTransform.setRotation(rotation);
@@ -847,7 +842,8 @@ public abstract class Spatial implements Savable, Hintable {
* The time in seconds between the last two consecutive frames (time per frame). See
* {@link ReadOnlyTimer#getTimePerFrame()}
*/
- protected void updateChildren(final double time) {}
+ protected void updateChildren(final double time) {
+ }
/**
* Update all controllers set on this spatial.
@@ -974,12 +970,14 @@ public abstract class Spatial implements Savable, Hintable {
* @param stack
* The stack for each state
*/
- protected void applyWorldRenderStates(final boolean recurse, final RenderState.StateStack stack) {}
+ protected void applyWorldRenderStates(final boolean recurse, final RenderState.StateStack stack) {
+ }
/**
* Sort the ligts on this spatial.
*/
- public void sortLights() {}
+ public void sortLights() {
+ }
/**
* Retrieves the complete renderstate list.
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 473a70b..8bcd95f 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
@@ -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 PassNodeState implements Savable, Serializable {
/**
* Applies all currently set renderstates to the supplied context
- *
+ *
* @param context
*/
public void applyPassNodeStates(final RenderContext context) {
@@ -50,7 +50,7 @@ public class PassNodeState implements Savable, Serializable {
* Enforce a particular state. In other words, the given state will override any state of the same type set on a
* scene object. Remember to clear the state when done enforcing. Very useful for multipass techniques where
* multiple sets of states need to be applied to a scenegraph drawn multiple times.
- *
+ *
* @param state
* state to enforce
*/
@@ -69,7 +69,7 @@ public class PassNodeState implements Savable, Serializable {
/**
* Clears an enforced render state index by setting it to null. This allows object specific states to be used.
- *
+ *
* @param type
* The type of RenderState to clear enforcement on.
*/
@@ -78,9 +78,7 @@ public class PassNodeState implements Savable, Serializable {
}
/**
- * sets all enforced states to null.
- *
- * @see RenderContext#clearEnforcedState(int)
+ * sets all enforced states to null
*/
public void clearPassStates() {
_passStates.clear();
diff --git a/ardor3d-core/src/main/java/com/ardor3d/spline/Curve.java b/ardor3d-core/src/main/java/com/ardor3d/spline/Curve.java
index 76b1c40..b737ee8 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/spline/Curve.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/spline/Curve.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>.
*/
@@ -34,7 +34,7 @@ public class Curve {
/**
* Creates a new instance of <code>Curve</code>.
- *
+ *
* @param controlPoints
* see {@link #setControlPoints(List)}
* @param spline
@@ -50,7 +50,7 @@ public class Curve {
/**
* Creates a new <code>Point</code> from the control points making up this curve. It will have the name
* <code>point</code>, no normals, colour or texture, these can be added to the returned point if needed.
- *
+ *
* @param steps
* The number of iterations to perform between control points, the higher this number the more points
* will be shown, but it will also contain more vertices, must be greater than one. Use two to just show
@@ -64,7 +64,7 @@ public class Curve {
/**
* Creates a new <code>Point</code> from the given control point indices. It will have the name <code>point</code>,
* no normals, colour or texture, these can be added to the returned point if needed.
- *
+ *
* @param start
* The index of the control point to start from, must be greater than or equal to one and less than
* <code>end</code>.
@@ -85,7 +85,7 @@ public class Curve {
/**
* Creates a new <code>Line</code> from the control points making up this curve. It will have the name
* <code>curve</code>, no normals, colour or texture, these can be added to the returned line if needed.
- *
+ *
* @param steps
* The number of iterations to perform between control points, the higher this number the smoother the
* returned line will be, but it will also contain more vertices, must be greater than one.
@@ -98,7 +98,7 @@ public class Curve {
/**
* Creates a new <code>Line</code> from the given control point indices. It will have the name <code>curve</code>,
* no normals, colour or texture, these can be added to the returned line if needed.
- *
+ *
* @param start
* The index of the control point to start from, must be greater than or equal to one and less than
* <code>end</code>.
@@ -126,13 +126,13 @@ public class Curve {
/**
* Calculates the length of this curve.
* <p>
- * <strong>Important note:</strong><br />
+ * <strong>Important note:</strong><br>
* To calculate the length of a curve it must be interpolated (hence the steps parameter), this method will do this
* EVERY time it's called (creating a lot of garbage vectors in the process). This has been done for the sake of
* keeping this class simple and the code as readable as possible. Therefore the length should be manually cached
* somewhere in your code if it is going to be used repeatedly.
* </p>
- *
+ *
* @param steps
* The number of iterations to perform between control points, the higher this number the more accurate
* the returned result will be.
@@ -146,10 +146,10 @@ public class Curve {
/**
* Calculates the length between the given control point indices.
* <p>
- * <strong>Important note:</strong><br />
+ * <strong>Important note:</strong><br>
* See the Javadoc for the {@link #getApproximateLength(int)} method for important information.
* </p>
- *
+ *
* @param start
* The index of the control point to start from, must be greater than or equal to one and less than
* <code>end</code>.
@@ -176,7 +176,7 @@ public class Curve {
/**
* Interpolates between the control points at the given indices.
- *
+ *
* @param start
* The index of the control point to start from.
* @param end
@@ -192,7 +192,7 @@ public class Curve {
/**
* Interpolates between the control points at the given indices.
- *
+ *
* @param start
* The index of the control point to start from.
* @param end
@@ -235,7 +235,8 @@ public class Curve {
throw new IllegalArgumentException("controlPoints can not be null!");
}
if (controlPoints.size() < 4) {
- throw new IllegalArgumentException("controlPoints must contain at least 4 elements for this class to work!");
+ throw new IllegalArgumentException(
+ "controlPoints must contain at least 4 elements for this class to work!");
}
_controlPoints = controlPoints;
@@ -247,7 +248,8 @@ public class Curve {
*/
public List<ReadOnlyVector3> getControlPoints() {
assert (null != _controlPoints) : "_controlPoints was null, it must be set before use!";
- assert (_controlPoints.size() >= 4) : "_controlPoints contained less than 4 elements, it must be contain at least 4 for this class to work!";
+ assert (_controlPoints
+ .size() >= 4) : "_controlPoints contained less than 4 elements, it must be contain at least 4 for this class to work!";
return _controlPoints;
}
@@ -267,7 +269,7 @@ public class Curve {
/**
* The default is a {@link CatmullRomSpline}.
- *
+ *
* @return The spline, will not be <code>null</code>.
* @see #setSpline(Spline)
*/
@@ -279,6 +281,14 @@ public class Curve {
/**
* Interpolates the curve and returns an array of vectors.
+ *
+ * @param start
+ * the start index
+ * @param end
+ * the end index
+ * @param steps
+ * the number of steps
+ * @return the interpolated points
*/
private Vector3[] toVector3(final int start, final int end, final int steps) {
if (start <= 0) {
diff --git a/ardor3d-core/src/main/java/com/ardor3d/ui/text/BMText.java b/ardor3d-core/src/main/java/com/ardor3d/ui/text/BMText.java
index b357e54..f152aae 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/ui/text/BMText.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/ui/text/BMText.java
@@ -151,7 +151,8 @@ public class BMText extends Mesh {
return new BMText();
}
- protected BMText() {}
+ protected BMText() {
+ }
/**
*
@@ -453,7 +454,7 @@ public class BMText extends Mesh {
}
/**
- * Set transparency based on distance from camera to text. if (distance < range.x) then opaque, if (distance >
+ * Set transparency based on distance from camera to text. if (distance &lt; range.x) then opaque, if (distance &gt;
* range.y) then transparent, else lerp
*/
protected void distanceAlphaFade(final ReadOnlyVector2 range, final double distance) {
diff --git a/ardor3d-core/src/main/java/com/ardor3d/util/AbstractIterator.java b/ardor3d-core/src/main/java/com/ardor3d/util/AbstractIterator.java
index 85a9f87..ac25477 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/util/AbstractIterator.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/util/AbstractIterator.java
@@ -70,7 +70,8 @@ public abstract class AbstractIterator<T> implements Iterator<T> {
private State state = State.NOT_READY;
/** Constructor for use by subclasses. */
- protected AbstractIterator() {}
+ protected AbstractIterator() {
+ }
private enum State {
/** We have computed the next element and haven't returned it yet. */
@@ -171,6 +172,8 @@ public abstract class AbstractIterator<T> implements Iterator<T> {
* <p>
* Implementations of {@code AbstractIterator} that wish to expose this functionality should implement
* {@code PeekingIterator}.
+ *
+ * @return the next element in the iteration without advancing the iteration
*/
public final T peek() {
if (!hasNext()) {
diff --git a/ardor3d-core/src/main/java/com/ardor3d/util/DrawableCamera.java b/ardor3d-core/src/main/java/com/ardor3d/util/DrawableCamera.java
index 6c7101b..fb591d7 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/util/DrawableCamera.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/util/DrawableCamera.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>.
*/
@@ -35,11 +35,13 @@ public class DrawableCamera extends Mesh {
/**
* Instantiates a new drawable camera.
- *
- * @param width
- * the width
- * @param height
- * the height
+ *
+ * @param camera
+ * the camera
+ * @param color
+ * the color
+ * @param pattern
+ * the pattern
*/
public DrawableCamera(final Camera camera, final ColorRGBA color, final short pattern) {
super("DrawableCamera");