Merge pull request #495 from Dokthar/typo_fix

That's not those typos you're looking for....
define_list_fix
Rémy Bouquet 9 years ago
commit ba92462521
  1. 6
      jme3-core/src/main/java/com/jme3/animation/AnimationFactory.java
  2. 6
      jme3-core/src/main/java/com/jme3/animation/AudioTrack.java
  3. 6
      jme3-core/src/main/java/com/jme3/animation/ClonableTrack.java
  4. 18
      jme3-core/src/main/java/com/jme3/animation/EffectTrack.java
  5. 13
      jme3-core/src/main/java/com/jme3/app/ChaseCameraAppState.java
  6. 26
      jme3-core/src/main/java/com/jme3/cinematic/Cinematic.java
  7. 4
      jme3-core/src/main/java/com/jme3/cinematic/MotionPath.java
  8. 2
      jme3-core/src/main/java/com/jme3/cinematic/MotionPathListener.java
  9. 14
      jme3-core/src/main/java/com/jme3/cinematic/events/AbstractCinematicEvent.java
  10. 14
      jme3-core/src/main/java/com/jme3/cinematic/events/AnimationEvent.java
  11. 2
      jme3-core/src/main/java/com/jme3/cinematic/events/CinematicEvent.java
  12. 4
      jme3-core/src/main/java/com/jme3/cinematic/events/MotionEvent.java
  13. 26
      jme3-core/src/main/java/com/jme3/cinematic/events/SoundEvent.java
  14. 4
      jme3-core/src/main/java/com/jme3/cinematic/events/SoundTrack.java
  15. 12
      jme3-core/src/main/java/com/jme3/input/ChaseCamera.java
  16. 4
      jme3-core/src/main/java/com/jme3/light/SpotLight.java
  17. 8
      jme3-core/src/main/java/com/jme3/math/Spline.java
  18. 18
      jme3-core/src/main/java/com/jme3/shader/Glsl100ShaderGenerator.java
  19. 2
      jme3-core/src/main/java/com/jme3/shader/Glsl150ShaderGenerator.java
  20. 8
      jme3-core/src/main/java/com/jme3/shader/ShaderGenerator.java
  21. 14
      jme3-core/src/main/java/com/jme3/shader/ShaderNode.java
  22. 16
      jme3-core/src/main/java/com/jme3/shader/ShaderNodeDefinition.java
  23. 14
      jme3-core/src/main/java/com/jme3/shader/ShaderNodeVariable.java
  24. 2
      jme3-core/src/main/java/com/jme3/shader/ShaderVariable.java
  25. 10
      jme3-core/src/main/java/com/jme3/shader/VariableMapping.java
  26. 8
      jme3-core/src/main/java/com/jme3/shadow/AbstractShadowFilter.java
  27. 4
      jme3-core/src/main/java/com/jme3/shadow/AbstractShadowRenderer.java
  28. 8
      jme3-core/src/main/java/com/jme3/shadow/PssmShadowFilter.java
  29. 10
      jme3-core/src/main/java/com/jme3/shadow/PssmShadowRenderer.java
  30. 18
      jme3-core/src/main/java/com/jme3/util/BufferUtils.java
  31. 4
      jme3-core/src/main/java/com/jme3/util/ListSort.java
  32. 4
      jme3-core/src/main/java/com/jme3/util/MaterialDebugAppState.java
  33. 2
      jme3-core/src/main/java/com/jme3/util/mikktspace/MikktspaceTangentGenerator.java
  34. 2
      jme3-core/src/plugins/java/com/jme3/material/plugins/ConditionParser.java
  35. 6
      jme3-core/src/plugins/java/com/jme3/material/plugins/MatParseException.java
  36. 34
      jme3-core/src/plugins/java/com/jme3/material/plugins/ShaderNodeLoaderDelegate.java
  37. 14
      jme3-core/src/tools/java/jme3tools/optimize/LodGenerator.java

