Package Max for Live

live.map

Simplify the process of selecting Live interface elements for use with the Live API.

Description

The live.map object encapsulates the process of using the mouse to select Live user interface elements to determine their LOM paths and IDs.

Arguments

None.

Attributes

mapping[int]

When enabled ( 1 ), the live.map object is listening for mouse selection of Live user interface elements. When disabled ( 0 ), the object is not listening.

strict[int]

When enabled ( 1 ), the live.map object will ignore mouse clicks on Live user interface elements inside the same device as the live.map object.

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

annotation[symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background[int]: 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]: 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]: 0

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile[symbol]

JS Painter File

patching_rect[4 floats]: 0. 0. 100. 0.

Sets the position and size of the object in the patcher window.

position[2 floats]

write-only

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]: 0

Sets whether an object belongs to the patcher's presentation.

presentation_rect[4 floats]: 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]

write-only

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]

write-only

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

bang

Begin the process of listening for mouse clicks for Live user interface element selection. Selecting a Live user interface element will automatically stop mapping after outputting the path and ID of the selected element.

int

1 in the left inlet of the object will begin the process of listening for mouse clicks for Live user interface element selection. Selecting a Live user interface element will automatically stop mapping after outputting the path and ID of the selected element. A 0 will manually stop mapping, whether or not a Live user interface element was selected.

Arguments:

enable [int]

cancel

Stop mapping if it was started.

getdefault

Output the default value of the mapped Live user interface element, preceded by the word default , from the rightmost outlet of the object.

getrange

Output the range of the mapped Live user interface element, preceded by the word range , from the rightmost outlet of the object.

unmap

If an element was previously mapped, clear the internal state of the live.map object, as well as any information about default value, range, etc.

Output

Outlets

The live.map object's outlets send, from right to left:

dumpout : outputs the response to the getdefault and getrange methods, as well as any attribute value queries
mapping : outputs the current mapping state ( 0 or 1 )
name : output the element name when mapped (when unmapped, the name <none> will be output)
id : output the element LOM ID when mapped (when unmapped, the ID 0 will be output)
path : output the element LOM path when mapped (when unmapped, the path <none> will be output)