Breakpoint function editor Draw or store a set of x, y points as floating-point numbers. The output the entire function is useful as an input for line~. You can also get an interpolated y value for any x value. Cycling '74 Max MSP U/I bang Outputs All, float Outputs Y at X, list Edits TEXT_HERE Interpolated Y (float) for Input X TEXT_HERE All Points in line Format TEXT_HERE dump Message Output (list) TEXT_HERE bang When Changed With Mouse TEXT_HERE TEXT_HERE TEXT_HERE Output a list of breakpoints Triggers a list output of the current breakpoints from the middle-left outlet formatted for use by the line~ object. As an example, if the function contained breakpoints at X = 1, Y = 0; X = 10, Y = 1; and X = 20, Y = 0, the output would be 0, 1 9 0 10. If the optional output mode is enabled, the output would be 0 0 1 9 0 10.

If there are any sustain points in the function, bang outputs a list of all the points up to the sustain point. Additional points in the function, up to a subsequent sustain point or the end point, whichever applies, can be output by sending the next message. See the description of the next and sustain messages for additional information. Output an interpolated y-axis value The value is taken as an X value and outputs a corresponding Y value out the left outlet. The Y value is produced by linear floating-point interpolation of the function. If the X value lies outside the first or last breakpoint, the Y value is 0. Output an interpolated y-axis value The value is taken as an X value and outputs a corresponding Y value out the left outlet. The Y value is produced by linear floating-point interpolation of the function. If the X value lies outside the first or last breakpoint, the Y value is 0. Add a new breakpoint If the list contains two values, a new point is added to the function. The first value is X, the second is Y.

If the list contains three values, an existing point in the function is modified. The first value is the index (starting at 0) of a breakpoint to modify, the second is the new X value for the breakpoint, and the third is the new Y value for the breakpoint. (If the index number in the list refers to a breakpoint that does not exist, the message is ignored.) Clear breakpoints The word clear by itself erases all existing breakpoints. The word clear can also be followed by one or more breakpoint indices (starting at 0) to clear selected breakpoints. Clear all fixed-value states The word clearfix clears all fix states (sets them to 0). Clear all sustain states The word clearsustain clears all sustain states (sets them to 0). TEXT_HERE TEXT_HERE Copy the points from a function The copy message copies all of the current function points to the clipboard so that they can be pasted into another function object. Output all breakpoints Outputs a series of two-item lists, containing the X and Y values for each of the breakpoints, out the function object's middle-right outlet. An optional symbol argument can be used to specify a receive objects as a destination. Toggle breakpoint editing The word fix, followed by a number specifying the index of a point and 0 or 1, prevents the user from changing the point if the second number is 1, and allows the user to change the point if the second number is 0. By default, points are moveable unless clickmove 0 has been sent to disable moving of all points. Report all fixed-value points The word getfix. with no arguments, will cause the function object to send a list all fix points out the object's middle-right outlet. If an index is provided as an argument, the fix state for that point will be output. Report all sustain points The word getsustain. with no arguments, will cause the function object to send a list all sustain points out the object's middle-right outlet. If an index is provided as an argument, the sustain state for that point will be output. Output all breakpoints as a single list Outputs a single list which contains all X and Y values for each of the breakpoints out the function object's middle-right outlet.An optional symbol argument can be used to specify a receive objects as a destination. Continue from a sustain point The next message continues a list output from the sustain point where the output of the last bang or next message ended. For instance, if the function contained breakpoints at (a) X = 1, Y = 0; (b) X = 10, Y = 1; and (c) X = 20, Y = 0, and point b was a sustain point, a bang message would output 0, 1 9 and a subsequent next message would output 1, 0 10. After a next message reaches the end point, a subsequent next message is equivalent to a bang message. next is also equivalent to a bang when no bang has been sent that reached a sustain point, or when a function contains no sustain points. Manually add or edit breakpoints You can use the mouse to draw points in a line segment function; the finished function can then be sent to a line~ object for use as a control signal in MSP. Clicking on empty space in the function adds a breakpoint, which you can begin to move immediately by dragging (unless function has been sent the clickadd 0 message). Clicking on a breakpoint allows you to move the breakpoint by dragging (unless function has been sent the clickmove 0 message). The X and Y values of the breakpoint are displayed in the upper part of the object’s box. Shift-clicking on a breakpoint deletes that point from the function. Command-clicking on Macintosh or Control-clicking on Windows on a breakpoint toggles the sustain property of the point. Sustain points are outlined in white. Whenever an editing operation with the mouse is completed, a bang is sent out the right outlet.
Points with a Y value of 0 are outlined circles; other points are solid. This allows you to see at a glance whether a function starts or ends at Y = 0. Output a breakpoint value The word nth, followed by a number, uses the number as the index (starting at 0) of a breakpoint, and outputs the Y value of the breakpoint out the left outlet. If no breakpoint with the specified index exists, no output occurs. Quantize points on the grid's horizontal axis This message will cause all of the points to automatically snap to the horizontal grid as defined by the gridstep_x attribute. Quantize points on the grid's vertical axis This message will cause all of the points to automatically snap to the vertical grid as defined by the gridstep_y attribute. Paste the points of a copied function The paste message pastes all of the points of a previously copied function into a function object. Set breakpoint values Given the number of points already defined within function's graphic editor, a corresponding list of x-y-coordinate pairs will set the position of each point. Draw a curve between two points The word setcurve, followed by an integer that specifies the index of a function point (numbered from 1) and a floating point value that specifies a curve, will create a curved line segment between the specified point and the next point.

