scale
Gen Reference

scale

Map an input range of values to an output range

Description

Similar to the Max scale and MSP scale~ objects. Inputs are: 1) value to scale, 2) input lower bound, 3), input upper bound, 4) output lower bound, 5) output upper bound, 6) exponential curve. Default lower and upper bounds are zero and one; default exponential curve is 1 (linear). No bound clamping is performed. The high and low values can be reversed for inverted mapping.

Constructors

  • { arguments={ilo, ihi, olo, ohi, exp}, inlets={input} }
  • { arguments={ilo, ihi, olo, ohi}, inlets={input, exp} }
  • { arguments={ilo, ihi, olo}, inlets={input, ohi, exp} }
  • { arguments={ilo, ihi}, inlets={input, olo, ohi, exp} }
  • { arguments={ilo}, inlets={input, ihi, olo, ohi, exp} }
  • { arguments={}, inlets={input, ilo, ihi, olo, ohi, exp} }

Inlets

exp

Typefloat

exponential curve

ihi

Typefloat

input range upper value

ilo

Typefloat

input range lower value

input

Typefloat

value to scale

ohi

Typefloat

output range upper value

olo

Typefloat

output range lower value

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.

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 [float]

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

textjustification [int]

Text Justification

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.

See Also

Name Description
clamp Clamp values in a specified range
fold Fold input to a range within a low and high output value
gate Select between a number of outputs
mix Linear crossfade of inputs
selector Select between a number of inputs
smoothstep Smoothed fade of inputs
switch Conditional ternary operator
wrap Wrap input to a range within a low and high output value