live.grid
Description
live.grid is a user interfaces object designed for use with the chucker~ object. It provides a display grid of steps, constraints for transposition, and playback direction for use in controlling the chucker~ object.
Examples

Arguments
None.
Attributes
amountcolor [4 floats]
Defines the color of the overlay in RGBA format.
annotation_name [symbol] (default: )
The string that is prepended to annotations. This shows up in the Info pane in Live, and the clue window in Max.
bgstepcolor [4 floats]
Sets the background step color of the live.grid object in RGBA format.
bgstepcolor2 [4 floats]
Sets the second background step color of the live.grid object in RGBA format.
bordercolor [4 floats]
Sets the border color of the live.grid object in RGBA format.
bordercolor2 [4 floats]
Sets the second border color of the live.grid object in RGBA format.
columns [int] (default: 16)
Sets the number of columns in the live.grid object's display
direction [int] (default: 1)
Toggles the display of the directions arrows.
direction_height [float] (default: 15.)
Sets the height of the direction panel.
directioncolor [4 floats]
Sets the color of the direction's arrows in RGBA format.
displayamount [int] (default: 0)
Enables the display the of the live.grid steps. This is only available in non-matrix mode.
attribute color overfreezecolor [4 floats]
Sets the color of all frozen steps in RGBA format.
hbgcolor [4 floats]
Sets the highlighted background color of the live.grid object in RGBA format.
link [int] (default: 0)
Toggles live.grid objects are sent out the right outlet.
mode. When activated, all the necessary messages to synchronize twomarker_horizontal [int] (default: 4)
Defines the "first beat" indicator on the live.grid object's horizontal axis. The attribute sets the display color for this indicator. To hide the indicator, set the attribute value to zero.
marker_vertical [int] (default: 4)
Defines the "first beat" indicator on the live.grid object's vertical axis. The attribute sets the display color for this indicator. To hide the indicator, set the attribute value to zero.
matrixmode [int] (default: 0)
Toggles matrix mode for the object's display. In matrix mode, multiple cells in a row or column may be selected.
Note: The and messages change their syntax slightly when used in conjunction with this attribute. See the listing for these messages for more details.
mode [int] (default: 0)
Defines the current display mode.
Possible values:
0 = 'Step Edit'
1 = 'Step constraint'
rounded [float] (default: 4.)
Defines the roundness of the grid in pixels.
rows [int] (default: 16)
Sets the number of rows in the live.grid object's display. The minimum number of rows is 2 when the attribute is not set, and 1 if it is.
spacing [float] (default: 1.)
Defines the grid spacing in pixels.
stepcolor [4 floats]
Sets the step color of the live.grid object in RGBA format.
Common Box Attributes
Parameter Attributes
Messages
int
Arguments
list
Arguments
When the attribute is set to 1, a of 3 values sets the step index, value and direction.
When the attribute is set to 1, a list of 3 values sets the object's behavior: , , and . An optional fourth value can be used to set direction (-1/0/1).
clear
constraint
Arguments
directions
Arguments
: Backward
: Stop
: Forward
down
Note: The current constraints, if any, are also taken into account when altering current step values; the resulting shift might be "rounded" to the closest step.
freeze
Arguments
getcell
Arguments
y-index [int]
getcolumn
Arguments
getconstraint
Arguments
: Constraint
: No constraint
getdirections
Arguments
: Backward
: Stop
: Forward
getrow
Arguments
init
left
Note: The current constraints, if any, are also taken into account when altering current step values; the resulting shift might be "rounded" to the closest step.
linkdump
attribute is set to 1, the message sends all messages required to synchronize onerandom
Arguments
: Randomize the steps values
: Randomize constraints and make sure that the steps values are correct with respect to the new constraints grid
: Randomize directions if the attribute is set to 1.
reset
Arguments
: Reset the steps values (Note: since the reset may interact with the current constraints, a given step value may not be completely reset)
: Clear all constraints
: Set all the directions to if the attribute is set to 1.
right
Note: The current constraints, if any, are also taken into account when altering current step values; the resulting shift might be "rounded" to the closest step.
set
Arguments
setcell
Arguments
y-index [int]
value [int]
steps
Arguments
up
Note: The current constraints, if any, are also taken into account when altering current step values; the resulting shift might be "rounded" to the closest step.
Output
anything
Out the fifth outlet: dumpout message used to query the live.grid object.
Out the rightmost outlet: Synchronization messages are sent through this outlet when the attribute is set to 1.
list
Out the leftmost outlet: Current step value: y value, direction (optional, depending on the visibility of the directions pane).
Out second outlet: The steps values are sent out this outlet whenever they are changed via the mouse or a message. If the live.grid object is in Matrix Mode, the step value/y value coordinates of all "on" points are sent out the outlet.
Out third outlet: The directions values are sent out this outlet whenever they are changed via the mouse or a message. Note that this outlet does not output anything when the attribute is set to 0.
Out the fourth outlet: Mouseover information: x, y, direction (optional, depending on the visibility of the directions panel). Also when the mouse is used to change a setting, the message is sent, where N indicates the type of change (0 = steps, 1 = directions, 2 = constraints).
See Also
Name | Description |
---|---|
Max For Live | Max For Live |
live.step | |
multislider | |
itable | |
matrixctrl | |
chucker~ |