Curve factor values from 0 to 1.0 produce an "exponential" curve when increasing in value and values from -1.0 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. The mode attribute must be set to 1 (curve mode) for this message to be effective. Set the maximum X-axis value The word setdomain, followed by a float or int value, sets the maximum displayed X value, then modifies the X values of all breakpoints so that they remain in the same place given the new domain. Set minimum and maximum Y-axis values The word setrange, followed by two float or int values, sets the minimum and maximum display range for Y values, then modifies the Y values of all breakpoints so that they remain in the same place given the new range. Set the sustain state for a breakpoint The word sustain, followed by number specifying the index of a point and zero or one, turns that point into a sustain point if the second number is 1, or into a regular point if the second number is 0. By default, points are regular (non-sustain). The behavior of sustain points is discussed in the description of the bang message above. Command-clicking on Macintosh or Control-clicking on Windows also toggle the sustain property of a point. Add a point with curve information The word xyc, followed by an two numbers that specifies X and Y values and a floating point number that specifies a curve factor, will add a new point with curve information to the function.

Curve factor values from 0 to 1.0 produce an "exponential" curve when increasing in value and values from -1.0 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. The mode attribute must be set to 1 (curve mode) for this message to be effective. Automatic sustain mode Toggles setting the sustain point to the one before last point. This feature requires that there are more than two points in the current function. The default is 0 (off). Background color Sets the display color for the background in RGBA format. TEXT_HERE TEXT_HERE Click-to-add flag Toggles a user's ability to create new breakpoints by clicking and dragging with the mouse. This feature is enabled by default. Click-to-move flag Toggles a user's ability to move existing breakpoints by dragging them with the mouse. This feature is enabled by default. Toggles a user's ability to specify a sustain point by clicking with the mouse. Click-to-sustain flag Cursor Position Sets the position of the cursor along the function object's X axis. TEXT_HERE TEXT_HERE Maximum sustain value Sets the maximum displayed X value. Display Grid Enables and selects the display of a grid for the function object display. The modes are:

0: No grid displayed (default).
1: Horizontal grid displayed.
2: Vertical grid displayed.
3: Horizontal and vertical grids displayed. TEXT_HERE TEXT_HERE TEXT_HERE TEXT_HERE TEXT_HERE TEXT_HERE TEXT_HERE TEXT_HERE Grid Color TEXT_HERE Horizontal Grid Step Sets the horizontal (x) grid step for the function object's display. Vertical Grid Step Sets the vertical (y) grid step for the function object's display. Legend display flag Toggles the numerical display (legend) of the function object, displayed when a point is highlighted or updated. Color Sets the display color for the function line segments in RGBA format. Line Thickness Sets the thickness (width) of the lines drawn between points. Mode Selects the function object's drawing mode. The modes are:

