Class BO.filters.Scaler
Extends
BO.filters.FilterBase.
Scales up an input value from its min and max range to a specified
minimum to maximum range. See Breakout/examples/filters/scaler.html for an
example application.
Defined in: Scaler.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
BO.filters.Scaler(inMin, inMax, outMin, outMax, type, limiter)
Scales an input value from its min and max range to a specified minimum to maximum range.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
BO.filters.Scaler.CUBE(val)
y = x^4
|
| <static> |
BO.filters.Scaler.CUBE_ROOT(val)
y = pow(x, 1/4)
|
| <static> |
BO.filters.Scaler.LINEAR(val)
y = x
|
|
processSample(val)
Override FilterBase.processSample
|
|
| <static> |
BO.filters.Scaler.SQUARE(val)
y = x * x
|
| <static> |
BO.filters.Scaler.SQUARE_ROOT(val)
y = sqrt(x)
|
Class Detail
BO.filters.Scaler(inMin, inMax, outMin, outMax, type, limiter)
Scales an input value from its min and max range to a specified minimum to maximum range.
A number of scaling functions are provided.
- Parameters:
- {Number} inMin
- minimum input value
- {Number} inMax
- maximum input value
- {Number} outMin
- minimum output value
- {Number} outMax
- maximum output value
- {Function} type
- The function used to map the input curve
- {Boolean} limiter
- Whether or not to restrict the input value if it exceeds the specified range.
Method Detail
<static>
BO.filters.Scaler.CUBE(val)
y = x^4
- Parameters:
- val
<static>
BO.filters.Scaler.CUBE_ROOT(val)
y = pow(x, 1/4)
- Parameters:
- val
<static>
BO.filters.Scaler.LINEAR(val)
y = x
- Parameters:
- val
processSample(val)
Override FilterBase.processSample
- Parameters:
- val
<static>
BO.filters.Scaler.SQUARE(val)
y = x * x
- Parameters:
- val
<static>
BO.filters.Scaler.SQUARE_ROOT(val)
y = sqrt(x)
- Parameters:
- val