@ -44,10 +44,10 @@ import com.jme3.math.Vector3f;
* Usage is : <br> * Usage is : <br>
* - Create the AnimationHelper<br> * - Create the AnimationHelper<br>
* - add some keyFrames<br> * - add some keyFrames<br>
* - call the buildAnimation() method that will retruna new Animation<br> * - call the buildAnimation() method that will return a new Animation<br>
* - add the generated Animation to any existing AnimationControl<br> * - add the generated Animation to any existing AnimationControl<br>
* <br><br> * <br><br>
* Note that the first keyFrame (index 0) is defaulted with the identy transforms. * Note that the first keyFrame (index 0) is defaulted with the identity transforms.
* If you want to change that you have to replace this keyFrame with any transform you want. * If you want to change that you have to replace this keyFrame with any transform you want.
* *
* @author Nehon * @author Nehon
@ -55,7 +55,7 @@ import com.jme3.math.Vector3f;
public class AnimationFactory { public class AnimationFactory {
/** /**
* step for splitting rotation that have a n ange above PI/2 * step for splitting rotation that have a n angle above PI/2
*/ */
private final static float EULER_STEP = FastMath.QUARTER_PI * 3; private final static float EULER_STEP = FastMath.QUARTER_PI * 3;

@ -46,7 +46,7 @@ import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
/** /**
* AudioTrack is a track to add to an existing animation, to paly a sound during * AudioTrack is a track to add to an existing animation, to play a sound during
* an animations for example : gun shot, foot step, shout, etc... * an animations for example : gun shot, foot step, shout, etc...
* *
* usage is * usage is
@ -144,7 +144,7 @@ public class AudioTrack implements ClonableTrack {
} }
/** /**
* Retruns the length of the track * Return the length of the track
* *
* @return length of the track * @return length of the track
*/ */
@ -170,7 +170,7 @@ public class AudioTrack implements ClonableTrack {
/** /**
* This method clone the Track and search for the cloned counterpart of the * This method clone the Track and search for the cloned counterpart of the
* original audio node in the given cloned spatial. The spatial is assumed * original audio node in the given cloned spatial. The spatial is assumed
* to be the Spatial holding the AnimControl controling the animation using * to be the Spatial holding the AnimControl controlling the animation using
* this Track. * this Track.
* *
* @param spatial the Spatial holding the AnimControl * @param spatial the Spatial holding the AnimControl

@ -36,7 +36,7 @@ import com.jme3.util.clone.JmeCloneable;
/** /**
* An interface that allow to clone a Track for a given Spatial. * An interface that allow to clone a Track for a given Spatial.
* The spatial fed to the method is the Spatial holding the AnimControl controling the Animation using this track. * The spatial fed to the method is the Spatial holding the AnimControl controlling the Animation using this track.
* *
* Implement this interface only if you make your own Savable Track and that the track has a direct reference to a Spatial in the scene graph. * Implement this interface only if you make your own Savable Track and that the track has a direct reference to a Spatial in the scene graph.
* This Spatial is assumed to be a child of the spatial holding the AnimControl. * This Spatial is assumed to be a child of the spatial holding the AnimControl.
@ -48,11 +48,11 @@ public interface ClonableTrack extends Track, JmeCloneable {
/** /**
* Allows to clone the track for a given Spatial. * Allows to clone the track for a given Spatial.
* The spatial fed to the method is the Spatial holding the AnimControl controling the Animation using this track. * The spatial fed to the method is the Spatial holding the AnimControl controlling the Animation using this track.
* This method will be called during the loading process of a j3o model by the assetManager. * This method will be called during the loading process of a j3o model by the assetManager.
* The assetManager keeps the original model in cache and returns a clone of the model. * The assetManager keeps the original model in cache and returns a clone of the model.
* *
* This method prupose is to find the cloned reference of the original spatial which it refers to in the cloned model. * This method purpose is to find the cloned reference of the original spatial which it refers to in the cloned model.
* *
* See EffectTrack for a proper implementation. * See EffectTrack for a proper implementation.
* *

@ -51,7 +51,7 @@ import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
/** /**
* EffectTrack is a track to add to an existing animation, to emmit particles * EffectTrack is a track to add to an existing animation, to emit particles
* during animations for example : exhausts, dust raised by foot steps, shock * during animations for example : exhausts, dust raised by foot steps, shock
* waves, lightnings etc... * waves, lightnings etc...
* *
@ -62,9 +62,9 @@ import java.util.logging.Logger;
* control.getAnim("TheAnim").addTrack(track); * control.getAnim("TheAnim").addTrack(track);
* </pre> * </pre>
* *
* if the emitter has emmits 0 particles per seconds emmitAllPArticles will be * if the emitter has emits 0 particles per seconds emmitAllPArticles will be
* called on it at time 0 + startOffset. if it he it has more it will start * called on it at time 0 + startOffset. if it he it has more it will start
* emmit normally at time 0 + startOffset. * emit normally at time 0 + startOffset.
* *
* *
* @author Nehon * @author Nehon
@ -167,7 +167,7 @@ public class EffectTrack implements ClonableTrack {
/** /**
* Creates and EffectTrack * Creates and EffectTrack
* *
* @param emitter the emmitter of the track * @param emitter the emitter of the track
* @param length the length of the track (usually the length of the * @param length the length of the track (usually the length of the
* animation you want to add the track to) * animation you want to add the track to)
*/ */
@ -186,10 +186,10 @@ public class EffectTrack implements ClonableTrack {
/** /**
* Creates and EffectTrack * Creates and EffectTrack
* *
* @param emitter the emmitter of the track * @param emitter the emitter of the track
* @param length the length of the track (usually the length of the * @param length the length of the track (usually the length of the
* animation you want to add the track to) * animation you want to add the track to)
* @param startOffset the time in second when the emitter will be triggerd * @param startOffset the time in second when the emitter will be triggered
* after the animation starts (default is 0) * after the animation starts (default is 0)
*/ */
public EffectTrack(ParticleEmitter emitter, float length, float startOffset) { public EffectTrack(ParticleEmitter emitter, float length, float startOffset) {
@ -244,7 +244,7 @@ public class EffectTrack implements ClonableTrack {
} }
/** /**
* Retruns the length of the track * Return the length of the track
* *
* @return length of the track * @return length of the track
*/ */
@ -269,8 +269,8 @@ public class EffectTrack implements ClonableTrack {
/** /**
* This method clone the Track and search for the cloned counterpart of the * This method clone the Track and search for the cloned counterpart of the
* original emmitter in the given cloned spatial. The spatial is assumed to * original emitter in the given cloned spatial. The spatial is assumed to
* be the Spatial holding the AnimControl controling the animation using * be the Spatial holding the AnimControl controlling the animation using
* this Track. * this Track.
* *
* @param spatial the Spatial holding the AnimControl * @param spatial the Spatial holding the AnimControl

@ -51,7 +51,7 @@ import com.jme3.scene.control.CameraControl;
import com.jme3.util.TempVars; import com.jme3.util.TempVars;
/** /**
* This class is a camera controler that allow the camera to follow a target * This class is a camera controller that allow the camera to follow a target
* Spatial. * Spatial.
* *
* @author Nehon * @author Nehon
@ -110,7 +110,6 @@ public class ChaseCameraAppState extends AbstractAppState implements ActionListe
/** /**
* Registers inputs with the input manager * Registers inputs with the input manager
* *
* @param inputManager
*/ */
public final void registerWithInput() { public final void registerWithInput() {
@ -216,7 +215,7 @@ public class ChaseCameraAppState extends AbstractAppState implements ActionListe
} }
/** /**
* Sets custom triggers for toggleing the rotation of the cam deafult are * Sets custom triggers for toggling the rotation of the cam default are
* new MouseButtonTrigger(MouseInput.BUTTON_LEFT) left mouse button new * new MouseButtonTrigger(MouseInput.BUTTON_LEFT) left mouse button new
* MouseButtonTrigger(MouseInput.BUTTON_RIGHT) right mouse button * MouseButtonTrigger(MouseInput.BUTTON_RIGHT) right mouse button
* *
@ -232,7 +231,7 @@ public class ChaseCameraAppState extends AbstractAppState implements ActionListe
} }
/** /**
* Sets custom triggers for zomming in the cam default is new * Sets custom triggers for zooming in the cam default is new
* MouseAxisTrigger(MouseInput.AXIS_WHEEL, true) mouse wheel up * MouseAxisTrigger(MouseInput.AXIS_WHEEL, true) mouse wheel up
* *
* @param triggers * @param triggers
@ -247,7 +246,7 @@ public class ChaseCameraAppState extends AbstractAppState implements ActionListe
} }
/** /**
* Sets custom triggers for zomming out the cam default is new * Sets custom triggers for zooming out the cam default is new
* MouseAxisTrigger(MouseInput.AXIS_WHEEL, false) mouse wheel down * MouseAxisTrigger(MouseInput.AXIS_WHEEL, false) mouse wheel down
* *
* @param triggers * @param triggers
@ -293,6 +292,8 @@ public class ChaseCameraAppState extends AbstractAppState implements ActionListe
/** /**
* Sets the min zoom distance of the camera (default is 1) * Sets the min zoom distance of the camera (default is 1)
*
* @param minDistance
*/ */
public void setMinDistance(float minDistance) { public void setMinDistance(float minDistance) {
this.minDistance = minDistance; this.minDistance = minDistance;
@ -383,7 +384,7 @@ public class ChaseCameraAppState extends AbstractAppState implements ActionListe
} }
/** /**
* Sets the default distance at start of applicaiton * Sets the default distance at start of application
* *
* @param defaultDistance * @param defaultDistance
*/ */

@ -53,9 +53,9 @@ import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
/** /**
* An appstate for composing and playing cut scenes in a game. The cineamtic * An appstate for composing and playing cut scenes in a game. The cinematic
* schedules CinematicEvents over a timeline. Once the Cinematic created it has * schedules CinematicEvents over a timeline. Once the Cinematic created it has
* to be attched to the stateManager. * to be attached to the stateManager.
* *
* You can add various CinematicEvents to a Cinematic, see package * You can add various CinematicEvents to a Cinematic, see package
* com.jme3.cinematic.events * com.jme3.cinematic.events
@ -70,7 +70,7 @@ import java.util.logging.Logger;
* Cinematic#enqueueCinematicEvent(com.jme3.cinematic.events.CinematicEvent) * Cinematic#enqueueCinematicEvent(com.jme3.cinematic.events.CinematicEvent)
* that enqueue events one after the other according to their initialDuration * that enqueue events one after the other according to their initialDuration
* *
* a cinematic has convenient mathods to handle the playback : * a cinematic has convenient methods to handle the playback :
* @see Cinematic#play() * @see Cinematic#play()
* @see Cinematic#pause() * @see Cinematic#pause()
* @see Cinematic#stop() * @see Cinematic#stop()
@ -214,7 +214,7 @@ public class Cinematic extends AbstractCinematicEvent implements AppState {
} }
/** /**
* used internally for srialization * used internally for serialization
* *
* @param im * @param im
* @throws IOException * @throws IOException
@ -273,7 +273,7 @@ public class Cinematic extends AbstractCinematicEvent implements AppState {
/** /**
* passing true has the same effect as play() you should use play(), * passing true has the same effect as play() you should use play(),
* pause(), stop() to handle the cinemaic playing state. * pause(), stop() to handle the cinematic playing state.
* *
* @param enabled true or false * @param enabled true or false
*/ */
@ -349,7 +349,7 @@ public class Cinematic extends AbstractCinematicEvent implements AppState {
} }
/** /**
* This is used internally but can be alled to shuffle through the * This is used internally but can be called to shuffle through the
* cinematic. * cinematic.
* *
* @param time the time to shuffle to. * @param time the time to shuffle to.
@ -386,7 +386,7 @@ public class Cinematic extends AbstractCinematicEvent implements AppState {
* Adds a cinematic event to this cinematic at the given timestamp. This * Adds a cinematic event to this cinematic at the given timestamp. This
* operation returns a keyFrame * operation returns a keyFrame
* *
* @param timeStamp the time when the event will start after the begining of * @param timeStamp the time when the event will start after the beginning of
* the cinematic * the cinematic
* @param cinematicEvent the cinematic event * @param cinematicEvent the cinematic event
* @return the keyFrame for that event. * @return the keyFrame for that event.
@ -411,7 +411,7 @@ public class Cinematic extends AbstractCinematicEvent implements AppState {
* duration * duration
* *
* @param cinematicEvent the cinematic event to enqueue * @param cinematicEvent the cinematic event to enqueue
* @return the timestamp the evnt was scheduled. * @return the timestamp the event was scheduled.
*/ */
public float enqueueCinematicEvent(CinematicEvent cinematicEvent) { public float enqueueCinematicEvent(CinematicEvent cinematicEvent) {
float scheduleTime = nextEnqueue; float scheduleTime = nextEnqueue;
@ -494,7 +494,7 @@ public class Cinematic extends AbstractCinematicEvent implements AppState {
} }
/** /**
* fits the duration of the cinamatic to the duration of all its child * fits the duration of the cinematic to the duration of all its child
* cinematic events * cinematic events
*/ */
public void fitDuration() { public void fitDuration() {
@ -537,7 +537,7 @@ public class Cinematic extends AbstractCinematicEvent implements AppState {
/** /**
* returns a cameraNode given its name * returns a cameraNode given its name
* *
* @param cameraName the camera name (as registerd in * @param cameraName the camera name (as registered in
* Cinematic#bindCamera()) * Cinematic#bindCamera())
* @return the cameraNode for this name * @return the cameraNode for this name
*/ */
@ -560,7 +560,7 @@ public class Cinematic extends AbstractCinematicEvent implements AppState {
* Sets the active camera instantly (use activateCamera if you want to * Sets the active camera instantly (use activateCamera if you want to
* schedule that event) * schedule that event)
* *
* @param cameraName the camera name (as registerd in * @param cameraName the camera name (as registered in
* Cinematic#bindCamera()) * Cinematic#bindCamera())
*/ */
public void setActiveCamera(String cameraName) { public void setActiveCamera(String cameraName) {
@ -576,7 +576,7 @@ public class Cinematic extends AbstractCinematicEvent implements AppState {
* schedule an event that will activate the camera at the given time * schedule an event that will activate the camera at the given time
* *
* @param timeStamp the time to activate the cam * @param timeStamp the time to activate the cam
* @param cameraName the camera name (as registerd in * @param cameraName the camera name (as registered in
* Cinematic#bindCamera()) * Cinematic#bindCamera())
*/ */
public void activateCamera(final float timeStamp, final String cameraName) { public void activateCamera(final float timeStamp, final String cameraName) {
@ -680,7 +680,7 @@ public class Cinematic extends AbstractCinematicEvent implements AppState {
* sets the scene to use for this cinematic it is expected that the scene is * sets the scene to use for this cinematic it is expected that the scene is
* added before adding events to the cinematic * added before adding events to the cinematic
* *
* @param scene the scene where the cinematic should ttake place. * @param scene the scene where the cinematic should take place.
*/ */
public void setScene(Node scene) { public void setScene(Node scene) {
this.scene = scene; this.scene = scene;

@ -69,10 +69,10 @@ public class MotionPath implements Savable {
} }
/** /**
* interpolate the path giving the time since the beginnin and the motionControl * interpolate the path giving the time since the beginning and the motionControl
* this methods sets the new localTranslation to the spatial of the MotionEvent control. * this methods sets the new localTranslation to the spatial of the MotionEvent control.
* @param time the time since the animation started * @param time the time since the animation started
* @param control the ocntrol over the moving spatial * @param control the control over the moving spatial
*/ */
public float interpolatePath(float time, MotionEvent control, float tpf) { public float interpolatePath(float time, MotionEvent control, float tpf) {

@ -34,7 +34,7 @@ package com.jme3.cinematic;
import com.jme3.cinematic.events.MotionEvent; import com.jme3.cinematic.events.MotionEvent;
/** /**
* Trigger the events appening on an motion path * Trigger the events happening on an motion path
* @author Nehon * @author Nehon
*/ */
public interface MotionPathListener { public interface MotionPathListener {

@ -45,10 +45,10 @@ import java.util.ArrayList;
import java.util.List; import java.util.List;
/** /**
* This call contains the basic behaviour of a cinematic event. * This call contains the basic behavior of a cinematic event.
* Every cinematic event must extend this class. * Every cinematic event must extend this class.
* *
* A cinematic event must be given an inital duration in seconds * A cinematic event must be given an initial duration in seconds
* (duration of the event at speed = 1). Default is 10 sec. * (duration of the event at speed = 1). Default is 10 sec.
* @author Nehon * @author Nehon
*/ */
@ -67,13 +67,13 @@ public abstract class AbstractCinematicEvent implements CinematicEvent {
protected List<CinematicEventListener> listeners; protected List<CinematicEventListener> listeners;
/** /**
* Contruct a cinematic event (empty constructor). * Construct a cinematic event (empty constructor).
*/ */
public AbstractCinematicEvent() { public AbstractCinematicEvent() {
} }
/** /**
* Contruct a cinematic event with the given initial duration. * Construct a cinematic event with the given initial duration.
* @param initialDuration * @param initialDuration
*/ */
public AbstractCinematicEvent(float initialDuration) { public AbstractCinematicEvent(float initialDuration) {
@ -81,7 +81,7 @@ public abstract class AbstractCinematicEvent implements CinematicEvent {
} }
/** /**
* Contruct a cinematic event with the given loopMode. * Construct a cinematic event with the given loopMode.
* @param loopMode * @param loopMode
*/ */
public AbstractCinematicEvent(LoopMode loopMode) { public AbstractCinematicEvent(LoopMode loopMode) {
@ -89,7 +89,7 @@ public abstract class AbstractCinematicEvent implements CinematicEvent {
} }
/** /**
* Contruct a cinematic event with the given loopMode and the given initialDuration. * Construct a cinematic event with the given loopMode and the given initialDuration.
* @param initialDuration the duration of the event at speed = 1. * @param initialDuration the duration of the event at speed = 1.
* @param loopMode the loop mode of the event. * @param loopMode the loop mode of the event.
*/ */
@ -199,7 +199,7 @@ public abstract class AbstractCinematicEvent implements CinematicEvent {
public abstract void onPause(); public abstract void onPause();
/** /**
* Returns the actual duration of the animtion (initialDuration/speed) * Returns the actual duration of the animation (initialDuration/speed)
* @return * @return
*/ */
public float getDuration() { public float getDuration() {

@ -77,7 +77,7 @@ public class AnimationEvent extends AbstractCinematicEvent {
/** /**
* used for serialization don't call directly use one of the following * used for serialization don't call directly use one of the following
* contructors * constructors
*/ */
public AnimationEvent() { public AnimationEvent() {
} }
@ -99,7 +99,7 @@ public class AnimationEvent extends AbstractCinematicEvent {
* *
* @param model the model on which the animation will be played * @param model the model on which the animation will be played
* @param animationName the name of the animation to play * @param animationName the name of the animation to play
* @param initialDuration the initialduration of the event * @param initialDuration the initial duration of the event
*/ */
public AnimationEvent(Spatial model, String animationName, float initialDuration) { public AnimationEvent(Spatial model, String animationName, float initialDuration) {
super(initialDuration); super(initialDuration);
@ -127,7 +127,7 @@ public class AnimationEvent extends AbstractCinematicEvent {
* *
* @param model the model on which the animation will be played * @param model the model on which the animation will be played
* @param animationName the name of the animation to play * @param animationName the name of the animation to play
* @param initialDuration the initialduration of the event * @param initialDuration the initial duration of the event
* @param loopMode the loopMode * @param loopMode the loopMode
* @see LoopMode * @see LoopMode
*/ */
@ -142,7 +142,7 @@ public class AnimationEvent extends AbstractCinematicEvent {
* *
* @param model the model on which the animation will be played * @param model the model on which the animation will be played
* @param animationName the name of the animation to play * @param animationName the name of the animation to play
* @param initialDuration the initialduration of the event * @param initialDuration the initial duration of the event
* @param blendTime the time during the animation are gonna be blended * @param blendTime the time during the animation are gonna be blended
* @see AnimChannel#setAnim(java.lang.String, float) * @see AnimChannel#setAnim(java.lang.String, float)
*/ */
@ -176,7 +176,7 @@ public class AnimationEvent extends AbstractCinematicEvent {
* *
* @param model the model on which the animation will be played * @param model the model on which the animation will be played
* @param animationName the name of the animation to play * @param animationName the name of the animation to play
* @param initialDuration the initialduration of the event * @param initialDuration the initial duration of the event
* @param loopMode the loopMode * @param loopMode the loopMode
* @see LoopMode * @see LoopMode
* @param blendTime the time during the animation are gonna be blended * @param blendTime the time during the animation are gonna be blended
@ -245,7 +245,7 @@ public class AnimationEvent extends AbstractCinematicEvent {
* *
* @param model the model on which the animation will be played * @param model the model on which the animation will be played
* @param animationName the name of the animation to play * @param animationName the name of the animation to play
* @param initialDuration the initialduration of the event * @param initialDuration the initial duration of the event
* @param channelIndex the index of the channel default is 0. Events on the * @param channelIndex the index of the channel default is 0. Events on the
* same channelIndex will use the same channel. * same channelIndex will use the same channel.
*/ */
@ -261,7 +261,7 @@ public class AnimationEvent extends AbstractCinematicEvent {
* *
* @param model the model on which the animation will be played * @param model the model on which the animation will be played
* @param animationName the name of the animation to play * @param animationName the name of the animation to play
* @param initialDuration the initialduration of the event * @param initialDuration the initial duration of the event
* @param loopMode the loopMode * @param loopMode the loopMode
* @see LoopMode * @see LoopMode
* @param channelIndex the index of the channel default is 0. Events on the * @param channelIndex the index of the channel default is 0. Events on the

@ -136,7 +136,7 @@ public interface CinematicEvent extends Savable {
public void initEvent(Application app, Cinematic cinematic); public void initEvent(Application app, Cinematic cinematic);
/** /**
* When this method is invoked, the event should fast forward to the given time according tim 0 is the start of the event. * When this method is invoked, the event should fast forward to the given time according time 0 is the start of the event.
* @param time the time to fast forward to * @param time the time to fast forward to
*/ */
public void setTime(float time); public void setTime(float time);

@ -90,8 +90,8 @@ public class MotionEvent extends AbstractCinematicEvent implements Control, JmeC
*/ */
Path, Path,
/** /**
* The target rotates with the direction of the path but with the additon of a rtotation * The target rotates with the direction of the path but with the addition of a rotation
* you need to use the setRotation mathod when using this Direction * you need to use the setRotation method when using this Direction
*/ */
PathAndRotation, PathAndRotation,
/** /**

@ -54,7 +54,7 @@ public class SoundEvent extends AbstractCinematicEvent {
/** /**
* creates a sound track from the given resource path * creates a sound track from the given resource path
* @param path the path to an audi file (ie : "Sounds/mySound.wav") * @param path the path to an audio file (ie : "Sounds/mySound.wav")
*/ */
public SoundEvent(String path) { public SoundEvent(String path) {
this.path = path; this.path = path;
@ -62,7 +62,7 @@ public class SoundEvent extends AbstractCinematicEvent {
/** /**
* creates a sound track from the given resource path * creates a sound track from the given resource path
* @param path the path to an audi file (ie : "Sounds/mySound.wav") * @param path the path to an audio file (ie : "Sounds/mySound.wav")
* @param stream true to make the audio data streamed * @param stream true to make the audio data streamed
*/ */
public SoundEvent(String path, boolean stream) { public SoundEvent(String path, boolean stream) {
@ -72,9 +72,9 @@ public class SoundEvent extends AbstractCinematicEvent {
/** /**
* creates a sound track from the given resource path * creates a sound track from the given resource path
* @param path the path to an audi file (ie : "Sounds/mySound.wav") * @param path the path to an audio file (ie : "Sounds/mySound.wav")
* @param stream true to make the audio data streamed * @param stream true to make the audio data streamed
* @param initialDuration the nitial duration of the event * @param initialDuration the initial duration of the event
*/ */
public SoundEvent(String path, boolean stream, float initialDuration) { public SoundEvent(String path, boolean stream, float initialDuration) {
super(initialDuration); super(initialDuration);
@ -84,7 +84,7 @@ public class SoundEvent extends AbstractCinematicEvent {
/** /**
* creates a sound track from the given resource path * creates a sound track from the given resource path
* @param path the path to an audi file (ie : "Sounds/mySound.wav") * @param path the path to an audio file (ie : "Sounds/mySound.wav")
* @param stream true to make the audio data streamed * @param stream true to make the audio data streamed
* @param loopMode the loopMode * @param loopMode the loopMode
* @see LoopMode * @see LoopMode
@ -97,9 +97,9 @@ public class SoundEvent extends AbstractCinematicEvent {
/** /**
* creates a sound track from the given resource path * creates a sound track from the given resource path
* @param path the path to an audi file (ie : "Sounds/mySound.wav") * @param path the path to an audio file (ie : "Sounds/mySound.wav")
* @param stream true to make the audio data streamed * @param stream true to make the audio data streamed
* @param initialDuration the nitial duration of the event * @param initialDuration the initial duration of the event
* @param loopMode the loopMode * @param loopMode the loopMode
* @see LoopMode * @see LoopMode
*/ */
@ -111,8 +111,8 @@ public class SoundEvent extends AbstractCinematicEvent {
/** /**
* creates a sound track from the given resource path * creates a sound track from the given resource path
* @param path the path to an audi file (ie : "Sounds/mySound.wav") * @param path the path to an audio file (ie : "Sounds/mySound.wav")
* @param initialDuration the nitial duration of the event * @param initialDuration the initial duration of the event
*/ */
public SoundEvent(String path, float initialDuration) { public SoundEvent(String path, float initialDuration) {
super(initialDuration); super(initialDuration);
@ -121,7 +121,7 @@ public class SoundEvent extends AbstractCinematicEvent {
/** /**
* creates a sound track from the given resource path * creates a sound track from the given resource path
* @param path the path to an audi file (ie : "Sounds/mySound.wav") * @param path the path to an audio file (ie : "Sounds/mySound.wav")
* @param loopMode the loopMode * @param loopMode the loopMode
* @see LoopMode * @see LoopMode
*/ */
@ -132,8 +132,8 @@ public class SoundEvent extends AbstractCinematicEvent {
/** /**
* creates a sound track from the given resource path * creates a sound track from the given resource path
* @param path the path to an audi file (ie : "Sounds/mySound.wav") * @param path the path to an audio file (ie : "Sounds/mySound.wav")
* @param initialDuration the nitial duration of the event * @param initialDuration the initial duration of the event
* @param loopMode the loopMode * @param loopMode the loopMode
* @see LoopMode * @see LoopMode
*/ */
@ -192,7 +192,7 @@ public class SoundEvent extends AbstractCinematicEvent {
} }
/** /**
* Returns the underlying audion node of this sound track * Returns the underlying audio node of this sound track
* @return * @return
*/ */
public AudioNode getAudioNode() { public AudioNode getAudioNode() {

@ -43,7 +43,7 @@ public class SoundTrack extends SoundEvent {
/** /**
* creates a sound track from the given resource path * creates a sound track from the given resource path
* @param path the path to an audi file (ie : "Sounds/mySound.wav") * @param path the path to an audio file (ie : "Sounds/mySound.wav")
*/ */
public SoundTrack(String path) { public SoundTrack(String path) {
super(path); super(path);
@ -51,7 +51,7 @@ public class SoundTrack extends SoundEvent {
/** /**
* creates a sound track from the given resource path * creates a sound track from the given resource path
* @param path the path to an audi file (ie : "Sounds/mySound.wav") * @param path the path to an audio file (ie : "Sounds/mySound.wav")
* @param stream true to make the audio data streamed * @param stream true to make the audio data streamed
*/ */
public SoundTrack(String path, boolean stream) { public SoundTrack(String path, boolean stream) {

@ -267,8 +267,8 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
} }
/** /**
* Sets custom triggers for toggleing the rotation of the cam * Sets custom triggers for toggling the rotation of the cam
* deafult are * default are
* new MouseButtonTrigger(MouseInput.BUTTON_LEFT) left mouse button * new MouseButtonTrigger(MouseInput.BUTTON_LEFT) left mouse button
* new MouseButtonTrigger(MouseInput.BUTTON_RIGHT) right mouse button * new MouseButtonTrigger(MouseInput.BUTTON_RIGHT) right mouse button
* @param triggers * @param triggers
@ -280,7 +280,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
} }
/** /**
* Sets custom triggers for zomming in the cam * Sets custom triggers for zooming in the cam
* default is * default is
* new MouseAxisTrigger(MouseInput.AXIS_WHEEL, true) mouse wheel up * new MouseAxisTrigger(MouseInput.AXIS_WHEEL, true) mouse wheel up
* @param triggers * @param triggers
@ -292,7 +292,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
} }
/** /**
* Sets custom triggers for zomming out the cam * Sets custom triggers for zooming out the cam
* default is * default is
* new MouseAxisTrigger(MouseInput.AXIS_WHEEL, false) mouse wheel down * new MouseAxisTrigger(MouseInput.AXIS_WHEEL, false) mouse wheel down
* @param triggers * @param triggers
@ -719,7 +719,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
} }
/** /**
* Sets the rotation sensitivity, the lower the value the slower the camera will rotates around the target when draging with the mouse * Sets the rotation sensitivity, the lower the value the slower the camera will rotates around the target when dragging with the mouse
* default is 5, values over 5 should have no effect. * default is 5, values over 5 should have no effect.
* If you want a significant slow down try values below 1. * If you want a significant slow down try values below 1.
* Only has an effect if smoothMotion is set to true * Only has an effect if smoothMotion is set to true
@ -820,7 +820,7 @@ public class ChaseCamera implements ActionListener, AnalogListener, Control, Jme
} }
/** /**
* Sets the default distance at start of applicaiton * Sets the default distance at start of application
* @param defaultDistance * @param defaultDistance
*/ */
public void setDefaultDistance(float defaultDistance) { public void setDefaultDistance(float defaultDistance) {

@ -48,7 +48,7 @@ import java.io.IOException;
/** /**
* Represents a spot light. * Represents a spot light.
* A spot light emits a cone of light from a position and in a direction. * A spot light emits a cone of light from a position and in a direction.
* It can be used to fake torch lights or cars' lights. * It can be used to fake torch lights or car's lights.
* <p> * <p>
* In addition to a position and a direction, spot lights also have a range which * In addition to a position and a direction, spot lights also have a range which
* can be used to attenuate the influence of the light depending on the * can be used to attenuate the influence of the light depending on the
@ -415,7 +415,7 @@ public class SpotLight extends Light {
/** /**
* for internal use only * for internal use only
* @return the cosines of the inner and outter angle packed in a float * @return the cosines of the inner and outer angle packed in a float
*/ */
public float getPackedAngleCos() { public float getPackedAngleCos() {
return packedAngleCos; return packedAngleCos;

@ -273,8 +273,8 @@ public class Spline implements Savable {
} }
/** /**
* Iterpolate a position on the spline * Interpolate a position on the spline
* @param value a value from 0 to 1 that represent the postion between the curent control point and the next one * @param value a value from 0 to 1 that represent the position between the current control point and the next one
* @param currentControlPoint the current control point * @param currentControlPoint the current control point
* @param store a vector to store the result (use null to create a new one that will be returned by the method) * @param store a vector to store the result (use null to create a new one that will be returned by the method)
* @return the position * @return the position
@ -350,7 +350,7 @@ public class Spline implements Savable {
} }
/** /**
* return the total lenght of the spline * return the total length of the spline
*/ */
public float getTotalLength() { public float getTotalLength() {
return totalLength; return totalLength;
@ -380,7 +380,7 @@ public class Spline implements Savable {
} }
/** /**
* returns a list of float representing the segments lenght * returns a list of float representing the segments length
*/ */
public List<Float> getSegmentsLength() { public List<Float> getSegmentsLength() {
return segmentsLength; return segmentsLength;

@ -66,7 +66,7 @@ public class Glsl100ShaderGenerator extends ShaderGenerator {
} }
/** /**
* decalre a list of uniforms * declare a list of uniforms
* *
* @param source the source to append to * @param source the source to append to
* @param uniforms the list of uniforms * @param uniforms the list of uniforms
@ -81,7 +81,7 @@ public class Glsl100ShaderGenerator extends ShaderGenerator {
/** /**
* {@inheritDoc} * {@inheritDoc}
* *
* attributes are all declared, inPositon is decalred even if it's not in * attributes are all declared, inPositon is declared even if it's not in
* the list and it's condition is nulled. * the list and it's condition is nulled.
*/ */
@Override @Override
@ -187,7 +187,7 @@ public class Glsl100ShaderGenerator extends ShaderGenerator {
} }
/** /**
* Appends an ouput assignment to a shader globalOutputName = * Appends an output assignment to a shader globalOutputName =
* nameSpace_varName; * nameSpace_varName;
* *
* @param source the source StringBuilter to append the code. * @param source the source StringBuilter to append the code.
@ -212,7 +212,7 @@ public class Glsl100ShaderGenerator extends ShaderGenerator {
* *
* 1. declaring and mapping input<br> * 1. declaring and mapping input<br>
* variables : variable replaced with MatParams or WorldParams are not * variables : variable replaced with MatParams or WorldParams are not
* declared and are replaced by the parma acual name in the code. For others * declared and are replaced by the param actual name in the code. For others
* variables, the name space is appended with a "_" before the variable name * variables, the name space is appended with a "_" before the variable name
* in the code to avoid names collision between shaderNodes. <br> * in the code to avoid names collision between shaderNodes. <br>
* *
@ -227,7 +227,7 @@ public class Glsl100ShaderGenerator extends ShaderGenerator {
* 4. mapping outputs to global output if needed<br> * 4. mapping outputs to global output if needed<br>
* *
*<br> *<br>
* All of this is embed in a #if coditional statement if needed * All of this is embed in a #if conditional statement if needed
*/ */
@Override @Override
protected void generateNodeMainSection(StringBuilder source, ShaderNode shaderNode, String nodeSource, ShaderGenerationInfo info) { protected void generateNodeMainSection(StringBuilder source, ShaderNode shaderNode, String nodeSource, ShaderGenerationInfo info) {
@ -432,7 +432,7 @@ public class Glsl100ShaderGenerator extends ShaderGenerator {
/** /**
* replaces a variable name in a shaderNode source code by prefixing it * replaces a variable name in a shaderNode source code by prefixing it
* with its nameSpace and "_" if needed. * with its nameSpace and "_" if needed.
* @param nodeSource the source ot modify * @param nodeSource the source to modify
* @param var the variable to replace * @param var the variable to replace
* @return the modified source * @return the modified source
*/ */
@ -476,7 +476,7 @@ public class Glsl100ShaderGenerator extends ShaderGenerator {
/** /**
* returns the name space to append for a variable. * returns the name space to append for a variable.
* Attributes, WorldParam and MatParam names psace must not be appended * Attributes, WorldParam and MatParam names space must not be appended
* @param var the variable * @param var the variable
* @return the namespace to append for this variable * @return the namespace to append for this variable
*/ */
@ -493,7 +493,7 @@ public class Glsl100ShaderGenerator extends ShaderGenerator {
* One can use a #if defined(inputVariableName) in a shaderNode code. * One can use a #if defined(inputVariableName) in a shaderNode code.
* This method is responsible for changing the variable name with the * This method is responsible for changing the variable name with the
* appropriate defined based on the mapping condition of this variable. * appropriate defined based on the mapping condition of this variable.
* Complex condition synthax are handled. * Complex condition syntax are handled.
* *
* @param nodeSource the sahderNode source code * @param nodeSource the sahderNode source code
* @param shaderNode the ShaderNode being processed * @param shaderNode the ShaderNode being processed
@ -574,7 +574,7 @@ public class Glsl100ShaderGenerator extends ShaderGenerator {
* @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 an 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 implementaiton but can be used in overidings * this in not used in this implementation but can be used in overridings
* implementation * implementation
*/ */
protected void declareVarying(StringBuilder source, ShaderNodeVariable var, boolean input) { protected void declareVarying(StringBuilder source, ShaderNodeVariable var, boolean input) {

@ -85,7 +85,7 @@ public class Glsl150ShaderGenerator extends Glsl100ShaderGenerator {
* "out" keyword. * "out" keyword.
* *
* after the "void main(){", the vertex output are declared and initialized * after the "void main(){", the vertex output are declared and initialized
* and the frgament outputs are declared * and the fragment outputs are declared
*/ */
@Override @Override
protected void generateStartOfMainSection(StringBuilder source, ShaderGenerationInfo info, Shader.ShaderType type) { protected void generateStartOfMainSection(StringBuilder source, ShaderGenerationInfo info, Shader.ShaderType type) {

@ -41,7 +41,7 @@ import java.util.List;
/** /**
* This class is the base for a shader generator using the ShaderNodes system, * This class is the base for a shader generator using the ShaderNodes system,
* it contains basis mechnaism of generation, but no actual generation code. * it contains basis mechanism of generation, but no actual generation code.
* This class is abstract, any Shader generator must extend it. * This class is abstract, any Shader generator must extend it.
* *
* @author Nehon * @author Nehon
@ -205,10 +205,10 @@ public abstract class ShaderGenerator {
} }
/** /**
* returns the laguage + version of the shader should be somthing like * returns the language + version of the shader should be something like
* "GLSL100" for glsl 1.0 "GLSL150" for glsl 1.5. * "GLSL100" for glsl 1.0 "GLSL150" for glsl 1.5.
* *
* @param type the shader type for wich the version should be returned. * @param type the shader type for which the version should be returned.
* *
* @return the shaderLanguage and version. * @return the shaderLanguage and version.
*/ */
@ -282,7 +282,7 @@ public abstract class ShaderGenerator {
/** /**
* Appends the given shaderNode main part to the shader declarative part. If * Appends the given shaderNode main part to the shader declarative part. If
* needed the sahder type can be determined by fetching the shaderNode's * needed the shader type can be determined by fetching the shaderNode's
* definition type. * definition type.
* *
* @see ShaderNode#getDefinition() * @see ShaderNode#getDefinition()

@ -47,10 +47,10 @@ import java.util.List;
* *
* A ShaderNode is based on a definition that has a shader code, inputs and * A ShaderNode is based on a definition that has a shader code, inputs and
* output variables. This node can be activated based on a condition, and has * output variables. This node can be activated based on a condition, and has
* input and ouput mapping. * input and output mapping.
* *
* This class is not intended to be used by JME users directly. It's the * This class is not intended to be used by JME users directly. It's the
* stucture for loading shader nodes from a J3md ùaterial definition file * structure for loading shader nodes from a J3md material definition file
* *
* @author Nehon * @author Nehon
*/ */
@ -67,7 +67,7 @@ public class ShaderNode implements Savable {
* *
* @param name the name * @param name the name
* @param definition the ShaderNodeDefinition * @param definition the ShaderNodeDefinition
* @param condition the conditionto activate this node * @param condition the condition to activate this node
*/ */
public ShaderNode(String name, ShaderNodeDefinition definition, String condition) { public ShaderNode(String name, ShaderNodeDefinition definition, String condition) {
this.name = name; this.name = name;
@ -125,7 +125,7 @@ public class ShaderNode implements Savable {
} }
/** /**
* sets the ocndition * sets the condition
* *
* @param condition the condition * @param condition the condition
*/ */
@ -165,14 +165,14 @@ public class ShaderNode implements Savable {
/** /**
* sets the output mappings * sets the output mappings
* *
* @param inputMapping the output mappings * @param outputMapping the output mappings
*/ */
public void setOutputMapping(List<VariableMapping> outputMapping) { public void setOutputMapping(List<VariableMapping> outputMapping) {
this.outputMapping = outputMapping; this.outputMapping = outputMapping;
} }
/** /**
* jme seralization * jme serialization
* *
* @param ex the exporter * @param ex the exporter
* @throws IOException * @throws IOException
@ -188,7 +188,7 @@ public class ShaderNode implements Savable {
} }
/** /**
* jme seralization * jme serialization
* *
* @param im the importer * @param im the importer
* @throws IOException * @throws IOException

@ -43,7 +43,7 @@ import java.util.Arrays;
import java.util.List; import java.util.List;
/** /**
* Shader node definition structure meant for holding loaded datat from a * Shader node definition structure meant for holding loaded data from a
* material definition j3md file * material definition j3md file
* *
* @author Nehon * @author Nehon
@ -109,7 +109,7 @@ public class ShaderNodeDefinition implements Savable {
} }
/** /**
* sets the type of shader this def applies to * sets the type of shader this definition applies to
* *
* @param type the type * @param type the type
*/ */
@ -119,14 +119,14 @@ public class ShaderNodeDefinition implements Savable {
/** /**
* *
* @return the docuentation for tthis definition * @return the documentation for this definition
*/ */
public String getDocumentation() { public String getDocumentation() {
return documentation; return documentation;
} }
/** /**
* sets the dcumentation * sets the documentation
* *
* @param documentation the documentation * @param documentation the documentation
*/ */
@ -162,7 +162,7 @@ public class ShaderNodeDefinition implements Savable {
/** /**
* sets the output variables of this definition * sets the output variables of this definition
* *
* @param inputs the output * @param outputs the output
*/ */
public void setOutputs(List<ShaderNodeVariable> outputs) { public void setOutputs(List<ShaderNodeVariable> outputs) {
this.outputs = outputs; this.outputs = outputs;
@ -187,11 +187,12 @@ public class ShaderNodeDefinition implements Savable {
/** /**
* jme seralization (not used) * jme serialization (not used)
* *
* @param ex the exporter * @param ex the exporter
* @throws IOException * @throws IOException
*/ */
@Override
public void write(JmeExporter ex) throws IOException { public void write(JmeExporter ex) throws IOException {
OutputCapsule oc = (OutputCapsule) ex.getCapsule(this); OutputCapsule oc = (OutputCapsule) ex.getCapsule(this);
oc.write(name, "name", ""); oc.write(name, "name", "");
@ -222,11 +223,12 @@ public class ShaderNodeDefinition implements Savable {
/** /**
* jme seralization (not used) * jme serialization (not used)
* *
* @param im the importer * @param im the importer
* @throws IOException * @throws IOException
*/ */
@Override
public void read(JmeImporter im) throws IOException { public void read(JmeImporter im) throws IOException {
InputCapsule ic = (InputCapsule) im.getCapsule(this); InputCapsule ic = (InputCapsule) im.getCapsule(this);
name = ic.readString("name", ""); name = ic.readString("name", "");

@ -69,7 +69,7 @@ public class ShaderNodeVariable implements Savable, Cloneable {
* *
* @param type the glsl type of the variable * @param type the glsl type of the variable
* @param nameSpace the nameSpace (can be the name of the shaderNode or * @param nameSpace the nameSpace (can be the name of the shaderNode or
* Globel,Attr,MatParam,WorldParam) * Global,Attr,MatParam,WorldParam)
* @param name the name of the variable * @param name the name of the variable
* @param multiplicity the number of element if this variable is an array. Can be an Int of a declared material parameter * @param multiplicity the number of element if this variable is an array. Can be an Int of a declared material parameter
*/ */
@ -85,7 +85,7 @@ public class ShaderNodeVariable implements Savable, Cloneable {
* *
* @param type the glsl type of the variable * @param type the glsl type of the variable
* @param nameSpace the nameSpace (can be the name of the shaderNode or * @param nameSpace the nameSpace (can be the name of the shaderNode or
* Globel,Attr,MatParam,WorldParam) * Global,Attr,MatParam,WorldParam)
* @param name the name of the variable * @param name the name of the variable
*/ */
public ShaderNodeVariable(String type, String nameSpace, String name) { public ShaderNodeVariable(String type, String nameSpace, String name) {
@ -132,7 +132,7 @@ public class ShaderNodeVariable implements Savable, Cloneable {
/** /**
* *
* @return the name space (can be the name of the shaderNode or * @return the name space (can be the name of the shaderNode or
* Globel,Attr,MatParam,WorldParam) * Global,Attr,MatParam,WorldParam)
*/ */
public String getNameSpace() { public String getNameSpace() {
return nameSpace; return nameSpace;
@ -140,7 +140,7 @@ public class ShaderNodeVariable implements Savable, Cloneable {
/** /**
* sets the nameSpace (can be the name of the shaderNode or * sets the nameSpace (can be the name of the shaderNode or
* Globel,Attr,MatParam,WorldParam) * Global,Attr,MatParam,WorldParam)
* *
* @param nameSpace * @param nameSpace
*/ */
@ -176,11 +176,12 @@ public class ShaderNodeVariable implements Savable, Cloneable {
} }
/** /**
* jme seralization (not used) * jme serialization (not used)
* *
* @param ex the exporter * @param ex the exporter
* @throws IOException * @throws IOException
*/ */
@Override
public void write(JmeExporter ex) throws IOException { public void write(JmeExporter ex) throws IOException {
OutputCapsule oc = (OutputCapsule) ex.getCapsule(this); OutputCapsule oc = (OutputCapsule) ex.getCapsule(this);
oc.write(name, "name", ""); oc.write(name, "name", "");
@ -193,11 +194,12 @@ public class ShaderNodeVariable implements Savable, Cloneable {
} }
/** /**
* jme seralization (not used) * jme serialization (not used)
* *
* @param im the importer * @param im the importer
* @throws IOException * @throws IOException
*/ */
@Override
public void read(JmeImporter im) throws IOException { public void read(JmeImporter im) throws IOException {
InputCapsule ic = (InputCapsule) im.getCapsule(this); InputCapsule ic = (InputCapsule) im.getCapsule(this);
name = ic.readString("name", ""); name = ic.readString("name", "");

@ -43,7 +43,7 @@ public class ShaderVariable {
/** /**
* Name of the uniform as was declared in the shader. * Name of the uniform as was declared in the shader.
* E.g name = "g_WorldMatrix" if the decleration was * E.g name = "g_WorldMatrix" if the declaration was
* "uniform mat4 g_WorldMatrix;". * "uniform mat4 g_WorldMatrix;".
*/ */
protected String name = null; protected String name = null;

@ -102,7 +102,7 @@ public class VariableMapping implements Savable {
/** /**
* sets the right variable * sets the right variable
* *
* @param leftVariable the right variable * @param rightVariable the right variable
*/ */
public void setRightVariable(ShaderNodeVariable rightVariable) { public void setRightVariable(ShaderNodeVariable rightVariable) {
this.rightVariable = rightVariable; this.rightVariable = rightVariable;
@ -153,18 +153,19 @@ public class VariableMapping implements Savable {
/** /**
* sets the right swizzle * sets the right swizzle
* *
* @param leftSwizzling the right swizzle * @param rightSwizzling the right swizzle
*/ */
public void setRightSwizzling(String rightSwizzling) { public void setRightSwizzling(String rightSwizzling) {
this.rightSwizzling = rightSwizzling; this.rightSwizzling = rightSwizzling;
} }
/** /**
* jme seralization (not used) * jme serialization (not used)
* *
* @param ex the exporter * @param ex the exporter
* @throws IOException * @throws IOException
*/ */
@Override
public void write(JmeExporter ex) throws IOException { public void write(JmeExporter ex) throws IOException {
OutputCapsule oc = (OutputCapsule) ex.getCapsule(this); OutputCapsule oc = (OutputCapsule) ex.getCapsule(this);
oc.write(leftVariable, "leftVariable", null); oc.write(leftVariable, "leftVariable", null);
@ -175,11 +176,12 @@ public class VariableMapping implements Savable {
} }
/** /**
* jme seralization (not used) * jme serialization (not used)
* *
* @param im the importer * @param im the importer
* @throws IOException * @throws IOException
*/ */
@Override
public void read(JmeImporter im) throws IOException { public void read(JmeImporter im) throws IOException {
InputCapsule ic = (InputCapsule) im.getCapsule(this); InputCapsule ic = (InputCapsule) im.getCapsule(this);
leftVariable = (ShaderNodeVariable) ic.readSavable("leftVariable", null); leftVariable = (ShaderNodeVariable) ic.readSavable("leftVariable", null);

@ -51,7 +51,7 @@ import java.io.IOException;
/** /**
* *
* Generic abstract filter that holds common implementations for the different * Generic abstract filter that holds common implementations for the different
* shadow filtesr * shadow filters
* *
* @author Rémy Bouquet aka Nehon * @author Rémy Bouquet aka Nehon
*/ */
@ -140,7 +140,7 @@ public abstract class AbstractShadowFilter<T extends AbstractShadowRenderer> ext
/** /**
* Set the distance from the eye where the shadows will be rendered default * Set the distance from the eye where the shadows will be rendered default
* value is dynamicaly computed to the shadow casters/receivers union bound * value is dynamically computed to the shadow casters/receivers union bound
* zFar, capped to view frustum far value. * zFar, capped to view frustum far value.
* *
* @param zFar the zFar values that override the computed one * @param zFar the zFar values that override the computed one
@ -181,7 +181,7 @@ public abstract class AbstractShadowFilter<T extends AbstractShadowRenderer> ext
/** /**
* Set the shadowIntensity, the value should be between 0 and 1, a 0 value * Set the shadowIntensity, the value should be between 0 and 1, a 0 value
* gives a bright and invisilble shadow, a 1 value gives a pitch black * gives a bright and invisible shadow, a 1 value gives a pitch black
* shadow, default is 0.7 * shadow, default is 0.7
* *
* @param shadowIntensity the darkness of the shadow * @param shadowIntensity the darkness of the shadow
@ -285,7 +285,7 @@ public abstract class AbstractShadowFilter<T extends AbstractShadowRenderer> ext
/** /**
* returns the pre shadows pass render state. * returns the pre shadows pass render state.
* use it to adjust the RenderState parameters of the pre shadow pass. * use it to adjust the RenderState parameters of the pre shadow pass.
* Note that this will be overriden if the preShadow technique in the material has a ForcedRenderState * Note that this will be overridden if the preShadow technique in the material has a ForcedRenderState
* @return the pre shadow render state. * @return the pre shadow render state.
*/ */
public RenderState getPreShadowForcedRenderState() { public RenderState getPreShadowForcedRenderState() {

@ -621,7 +621,7 @@ public abstract class AbstractShadowRenderer implements SceneProcessor, Savable
/** /**
* Set the distance from the eye where the shadows will be rendered default * Set the distance from the eye where the shadows will be rendered default
* value is dynamicaly computed to the shadow casters/receivers union bound * value is dynamically computed to the shadow casters/receivers union bound
* zFar, capped to view frustum far value. * zFar, capped to view frustum far value.
* *
* @param zFar the zFar values that override the computed one * @param zFar the zFar values that override the computed one
@ -752,7 +752,7 @@ public abstract class AbstractShadowRenderer implements SceneProcessor, Savable
/** /**
* returns the pre shadows pass render state. * returns the pre shadows pass render state.
* use it to adjust the RenderState parameters of the pre shadow pass. * use it to adjust the RenderState parameters of the pre shadow pass.
* Note that this will be overriden if the preShadow technique in the material has a ForcedRenderState * Note that this will be overridden if the preShadow technique in the material has a ForcedRenderState
* @return the pre shadow render state. * @return the pre shadow render state.
*/ */
public RenderState getPreShadowForcedRenderState() { public RenderState getPreShadowForcedRenderState() {

@ -140,7 +140,7 @@ public class PssmShadowFilter extends Filter {
} }
/** /**
* returns the labda parameter * returns the lambda parameter
* @see #setLambda(float lambda) * @see #setLambda(float lambda)
* @return lambda * @return lambda
*/ */
@ -171,7 +171,7 @@ public class PssmShadowFilter extends Filter {
/** /**
* Set the distance from the eye where the shadows will be rendered * Set the distance from the eye where the shadows will be rendered
* default value is dynamicaly computed to the shadow casters/receivers union bound zFar, capped to view frustum far value. * default value is dynamically computed to the shadow casters/receivers union bound zFar, capped to view frustum far value.
* @param zFar the zFar values that override the computed one * @param zFar the zFar values that override the computed one
*/ */
public void setShadowZExtend(float zFar) { public void setShadowZExtend(float zFar) {
@ -179,7 +179,7 @@ public class PssmShadowFilter extends Filter {
} }
/** /**
* returns the shdaow intensity * returns the shadow intensity
* @see #setShadowIntensity(float shadowIntensity) * @see #setShadowIntensity(float shadowIntensity)
* @return shadowIntensity * @return shadowIntensity
*/ */
@ -189,7 +189,7 @@ public class PssmShadowFilter extends Filter {
/** /**
* Set the shadowIntensity, the value should be between 0 and 1, * Set the shadowIntensity, the value should be between 0 and 1,
* a 0 value gives a bright and invisilble shadow, * a 0 value gives a bright and invisible shadow,
* a 1 value gives a pitch black shadow, * a 1 value gives a pitch black shadow,
* default is 0.7 * default is 0.7
* @param shadowIntensity the darkness of the shadow * @param shadowIntensity the darkness of the shadow

@ -481,7 +481,7 @@ public class PssmShadowRenderer implements SceneProcessor {
} }
/** /**
* For dubuging purpose Allow to "snapshot" the current frustrum to the * For debugging purpose Allow to "snapshot" the current frustrum to the
* scene * scene
*/ */
public void displayDebug() { public void displayDebug() {
@ -591,7 +591,7 @@ public class PssmShadowRenderer implements SceneProcessor {
} }
/** /**
* returns the labda parameter see #setLambda(float lambda) * returns the lambda parameter see #setLambda(float lambda)
* *
* @return lambda * @return lambda
*/ */
@ -623,7 +623,7 @@ public class PssmShadowRenderer implements SceneProcessor {
/** /**
* Set the distance from the eye where the shadows will be rendered default * Set the distance from the eye where the shadows will be rendered default
* value is dynamicaly computed to the shadow casters/receivers union bound * value is dynamically computed to the shadow casters/receivers union bound
* zFar, capped to view frustum far value. * zFar, capped to view frustum far value.
* *
* @param zFar the zFar values that override the computed one * @param zFar the zFar values that override the computed one
@ -637,7 +637,7 @@ public class PssmShadowRenderer implements SceneProcessor {
} }
/** /**
* returns the shdaow intensity * returns the shadow intensity
* *
* @see #setShadowIntensity(float shadowIntensity) * @see #setShadowIntensity(float shadowIntensity)
* @return shadowIntensity * @return shadowIntensity
@ -648,7 +648,7 @@ public class PssmShadowRenderer implements SceneProcessor {
/** /**
* Set the shadowIntensity, the value should be between 0 and 1, a 0 value * Set the shadowIntensity, the value should be between 0 and 1, a 0 value
* gives a bright and invisilble shadow, a 1 value gives a pitch black * gives a bright and invisible shadow, a 1 value gives a pitch black
* shadow, default is 0.7 * shadow, default is 0.7
* *
* @param shadowIntensity the darkness of the shadow * @param shadowIntensity the darkness of the shadow

@ -325,7 +325,7 @@ public final class BufferUtils {
* @param buf * @param buf
* the buffer to insert into * the buffer to insert into
* @param index * @param index
* the postion to place the data; in terms of quaternions not floats * the position to place the data; in terms of quaternions not floats
*/ */
public static void setInBuffer(Quaternion quat, FloatBuffer buf, public static void setInBuffer(Quaternion quat, FloatBuffer buf,
int index) { int index) {
@ -345,7 +345,7 @@ public final class BufferUtils {
* @param buf * @param buf
* the buffer to insert into * the buffer to insert into
* @param index * @param index
* the postion to place the data; in terms of vector4 not floats * the position to place the data; in terms of vector4 not floats
*/ */
public static void setInBuffer(Vector4f vec, FloatBuffer buf, public static void setInBuffer(Vector4f vec, FloatBuffer buf,
int index) { int index) {
@ -438,7 +438,7 @@ public final class BufferUtils {
/** /**
* Copies a Vector3f from one position in the buffer to another. The index * Copies a Vector3f from one position in the buffer to another. The index
* values are in terms of vector number (eg, vector number 0 is postions 0-2 * values are in terms of vector number (eg, vector number 0 is positions 0-2
* in the FloatBuffer.) * in the FloatBuffer.)
* *
* @param buf * @param buf
@ -600,7 +600,7 @@ public final class BufferUtils {
* @param buf * @param buf
* the buffer to insert into * the buffer to insert into
* @param index * @param index
* the postion to place the data; in terms of vectors not floats * the position to place the data; in terms of vectors not floats
*/ */
public static void setInBuffer(Vector2f vector, FloatBuffer buf, int index) { public static void setInBuffer(Vector2f vector, FloatBuffer buf, int index) {
buf.put(index * 2, vector.x); buf.put(index * 2, vector.x);
@ -643,7 +643,7 @@ public final class BufferUtils {
/** /**
* Copies a Vector2f from one position in the buffer to another. The index * Copies a Vector2f from one position in the buffer to another. The index
* values are in terms of vector number (eg, vector number 0 is postions 0-1 * values are in terms of vector number (eg, vector number 0 is positions 0-1
* in the FloatBuffer.) * in the FloatBuffer.)
* *
* @param buf * @param buf
@ -835,7 +835,7 @@ public final class BufferUtils {
/** /**
* Creates a new DoubleBuffer with the same contents as the given * Creates a new DoubleBuffer with the same contents as the given
* DoubleBuffer. The new DoubleBuffer is seperate from the old one and * DoubleBuffer. The new DoubleBuffer is separate from the old one and
* changes are not reflected across. If you want to reflect changes, * changes are not reflected across. If you want to reflect changes,
* consider using Buffer.duplicate(). * consider using Buffer.duplicate().
* *
@ -897,7 +897,7 @@ public final class BufferUtils {
/** /**
* Creates a new FloatBuffer with the same contents as the given * Creates a new FloatBuffer with the same contents as the given
* FloatBuffer. The new FloatBuffer is seperate from the old one and changes * FloatBuffer. The new FloatBuffer is separate from the old one and changes
* are not reflected across. If you want to reflect changes, consider using * are not reflected across. If you want to reflect changes, consider using
* Buffer.duplicate(). * Buffer.duplicate().
* *
@ -960,7 +960,7 @@ public final class BufferUtils {
/** /**
* Creates a new IntBuffer with the same contents as the given IntBuffer. * Creates a new IntBuffer with the same contents as the given IntBuffer.
* The new IntBuffer is seperate from the old one and changes are not * The new IntBuffer is separate from the old one and changes are not
* reflected across. If you want to reflect changes, consider using * reflected across. If you want to reflect changes, consider using
* Buffer.duplicate(). * Buffer.duplicate().
* *
@ -1116,7 +1116,7 @@ public final class BufferUtils {
/** /**
* Creates a new ShortBuffer with the same contents as the given ShortBuffer. * Creates a new ShortBuffer with the same contents as the given ShortBuffer.
* The new ShortBuffer is seperate from the old one and changes are not * The new ShortBuffer is separate from the old one and changes are not
* reflected across. If you want to reflect changes, consider using * reflected across. If you want to reflect changes, consider using
* Buffer.duplicate(). * Buffer.duplicate().
* *

@ -124,7 +124,7 @@ public class ListSort<T> {
} }
/** /**
* Allocate temp veriables for the given length This method should be called * Allocate temp variables for the given length This method should be called
* at least once, but only if the length of the list to sort changed before * at least once, but only if the length of the list to sort changed before
* sorting * sorting
* *
@ -427,7 +427,7 @@ public class ListSort<T> {
/** /**
* Merge runs A and B where A index in the stack is idx and B index is idx+1 * Merge runs A and B where A index in the stack is idx and B index is idx+1
* *
* @param idx index of the firts of two runs to merge * @param idx index of the first of two runs to merge
*/ */
private void mergeRuns(int idx) { private void mergeRuns(int idx) {

@ -67,10 +67,10 @@ import java.util.logging.Logger;
* This appState is for debug purpose only, and was made to provide an easy way * This appState is for debug purpose only, and was made to provide an easy way
* to test shaders, with a live update capability. * to test shaders, with a live update capability.
* *
* This calss provides and easy way to reload a material and catches compilation * This class provides and easy way to reload a material and catches compilation
* errors when needed and displays the error in the console. * errors when needed and displays the error in the console.
* *
* If no error accur on compilation, the material is reloaded in the scene. * If no error occur on compilation, the material is reloaded in the scene.
* *
* You can either trigger the reload when pressing a key (or whatever input is * You can either trigger the reload when pressing a key (or whatever input is
* supported by Triggers you can attach to the input manager), or trigger it * supported by Triggers you can attach to the input manager), or trigger it

@ -23,7 +23,7 @@ import java.util.logging.Logger;
* https://developer.blender.org/diffusion/B/browse/master/intern/mikktspace/mikktspace.c * https://developer.blender.org/diffusion/B/browse/master/intern/mikktspace/mikktspace.c
* https://developer.blender.org/diffusion/B/browse/master/intern/mikktspace/mikktspace.h * https://developer.blender.org/diffusion/B/browse/master/intern/mikktspace/mikktspace.h
* *
* MikkTspace looks like the new standard of tengent generation in 3D softwares. * MikkTspace looks like the new standard of tangent generation in 3D softwares.
* Xnormal, Blender, Substance painter, and many more use it. * Xnormal, Blender, Substance painter, and many more use it.
* *
* Usage is : * Usage is :

@ -41,7 +41,7 @@ import java.util.regex.Pattern;
* style. * style.
* *
* extractDefines is able to get a list of defines in an expression and update * extractDefines is able to get a list of defines in an expression and update
* the formatter expression with upercased defines * the formatter expression with uppercased defines
* *
* @author Nehon * @author Nehon
*/ */

@ -36,7 +36,7 @@ import java.io.IOException;
/** /**
* Custom Exception to report a j3md Material definition file parsing error. * Custom Exception to report a j3md Material definition file parsing error.
* This exception reports the line number where the error occured. * This exception reports the line number where the error occurred.
* *
* @author Nehon * @author Nehon
*/ */
@ -70,7 +70,7 @@ public class MatParseException extends IOException {
* @param expected the expected value * @param expected the expected value
* @param got the actual value * @param got the actual value
* @param statement the read statement * @param statement the read statement
* @param cause the embed exception that occured * @param cause the embed exception that occurred
*/ */
public MatParseException(String expected, String got, Statement statement, Throwable cause) { public MatParseException(String expected, String got, Statement statement, Throwable cause) {
super("Error On line " + statement.getLineNumber() + " : " + statement.getLine() + "\n->Expected " + (expected == null ? "a statement" : expected) + ", got '" + got + "'!", cause); super("Error On line " + statement.getLineNumber() + " : " + statement.getLine() + "\n->Expected " + (expected == null ? "a statement" : expected) + ", got '" + got + "'!", cause);
@ -82,7 +82,7 @@ public class MatParseException extends IOException {
* *
* @param text the error message * @param text the error message
* @param statement the statement where the error occur * @param statement the statement where the error occur
* @param cause the embed exception that occured * @param cause the embed exception that occurred
*/ */
public MatParseException(String text, Statement statement, Throwable cause) { public MatParseException(String text, Statement statement, Throwable cause) {
super("Error On line " + statement.getLineNumber() + " : " + statement.getLine() + "\n->" + text, cause); super("Error On line " + statement.getLineNumber() + " : " + statement.getLine() + "\n->" + text, cause);

@ -59,7 +59,7 @@ import java.util.Map;
* *
* Also it allows to load the ShaderNodes from a j3md file and build the * Also it allows to load the ShaderNodes from a j3md file and build the
* ShaderNodes list of each technique and the ShaderGenerationInfo needed to * ShaderNodes list of each technique and the ShaderGenerationInfo needed to
* generate the sahders * generate shaders
* *
* @author Nehon * @author Nehon
*/ */
@ -209,9 +209,9 @@ public class ShaderNodeLoaderDelegate {
* ShaderNodesDefinition This method is used by the j3m loader. * ShaderNodesDefinition This method is used by the j3m loader.
* *
* When loaded in a material, the definitions are not stored as a list, but * When loaded in a material, the definitions are not stored as a list, but
* they are stores in Shadernodes based onthis definition. * they are stores in Shadernodes based on this definition.
* *
* The map is here to map the defintion to the nodes, and ovoid reloading * The map is here to map the definition to the nodes, and ovoid reloading
* already loaded definitions * already loaded definitions
* *
* @param statements the list of statements to parse * @param statements the list of statements to parse
@ -222,7 +222,7 @@ public class ShaderNodeLoaderDelegate {
} }
/** /**
* effectiveliy reads the ShaderNodesDefinitions block * effectively reads the ShaderNodesDefinitions block
* *
* @param statements the list of statements to parse * @param statements the list of statements to parse
* @param key the ShaderNodeDefinitionKey * @param key the ShaderNodeDefinitionKey
@ -273,7 +273,7 @@ public class ShaderNodeLoaderDelegate {
* reads a variable declaration statement &lt;glslType&gt; &lt;varName&gt; * reads a variable declaration statement &lt;glslType&gt; &lt;varName&gt;
* *
* @param statement the statement to parse * @param statement the statement to parse
* @return a ShaderNodeVariable axtracted from the statement * @return a ShaderNodeVariable extracted from the statement
* @throws IOException * @throws IOException
*/ */
protected ShaderNodeVariable readVariable(Statement statement) throws IOException { protected ShaderNodeVariable readVariable(Statement statement) throws IOException {
@ -448,7 +448,7 @@ public class ShaderNodeLoaderDelegate {
} }
/** /**
* searcha variable in the given list and updates its type and namespace * search a variable in the given list and updates its type and namespace
* *
* @param var the variable to update * @param var the variable to update
* @param list the variables list * @param list the variables list
@ -531,7 +531,7 @@ public class ShaderNodeLoaderDelegate {
/** /**
* updates the right variable of the given mapping from a UniformBinding (a * updates the right variable of the given mapping from a UniformBinding (a
* WorldParam) it checks if the unifrom hasn't already been loaded, add it * WorldParam) it checks if the uniform hasn't already been loaded, add it
* to the maps if not. * to the maps if not.
* *
* @param param the WorldParam UniformBinding * @param param the WorldParam UniformBinding
@ -559,7 +559,7 @@ public class ShaderNodeLoaderDelegate {
/** /**
* updates the right variable of the given mapping from a MatParam (a * updates the right variable of the given mapping from a MatParam (a
* WorldParam) it checks if the unifrom hasn't already been loaded, add it * WorldParam) it checks if the uniform hasn't already been loaded, add it
* to the maps if not. * to the maps if not.
* *
* @param param the MatParam * @param param the MatParam
@ -622,7 +622,7 @@ public class ShaderNodeLoaderDelegate {
} }
/** /**
* Adds a define to the techniquedef * Adds a define to the technique def
* *
* @param paramName * @param paramName
*/ */
@ -767,7 +767,7 @@ public class ShaderNodeLoaderDelegate {
/** /**
* reads an output mapping * reads an output mapping
* *
* @param statement1 the staement being read * @param statement1 the statement being read
* @return the mapping * @return the mapping
* @throws IOException * @throws IOException
*/ */
@ -803,7 +803,7 @@ public class ShaderNodeLoaderDelegate {
} }
/** /**
* Reads alist of ShaderNodes * Reads a list of ShaderNodes
* *
* @param statements the list of statements to read * @param statements the list of statements to read
* @throws IOException * @throws IOException
@ -843,7 +843,7 @@ public class ShaderNodeLoaderDelegate {
* retrieve the leftType corresponding sampler type from the rightType * retrieve the leftType corresponding sampler type from the rightType
* *
* @param leftType the left samplerType * @param leftType the left samplerType
* @param rightType the right sampler type (can be multiple types sparated * @param rightType the right sampler type (can be multiple types separated
* by "|" * by "|"
* @return the type or null if not found * @return the type or null if not found
*/ */
@ -885,7 +885,7 @@ public class ShaderNodeLoaderDelegate {
/** /**
* store an attribute * store an attribute
* *
* @param var the variable ot store * @param var the variable to store
*/ */
public void storeAttribute(ShaderNodeVariable var) { public void storeAttribute(ShaderNodeVariable var) {
storeVariable(var, techniqueDef.getShaderGenerationInfo().getAttributes()); storeVariable(var, techniqueDef.getShaderGenerationInfo().getAttributes());
@ -894,7 +894,7 @@ public class ShaderNodeLoaderDelegate {
/** /**
* store a vertex uniform * store a vertex uniform
* *
* @param var the variable ot store * @param var the variable to store
*/ */
public void storeVertexUniform(ShaderNodeVariable var) { public void storeVertexUniform(ShaderNodeVariable var) {
storeVariable(var, techniqueDef.getShaderGenerationInfo().getVertexUniforms()); storeVariable(var, techniqueDef.getShaderGenerationInfo().getVertexUniforms());
@ -904,7 +904,7 @@ public class ShaderNodeLoaderDelegate {
/** /**
* store a fragment uniform * store a fragment uniform
* *
* @param var the variable ot store * @param var the variable to store
*/ */
public void storeFragmentUniform(ShaderNodeVariable var) { public void storeFragmentUniform(ShaderNodeVariable var) {
storeVariable(var, techniqueDef.getShaderGenerationInfo().getFragmentUniforms()); storeVariable(var, techniqueDef.getShaderGenerationInfo().getFragmentUniforms());
@ -921,7 +921,7 @@ public class ShaderNodeLoaderDelegate {
} }
/** /**
* find the definiton from this statement (loads it if necessary) * find the definition from this statement (loads it if necessary)
* *
* @param statement the statement being read * @param statement the statement being read
* @return the definition * @return the definition
@ -1049,7 +1049,7 @@ public class ShaderNodeLoaderDelegate {
} }
/** /**
* check the types of a mapping, left type must match right type tkae the * check the types of a mapping, left type must match right type take the
* swizzle into account * swizzle into account
* *
* @param mapping the mapping * @param mapping the mapping

@ -81,14 +81,14 @@ import java.util.logging.Logger;
* informations can be found here http://www.melax.com/polychop * informations can be found here http://www.melax.com/polychop
* http://sajty.elementfx.com/progressivemesh/GSoC2012.pdf </p> * http://sajty.elementfx.com/progressivemesh/GSoC2012.pdf </p>
* *
* <p>The algorithm sort the vertice according to their collapsse cost * <p>The algorithm sort vertices according to their collapse cost
* ascending. It collapse from the "cheapest" vertex to the more expensive.<br> * ascending. It collapse from the "cheapest" vertex to the more expensive.<br>
* <strong>Usage : </strong><br> * <strong>Usage : </strong><br>
* <pre> * <pre>
* LodGenerator lODGenerator = new LodGenerator(geometry); * LodGenerator lODGenerator = new LodGenerator(geometry);
* lODGenerator.bakeLods(reductionMethod,reductionvalue); * lODGenerator.bakeLods(reductionMethod,reductionvalue);
* </pre> redutionMethod type is VertexReductionMethod described here * </pre> redutionMethod type is VertexReductionMethod described here
* {@link TriangleReductionMethod} reductionvalue depends on the * {@link TriangleReductionMethod} reduction value depends on the
* reductionMethod<p> * reductionMethod<p>
* *
* *
@ -111,7 +111,7 @@ public class LodGenerator {
private Mesh mesh; private Mesh mesh;
/** /**
* Describe the way trinagles will be removed. <br> PROPORTIONAL : * Describe the way triangles will be removed. <br> PROPORTIONAL :
* Percentage of triangles to be removed from the mesh. Valid range is a * Percentage of triangles to be removed from the mesh. Valid range is a
* number between 0.0 and 1.0 <br> CONSTANT : Triangle count to be removed * number between 0.0 and 1.0 <br> CONSTANT : Triangle count to be removed
* from the mesh. Pass only integers or it will be rounded. <br> * from the mesh. Pass only integers or it will be rounded. <br>
@ -240,7 +240,7 @@ public class LodGenerator {
} }
} }
/** /**
* Compartator used to sort vertices according to their collapse cost * Comparator used to sort vertices according to their collapse cost
*/ */
private Comparator collapseComparator = new Comparator<Vertex>() { private Comparator collapseComparator = new Comparator<Vertex>() {
public int compare(Vertex o1, Vertex o2) { public int compare(Vertex o1, Vertex o2) {
@ -525,14 +525,14 @@ public class LodGenerator {
/** /**
* Computes the lod and return a list of VertexBuffers that can then be used * Computes the lod and return a list of VertexBuffers that can then be used
* for lod (use Mesg.setLodLevels(VertexBuffer[]))<br> * for lod (use Mesh.setLodLevels(VertexBuffer[]))<br>
* *
* This method must be fed with the reduction method * This method must be fed with the reduction method
* {@link TriangleReductionMethod} and a list of reduction values.<br> for * {@link TriangleReductionMethod} and a list of reduction values.<br> for
* each value a lod will be generated. <br> The resulting array will always * each value a lod will be generated. <br> The resulting array will always
* contain at index 0 the original index buffer of the mesh. <p> * contain at index 0 the original index buffer of the mesh. <p>
* <strong>Important note :</strong> some meshes cannot be decimated, so the * <strong>Important note :</strong> some meshes cannot be decimated, so the
* result of this method can varry depending of the given mesh. Also the * result of this method can vary depending of the given mesh. Also the
* reduction values are indicative and the produces mesh will not always * reduction values are indicative and the produces mesh will not always
* meet the required reduction. * meet the required reduction.
* *
@ -597,7 +597,7 @@ public class LodGenerator {
* This method must be fed with the reduction method * This method must be fed with the reduction method
* {@link TriangleReductionMethod} and a list of reduction values.<br> for * {@link TriangleReductionMethod} and a list of reduction values.<br> for
* each value a lod will be generated. <p> <strong>Important note :</strong> * each value a lod will be generated. <p> <strong>Important note :</strong>
* some meshes cannot be decimated, so the result of this method can varry * some meshes cannot be decimated, so the result of this method can vary
* depending of the given mesh. Also the reduction values are indicative and * depending of the given mesh. Also the reduction values are indicative and
* the produces mesh will not always meet the required reduction. * the produces mesh will not always meet the required reduction.
* *

Loading…
Cancel
Save