0: Linear mode (default).
1: Curve mode. The amount of curve between each point is set using the setcurve message. Linear mode TEXT_HERE Curve mode TEXT_HERE Mouse Mode This attribute changes the behavior of what happens when moving a function point via the mouse. When mousemode is set to 'free' (default), the point being moved can only be moved between the preceding and subsequent points, and all other points are unchanged. When mousemode is set to 'shift', all subsequent points are moved an equal amount on the x axis, keeping their relative distance on the x axis from the point being moved. Move point without moving others TEXT_HERE Move point and shift subsequent points TEXT_HERE Output Mouse Information When mousereport is set to 1, a three item list of mouse data is output from the third outlet. The list contains the mouse's current position on the x and y axis, as well as the current point under the mouse pointer. If no point is under the mouse, a -1 is output. The list is only output when the mouse is over the function object and the patcher is locked. Output mode Sets the function object's output mode.
Normal: When the object receives a bang, it outputs a list of the current breakpoints formatted for use by the line~ object.
List: When the object receives a bang, it sends its values in single list in which the first Y value is followed by a 0, followed by any additional Y values and associated times. TEXT_HERE TEXT_HERE TEXT_HERE TEXT_HERE Enable parameter mode handling Enables use of this object with Max for Live Parameters and allows for setting initial parameter values in the Max environment. TEXT_HERE TEXT_HERE Y-axis display range Sets the minimum and maximum display ranges for Y values. Snap Mouse to Grid Enables and selects a snap to grid mode for the placement of function points. Snap to grid may be enabled even when the grid is not displayed (set using the grid attribute. The modes are:

0: Snap to grid disabled (default).
1: Snap to horizontal grid.
2: Snap to vertical grid.
3: Snap to horizontal and vertical grids. TEXT_HERE TEXT_HERE TEXT_HERE TEXT_HERE TEXT_HERE TEXT_HERE TEXT_HERE TEXT_HERE Style Sets the style to be applied to the object. Styles can be set using the Format palette. Grid and Sustain Color Sets the display colors for the function grid and for indicating sustain in RGBA format. Text Color Sets the display color for text in RGBA format. Horizontal zoom factor Sets the horizontal zoom for the function object's display. Zoom values are set using a pair of floating point values in the range 0.0 - 1.0. Vertical zoom factor Sets the vertical zoom for the function object's display. Zoom values are set using a pair of floating point values in the range 0.0 - 1.0. Out left outlet: The interpolated Y value is sent out in response to a float or int X value received in the inlet; or a stored Y value is sent out in response to an nth message. Out middle-left outlet: When bang is received, a list containing information about all stored values will be sent out the outlet. This format is intended for input to the line~ object.

If the function object is in linear mode (set via the mode attribute), a float is sent out for the first stored Y value, followed by a list containing pairs of numbers indicating each subsequent stored Y value and its transition time (the difference between X and the previous X). If the function object is in linear mode (set via the mode attribute), a float is sent out for the first stored Y value, followed by a list containing pairs of numbers indicating each subsequent stored Y value and its transition time (the difference between X and the previous X).

If the function object is in curve mode (set via the mode attribute), a float is sent out for the first stored Y value, followed by a list containing triplets of numbers indicating each subsequent stored Y value, its transition time (the difference between X and the previous X), and a curve factor value (see the setcurve message listing).

Out middle-right outlet: If the function object is in linear mode (set via the mode attribute), a series of two-item lists containing the X and Y values of each of the function object's breakpoints is sent out when a dump message is received.

If the function object is in curve mode (set via the mode attribute), a series of three-item lists containing the X and Y values and a curve factor of each of the function object's breakpoints is sent out when a dump message is received. Out right outlet: When a mouse editing operation is completed, a bang is sent out.