at.wisch.joystick.ffeffect
Class FrictionEffect

java.lang.Object
  extended by at.wisch.joystick.ffeffect.Effect
      extended by at.wisch.joystick.ffeffect.ConditionEffect
          extended by at.wisch.joystick.ffeffect.FrictionEffect

public class FrictionEffect
extends ConditionEffect

The Class FrictionEffect. ConditionEffect based on axes movement.

Author:
Martin Wischenbart

Field Summary
 
Fields inherited from class at.wisch.joystick.ffeffect.Effect
EFFECT_CONSTANT, EFFECT_CUSTOM, EFFECT_DAMPER, EFFECT_FRICTION, EFFECT_INERTIA, EFFECT_RAMP, EFFECT_SAWTOOHDOWN, EFFECT_SAWTOOTHUP, EFFECT_SINE, EFFECT_SPRING, EFFECT_SQUARE, EFFECT_TRIANGLE, INFINITE_LENGTH, MAX_DELAY, MAX_LENGTH, MAX_LEVEL, MIN_LEVEL, NO_BUTTON
 
Constructor Summary
FrictionEffect()
          Instantiates a new FrictionEffect with default parameters.
FrictionEffect(int effectLength, int effectDelay, int buttonIndex, int buttonInterval, int[] rightSat, int[] leftSat, int[] rightCoef, int[] leftCoef, float[] deadband, float[] center)
          Instantiates a new FrictionEffect with the specified parameters.
 
Method Summary
 java.lang.String getName()
          Gets the effect type as a String.
 
Methods inherited from class at.wisch.joystick.ffeffect.ConditionEffect
getCenter, getDeadband, getLeftCoef, getLeftSat, getRightCoef, getRightSat, getStrength, setCenter, setDeadband, setLeftCoef, setLeftSat, setRightCoef, setRightSat, setStrength
 
Methods inherited from class at.wisch.joystick.ffeffect.Effect
getButtonIndex, getButtonInterval, getDefaultDirection, getEffectDelay, getEffectLength, getEffectType, setButtonIndex, setButtonInterval, setDefaultDirection, setEffectDelay, setEffectLength
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FrictionEffect

public FrictionEffect(int effectLength,
                      int effectDelay,
                      int buttonIndex,
                      int buttonInterval,
                      int[] rightSat,
                      int[] leftSat,
                      int[] rightCoef,
                      int[] leftCoef,
                      float[] deadband,
                      float[] center)
Instantiates a new FrictionEffect with the specified parameters.

Parameters:
effectLength - the effect length
effectDelay - the effect delay
buttonIndex - the button index
buttonInterval - the button interval
rightSat - rightSat array: Level when joystick is to the positive side
leftSat - leftSat array: Level when joystick is to the negative side
rightCoef - rightCoef array: How fast to increase the force towards the positive side
leftCoef - leftCoef array: How fast to increase the force towards the negative side
deadband - the deadband zone around the center
center - the center
See Also:
FrictionEffect()

FrictionEffect

public FrictionEffect()
Instantiates a new FrictionEffect with default parameters.

See Also:
FrictionEffect(int, int, int, int, int[], int[], int[], int[], float[], float[])
Method Detail

getName

public java.lang.String getName()
Gets the effect type as a String.

Specified by:
getName in class Effect
Returns:
the effect type as a String: "Friction"
See Also:
Effect.getEffectType()