Show:

BO.filters.Scaler Class

Extends BO.filters.FilterBase
Defined in: src/filters/Scaler.js:22

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.

Constructor

BO.filters.Scaler

(
  • inMin
  • inMax
  • outMin
  • outMax
  • type
  • limiter
)

Defined in src/filters/Scaler.js:22

Parameters:

  • inMin Number

    minimum input value

  • inMax Number

    maximum input value

  • outMin Number

    minimum output value

  • outMax Number

    maximum output value

  • type Function

    The function used to map the input curve

  • limiter Boolean

    Whether or not to restrict the input value if it exceeds the specified range.

Item Index

Methods

Methods

processSample

(
  • val
)
Number protected

Inherited from BO.filters.FilterBase: src/filters/FilterBase.js:30

Process the value to be filtered and return the filtered result.

Parameters:

  • val Number

    The input value to be filtered.

Returns:

Number:

The resulting value after applying the filter.

Scaler.CUBE

() static

Defined in src/filters/Scaler.js:96

y = x^4

Scaler.CUBE_ROOT

() static

Defined in src/filters/Scaler.js:105

y = pow(x, 1/4)

Scaler.LINEAR

() static

Defined in src/filters/Scaler.js:69

y = x

Scaler.SQUARE

() static

Defined in src/filters/Scaler.js:78

y = x * x

Scaler.SQUARE_ROOT

() static

Defined in src/filters/Scaler.js:87

y = sqrt(x)