correct more grammar/spelling errors in comments
This commit is contained in:
parent
5a1a5771ec
commit
4f664f33cc
@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (c) 2009-2012 jMonkeyEngine
|
* Copyright (c) 2009-2018 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
|
||||||
@ -34,7 +34,7 @@ package com.jme3.cinematic;
|
|||||||
import com.jme3.cinematic.events.MotionEvent;
|
import com.jme3.cinematic.events.MotionEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Trigger the events happening on an motion path
|
* Trigger the events happening on a motion path
|
||||||
* @author Nehon
|
* @author Nehon
|
||||||
*/
|
*/
|
||||||
public interface MotionPathListener {
|
public interface MotionPathListener {
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (c) 2009-2012 jMonkeyEngine
|
* Copyright (c) 2009-2018 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
|
||||||
@ -123,7 +123,7 @@ public interface Joystick {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the POV Y axis for this joystick. This is a convenience axis
|
* Returns the POV Y axis for this joystick. This is a convenience axis
|
||||||
* providing an y-axis subview of the HAT axis.
|
* providing a y-axis subview of the HAT axis.
|
||||||
*
|
*
|
||||||
* @see JoystickAxis#assignAxis(java.lang.String, java.lang.String)
|
* @see JoystickAxis#assignAxis(java.lang.String, java.lang.String)
|
||||||
*/
|
*/
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (c) 2009-2012 jMonkeyEngine
|
* Copyright (c) 2009-2018 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
|
||||||
@ -860,7 +860,7 @@ final public class FastMath {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Takes an value and expresses it in terms of min to max.
|
* Takes a value and expresses it in terms of min to max.
|
||||||
*
|
*
|
||||||
* @param val -
|
* @param val -
|
||||||
* the angle to normalize (in radians)
|
* the angle to normalize (in radians)
|
||||||
|
@ -606,7 +606,7 @@ public class Glsl100ShaderGenerator extends ShaderGenerator {
|
|||||||
/**
|
/**
|
||||||
* Declares a varying
|
* Declares a varying
|
||||||
* @param source the StringBuilder to use
|
* @param source the StringBuilder to use
|
||||||
* @param var the variable to declare as an varying
|
* @param var the variable to declare as a varying
|
||||||
* @param input a boolean set to true if the this varying is an input.
|
* @param input a boolean set to true if the this varying is an input.
|
||||||
* this in not used in this implementation but can be used in overriding
|
* this in not used in this implementation but can be used in overriding
|
||||||
* implementation
|
* implementation
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (c) 2009-2012 jMonkeyEngine
|
* Copyright (c) 2009-2018 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
|
||||||
@ -269,7 +269,7 @@ public class ByteUtils {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public static long convertLongFromBytes(byte[] bytes, int offset) {
|
public static long convertLongFromBytes(byte[] bytes, int offset) {
|
||||||
// Convert it to an long
|
// Convert it to a long
|
||||||
return ((((long) bytes[offset+7]) & 0xFF)
|
return ((((long) bytes[offset+7]) & 0xFF)
|
||||||
+ ((((long) bytes[offset+6]) & 0xFF) << 8)
|
+ ((((long) bytes[offset+6]) & 0xFF) << 8)
|
||||||
+ ((((long) bytes[offset+5]) & 0xFF) << 16)
|
+ ((((long) bytes[offset+5]) & 0xFF) << 16)
|
||||||
@ -340,7 +340,7 @@ public class ByteUtils {
|
|||||||
// ********** byte <> float METHODS **********
|
// ********** byte <> float METHODS **********
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Writes an float out to an OutputStream.
|
* Writes a float out to an OutputStream.
|
||||||
*
|
*
|
||||||
* @param outputStream
|
* @param outputStream
|
||||||
* The OutputStream the float will be written to
|
* The OutputStream the float will be written to
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (c) 2009-2012 jMonkeyEngine
|
* Copyright (c) 2009-2018 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,7 +116,7 @@ public class Coordinate {
|
|||||||
* This constructor takes a coordinate in the ALRS formats i.e
|
* This constructor takes a coordinate in the ALRS formats i.e
|
||||||
* 38∞31.64'N for lat, and 28∞19.12'W for long
|
* 38∞31.64'N for lat, and 28∞19.12'W for long
|
||||||
* Note: ALRS positions are occasionally written with the decimal minutes
|
* Note: ALRS positions are occasionally written with the decimal minutes
|
||||||
* apostrophe in the 'wrong' place and with an non CP1252 compliant decimal character.
|
* apostrophe in the 'wrong' place and with a non CP1252 compliant decimal character.
|
||||||
* This issue has to be corrected in the source database
|
* This issue has to be corrected in the source database
|
||||||
* @param coOrdinate
|
* @param coOrdinate
|
||||||
* @throws InvalidPositionException
|
* @throws InvalidPositionException
|
||||||
|
@ -124,7 +124,7 @@ public class RadialBlurFilter extends Filter {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* sets the sample streanght default is 2.2
|
* sets the sample strength default is 2.2
|
||||||
* @param sampleStrength
|
* @param sampleStrength
|
||||||
*/
|
*/
|
||||||
public void setSampleStrength(float sampleStrength) {
|
public void setSampleStrength(float sampleStrength) {
|
||||||
|
@ -569,8 +569,8 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
|
|||||||
/**
|
/**
|
||||||
* This is a constant related to the index of refraction (IOR) used to compute the fresnel term.
|
* This is a constant related to the index of refraction (IOR) used to compute the fresnel term.
|
||||||
* F = R0 + (1-R0)( 1 - N.V)^5
|
* F = R0 + (1-R0)( 1 - N.V)^5
|
||||||
* where F is the fresnel term, R0 the constant, N the normal vector and V tne view vector.
|
* where F is the fresnel term, R0 the constant, N the normal vector and V the view vector.
|
||||||
* It usually depend on the material you are lookinh through (here water).
|
* It usually depend on the material you are looking through (here water).
|
||||||
* Default value is 0.3f
|
* Default value is 0.3f
|
||||||
* In practice, the lowest the value and the less the reflection can be seen on water
|
* In practice, the lowest the value and the less the reflection can be seen on water
|
||||||
* @param refractionConstant
|
* @param refractionConstant
|
||||||
@ -683,7 +683,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* returns the refractionStrenght
|
* returns the refractionStrength
|
||||||
* @return
|
* @return
|
||||||
*/
|
*/
|
||||||
public float getRefractionStrength() {
|
public float getRefractionStrength() {
|
||||||
@ -692,7 +692,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* This value modifies current fresnel term. If you want to weaken
|
* This value modifies current fresnel term. If you want to weaken
|
||||||
* reflections use bigger value. If you want to empasize them use
|
* reflections use bigger value. If you want to emphasize them use
|
||||||
* value smaller then 0. Default is 0.0f.
|
* value smaller then 0. Default is 0.0f.
|
||||||
* @param refractionStrength
|
* @param refractionStrength
|
||||||
*/
|
*/
|
||||||
@ -725,7 +725,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* returns the foam existance vector
|
* returns the foam existence vector
|
||||||
* @return
|
* @return
|
||||||
*/
|
*/
|
||||||
public Vector3f getFoamExistence() {
|
public Vector3f getFoamExistence() {
|
||||||
@ -766,7 +766,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the color exctinction vector of the water
|
* Returns the color extinction vector of the water
|
||||||
* @return
|
* @return
|
||||||
*/
|
*/
|
||||||
public Vector3f getColorExtinction() {
|
public Vector3f getColorExtinction() {
|
||||||
@ -778,7 +778,7 @@ public class WaterFilter extends Filter implements JmeCloneable, Cloneable {
|
|||||||
* the first value is for red
|
* the first value is for red
|
||||||
* the second is for green
|
* the second is for green
|
||||||
* the third is for blue
|
* the third is for blue
|
||||||
* Play with thos parameters to "trouble" the water
|
* Play with those parameters to "trouble" the water
|
||||||
* default is (5.0, 20.0, 30.0f);
|
* default is (5.0, 20.0, 30.0f);
|
||||||
* @param colorExtinction
|
* @param colorExtinction
|
||||||
*/
|
*/
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (c) 2009-2017 jMonkeyEngine
|
* Copyright (c) 2009-2018 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
|
||||||
@ -51,7 +51,7 @@ import com.jme3.scene.Spatial;
|
|||||||
import com.jme3.scene.shape.Box;
|
import com.jme3.scene.shape.Box;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Simple application to an test attachments node on the Jaime model.
|
* Simple application to test an attachments node on the Jaime model.
|
||||||
*
|
*
|
||||||
* Derived from {@link jme3test.model.anim.TestOgreAnim}.
|
* Derived from {@link jme3test.model.anim.TestOgreAnim}.
|
||||||
*/
|
*/
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (c) 2009-2017 jMonkeyEngine
|
* Copyright (c) 2009-2018 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
|
||||||
@ -38,7 +38,7 @@ import com.jme3.scene.Geometry;
|
|||||||
import com.jme3.scene.shape.Box;
|
import com.jme3.scene.shape.Box;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Simple application to an test a viewport/camera with a different aspect ratio
|
* Simple application to test a viewport/camera with a different aspect ratio
|
||||||
* than the display -- issue #357. The cube should render as a blue square, not
|
* than the display -- issue #357. The cube should render as a blue square, not
|
||||||
* a rectangle.
|
* a rectangle.
|
||||||
*
|
*
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (c) 2009-2012 jMonkeyEngine
|
* Copyright (c) 2009-2018 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
|
||||||
@ -152,7 +152,7 @@ public class OGGLoader implements AssetLoader {
|
|||||||
// HACK: Reload the logical and vorbis streams from scratch
|
// HACK: Reload the logical and vorbis streams from scratch
|
||||||
// based on the existing ogg page data.
|
// based on the existing ogg page data.
|
||||||
// This fixes an audio discontinuity issue when looping
|
// This fixes an audio discontinuity issue when looping
|
||||||
// an streaming OGG file via setTime(0).
|
// a streaming OGG file via setTime(0).
|
||||||
ls = ((CachedOggStream) ps).reloadLogicalOggStream();
|
ls = ((CachedOggStream) ps).reloadLogicalOggStream();
|
||||||
vs = new VorbisStream(ls);
|
vs = new VorbisStream(ls);
|
||||||
endOfStream = false;
|
endOfStream = false;
|
||||||
|
@ -37,7 +37,7 @@ import java.util.logging.Level;
|
|||||||
import java.util.logging.Logger;
|
import java.util.logging.Logger;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates an heightmap based on the fault algorithm. Each iteration, a random line
|
* Creates a heightmap based on the fault algorithm. Each iteration, a random line
|
||||||
* crossing the map is generated. On one side height values are raised, on the other side
|
* crossing the map is generated. On one side height values are raised, on the other side
|
||||||
* lowered.
|
* lowered.
|
||||||
* @author cghislai
|
* @author cghislai
|
||||||
@ -118,7 +118,7 @@ public class FaultHeightMap extends AbstractHeightMap {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create an heightmap with linear step faults.
|
* Create a heightmap with linear step faults.
|
||||||
* @param size size of heightmap
|
* @param size size of heightmap
|
||||||
* @param iterations number of iterations
|
* @param iterations number of iterations
|
||||||
* @param minFaultHeight Height modified on each side
|
* @param minFaultHeight Height modified on each side
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (c) 2009-2012 jMonkeyEngine
|
* Copyright (c) 2009-2018 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
|
||||||
@ -37,7 +37,7 @@ import java.util.logging.Level;
|
|||||||
import java.util.logging.Logger;
|
import java.util.logging.Logger;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* <code>MidpointDisplacementHeightMap</code> generates an heightmap based on
|
* <code>MidpointDisplacementHeightMap</code> generates a heightmap based on
|
||||||
* the midpoint displacement algorithm. See Constructor javadoc for more info.
|
* the midpoint displacement algorithm. See Constructor javadoc for more info.
|
||||||
* @author cghislai
|
* @author cghislai
|
||||||
*/
|
*/
|
||||||
@ -50,7 +50,7 @@ public class MidpointDisplacementHeightMap extends AbstractHeightMap {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* The constructor generates the heightmap. After the first 4 corners are
|
* The constructor generates the heightmap. After the first 4 corners are
|
||||||
* randomly given an height, the center will be heighted to the average of
|
* randomly given a height, the center will be heighted to the average of
|
||||||
* the 4 corners to which a random value is added. Then other passes fill
|
* the 4 corners to which a random value is added. Then other passes fill
|
||||||
* the heightmap by the same principle.
|
* the heightmap by the same principle.
|
||||||
* The random value is generated between the values <code>-range</code>
|
* The random value is generated between the values <code>-range</code>
|
||||||
@ -87,7 +87,7 @@ public class MidpointDisplacementHeightMap extends AbstractHeightMap {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* The constructor generates the heightmap. After the first 4 corners are
|
* The constructor generates the heightmap. After the first 4 corners are
|
||||||
* randomly given an height, the center will be heighted to the average of
|
* randomly given a height, the center will be heighted to the average of
|
||||||
* the 4 corners to which a random value is added. Then other passes fill
|
* the 4 corners to which a random value is added. Then other passes fill
|
||||||
* the heightmap by the same principle.
|
* the heightmap by the same principle.
|
||||||
* The random value is generated between the values <code>-range</code>
|
* The random value is generated between the values <code>-range</code>
|
||||||
@ -156,10 +156,10 @@ public class MidpointDisplacementHeightMap extends AbstractHeightMap {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Will fill the value at (coords[0]+stepSize/2, coords[1]+stepSize/2) with
|
* Will fill the value at (coords[0]+stepSize/2, coords[1]+stepSize/2) with
|
||||||
* the average from the corners of the square with topleft corner at (coords[0],coords[1])
|
* the average from the corners of the square with top, left corner at (coords[0],coords[1])
|
||||||
* and width of stepSize.
|
* and width of stepSize.
|
||||||
* @param tempBuffer the temprary heightmap
|
* @param tempBuffer the temporary heightmap
|
||||||
* @param coords an int array of lenght 2 with the x coord in position 0
|
* @param coords an int array of length 2 with the x coord in position 0
|
||||||
* @param stepSize the size of the square
|
* @param stepSize the size of the square
|
||||||
* @param offsetRange the offset range within a random value is picked and added to the average
|
* @param offsetRange the offset range within a random value is picked and added to the average
|
||||||
* @param random the random generator
|
* @param random the random generator
|
||||||
|
@ -92,8 +92,8 @@ public interface VRAPI {
|
|||||||
public void reset();
|
public void reset();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the size of an Head Mounted Device (HMD) rendering area in pixels.
|
* Get the size of a Head Mounted Device (HMD) rendering area in pixels.
|
||||||
* @param store the size of an Head Mounted Device (HMD) rendering area in pixels (modified).
|
* @param store the size of a Head Mounted Device (HMD) rendering area in pixels (modified).
|
||||||
*/
|
*/
|
||||||
public void getRenderSize(Vector2f store);
|
public void getRenderSize(Vector2f store);
|
||||||
|
|
||||||
|
@ -89,16 +89,16 @@ public interface VRInputAPI {
|
|||||||
public boolean init();
|
public boolean init();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the number of tracked controller (for example an hand controllers) attached to the VR system.
|
* Get the number of tracked controllers (for example, hand controllers) attached to the VR system.
|
||||||
* @return the number of controller attached to the VR system.
|
* @return the number of controllers attached to the VR system.
|
||||||
* @see #getTrackedController(int)
|
* @see #getTrackedController(int)
|
||||||
*/
|
*/
|
||||||
public int getTrackedControllerCount();
|
public int getTrackedControllerCount();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the tracked controller (for example an hand controllers) that is attached to the VR system.
|
* Get a tracked controller (for example, a hand controller) that is attached to the VR system.
|
||||||
* @param index the index of the controller.
|
* @param index the index of the controller.
|
||||||
* @return the tracked controller (for example an hand controllers) that is attached to the VR system.
|
* @return the tracked controller (for example, a hand controller) that is attached to the VR system.
|
||||||
* @see #getTrackedControllerCount()
|
* @see #getTrackedControllerCount()
|
||||||
*/
|
*/
|
||||||
public VRTrackedController getTrackedController(int index);
|
public VRTrackedController getTrackedController(int index);
|
||||||
@ -189,7 +189,7 @@ public interface VRInputAPI {
|
|||||||
public Vector3f getFinalObserverPosition(int index);
|
public Vector3f getFinalObserverPosition(int index);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Trigger an haptic pulse on the selected controller for the duration given in parameters (in seconds).
|
* Trigger a haptic pulse on the selected controller for the duration given in parameters (in seconds).
|
||||||
* @param controllerIndex the index of the controller.
|
* @param controllerIndex the index of the controller.
|
||||||
* @param seconds the duration of the pulse in seconds.
|
* @param seconds the duration of the pulse in seconds.
|
||||||
*/
|
*/
|
||||||
|
@ -486,7 +486,7 @@ public class OpenVRInput implements VRInputAPI {
|
|||||||
}
|
}
|
||||||
trackedControllers.add(new OpenVRTrackedController(i, this, controllerName, manufacturerName, environment));
|
trackedControllers.add(new OpenVRTrackedController(i, this, controllerName, manufacturerName, environment));
|
||||||
|
|
||||||
// Send an Haptic pulse to the controller
|
// Send a Haptic pulse to the controller
|
||||||
triggerHapticPulse(controllerCount, 1.0f);
|
triggerHapticPulse(controllerCount, 1.0f);
|
||||||
|
|
||||||
controllerCount++;
|
controllerCount++;
|
||||||
|
Loading…
x
Reference in New Issue
Block a user