kinetic.util
Class EffectParameter.BoundedDouble

java.lang.Object
  |
  +--kinetic.util.EffectParameter
        |
        +--kinetic.util.EffectParameter.BoundedDouble
Enclosing class:
EffectParameter

public static class EffectParameter.BoundedDouble
extends EffectParameter

Bounded Double Parameter Class


Nested Class Summary
 
Nested classes inherited from class kinetic.util.EffectParameter
EffectParameter.Boolean, EffectParameter.BoundedDouble, EffectParameter.BoundedInteger, EffectParameter.Double, EffectParameter.EnumeratedString, EffectParameter.Integer, EffectParameter.Percentage, EffectParameter.String, EffectParameter.ZeroToOne
 
Field Summary
 
Fields inherited from class kinetic.util.EffectParameter
currentValue, defaultValue, name, type, TYPE_BOOLEAN, TYPE_BOUNDED_DOUBLE, TYPE_BOUNDED_INTEGER, TYPE_DOUBLE, TYPE_ENUMERATED_STRING, TYPE_INTEGER, TYPE_PERCENTAGE, TYPE_STRING, TYPE_UNKNOWN, TYPE_ZERO_TO_ONE
 
Constructor Summary
EffectParameter.BoundedDouble(java.lang.String n, double v, double lower, double upper)
          creates a new instance of the type parameter
 
Method Summary
 double getLowerBound()
          gets the lower bound
 double getUpperBound()
          gets the upper bound
 double getValue()
          gets the type casted version of the current value object
 void setLowerBound(double v)
          sets the lower bound
 void setUpperBound(double v)
          sets the upper bound
 void setValue(double v)
          sets the current value object with a type casted variable
 
Methods inherited from class kinetic.util.EffectParameter
getCurrentObject, getDefaultObject, getName, getType, setCurrentObject, setDefaultObject, setName, setType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EffectParameter.BoundedDouble

public EffectParameter.BoundedDouble(java.lang.String n,
                                     double v,
                                     double lower,
                                     double upper)
creates a new instance of the type parameter

Parameters:
n - name of the parameter
v - the default and initial value for the parameter
lower - lower bound for the parameter
upper - upper bound for the parameter
Method Detail

getValue

public double getValue()
gets the type casted version of the current value object

Returns:
value of the parameter

setValue

public void setValue(double v)
sets the current value object with a type casted variable

Parameters:
v - new value for the parameter

getUpperBound

public double getUpperBound()
gets the upper bound

Returns:
upper bound

getLowerBound

public double getLowerBound()
gets the lower bound

Returns:
lower bound

setUpperBound

public void setUpperBound(double v)
sets the upper bound

Parameters:
v - upper bound

setLowerBound

public void setLowerBound(double v)
sets the lower bound

Parameters:
v - lower bound