diff --git a/jme3-effects/build.gradle b/jme3-effects/build.gradle
index 1274ae2745..0a77d7d720 100644
--- a/jme3-effects/build.gradle
+++ b/jme3-effects/build.gradle
@@ -5,10 +5,3 @@ if (!hasProperty('mainClass')) {
dependencies {
compile project(':jme3-core')
}
-
-javadoc {
- // Disable doclint for JDK8+.
- if (JavaVersion.current().isJava8Compatible()){
- options.addStringOption('Xdoclint:none', '-quiet')
- }
-}
diff --git a/jme3-effects/src/main/java/com/jme3/post/filters/BloomFilter.java b/jme3-effects/src/main/java/com/jme3/post/filters/BloomFilter.java
index 1d4ad6021b..9428cae8a1 100644
--- a/jme3-effects/src/main/java/com/jme3/post/filters/BloomFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/post/filters/BloomFilter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2009-2019 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -109,7 +109,8 @@ public BloomFilter() {
/**
* Creates the bloom filter with the specific glow mode
- * @param glowMode
+ *
+ * @param glowMode the desired mode (default=Scene)
*/
public BloomFilter(GlowMode glowMode) {
this();
@@ -234,7 +235,8 @@ public float getBloomIntensity() {
/**
* intensity of the bloom effect default is 2.0
- * @param bloomIntensity
+ *
+ * @param bloomIntensity the desired intensity (default=2)
*/
public void setBloomIntensity(float bloomIntensity) {
this.bloomIntensity = bloomIntensity;
@@ -250,7 +252,8 @@ public float getBlurScale() {
/**
* sets The spread of the bloom default is 1.5f
- * @param blurScale
+ *
+ * @param blurScale the desired scale (default=1.5)
*/
public void setBlurScale(float blurScale) {
this.blurScale = blurScale;
@@ -267,7 +270,8 @@ public float getExposureCutOff() {
/**
* Define the color threshold on which the bloom will be applied (0.0 to 1.0)
- * @param exposureCutOff
+ *
+ * @param exposureCutOff the desired threshold (≥0, ≤1, default=0)
*/
public void setExposureCutOff(float exposureCutOff) {
this.exposureCutOff = exposureCutOff;
@@ -284,8 +288,9 @@ public float getExposurePower() {
/**
* defines how many time the bloom extracted color will be multiplied by itself. default id 5.0
- * a high value will reduce rough edges in the bloom and somhow the range of the bloom area *
- * @param exposurePower
+ * a high value will reduce rough edges in the bloom and somhow the range of the bloom area
+ *
+ * @param exposurePower the desired exponent (default=5)
*/
public void setExposurePower(float exposurePower) {
this.exposurePower = exposurePower;
@@ -303,7 +308,8 @@ public float getDownSamplingFactor() {
/**
* Sets the downSampling factor : the size of the computed texture will be divided by this factor. default is 1 for no downsampling
* A 2 value is a good way of widening the blur
- * @param downSamplingFactor
+ *
+ * @param downSamplingFactor the desired factor (default=1)
*/
public void setDownSamplingFactor(float downSamplingFactor) {
this.downSamplingFactor = downSamplingFactor;
diff --git a/jme3-effects/src/main/java/com/jme3/post/filters/CartoonEdgeFilter.java b/jme3-effects/src/main/java/com/jme3/post/filters/CartoonEdgeFilter.java
index c1d5b0dfb6..d78606190c 100644
--- a/jme3-effects/src/main/java/com/jme3/post/filters/CartoonEdgeFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/post/filters/CartoonEdgeFilter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2009-2019 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -124,7 +124,8 @@ public float getDepthSensitivity() {
/**
* sets the depth sensitivity
* defines how much depth will influence edges, default is 10
- * @param depthSensitivity
+ *
+ * @param depthSensitivity the desired sensitivity (default=10)
*/
public void setDepthSensitivity(float depthSensitivity) {
this.depthSensitivity = depthSensitivity;
@@ -145,7 +146,8 @@ public float getDepthThreshold() {
/**
* sets the depth threshold
* Defines at what threshold of difference of depth an edge is outlined default is 0.1f
- * @param depthThreshold
+ *
+ * @param depthThreshold the desired threshold (default=0.1)
*/
public void setDepthThreshold(float depthThreshold) {
this.depthThreshold = depthThreshold;
@@ -166,7 +168,8 @@ public float getEdgeIntensity() {
/**
* sets the edge intensity
* Defineshow visible will be the outlined edges
- * @param edgeIntensity
+ *
+ * @param edgeIntensity the desired intensity (default=1)
*/
public void setEdgeIntensity(float edgeIntensity) {
this.edgeIntensity = edgeIntensity;
@@ -185,7 +188,8 @@ public float getEdgeWidth() {
/**
* sets the witdh of the edge in pixels default is 1
- * @param edgeWidth
+ *
+ * @param edgeWidth the desired width (in pixels, default=1)
*/
public void setEdgeWidth(float edgeWidth) {
this.edgeWidth = edgeWidth;
@@ -206,7 +210,8 @@ public float getNormalSensitivity() {
/**
* sets the normals sensitivity default is 1
- * @param normalSensitivity
+ *
+ * @param normalSensitivity the desired sensitivity (default=1)
*/
public void setNormalSensitivity(float normalSensitivity) {
this.normalSensitivity = normalSensitivity;
@@ -227,7 +232,8 @@ public float getNormalThreshold() {
/**
* sets the normal threshold default is 0.5
- * @param normalThreshold
+ *
+ * @param normalThreshold the desired threshold (default=0.5)
*/
public void setNormalThreshold(float normalThreshold) {
this.normalThreshold = normalThreshold;
@@ -246,7 +252,8 @@ public ColorRGBA getEdgeColor() {
/**
* Sets the edge color, default is black
- * @param edgeColor
+ *
+ * @param edgeColor the desired color (alias created, default=(0,0,0,1))
*/
public void setEdgeColor(ColorRGBA edgeColor) {
this.edgeColor = edgeColor;
diff --git a/jme3-effects/src/main/java/com/jme3/post/filters/ColorOverlayFilter.java b/jme3-effects/src/main/java/com/jme3/post/filters/ColorOverlayFilter.java
index 58f1c79411..87fd5cf02c 100644
--- a/jme3-effects/src/main/java/com/jme3/post/filters/ColorOverlayFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/post/filters/ColorOverlayFilter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -61,7 +61,8 @@ public ColorOverlayFilter() {
/**
* creates a colorOverlayFilter with the given color
- * @param color
+ *
+ * @param color the desired color (default=(1,1,1,1), alias created)
*/
public ColorOverlayFilter(ColorRGBA color) {
this();
@@ -82,8 +83,9 @@ public ColorRGBA getColor() {
}
/**
- * sets the color
- * @param color
+ * sets the color
+ *
+ * @param color the desired color (default=(1,1,1,1), alias created)
*/
public void setColor(final ColorRGBA color) {
this.color = color;
diff --git a/jme3-effects/src/main/java/com/jme3/post/filters/ComposeFilter.java b/jme3-effects/src/main/java/com/jme3/post/filters/ComposeFilter.java
index 401b31a6ff..fb333ed673 100644
--- a/jme3-effects/src/main/java/com/jme3/post/filters/ComposeFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/post/filters/ComposeFilter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2009-2019 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -68,7 +68,7 @@ public ComposeFilter() {
/**
* creates a ComposeFilter with the given texture
*
- * @param compositeTexture
+ * @param compositeTexture the texture to use (alias created)
*/
public ComposeFilter(Texture2D compositeTexture) {
this();
@@ -93,7 +93,7 @@ public Texture2D getCompositeTexture() {
/**
* sets the compositeTexture
*
- * @param compositeTexture
+ * @param compositeTexture the desired texture (alias created)
*/
public void setCompositeTexture(Texture2D compositeTexture) {
this.compositeTexture = compositeTexture;
diff --git a/jme3-effects/src/main/java/com/jme3/post/filters/CrossHatchFilter.java b/jme3-effects/src/main/java/com/jme3/post/filters/CrossHatchFilter.java
index 28c3a36873..928805f6a2 100644
--- a/jme3-effects/src/main/java/com/jme3/post/filters/CrossHatchFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/post/filters/CrossHatchFilter.java
@@ -114,7 +114,8 @@ protected Material getMaterial() {
/**
* Sets color used to draw lines
- * @param lineColor
+ *
+ * @param lineColor the desired color (alias created, default=(0,0,0,1))
*/
public void setLineColor(ColorRGBA lineColor) {
this.lineColor = lineColor;
@@ -125,7 +126,8 @@ public void setLineColor(ColorRGBA lineColor) {
/**
* Sets color used as background
- * @param paperColor
+ *
+ * @param paperColor the desired color (alias created, default=(1,1,1,1))
*/
public void setPaperColor(ColorRGBA paperColor) {
this.paperColor = paperColor;
@@ -136,7 +138,8 @@ public void setPaperColor(ColorRGBA paperColor) {
/**
* Sets color influence of original image on lines drawn
- * @param colorInfluenceLine
+ *
+ * @param colorInfluenceLine the desired factor (default=0.8)
*/
public void setColorInfluenceLine(float colorInfluenceLine) {
this.colorInfluenceLine = colorInfluenceLine;
@@ -147,7 +150,8 @@ public void setColorInfluenceLine(float colorInfluenceLine) {
/**
* Sets color influence of original image on non-line areas
- * @param colorInfluencePaper
+ *
+ * @param colorInfluencePaper the desired factor (default=0.1)
*/
public void setColorInfluencePaper(float colorInfluencePaper) {
this.colorInfluencePaper = colorInfluencePaper;
@@ -159,7 +163,8 @@ public void setColorInfluencePaper(float colorInfluencePaper) {
/**
* Sets line/paper color ratio for areas with values less than luminance5,
* really dark areas get no lines but a filled blob instead
- * @param fillValue
+ *
+ * @param fillValue the desired ratio (default=0.9)
*/
public void setFillValue(float fillValue) {
this.fillValue = fillValue;
@@ -195,7 +200,8 @@ public void setLuminanceLevels(float luminance1, float luminance2, float luminan
/**
* Sets the thickness of lines drawn
- * @param lineThickness
+ *
+ * @param lineThickness the desired thickness (in pixels, default=1)
*/
public void setLineThickness(float lineThickness) {
this.lineThickness = lineThickness;
@@ -208,7 +214,8 @@ public void setLineThickness(float lineThickness) {
* Sets minimum distance between lines drawn
* Primary lines are drawn at 2*lineDistance
* Secondary lines are drawn at lineDistance
- * @param lineDistance
+ *
+ * @param lineDistance the desired distance (in pixels, default=4)
*/
public void setLineDistance(float lineDistance) {
this.lineDistance = lineDistance;
@@ -235,6 +242,8 @@ public ColorRGBA getPaperColor() {
/**
* Returns current influence of image colors on lines
+ *
+ * @return the influence factor
*/
public float getColorInfluenceLine() {
return colorInfluenceLine;
@@ -242,6 +251,8 @@ public float getColorInfluenceLine() {
/**
* Returns current influence of image colors on paper background
+ *
+ * @return the influence factor
*/
public float getColorInfluencePaper() {
return colorInfluencePaper;
@@ -249,6 +260,8 @@ public float getColorInfluencePaper() {
/**
* Returns line/paper color ratio for blobs
+ *
+ * @return the ratio
*/
public float getFillValue() {
return fillValue;
@@ -256,6 +269,8 @@ public float getFillValue() {
/**
* Returns the thickness of the lines drawn
+ *
+ * @return the thickness (in pixels)
*/
public float getLineThickness() {
return lineThickness;
@@ -263,6 +278,8 @@ public float getLineThickness() {
/**
* Returns minimum distance between lines
+ *
+ * @return the distance (in pixels)
*/
public float getLineDistance() {
return lineDistance;
@@ -270,6 +287,8 @@ public float getLineDistance() {
/**
* Returns threshold for lines 1
+ *
+ * @return the first luminance threshold
*/
public float getLuminance1() {
return luminance1;
@@ -277,6 +296,8 @@ public float getLuminance1() {
/**
* Returns threshold for lines 2
+ *
+ * @return the 2nd luminance threshold
*/
public float getLuminance2() {
return luminance2;
@@ -284,6 +305,8 @@ public float getLuminance2() {
/**
* Returns threshold for lines 3
+ *
+ * @return the 3rd luminance threshold
*/
public float getLuminance3() {
return luminance3;
@@ -291,6 +314,8 @@ public float getLuminance3() {
/**
* Returns threshold for lines 4
+ *
+ * @return the 4th luminance threshold
*/
public float getLuminance4() {
return luminance4;
@@ -298,6 +323,8 @@ public float getLuminance4() {
/**
* Returns threshold for blobs
+ *
+ * @return the 5th luminance threshold
*/
public float getLuminance5() {
return luminance5;
diff --git a/jme3-effects/src/main/java/com/jme3/post/filters/DepthOfFieldFilter.java b/jme3-effects/src/main/java/com/jme3/post/filters/DepthOfFieldFilter.java
index 31ca381237..bce5a25f88 100644
--- a/jme3-effects/src/main/java/com/jme3/post/filters/DepthOfFieldFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/post/filters/DepthOfFieldFilter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2009-2019 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -98,6 +98,8 @@ protected void initFilter(AssetManager assets, RenderManager renderManager,
/**
* Sets the distance at which objects are purely in focus.
+ *
+ * @param f the desired distance (in world units, default=50)
*/
public void setFocusDistance(float f) {
@@ -120,6 +122,8 @@ public float getFocusDistance() {
* Sets the range to either side of focusDistance where the
* objects go gradually out of focus. Less than focusDistance - focusRange
* and greater than focusDistance + focusRange, objects are maximally "blurred".
+ *
+ * @param f the desired half extent (in world units, default=10)
*/
public void setFocusRange(float f) {
this.focusRange = f;
@@ -148,6 +152,8 @@ public float getFocusRange() {
*%MINIFYHTMLc3d0cd9fab65de6875a381fd3f83e1b338%*
* Where 'x' is the texel being modified. Setting blur scale higher
* than 1 spaces the samples out.
+ *
+ * @param f the desired filter scale (default=1)
*/
public void setBlurScale(float f) {
this.blurScale = f;
@@ -178,6 +184,8 @@ public float getBlurScale() {
* the near-camera blurring and should be set smaller than the default
* or to 0 to disable completely. Sometimes that cut-off is desired if
* mid-to-far field unfocusing is all that is desired.
+ *
+ * @param f the desired blur factor (default=0.2)
*/
public void setBlurThreshold( float f ) {
this.blurThreshold = f;
@@ -200,6 +208,8 @@ public float getBlurThreshold() {
* is rendered as gray scale. This can be used to more easily visualize
* where in your view the focus is centered and how steep the gradient/cutoff
* is, etc..
+ *
+ * @param b true to enable debugging, false to disable it (default=false)
*/
public void setDebugUnfocus( boolean b ) {
this.debugUnfocus = b;
diff --git a/jme3-effects/src/main/java/com/jme3/post/filters/FXAAFilter.java b/jme3-effects/src/main/java/com/jme3/post/filters/FXAAFilter.java
index b75873768e..d9a29762ef 100644
--- a/jme3-effects/src/main/java/com/jme3/post/filters/FXAAFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/post/filters/FXAAFilter.java
@@ -86,7 +86,7 @@ public void setSpanMax(float spanMax) {
/**
* set to 0.0f for higher quality
*
- * @param subPixelShift
+ * @param subPixelShift the desired shift (default=0.25)
*/
public void setSubPixelShift(float subPixelShift) {
this.subPixelShift = subPixelShift;
@@ -98,7 +98,7 @@ public void setSubPixelShift(float subPixelShift) {
/**
* set to 0.0f for higher quality
*
- * @param reduceMul
+ * @param reduceMul the desired value (default=0.125)
*/
public void setReduceMul(float reduceMul) {
this.reduceMul = reduceMul;
diff --git a/jme3-effects/src/main/java/com/jme3/post/filters/FadeFilter.java b/jme3-effects/src/main/java/com/jme3/post/filters/FadeFilter.java
index 8864f77576..d836bac44b 100644
--- a/jme3-effects/src/main/java/com/jme3/post/filters/FadeFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/post/filters/FadeFilter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2009-2019 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -65,7 +65,8 @@ public FadeFilter() {
/**
* Creates a FadeFilter with the given duration
- * @param duration
+ *
+ * @param duration the desired duration (in seconds, default=1)
*/
public FadeFilter(float duration) {
this();
@@ -109,7 +110,8 @@ public float getDuration() {
/**
* Sets the duration of the filter default is 1 second
- * @param duration
+ *
+ * @param duration the desired duration (in seconds, default=1)
*/
public void setDuration(float duration) {
this.duration = duration;
@@ -164,7 +166,8 @@ public float getValue() {
/**
* sets the fade value
* can be used to force complete black or compete scene
- * @param value
+ *
+ * @param value the desired value (default=1)
*/
public void setValue(float value) {
this.value = value;
diff --git a/jme3-effects/src/main/java/com/jme3/post/filters/FogFilter.java b/jme3-effects/src/main/java/com/jme3/post/filters/FogFilter.java
index 089dec5571..a961ef101e 100644
--- a/jme3-effects/src/main/java/com/jme3/post/filters/FogFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/post/filters/FogFilter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2009-2019 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -103,7 +103,8 @@ public ColorRGBA getFogColor() {
/**
* Sets the color of the fog
- * @param fogColor
+ *
+ * @param fogColor the desired color (alias created, default=(1,1,1,1))
*/
public void setFogColor(ColorRGBA fogColor) {
if (material != null) {
@@ -122,7 +123,8 @@ public float getFogDensity() {
/**
* Sets the density of the fog, a high value gives a thick fog
- * @param fogDensity
+ *
+ * @param fogDensity the desired density (default=0.7)
*/
public void setFogDensity(float fogDensity) {
if (material != null) {
@@ -141,7 +143,8 @@ public float getFogDistance() {
/**
* the distance of the fog. the higer the value the distant the fog looks
- * @param fogDistance
+ *
+ * @param fogDistance the desired distance (in world units, default=1000)
*/
public void setFogDistance(float fogDistance) {
if (material != null) {
diff --git a/jme3-effects/src/main/java/com/jme3/post/filters/GammaCorrectionFilter.java b/jme3-effects/src/main/java/com/jme3/post/filters/GammaCorrectionFilter.java
index 7c5bd4fd80..df29f9ed6c 100644
--- a/jme3-effects/src/main/java/com/jme3/post/filters/GammaCorrectionFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/post/filters/GammaCorrectionFilter.java
@@ -76,7 +76,7 @@ public float getGamma() {
/**
* set to 0.0 to disable gamma correction
*
- * @param gamma
+ * @param gamma the desired exponent (>0, default=2.2)
*/
public final void setGamma(float gamma) {
if(gamma<=0){
diff --git a/jme3-effects/src/main/java/com/jme3/post/filters/LightScatteringFilter.java b/jme3-effects/src/main/java/com/jme3/post/filters/LightScatteringFilter.java
index 845b1b8372..028e161424 100644
--- a/jme3-effects/src/main/java/com/jme3/post/filters/LightScatteringFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/post/filters/LightScatteringFilter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2009-2019 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -75,7 +75,9 @@ public LightScatteringFilter() {
/**
* Creates a lightScatteringFilter
- * @param lightPosition
+ *
+ * @param lightPosition the desired location (in world coordinates, alias
+ * created)
*/
public LightScatteringFilter(Vector3f lightPosition) {
this();
@@ -142,7 +144,9 @@ public float getBlurStart() {
/**
* sets the blur start
* at which distance from the light source the effect starts default is 0.02
- * @param blurStart
+ *
+ * @param blurStart the desired start distance (in world units,
+ * default=0.02)
*/
public void setBlurStart(float blurStart) {
this.blurStart = blurStart;
@@ -159,7 +163,8 @@ public float getBlurWidth() {
/**
* sets the blur width default is 0.9
- * @param blurWidth
+ *
+ * @param blurWidth the desired width (default=0.9)
*/
public void setBlurWidth(float blurWidth) {
this.blurWidth = blurWidth;
@@ -177,7 +182,8 @@ public float getLightDensity() {
/**
* sets how much the effect is visible over the rendered scene default is 1.4
- * @param lightDensity
+ *
+ * @param lightDensity the desired density (default=1.4)
*/
public void setLightDensity(float lightDensity) {
this.lightDensity = lightDensity;
@@ -193,7 +199,9 @@ public Vector3f getLightPosition() {
/**
* sets the light position
- * @param lightPosition
+ *
+ * @param lightPosition the desired location (in world coordinates, alias
+ * created)
*/
public void setLightPosition(Vector3f lightPosition) {
this.lightPosition = lightPosition;
@@ -210,7 +218,8 @@ public int getNbSamples() {
/**
* sets the number of samples for the radial blur default is 50
* the higher the value the higher the quality, but the slower the performance.
- * @param nbSamples
+ *
+ * @param nbSamples the desired number of samples (default=50)
*/
public void setNbSamples(int nbSamples) {
this.nbSamples = nbSamples;
diff --git a/jme3-effects/src/main/java/com/jme3/post/filters/PosterizationFilter.java b/jme3-effects/src/main/java/com/jme3/post/filters/PosterizationFilter.java
index 6b69825c06..d6047ea907 100644
--- a/jme3-effects/src/main/java/com/jme3/post/filters/PosterizationFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/post/filters/PosterizationFilter.java
@@ -64,7 +64,8 @@ public PosterizationFilter() {
/**
* Creates a posterization Filter with the given number of colors
- * @param numColors
+ *
+ * @param numColors the desired number of colors (>0, default=8)
*/
public PosterizationFilter(int numColors) {
this();
@@ -73,8 +74,9 @@ public PosterizationFilter(int numColors) {
/**
* Creates a posterization Filter with the given number of colors and gamma
- * @param numColors
- * @param gamma
+ *
+ * @param numColors the desired number of colors (>0, default=8)
+ * @param gamma the desired exponent (default=0.6)
*/
public PosterizationFilter(int numColors, float gamma) {
this(numColors);
@@ -96,6 +98,8 @@ protected Material getMaterial() {
/**
* Sets number of color levels used to draw the screen
+ *
+ * @param numColors the desired number of colors (>0, default=8)
*/
public void setNumColors(int numColors) {
this.numColors = numColors;
@@ -106,6 +110,8 @@ public void setNumColors(int numColors) {
/**
* Sets gamma level used to enhange visual quality
+ *
+ * @param gamma the desired exponent (default=0.6)
*/
public void setGamma(float gamma) {
this.gamma = gamma;
@@ -116,6 +122,8 @@ public void setGamma(float gamma) {
/**
* Sets current strength value, i.e. influence on final image
+ *
+ * @param strength the desired influence factor (default=1)
*/
public void setStrength(float strength) {
this.strength = strength;
@@ -126,6 +134,8 @@ public void setStrength(float strength) {
/**
* Returns number of color levels used
+ *
+ * @return the count (>0)
*/
public int getNumColors() {
return numColors;
@@ -133,6 +143,8 @@ public int getNumColors() {
/**
* Returns current gamma value
+ *
+ * @return the exponent
*/
public float getGamma() {
return gamma;
@@ -140,6 +152,8 @@ public float getGamma() {
/**
* Returns current strength value, i.e. influence on final image
+ *
+ * @return the influence factor
*/
public float getStrength() {
return strength;
diff --git a/jme3-effects/src/main/java/com/jme3/post/filters/RadialBlurFilter.java b/jme3-effects/src/main/java/com/jme3/post/filters/RadialBlurFilter.java
index c79339848f..3c70e23d12 100644
--- a/jme3-effects/src/main/java/com/jme3/post/filters/RadialBlurFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/post/filters/RadialBlurFilter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2009-2019 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -89,7 +89,8 @@ public float getSampleDistance() {
/**
* sets the samples distances default is 1
- * @param sampleDist
+ *
+ * @param sampleDist the desired distance (default=1)
*/
public void setSampleDistance(float sampleDist) {
this.sampleDist = sampleDist;
@@ -107,7 +108,7 @@ public float getSampleDist() {
/**
*
- * @param sampleDist
+ * @param sampleDist the desired distance (default=1)
* @deprecated use {@link #setSampleDistance(float sampleDist)}
*/
@Deprecated
@@ -125,7 +126,8 @@ public float getSampleStrength() {
/**
* sets the sample strength default is 2.2
- * @param sampleStrength
+ *
+ * @param sampleStrength the desired strength (default=2.2)
*/
public void setSampleStrength(float sampleStrength) {
this.sampleStrength = sampleStrength;
diff --git a/jme3-effects/src/main/java/com/jme3/post/ssao/SSAOFilter.java b/jme3-effects/src/main/java/com/jme3/post/ssao/SSAOFilter.java
index 1e4aa3410f..5d053b5bda 100644
--- a/jme3-effects/src/main/java/com/jme3/post/ssao/SSAOFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/post/ssao/SSAOFilter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2009-2020 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -208,7 +208,8 @@ public float getBias() {
/**
* Sets the width of the occlusion cone considered by the occludee default is 0.1f
- * @param bias
+ *
+ * @param bias the desired width (default=0.1)
*/
public void setBias(float bias) {
this.bias = bias;
@@ -227,7 +228,8 @@ public float getIntensity() {
/**
* Sets the Ambient occlusion intensity default is 1.2f
- * @param intensity
+ *
+ * @param intensity the desired intensity (default=1.5)
*/
public void setIntensity(float intensity) {
this.intensity = intensity;
@@ -247,8 +249,9 @@ public float getSampleRadius() {
}
/**
- * Sets the radius of the area where random samples will be picked default 5.1f
- * @param sampleRadius
+ * Sets the radius of the area where random samples will be picked default 5.1f
+ *
+ * @param sampleRadius the desired radius (default=5.1)
*/
public void setSampleRadius(float sampleRadius) {
this.sampleRadius = sampleRadius;
@@ -270,7 +273,8 @@ public float getScale() {
/**
*
* Returns the distance between occluders and occludee. default 0.2f
- * @param scale
+ *
+ * @param scale the desired distance (default=0.2)
*/
public void setScale(float scale) {
this.scale = scale;
@@ -289,6 +293,8 @@ public boolean isUseAo() {
/**
* debugging only , will be removed
+ *
+ * @param useAo true to enable, false to disable (default=true)
*/
public void setUseAo(boolean useAo) {
this.useAo = useAo;
@@ -319,6 +325,8 @@ public boolean isUseOnlyAo() {
/**
* debugging only , will be removed
+ *
+ * @param useOnlyAo true to enable, false to disable (default=false)
*/
public void setUseOnlyAo(boolean useOnlyAo) {
this.useOnlyAo = useOnlyAo;
diff --git a/jme3-effects/src/main/java/com/jme3/water/ReflectionProcessor.java b/jme3-effects/src/main/java/com/jme3/water/ReflectionProcessor.java
index 533b3b1114..85d114d6af 100644
--- a/jme3-effects/src/main/java/com/jme3/water/ReflectionProcessor.java
+++ b/jme3-effects/src/main/java/com/jme3/water/ReflectionProcessor.java
@@ -125,7 +125,8 @@ public FrameBuffer getReflectionBuffer() {
/**
* Internal use only
* sets the frame buffer
- * @param reflectionBuffer
+ *
+ * @param reflectionBuffer the FrameBuffer to use (alias created)
*/
public void setReflectionBuffer(FrameBuffer reflectionBuffer) {
this.reflectionBuffer = reflectionBuffer;
@@ -141,7 +142,8 @@ public Camera getReflectionCam() {
/**
* sets the reflection cam
- * @param reflectionCam
+ *
+ * @param reflectionCam the Camera to use (alias created)
*/
public void setReflectionCam(Camera reflectionCam) {
this.reflectionCam = reflectionCam;
@@ -157,7 +159,8 @@ public Plane getReflectionClipPlane() {
/**
* Sets the reflection clip plane
- * @param reflectionClipPlane
+ *
+ * @param reflectionClipPlane the Plane to use (alias created)
*/
public void setReflectionClipPlane(Plane reflectionClipPlane) {
this.reflectionClipPlane = reflectionClipPlane;
diff --git a/jme3-effects/src/main/java/com/jme3/water/SimpleWaterProcessor.java b/jme3-effects/src/main/java/com/jme3/water/SimpleWaterProcessor.java
index f79fc110fe..503184cee0 100644
--- a/jme3-effects/src/main/java/com/jme3/water/SimpleWaterProcessor.java
+++ b/jme3-effects/src/main/java/com/jme3/water/SimpleWaterProcessor.java
@@ -324,7 +324,8 @@ public Material getMaterial() {
/**
* Sets the reflected scene, should not include the water quad!
* Set before adding processor.
- * @param spat
+ *
+ * @param spat the scene-graph subtree to be reflected (alias created)
*/
public void setReflectionScene(Spatial spat) {
reflectionScene = spat;
@@ -349,8 +350,9 @@ public int getRenderHeight() {
/**
* Set the reflection Texture render size,
* set before adding the processor!
- * @param width
- * @param height
+ *
+ * @param width the desired width (in pixels, default=512)
+ * @param height the desired height (in pixels, default=512)
*/
public void setRenderSize(int width, int height) {
renderWidth = width;
@@ -367,7 +369,8 @@ public Plane getPlane() {
/**
* Set the water plane for this processor.
- * @param plane
+ *
+ * @param plane the Plane to use (not null, unaffected)
*/
public void setPlane(Plane plane) {
this.plane.setConstant(plane.getConstant());
@@ -395,7 +398,9 @@ private void updateClipPlanes() {
/**
* Set the light Position for the processor
- * @param position
+ *
+ * @param position the desired location (in world coordinates,
+ * alias created)
*/
//TODO maybe we should provide a convenient method to compute position from direction
public void setLightPosition(Vector3f position) {
@@ -404,7 +409,8 @@ public void setLightPosition(Vector3f position) {
/**
* Set the color that will be added to the refraction texture.
- * @param color
+ *
+ * @param color the desired color (alias created)
*/
public void setWaterColor(ColorRGBA color) {
material.setColor("waterColor", color);
@@ -413,7 +419,8 @@ public void setWaterColor(ColorRGBA color) {
/**
* Higher values make the refraction texture shine through earlier.
* Default is 4
- * @param depth
+ *
+ * @param depth the desired depth (default=1)
*/
public void setWaterDepth(float depth) {
waterDepth = depth;
@@ -438,7 +445,8 @@ public float getWaterTransparency() {
/**
* sets the water transparency default os 0.1f
- * @param waterTransparency
+ *
+ * @param waterTransparency the desired transparency (default=0.4)
*/
public void setWaterTransparency(float waterTransparency) {
this.waterTransparency = Math.max(0, waterTransparency);
@@ -447,7 +455,8 @@ public void setWaterTransparency(float waterTransparency) {
/**
* Sets the speed of the wave animation, default = 0.05f.
- * @param speed
+ *
+ * @param speed the desired animation speed (default=0.05)
*/
public void setWaveSpeed(float speed) {
this.speed = speed;
@@ -463,6 +472,8 @@ public float getWaveSpeed(){
/**
* Sets the scale of distortion by the normal map, default = 0.2
+ *
+ * @param value the desired scale factor (default=0.2)
*/
public void setDistortionScale(float value) {
distortionScale = value;
@@ -471,6 +482,8 @@ public void setDistortionScale(float value) {
/**
* Sets how the normal and dudv map are mixed to create the wave effect, default = 0.5
+ *
+ * @param value the desired mix fraction (default=0.5)
*/
public void setDistortionMix(float value) {
distortionMix = value;
@@ -481,6 +494,8 @@ public void setDistortionMix(float value) {
* Sets the scale of the normal/dudv texture, default = 1.
* Note that the waves should be scaled by the texture coordinates of the quad to avoid animation artifacts,
* use mesh.scaleTextureCoordinates(Vector2f) for that.
+ *
+ * @param value the desired scale factor (default=1)
*/
public void setTexScale(float value) {
texScale = value;
@@ -528,7 +543,8 @@ public boolean isDebug() {
/**
* set to true to display reflection and refraction textures in the GUI for debug purpose
- * @param debug
+ *
+ * @param debug true to enable display, false to disable it (default=false)
*/
public void setDebug(boolean debug) {
this.debug = debug;
@@ -536,8 +552,9 @@ public void setDebug(boolean debug) {
/**
* Creates a quad with the water material applied to it.
- * @param width
- * @param height
+ *
+ * @param width the desired width (in mesh coordinates)
+ * @param height the desired height (in mesh coordinates)
* @return a new Geometry
*/
public Geometry createWaterGeometry(float width, float height) {
@@ -559,7 +576,8 @@ public float getReflectionClippingOffset() {
/**
* sets the reflection clipping plane offset
* set a nagetive value to lower the clipping plane for relection texture rendering.
- * @param reflectionClippingOffset
+ *
+ * @param reflectionClippingOffset the desired offset (default=-5)
*/
public void setReflectionClippingOffset(float reflectionClippingOffset) {
this.reflectionClippingOffset = reflectionClippingOffset;
@@ -577,7 +595,8 @@ public float getRefractionClippingOffset() {
/**
* Sets the refraction clipping plane offset
* set a positive value to raise the clipping plane for refraction texture rendering
- * @param refractionClippingOffset
+ *
+ * @param refractionClippingOffset the desired offset (default=0.3)
*/
public void setRefractionClippingOffset(float refractionClippingOffset) {
this.refractionClippingOffset = refractionClippingOffset;
diff --git a/jme3-effects/src/main/java/com/jme3/water/WaterFilter.java b/jme3-effects/src/main/java/com/jme3/water/WaterFilter.java
index a42a5d9479..dff702dabf 100644
--- a/jme3-effects/src/main/java/com/jme3/water/WaterFilter.java
+++ b/jme3-effects/src/main/java/com/jme3/water/WaterFilter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2009-2019 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -473,7 +473,8 @@ public float getWaterHeight() {
/**
* Sets the height of the water plane
* default is 0.0
- * @param waterHeight
+ *
+ * @param waterHeight the desired height (default=0)
*/
public void setWaterHeight(float waterHeight) {
this.waterHeight = waterHeight;
@@ -528,7 +529,8 @@ public float getWaterTransparency() {
* values as how clear water is. Therefore use smaller values (eg. 0.05)
* to have crystal clear water and bigger to achieve "muddy" water.
* default is 0.1f
- * @param waterTransparency
+ *
+ * @param waterTransparency the desired muddiness (default=0.1)
*/
public void setWaterTransparency(float waterTransparency) {
this.waterTransparency = waterTransparency;
@@ -549,7 +551,8 @@ public float getNormalScale() {
* Sets the normal scaling factors to apply to the normal map.
* the higher the value the more small ripples will be visible on the waves.
* default is 1.0
- * @param normalScale
+ *
+ * @param normalScale the scaling factor (default=3)
*/
public void setNormalScale(float normalScale) {
this.normalScale = normalScale;
@@ -573,7 +576,8 @@ public float getRefractionConstant() {
* It usually depend on the material you are looking through (here water).
* Default value is 0.3f
* In practice, the lowest the value and the less the reflection can be seen on water
- * @param refractionConstant
+ *
+ * @param refractionConstant the desired R0 value (default=0.5)
*/
public void setRefractionConstant(float refractionConstant) {
this.refractionConstant = refractionConstant;
@@ -593,7 +597,8 @@ public float getMaxAmplitude() {
/**
* Sets the maximum waves amplitude
* default is 1.0
- * @param maxAmplitude
+ *
+ * @param maxAmplitude the desired maximum amplitude (default=1.5)
*/
public void setMaxAmplitude(float maxAmplitude) {
this.maxAmplitude = maxAmplitude;
@@ -612,7 +617,9 @@ public Vector3f getLightDirection() {
/**
* Sets the light direction
- * @param lightDirection
+ *
+ * @param lightDirection the direction vector to use (alias created,
+ * default=(0,-1,0))
*/
public void setLightDirection(Vector3f lightDirection) {
this.lightDirection = lightDirection;
@@ -632,7 +639,8 @@ public ColorRGBA getLightColor() {
/**
* Sets the light color to use
* default is white
- * @param lightColor
+ *
+ * @param lightColor the color to use (alias created, default=(1,1,1,1))
*/
public void setLightColor(ColorRGBA lightColor) {
this.lightColor = lightColor;
@@ -653,7 +661,8 @@ public float getShoreHardness() {
* The smaller this value is, the softer the transition between
* shore and water. If you want hard edges use very big value.
* Default is 0.1f.
- * @param shoreHardness
+ *
+ * @param shoreHardness the desired hardness (default=0.1)
*/
public void setShoreHardness(float shoreHardness) {
this.shoreHardness = shoreHardness;
@@ -673,7 +682,8 @@ public float getFoamHardness() {
/**
* Sets the foam hardness : How much the foam will blend with the shore to avoid hard edged water plane.
* Default is 1.0
- * @param foamHardness
+ *
+ * @param foamHardness the desired hardness (default=1)
*/
public void setFoamHardness(float foamHardness) {
this.foamHardness = foamHardness;
@@ -694,7 +704,8 @@ public float getRefractionStrength() {
* This value modifies current fresnel term. If you want to weaken
* reflections use bigger value. If you want to emphasize them use
* value smaller then 0. Default is 0.0f.
- * @param refractionStrength
+ *
+ * @param refractionStrength the desired strength (default=0)
*/
public void setRefractionStrength(float refractionStrength) {
this.refractionStrength = refractionStrength;
@@ -715,7 +726,8 @@ public float getWaveScale() {
* Sets the scale factor of the waves height map
* the smaller the value the bigger the waves
* default is 0.005f
- * @param waveScale
+ *
+ * @param waveScale the desired scale factor (default=0.005)
*/
public void setWaveScale(float waveScale) {
this.waveScale = waveScale;
@@ -737,7 +749,8 @@ public Vector3f getFoamExistence() {
* at what it is completely invisible. The third value is at
* what height foam for waves appear (+ waterHeight).
* default is (0.45, 4.35, 1.0);
- * @param foamExistence
+ *
+ * @param foamExistence the desired parameters (alias created)
*/
public void setFoamExistence(Vector3f foamExistence) {
this.foamExistence = foamExistence;
@@ -756,7 +769,8 @@ public float getSunScale() {
/**
* Sets the scale of the sun for specular effect
- * @param sunScale
+ *
+ * @param sunScale the desired scale factor (default=3)
*/
public void setSunScale(float sunScale) {
this.sunScale = sunScale;
@@ -780,7 +794,9 @@ public Vector3f getColorExtinction() {
* the third is for blue
* Play with those parameters to "trouble" the water
* default is (5.0, 20.0, 30.0f);
- * @param colorExtinction
+ *
+ * @param colorExtinction the desired depth for each color component (alias
+ * created, default=(5,20,30))
*/
public void setColorExtinction(Vector3f colorExtinction) {
this.colorExtinction = colorExtinction;
@@ -814,7 +830,7 @@ public Texture2D getFoamTexture() {
/**
* Sets the height texture
*
- * @param heightTexture
+ * @param heightTexture the texture to use (alias created)
*/
public void setHeightTexture(Texture2D heightTexture) {
this.heightTexture = heightTexture;
@@ -866,7 +882,8 @@ public float getShininess() {
/**
* Sets the shininess factor of the water
* default is 0.7f
- * @param shininess
+ *
+ * @param shininess the desired factor (default=0.7)
*/
public void setShininess(float shininess) {
this.shininess = shininess;
@@ -885,7 +902,8 @@ public float getSpeed() {
/**
* Set the speed of the waves (0.0 is still) default is 1.0
- * @param speed
+ *
+ * @param speed the desired speedup factor (default=1)
*/
public void setSpeed(float speed) {
this.speed = speed;
@@ -904,7 +922,9 @@ public ColorRGBA getWaterColor() {
* Sets the color of the water
* see setDeepWaterColor for deep water color
* default is (0.0078f, 0.5176f, 0.5f,1.0f) (greenish blue)
- * @param waterColor
+ *
+ * @param waterColor the color to use (alias created,
+ * default=(0.0078,0.3176,0.5,1))
*/
public void setWaterColor(ColorRGBA waterColor) {
this.waterColor = waterColor;
@@ -925,7 +945,9 @@ public ColorRGBA getDeepWaterColor() {
* sets the deep water color
* see setWaterColor for general color
* default is (0.0039f, 0.00196f, 0.145f,1.0f) (very dark blue)
- * @param deepWaterColor
+ *
+ * @param deepWaterColor the color to use (alias created,
+ * default=(0.0039,0.00196,0.145,1))
*/
public void setDeepWaterColor(ColorRGBA deepWaterColor) {
this.deepWaterColor = deepWaterColor;
@@ -946,7 +968,9 @@ public Vector2f getWindDirection() {
* sets the wind direction
* the direction where the waves move
* default is (0.0f, -1.0f)
- * @param windDirection
+ *
+ * @param windDirection the direction vector to use (alias created,
+ * default=(0,-1))
*/
public void setWindDirection(Vector2f windDirection) {
this.windDirection = windDirection;
@@ -966,7 +990,9 @@ public int getReflectionMapSize() {
/**
* Sets the size of the reflection map
* default is 512, the higher, the better quality, but the slower the effect.
- * @param reflectionMapSize
+ *
+ * @param reflectionMapSize the desired size (in pixels per side,
+ * default=512)
*/
public void setReflectionMapSize(int reflectionMapSize) {
this.reflectionMapSize = reflectionMapSize;
@@ -991,7 +1017,8 @@ public boolean isUseFoam() {
/**
* set to true to use foam with water
* default true
- * @param useFoam
+ *
+ * @param useFoam true for foam, false for no foam (default=true)
*/
public void setUseFoam(boolean useFoam) {
this.useFoam = useFoam;
@@ -1032,7 +1059,9 @@ public boolean isUseCaustics() {
/**
* set to true if you want caustics to be rendered on the ground underwater, false otherwise
- * @param useCaustics
+ *
+ * @param useCaustics true to enable rendering fo caustics, false to disable
+ * it (default=true)
*/
public void setUseCaustics(boolean useCaustics) {
this.useCaustics = useCaustics;
@@ -1067,7 +1096,9 @@ public boolean isUseRefraction() {
/**
* set to true to use refraction (default is true)
- * @param useRefraction
+ *
+ * @param useRefraction true to enable refraction, false to disable it
+ * (default=true)
*/
public void setUseRefraction(boolean useRefraction) {
this.useRefraction = useRefraction;
@@ -1088,7 +1119,9 @@ public boolean isUseRipples() {
/**
*
* Set to true to use ripples
- * @param useRipples
+ *
+ * @param useRipples true to enable ripples, false to disable them
+ * (default=true)
*/
public void setUseRipples(boolean useRipples) {
this.useRipples = useRipples;
@@ -1108,7 +1141,9 @@ public boolean isUseSpecular() {
/**
* Set to true to use specular lightings on the water
- * @param useSpecular
+ *
+ * @param useSpecular true to enable the specular effect, false to disable
+ * it (default=true)
*/
public void setUseSpecular(boolean useSpecular) {
this.useSpecular = useSpecular;
@@ -1127,7 +1162,8 @@ public float getFoamIntensity() {
/**
* sets the foam intensity default is 0.5f
- * @param foamIntensity
+ *
+ * @param foamIntensity the desired intensity (default=0.5)
*/
public void setFoamIntensity(float foamIntensity) {
this.foamIntensity = foamIntensity;
@@ -1148,7 +1184,8 @@ public float getReflectionDisplace() {
/**
* Sets the reflection displace. define how troubled will look the reflection in the water. default is 30
- * @param reflectionDisplace
+ *
+ * @param reflectionDisplace the desired displacement (default=30)
*/
public void setReflectionDisplace(float reflectionDisplace) {
this.reflectionDisplace = reflectionDisplace;
@@ -1176,7 +1213,9 @@ public float getUnderWaterFogDistance() {
/**
* sets the distance of the fog when under water.
* default is 120 (120 world units) use a high value to raise the view range under water
- * @param underWaterFogDistance
+ *
+ * @param underWaterFogDistance the desired distance (in world units,
+ * default=120)
*/
public void setUnderWaterFogDistance(float underWaterFogDistance) {
this.underWaterFogDistance = underWaterFogDistance;
@@ -1195,7 +1234,9 @@ public float getCausticsIntensity() {
/**
* sets the intensity of caustics under water. goes from 0 to 1, default is 0.5f
- * @param causticsIntensity
+ *
+ * @param causticsIntensity the desired intensity (≥0, ≤1,
+ * default=0.5)
*/
public void setCausticsIntensity(float causticsIntensity) {
this.causticsIntensity = causticsIntensity;