linedrive Reference

Scale numbers exponentially

linedrive

Description

Scales number from one range to another with an exponential curve. Both the input and output ranges are expressed as single arguments representing the maximum value. The minimum values are the negative values of the ranges (argument * -1).

Examples

Use linedrive for exponential value scaling

Arguments

input [number]

The first argument is the maximum input value. The range used is from (argument * -1) to (argument).

output [number]

The second argument is the maximum output value. The range used is from (argument * -1) to (argument).

curve [number]

The third argument specifies the nature of the scaling curve. The third argument must be greater than 1. The larger the value, the more steeply exponential the curve is. An appropriate value for this argument is 1.06.

delay [int]

Unitsms

The fourth argument specifies a ramp time (slew rate). The linedrive object outputs a list consisting of the scaled output value followed by a ramp time in milliseconds which can be sent to a line or line~ object. The initial argument value can be modifed using the linedrive object's right inlet.

Attributes

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points). Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile [symbol]

JS Painter File

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [4 floats]

Sets the color for the object's text in RGBA format.

textjustification [int]

Sets the justification for the object's text. Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

int

Arguments

input [int]
In left inlet: The number is converted according to the following expression
y = b e^{-a log c} e^{x log c}
where x is the input, y is the output, a, b, and c are the three typed-in arguments, and e is the base of the natural logarithm (approximately 2.718282). The output is a two-item list containing y followed by the delay time most recently received in the right inlet.

  (inlet1)

Arguments

delay [int]
In right inlet: Sets the current delay time appended to the scaled output. A connected line~ object will ramp to the new target value over this time interval.

float

Arguments

input-to-conversion [float]
In left inlet: The number is converted according to the following expression
y = b e^{-a log c} e^{x log c}
where x is the input, y is the output, a, b, and c are the three typed-in arguments, and e is the base of the natural logarithm (approximately 2.718282). The output is a two-item list containing y followed by the delay time most recently received in the right inlet.

Output

list

When an int or float is received in the left inlet, a list is sent out containing a scaled version of the input (see the formula above) and the current delay time.

See Also

Name Description
expr Evaluate a mathematical expression
scale Map values to an output range