mc.gradient~

Generate a time-varying function over the space of a multichannel signal

Description

Add breakpoints to the mc.gradient~ to specify a function where both the domain and range go from 0 to 1. The output range is mapped across the space of a multichannel signal. Connect a phasor~ or another time-varying single- or multichannel signal to the mc.gradient~ object to drive its output.

Arguments

chans [int]

Change the number of channels in the output multichannel signal. The output channel count will not change until the audio is restarted. The default value of the chans attribute is 0 meaning the object's argument determines the number of output channels.

Attributes

chans [int] (default: 4)

Sets the number of channels in the multichannel output signal

mode [int] (default: 0)

Determines the direction of oscillation over the functions domain. Options are up, down, and up/down. Currently only up mode is supported.

Possible values:

0 = 'up' ( Values Increase )
Oscillation values in the Y-range increase over the functions domain.

1 = 'down' ( Values Decrease )
Oscillation values in the Y-range decrease over the functions domain (not currently supported).

2 = 'up down' ( Palindrome Mode )
Oscillation values in the Y-range move up then down over the functions domain (not currently supported).

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.

Messages

int

Arguments

function-values [int]
Converted to float

float

Arguments

function-values [float]
Return the function values for each channel at the specified x-position in the range 0.0 - 1.0.

list

Arguments

x-value [number]
y1-value [number]
y2-value [number]
phase [number]
The list message adds a new breakpoint. Up to 4 values can be used to specify the x postion, upper y value, lower y value, and phase offset of the breakpoint. If the list contains two values, it creates a breakpoint with a fixed y value at the x postion. An optional third value specifies the lower y value range and a fourth value can be used to specify the phase value (default 0.). If the supplied x value matches an existing breakpoint, that breakpoint will be modified.

chanval

Arguments

channel [int]
x-position [float]
Returns the value of the output function for a given channel and input position.

clear

The clear message removes all breakpoints in the current function, restoring it to the default state.

printfunction

The printfunction message prints the current function to the console.

signal

A single channel signal controls all breakpoints. A multichannel signal maps each channel to a separate breakpoint as they are ordered from left to right, wrapping if the number of input channels is greater than the number of breakpoints.

See Also

Name Description
MC MC
cycle~ Sinusoidal oscillator
function Breakpoint function editor
line~ Linear ramp generator
mc.cycle~ Sinusoidal oscillator (multichannel)
mc.evolve~ Generate a periodic multichannel function from breakpoint ranges
mc.line~ Linear ramp generator (multichannel)
mc.phasor~ Generate sawtooth signals (multichannel)
phasor~ Generate sawtooth signals
MC MC