sigonasr2
/
jmonkeyengine
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

jme3-desktop/jme3-effects JavaDoc corrections (comments only)

Browse Source
accellbaker
Stephen Gold 6 years ago
parent c11fbe4dd8
commit 7ad91651f1
17 changed files with 102 additions and 106 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 10
      jme3-desktop/src/main/java/com/jme3/app/state/AWTComponentAppState.java
  2. 3
      jme3-desktop/src/main/java/com/jme3/app/state/VideoRecorderAppState.java
  3. 4
      jme3-desktop/src/main/java/com/jme3/system/AWTFrameProcessor.java
  4. 15
      jme3-desktop/src/main/java/jme3tools/navigation/NavCalculator.java
  5. 18
      jme3-effects/src/main/java/com/jme3/post/filters/BloomFilter.java
  6. 16
      jme3-effects/src/main/java/com/jme3/post/filters/CartoonEdgeFilter.java
  7. 4
      jme3-effects/src/main/java/com/jme3/post/filters/ComposeFilter.java
  8. 6
      jme3-effects/src/main/java/com/jme3/post/filters/CrossHatchFilter.java
  9. 10
      jme3-effects/src/main/java/com/jme3/post/filters/DepthOfFieldFilter.java
  10. 6
      jme3-effects/src/main/java/com/jme3/post/filters/FadeFilter.java
  11. 8
      jme3-effects/src/main/java/com/jme3/post/filters/FogFilter.java
  12. 12
      jme3-effects/src/main/java/com/jme3/post/filters/LightScatteringFilter.java
  13. 8
      jme3-effects/src/main/java/com/jme3/post/filters/RadialBlurFilter.java
  14. 6
      jme3-effects/src/main/java/com/jme3/post/filters/TranslucentBucketFilter.java
  15. 8
      jme3-effects/src/main/java/com/jme3/water/ReflectionProcessor.java
  16. 22
      jme3-effects/src/main/java/com/jme3/water/SimpleWaterProcessor.java
  17. 52
      jme3-effects/src/main/java/com/jme3/water/WaterFilter.java

