jit.peek~ Reference

Read matrix data as an audio signal

jit.peek~

Description

jit.peek~ reads the value of one plane of a matrix cell at the position specified by the signal inputs. This value is output as a signal. The object arguments are [matrix_name] [dim_inputcount] [plane] .

Examples

Arguments

matrix_name []

The named matrix to access (default = none)

dim_inputcount []

The number of dimensions in the matrix (default = 2)

plane []

The plane in a cell whose value is output (default = 0)

Attributes

interp [int]

Interpolation flag (default = 0)

matrix_name [symbol]

The named matrix to access (default = none)

normalize [int]

Normalizated input coordinates flag (default = 0)

plane [int]

The plane in a cell whose value is output (default = 0)

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.

jspainterfile [symbol]

JS Painter File

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

signal

All inlets: Signal values arriving in these inlets specify the dimensional location of the data to be stored for the plane specified. A signal inlet is provided for each dimension specified by the dim_inputcount argument (i.e., jit.peek~ bigcube 3 has 3 inlets -- one for each of the 3 dimensions of the matrix).

See Also

Name Description
Working with Video in Jitter Working with Video in Jitter
jit.poke~ Write an audio signal into a matrix
peek~ Read and write sample values
poke~ Write sample values to a buffer by index
jit.buffer~ Access an MSP buffer~ in matrix form