A newer version of Max is available. Click here to access the latest version of the documentation

curve~

Exponential ramp generator

Description

Use the curve~ object to produce a signal that goes from an initial to target value over a specified time. It is similar to the line~ object, it produces non-linear ramps using a piecewise approximation of an exponential function.

Examples

Curved ramps used as control signals for frequency and amplitude

Discussion

This object uses the Max time format syntax; envelope times can be either single valued fixed or tempo-relative. The curve~ object produces non-linear ramps using a piecewise approximation of an exponential function. You specify the parameter to this exponential function in the curve~ object's right inlet. Values from 0 to 1 produce an "exponential" curve when increasing in value and values from -1 to 0 produce a "logarithmic" curve. The closer to 0 the curve parameter is, the closer the curve is to a straight line, and the farther away the parameter is from 0, the steeper the curve. curve~ can also accept a list of up to two or three arguments (the previous curve parameter is used if there are two arguments), or a list with two or more value, time, parameter triples. The curve~ is limited to 42 such triples in a single list. The object's approximation of the exponential becomes better when the vector size is smaller, but the object also becomes more computationally expensive.

Arguments

initial-value [number]

Optional

The first argument sets an initial value for the signal output. The default value for the parameter is 0.

curve-parameter [number]

Optional

The second argument sets the initial curve parameter. The default value for the curve parameter is 0.

Attributes

maxpoints [int]

Specify the maximum number of user defined points allowed in the curve. The default is 129 points.

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

target-value [int]
In left inlet: The number is the target value, to be arrived at in the time specified by the number in the middle inlet. If no time has been specified since the last target value, the time is considered to be 0 and the output signal jumps immediately to the target value (ints are converted to floats).

float

Arguments

target-value [float]
In left inlet: The number is the target value, to be arrived at in the time specified by the number in the middle inlet. If no time has been specified since the last target value, the time is considered to be 0 and the output signal jumps immediately to the target value.

list

Arguments

target-value [number]
ramp-time [float]
curve-parameter [float]
In left inlet: The first number specifies a target value; the second number specifies an amount of time, in milliseconds, to arrive at that value; and the optional third number specifies a curve parameter, for which values from 0 to 1 produce an exponential curve and values from -1 to 0 produce a logarithmic curve. The closer to 0 the curve parameter is, the more the curve resembles a straight line, and the farther away the parameter is from 0, the more the curve resembles a step. In the specified amount of time, curve~ generates an exponential ramp signal from the currently stored value to the target value.

In middle inlet: A list may be used to specify time in one of the Max time formats.

anything

Arguments

target-value [number]
ramp-time [float]
curve-parameter [float]
In left inlet: The first number specifies a target value; the second number specifies an amount of time, in milliseconds, to arrive at that value; and the optional third number specifies a curve parameter, for which values from 0 to 1 produce an exponential curve and values from -1 to 0 produce a logarithmic curve. The closer to 0 the curve parameter is, the more the curve resembles a straight line, and the farther away the parameter is from 0, the more the curve resembles a step. In the specified amount of time, curve~ generates an exponential ramp signal from the currently stored value to the target value.

In middle inlet: A list may be used to specify time in one of the Max time formats.

factor

Arguments

nonlinear-factor [float]
The word factor followed by a float will adjust the non-linear shaping parameters of curve~.

pause

In left inlet: Pauses the internal exponential ramp but does not change the target value nor clear pending target-time-parameter triples. curve~ will continue outputting whatever value was its current value when the pause message was received, until either it receives a resume message or until a new ramp is input.

resume

In left inlet: Resumes the internal exponential ramp and subsequent pending target-time pairs if the curve~ object was paused as a result of the pause message.

stop

In left inlet: Stops the internal exponential ramp and clears pending target-time parameter triples. curve~ will continue outputting whatever value was its current value when the stop message was received, resetting its target value to that value.

Output

bang

Out right outlet: When curve~ has finished generating all of its ramps, bang is sent out.

signal

Out left outlet: The current target value, or an exponential curve moving toward the target value according to the most recently received target value, transition time, and curve parameter.

See Also

Name Description
line~ Linear signal ramp generator
transport Control a master clock