10
jme3-desktop/src/main/java/com/jme3/app/state/AWTComponentAppState.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2018 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -116,8 +116,8 @@ public class AWTComponentAppState extends AbstractAppState {
} }
/** /**
* Get the {@link AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor. * Get the {@link com.jme3.system.AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor.
* @return the {@link AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor. * @return the {@link com.jme3.system.AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor.
* @see #setTransferMode(com.jme3.system.AWTFrameProcessor.TransferMode) * @see #setTransferMode(com.jme3.system.AWTFrameProcessor.TransferMode)
*/ */
public AWTFrameProcessor.TransferMode getTransferMode(){ public AWTFrameProcessor.TransferMode getTransferMode(){
@ -125,8 +125,8 @@ public class AWTComponentAppState extends AbstractAppState {
} }
/** /**
* Set the {@link AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor. * Set the {@link com.jme3.system.AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor.
* @param mode the {@link AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor. * @param mode the {@link com.jme3.system.AWTFrameProcessor.TransferMode transfer mode} that is used by the underlying frame processor.
* @see #getTransferMode() * @see #getTransferMode()
*/ */
public void setTransferMode(AWTFrameProcessor.TransferMode mode) { public void setTransferMode(AWTFrameProcessor.TransferMode mode) {

3
jme3-desktop/src/main/java/com/jme3/app/state/VideoRecorderAppState.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2012 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -120,7 +120,6 @@ public class VideoRecorderAppState extends AbstractAppState {
* This constructor allows you to specify the output file of the video as well as the quality * This constructor allows you to specify the output file of the video as well as the quality
* @param file the video file * @param file the video file
* @param quality the quality of the jpegs in the video stream (0.0 smallest file - 1.0 largest file) * @param quality the quality of the jpegs in the video stream (0.0 smallest file - 1.0 largest file)
* @param framerate the frame rate of the resulting video, the application will be locked to this framerate
*/ */
public VideoRecorderAppState(File file, float quality) { public VideoRecorderAppState(File file, float quality) {
this.file = file; this.file = file;

4
jme3-desktop/src/main/java/com/jme3/system/AWTFrameProcessor.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2018 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -420,7 +420,6 @@ public class AWTFrameProcessor implements SceneProcessor, PropertyChangeListener
* *
* @param destination the destination. * @param destination the destination.
* @param application the application. * @param application the application.
* @param inputNode the input node.
* @param viewPort the view port. * @param viewPort the view port.
* @param main true if this processor is main. * @param main true if this processor is main.
*/ */
@ -477,7 +476,6 @@ public class AWTFrameProcessor implements SceneProcessor, PropertyChangeListener
* *
* @param application the application. * @param application the application.
* @param destination the destination. * @param destination the destination.
* @param inputNode the input node.
*/ */
protected void bindDestination(Application application, Component destination) { protected void bindDestination(Application application, Component destination) {

15
jme3-desktop/src/main/java/jme3tools/navigation/NavCalculator.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2012 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -139,7 +139,7 @@ public class NavCalculator {
* Calculate a plane sailing situation - i.e. where Lats are the same * Calculate a plane sailing situation - i.e. where Lats are the same
* @param p1 * @param p1
* @param p2 * @param p2
* @return * @return a new instance
* @since 1.0 * @since 1.0
*/ */
public RLSailing planeSailing(Position p1, Position p2) { public RLSailing planeSailing(Position p1, Position p2) {
@ -171,7 +171,7 @@ public class NavCalculator {
* @param tc * @param tc
* @param p1 position one * @param p1 position one
* @param p2 position two * @param p2 position two
* @return * @return angle (in degrees)
* @since 1.0 * @since 1.0
*/ */
public static double convertCourse(float tc, Position p1, Position p2) { public static double convertCourse(float tc, Position p1, Position p2) {
@ -312,9 +312,8 @@ public class NavCalculator {
* Computes the coordinate of position B relative to an offset given * Computes the coordinate of position B relative to an offset given
* a distance and an angle. * a distance and an angle.
* *
* @param offset The offset position. * @param initialPos
* @param bearing The bearing between the offset and the coordinate * @param heading
* that you want to calculate.
* @param distance The distance, in meters, between the offset * @param distance The distance, in meters, between the offset
* and point B. * and point B.
* @return The position of point B that is located from * @return The position of point B that is located from
@ -554,7 +553,7 @@ public class NavCalculator {
* *
* @param p1 * @param p1
* @param p2 * @param p2
* @return * @return bearing (in degrees)
* @since 1.0 * @since 1.0
*/ */
public static int computeBearing(Position p1, Position p2) { public static int computeBearing(Position p1, Position p2) {
@ -572,7 +571,7 @@ public class NavCalculator {
* *
* @param p1 * @param p1
* @param p2 * @param p2
* @return * @return angle (in degrees)
*/ */
public static int computeAngle(Position p1, Position p2) { public static int computeAngle(Position p1, Position p2) {
// cos (adj / hyp) // cos (adj / hyp)

18
jme3-effects/src/main/java/com/jme3/post/filters/BloomFilter.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2012 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -52,7 +52,7 @@ import java.util.ArrayList;
* There are 2 mode : Scene and Objects.<br> * There are 2 mode : Scene and Objects.<br>
* Scene mode extracts the bright parts of the scene to make them glow<br> * Scene mode extracts the bright parts of the scene to make them glow<br>
* Object mode make objects glow according to their material's glowMap or their GlowColor<br> * Object mode make objects glow according to their material's glowMap or their GlowColor<br>
* @see <a href="http://jmonkeyengine.github.io/wiki/jme3/advanced/bloom_and_glow.html">advanced:bloom_and_glow</a> for more details * See <a href="http://jmonkeyengine.github.io/wiki/jme3/advanced/bloom_and_glow.html">advanced:bloom_and_glow</a> for more details
* *
* @author Rémy Bouquet aka Nehon * @author Rémy Bouquet aka Nehon
*/ */
@ -226,7 +226,7 @@ public class BloomFilter extends Filter {
/** /**
* returns the bloom intensity * returns the bloom intensity
* @return * @return the intensity value
*/ */
public float getBloomIntensity() { public float getBloomIntensity() {
return bloomIntensity; return bloomIntensity;
@ -242,7 +242,7 @@ public class BloomFilter extends Filter {
/** /**
* returns the blur scale * returns the blur scale
* @return * @return the blur scale
*/ */
public float getBlurScale() { public float getBlurScale() {
return blurScale; return blurScale;
@ -259,7 +259,7 @@ public class BloomFilter extends Filter {
/** /**
* returns the exposure cutoff<br> * returns the exposure cutoff<br>
* for more details see {@link #setExposureCutOff(float exposureCutOff)} * for more details see {@link #setExposureCutOff(float exposureCutOff)}
* @return * @return the exposure cutoff
*/ */
public float getExposureCutOff() { public float getExposureCutOff() {
return exposureCutOff; return exposureCutOff;
@ -275,8 +275,8 @@ public class BloomFilter extends Filter {
/** /**
* returns the exposure power<br> * returns the exposure power<br>
* form more details see {@link #setExposurePower(float exposurePower)} * for more details see {@link #setExposurePower(float exposurePower)}
* @return * @return the exposure power
*/ */
public float getExposurePower() { public float getExposurePower() {
return exposurePower; return exposurePower;
@ -293,8 +293,8 @@ public class BloomFilter extends Filter {
/** /**
* returns the downSampling factor<br> * returns the downSampling factor<br>
* form more details see {@link #setDownSamplingFactor(float downSamplingFactor)} * for more details see {@link #setDownSamplingFactor(float downSamplingFactor)}
* @return * @return the downsampling factor
*/ */
public float getDownSamplingFactor() { public float getDownSamplingFactor() {
return downSamplingFactor; return downSamplingFactor;

16
jme3-effects/src/main/java/com/jme3/post/filters/CartoonEdgeFilter.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2018 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -115,7 +115,7 @@ public class CartoonEdgeFilter extends Filter {
/** /**
* Return the depth sensitivity<br> * Return the depth sensitivity<br>
* for more details see {@link #setDepthSensitivity(float depthSensitivity)} * for more details see {@link #setDepthSensitivity(float depthSensitivity)}
* @return * @return the depth sensitivity
*/ */
public float getDepthSensitivity() { public float getDepthSensitivity() {
return depthSensitivity; return depthSensitivity;
@ -136,7 +136,7 @@ public class CartoonEdgeFilter extends Filter {
/** /**
* returns the depth threshold<br> * returns the depth threshold<br>
* for more details see {@link #setDepthThreshold(float depthThreshold)} * for more details see {@link #setDepthThreshold(float depthThreshold)}
* @return * @return the threshold
*/ */
public float getDepthThreshold() { public float getDepthThreshold() {
return depthThreshold; return depthThreshold;
@ -157,7 +157,7 @@ public class CartoonEdgeFilter extends Filter {
/** /**
* returns the edge intensity<br> * returns the edge intensity<br>
* for more details see {@link #setEdgeIntensity(float edgeIntensity) } * for more details see {@link #setEdgeIntensity(float edgeIntensity) }
* @return * @return the intensity
*/ */
public float getEdgeIntensity() { public float getEdgeIntensity() {
return edgeIntensity; return edgeIntensity;
@ -177,7 +177,7 @@ public class CartoonEdgeFilter extends Filter {
/** /**
* returns the width of the edges * returns the width of the edges
* @return * @return the width
*/ */
public float getEdgeWidth() { public float getEdgeWidth() {
return edgeWidth; return edgeWidth;
@ -198,7 +198,7 @@ public class CartoonEdgeFilter extends Filter {
/** /**
* returns the normals sensitivity<br> * returns the normals sensitivity<br>
* form more details see {@link #setNormalSensitivity(float normalSensitivity)} * form more details see {@link #setNormalSensitivity(float normalSensitivity)}
* @return * @return the sensitivity
*/ */
public float getNormalSensitivity() { public float getNormalSensitivity() {
return normalSensitivity; return normalSensitivity;
@ -219,7 +219,7 @@ public class CartoonEdgeFilter extends Filter {
* returns the normal threshold<br> * returns the normal threshold<br>
* for more details see {@link #setNormalThreshold(float normalThreshold)} * for more details see {@link #setNormalThreshold(float normalThreshold)}
* *
* @return * @return the threshold
*/ */
public float getNormalThreshold() { public float getNormalThreshold() {
return normalThreshold; return normalThreshold;
@ -238,7 +238,7 @@ public class CartoonEdgeFilter extends Filter {
/** /**
* returns the edge color * returns the edge color
* @return * @return the pre-existing instance
*/ */
public ColorRGBA getEdgeColor() { public ColorRGBA getEdgeColor() {
return edgeColor; return edgeColor;

4
jme3-effects/src/main/java/com/jme3/post/filters/ComposeFilter.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2012 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -68,7 +68,7 @@ public class ComposeFilter extends Filter {
/** /**
* creates a ComposeFilter with the given texture * creates a ComposeFilter with the given texture
* *
* @param color * @param compositeTexture
*/ */
public ComposeFilter(Texture2D compositeTexture) { public ComposeFilter(Texture2D compositeTexture) {
this(); this();

6
jme3-effects/src/main/java/com/jme3/post/filters/CrossHatchFilter.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2018 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -219,7 +219,7 @@ public class CrossHatchFilter extends Filter {
/** /**
* Returns line color * Returns line color
* @return * @return the pre-existing instance
*/ */
public ColorRGBA getLineColor() { public ColorRGBA getLineColor() {
return lineColor; return lineColor;
@ -227,7 +227,7 @@ public class CrossHatchFilter extends Filter {
/** /**
* Returns paper background color * Returns paper background color
* @return * @return the pre-existing instance
*/ */
public ColorRGBA getPaperColor() { public ColorRGBA getPaperColor() {
return paperColor; return paperColor;

10
jme3-effects/src/main/java/com/jme3/post/filters/DepthOfFieldFilter.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2018 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -110,7 +110,7 @@ public class DepthOfFieldFilter extends Filter {
/** /**
* returns the focus distance * returns the focus distance
* @return * @return the distance
*/ */
public float getFocusDistance() { public float getFocusDistance() {
return focusDistance; return focusDistance;
@ -131,7 +131,7 @@ public class DepthOfFieldFilter extends Filter {
/** /**
* returns the focus range * returns the focus range
* @return * @return the distance
*/ */
public float getFocusRange() { public float getFocusRange() {
return focusRange; return focusRange;
@ -159,7 +159,7 @@ public class DepthOfFieldFilter extends Filter {
/** /**
* returns the blur scale * returns the blur scale
* @return * @return the scale
*/ */
public float getBlurScale() { public float getBlurScale() {
return blurScale; return blurScale;
@ -188,7 +188,7 @@ public class DepthOfFieldFilter extends Filter {
/** /**
* returns the blur threshold. * returns the blur threshold.
* @return * @return the threshold
*/ */
public float getBlurThreshold() { public float getBlurThreshold() {
return blurThreshold; return blurThreshold;

6
jme3-effects/src/main/java/com/jme3/post/filters/FadeFilter.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2018 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -101,7 +101,7 @@ public class FadeFilter extends Filter {
/** /**
* returns the duration of the effect * returns the duration of the effect
* @return * @return the duration (in seconds)
*/ */
public float getDuration() { public float getDuration() {
return duration; return duration;
@ -155,7 +155,7 @@ public class FadeFilter extends Filter {
/** /**
* return the current value of the fading * return the current value of the fading
* can be used to check if fade is complete (eg value=1) * can be used to check if fade is complete (eg value=1)
* @return * @return the fractional progress (&ge;0, &le;1)
*/ */
public float getValue() { public float getValue() {
return value; return value;

8
jme3-effects/src/main/java/com/jme3/post/filters/FogFilter.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2012 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -95,7 +95,7 @@ public class FogFilter extends Filter {
/** /**
* returns the fog color * returns the fog color
* @return * @return the pre-existing instance
*/ */
public ColorRGBA getFogColor() { public ColorRGBA getFogColor() {
return fogColor; return fogColor;
@ -114,7 +114,7 @@ public class FogFilter extends Filter {
/** /**
* returns the fog density * returns the fog density
* @return * @return the density value
*/ */
public float getFogDensity() { public float getFogDensity() {
return fogDensity; return fogDensity;
@ -133,7 +133,7 @@ public class FogFilter extends Filter {
/** /**
* returns the fog distance * returns the fog distance
* @return * @return the distance
*/ */
public float getFogDistance() { public float getFogDistance() {
return fogDistance; return fogDistance;

12
jme3-effects/src/main/java/com/jme3/post/filters/LightScatteringFilter.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2018 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -133,7 +133,7 @@ public class LightScatteringFilter extends Filter {
/** /**
* returns the blur start of the scattering * returns the blur start of the scattering
* see {@link #setBlurStart(float blurStart)} * see {@link #setBlurStart(float blurStart)}
* @return * @return the start distance
*/ */
public float getBlurStart() { public float getBlurStart() {
return blurStart; return blurStart;
@ -151,7 +151,7 @@ public class LightScatteringFilter extends Filter {
/** /**
* returns the blur width<br> * returns the blur width<br>
* see {@link #setBlurWidth(float blurWidth)} * see {@link #setBlurWidth(float blurWidth)}
* @return * @return the width
*/ */
public float getBlurWidth() { public float getBlurWidth() {
return blurWidth; return blurWidth;
@ -169,7 +169,7 @@ public class LightScatteringFilter extends Filter {
* returns the light density * returns the light density
* see {@link #setLightDensity(float lightDensity)} * see {@link #setLightDensity(float lightDensity)}
* *
* @return * @return the density
*/ */
public float getLightDensity() { public float getLightDensity() {
return lightDensity; return lightDensity;
@ -185,7 +185,7 @@ public class LightScatteringFilter extends Filter {
/** /**
* returns the light position * returns the light position
* @return * @return the pre-existing vector
*/ */
public Vector3f getLightPosition() { public Vector3f getLightPosition() {
return lightPosition; return lightPosition;
@ -201,7 +201,7 @@ public class LightScatteringFilter extends Filter {
/** /**
* returns the number of samples for the radial blur * returns the number of samples for the radial blur
* @return * @return count (&ge;0)
*/ */
public int getNbSamples() { public int getNbSamples() {
return nbSamples; return nbSamples;

8
jme3-effects/src/main/java/com/jme3/post/filters/RadialBlurFilter.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2018 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -81,7 +81,7 @@ public class RadialBlurFilter extends Filter {
/** /**
* return the sample distance * return the sample distance
* @return * @return the distance
*/ */
public float getSampleDistance() { public float getSampleDistance() {
return sampleDist; return sampleDist;
@ -97,7 +97,7 @@ public class RadialBlurFilter extends Filter {
/** /**
* *
* @return * @return the distance
* @deprecated use {@link #getSampleDistance()} * @deprecated use {@link #getSampleDistance()}
*/ */
@Deprecated @Deprecated
@ -117,7 +117,7 @@ public class RadialBlurFilter extends Filter {
/** /**
* Returns the sample Strength * Returns the sample Strength
* @return * @return the strength value
*/ */
public float getSampleStrength() { public float getSampleStrength() {
return sampleStrength; return sampleStrength;

6
jme3-effects/src/main/java/com/jme3/post/filters/TranslucentBucketFilter.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2012 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -107,8 +107,8 @@ public final class TranslucentBucketFilter extends Filter {
} }
/** /**
* Override this method and return false if your Filter does not need the scene texture * Override this method and return true if your Filter needs the scene texture
* @return * @return false
*/ */
@Override @Override
protected boolean isRequiresSceneTexture() { protected boolean isRequiresSceneTexture() {

8
jme3-effects/src/main/java/com/jme3/water/ReflectionProcessor.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2012 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -110,7 +110,7 @@ public class ReflectionProcessor implements SceneProcessor {
/** /**
* Internal use only<br> * Internal use only<br>
* returns the frame buffer * returns the frame buffer
* @return * @return the pre-existing buffer
*/ */
public FrameBuffer getReflectionBuffer() { public FrameBuffer getReflectionBuffer() {
return reflectionBuffer; return reflectionBuffer;
@ -127,7 +127,7 @@ public class ReflectionProcessor implements SceneProcessor {
/** /**
* returns the reflection cam * returns the reflection cam
* @return * @return the pre-existing Camera
*/ */
public Camera getReflectionCam() { public Camera getReflectionCam() {
return reflectionCam; return reflectionCam;
@ -143,7 +143,7 @@ public class ReflectionProcessor implements SceneProcessor {
/** /**
* returns the reflection clip plane * returns the reflection clip plane
* @return * @return the pre-existing instance
*/ */
public Plane getReflectionClipPlane() { public Plane getReflectionClipPlane() {
return reflectionClipPlane; return reflectionClipPlane;

22
jme3-effects/src/main/java/com/jme3/water/SimpleWaterProcessor.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2018 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -310,7 +310,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
/** /**
* Get the water material from this processor, apply this to your water quad. * Get the water material from this processor, apply this to your water quad.
* @return * @return the pre-existing Material
*/ */
public Material getMaterial() { public Material getMaterial() {
return material; return material;
@ -327,7 +327,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
/** /**
* returns the width of the reflection and refraction textures * returns the width of the reflection and refraction textures
* @return * @return the width (in pixels)
*/ */
public int getRenderWidth() { public int getRenderWidth() {
return renderWidth; return renderWidth;
@ -335,7 +335,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
/** /**
* returns the height of the reflection and refraction textures * returns the height of the reflection and refraction textures
* @return * @return the height (in pixels)
*/ */
public int getRenderHeight() { public int getRenderHeight() {
return renderHeight; return renderHeight;
@ -354,7 +354,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
/** /**
* returns the water plane * returns the water plane
* @return * @return the pre-existing instance
*/ */
public Plane getPlane() { public Plane getPlane() {
return plane; return plane;
@ -417,7 +417,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
/** /**
* return the water depth * return the water depth
* @return * @return the depth
*/ */
public float getWaterDepth() { public float getWaterDepth() {
return waterDepth; return waterDepth;
@ -425,7 +425,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
/** /**
* returns water transparency * returns water transparency
* @return * @return the transparency value
*/ */
public float getWaterTransparency() { public float getWaterTransparency() {
return waterTransparency; return waterTransparency;
@ -515,7 +515,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
/** /**
* returns true if the waterprocessor is in debug mode * returns true if the waterprocessor is in debug mode
* @return * @return true if in debug mode, otherwise false
*/ */
public boolean isDebug() { public boolean isDebug() {
return debug; return debug;
@ -533,7 +533,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
* Creates a quad with the water material applied to it. * Creates a quad with the water material applied to it.
* @param width * @param width
* @param height * @param height
* @return * @return a new Geometry
*/ */
public Geometry createWaterGeometry(float width, float height) { public Geometry createWaterGeometry(float width, float height) {
Quad quad = new Quad(width, height); Quad quad = new Quad(width, height);
@ -545,7 +545,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
/** /**
* returns the reflection clipping plane offset * returns the reflection clipping plane offset
* @return * @return the offset value
*/ */
public float getReflectionClippingOffset() { public float getReflectionClippingOffset() {
return reflectionClippingOffset; return reflectionClippingOffset;
@ -563,7 +563,7 @@ public class SimpleWaterProcessor implements SceneProcessor {
/** /**
* returns the refraction clipping plane offset * returns the refraction clipping plane offset
* @return * @return the offset value
*/ */
public float getRefractionClippingOffset() { public float getRefractionClippingOffset() {
return refractionClippingOffset; return refractionClippingOffset;

52
jme3-effects/src/main/java/com/jme3/water/WaterFilter.java
Unescape View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009-2018 jMonkeyEngine * Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@ -464,7 +464,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* gets the height of the water plane * gets the height of the water plane
* @return * @return the height
*/ */
public float getWaterHeight() { public float getWaterHeight() {
return waterHeight; return waterHeight;
@ -517,7 +517,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* returns the waterTransparency value * returns the waterTransparency value
* @return * @return the transparency value
*/ */
public float getWaterTransparency() { public float getWaterTransparency() {
return waterTransparency; return waterTransparency;
@ -539,7 +539,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* Returns the normal scales applied to the normal map * Returns the normal scales applied to the normal map
* @return * @return the scale factor
*/ */
public float getNormalScale() { public float getNormalScale() {
return normalScale; return normalScale;
@ -559,8 +559,8 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
} }
/** /**
* returns the refractoin constant * returns the refraction constant
* @return * @return the refraction constant
*/ */
public float getRefractionConstant() { public float getRefractionConstant() {
return refractionConstant; return refractionConstant;
@ -584,7 +584,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* return the maximum wave amplitude * return the maximum wave amplitude
* @return * @return the maximum amplitude
*/ */
public float getMaxAmplitude() { public float getMaxAmplitude() {
return maxAmplitude; return maxAmplitude;
@ -604,7 +604,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* gets the light direction * gets the light direction
* @return * @return the pre-existing vector
*/ */
public Vector3f getLightDirection() { public Vector3f getLightDirection() {
return lightDirection; return lightDirection;
@ -623,7 +623,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* returns the light color * returns the light color
* @return * @return the pre-existing instance
*/ */
public ColorRGBA getLightColor() { public ColorRGBA getLightColor() {
return lightColor; return lightColor;
@ -643,7 +643,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* Return the shoreHardeness * Return the shoreHardeness
* @return * @return the hardness value
*/ */
public float getShoreHardness() { public float getShoreHardness() {
return shoreHardness; return shoreHardness;
@ -664,7 +664,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* returns the foam hardness * returns the foam hardness
* @return * @return the hardness value
*/ */
public float getFoamHardness() { public float getFoamHardness() {
return foamHardness; return foamHardness;
@ -684,7 +684,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* returns the refractionStrength * returns the refractionStrength
* @return * @return the strength value
*/ */
public float getRefractionStrength() { public float getRefractionStrength() {
return refractionStrength; return refractionStrength;
@ -705,7 +705,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* returns the scale factor of the waves height map * returns the scale factor of the waves height map
* @return * @return the scale factor
*/ */
public float getWaveScale() { public float getWaveScale() {
return waveScale; return waveScale;
@ -726,7 +726,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* returns the foam existence vector * returns the foam existence vector
* @return * @return the pre-existing vector
*/ */
public Vector3f getFoamExistence() { public Vector3f getFoamExistence() {
return foamExistence; return foamExistence;
@ -748,7 +748,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* gets the scale of the sun * gets the scale of the sun
* @return * @return the scale factor
*/ */
public float getSunScale() { public float getSunScale() {
return sunScale; return sunScale;
@ -767,7 +767,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* Returns the color extinction vector of the water * Returns the color extinction vector of the water
* @return * @return the pre-existing vector
*/ */
public Vector3f getColorExtinction() { public Vector3f getColorExtinction() {
return colorExtinction; return colorExtinction;
@ -857,7 +857,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* return the shininess factor of the water * return the shininess factor of the water
* @return * @return the shininess factor
*/ */
public float getShininess() { public float getShininess() {
return shininess; return shininess;
@ -877,7 +877,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* returns the speed of the waves * returns the speed of the waves
* @return * @return the speed value
*/ */
public float getSpeed() { public float getSpeed() {
return speed; return speed;
@ -894,7 +894,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* returns the color of the water * returns the color of the water
* *
* @return * @return the pre-existing instance
*/ */
public ColorRGBA getWaterColor() { public ColorRGBA getWaterColor() {
return waterColor; return waterColor;
@ -915,7 +915,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* returns the deep water color * returns the deep water color
* @return * @return the pre-existing instance
*/ */
public ColorRGBA getDeepWaterColor() { public ColorRGBA getDeepWaterColor() {
return deepWaterColor; return deepWaterColor;
@ -936,7 +936,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* returns the wind direction * returns the wind direction
* @return * @return the pre-existing direction vector
*/ */
public Vector2f getWindDirection() { public Vector2f getWindDirection() {
return windDirection; return windDirection;
@ -957,7 +957,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* returns the size of the reflection map * returns the size of the reflection map
* @return * @return the size (in pixels)
*/ */
public int getReflectionMapSize() { public int getReflectionMapSize() {
return reflectionMapSize; return reflectionMapSize;
@ -1119,7 +1119,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* returns the foam intensity * returns the foam intensity
* @return * @return the intensity value
*/ */
public float getFoamIntensity() { public float getFoamIntensity() {
return foamIntensity; return foamIntensity;
@ -1140,7 +1140,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* returns the reflection displace * returns the reflection displace
* see {@link #setReflectionDisplace(float) } * see {@link #setReflectionDisplace(float) }
* @return * @return the displacement value
*/ */
public float getReflectionDisplace() { public float getReflectionDisplace() {
return reflectionDisplace; return reflectionDisplace;
@ -1167,7 +1167,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* returns the distance of the fog when under water * returns the distance of the fog when under water
* @return * @return the distance
*/ */
public float getUnderWaterFogDistance() { public float getUnderWaterFogDistance() {
return underWaterFogDistance; return underWaterFogDistance;
@ -1187,7 +1187,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
/** /**
* get the intensity of caustics under water * get the intensity of caustics under water
* @return * @return the intensity value (&ge;0, &le;1)
*/ */
public float getCausticsIntensity() { public float getCausticsIntensity() {
return causticsIntensity; return causticsIntensity;

Write Preview
Loading…
Cancel
Save