jit.matrixset
Jitter Reference
Open Help

jit.matrixset

A set of matrices for storage/resequencing

Description

The jit.matrixset object keeps a set of internal matrices which may be written to or read from. This may be useful for data storage and/or matrix resequencing.

Examples

Arguments

None.

Attributes

dim [32 ints]

The dimensions of matrix data (default = 1 1)

dstdimend [32 ints]

The destination dimension end position (default = all dim values minus 1)

dstdimstart [32 ints]

The source dimension start position (default = all 0)

index [int]

The which of the matrices an incoming matrix will be written to (default = 0)

interp [int]

Interpolation flag (default = 0) When the flag is set, an input matrix is interpolated when copied to internal matrices.

matrixcount [int]

The number of matrices in the matrix set (default = 1)

planecount [int]

The number of planes in matrix data (default = 4)

planemap [32 ints]

Maps input planes to output planes (default = 0 1 2 3 ...)

thru [int]

Thru mode flag (default = 1) When the flag is set, a matrix is output when another one is received.

type [symbol]

The type of matrix data (default = char ) Supported data types are char , long , float32 , or float64 .

srcdimend [32 ints]

The source dimension end position (default = all dim values minus 1)

srcdimstart [32 ints]

The source dimension start position (default = all 0)

usedstdim [int]

Destdim use flag (default = 0) When the flag is set, the destination dimension's attributes are used when copying an input matrix to an internal matrix.

usesrcdim [int]

Srcdim use flag (default = 0) When the flag is set, the source dimension's attributes are used when copying an input matrix to an internal matrix.

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

bang

Sends a matrix out the left outlet.

clear

Sets all values to zero.

exportmovie

Arguments

filename [symbol]
FPS [float]
codec [symbol]
Exports a matrix as a QuickTime movie. The exportmovie message takes an optional argument to specify a file name. If no filename is specified, a file dialog will open to let you choose a file.

The default FPS is 30. frames per second

The default codec is h264 . For a list of supported codecs check the jit.record codec attribute.

importmovie

Arguments

filename [symbol]
time-offset [int]
index-ffset [int]
number-of-frames [int]
Imports a QuickTime movie into the matrix set. If no filename is specified, a file dialog will open to let you choose a file. The time-offset and index-offset arguments may be used to set a time and index offset for the QuickTime movie being imported (the default is 0 for both arguments). The number-of-frames argument specifies the number of frames to import (the default is set to the value specified by the matrixcount attribute). Note that the importmovie message will not resize the jit.matrixset.

read

Arguments

filename [symbol]
Reads Jitter binary data files (.jxf) into a matrix set. If no filename is specified, a file dialog will open to let you choose a file.

write

Arguments

filename [symbol]
Writes matrix set as a Jitter binary data file (.jxf). If no filename is specified, a file dialog will open to let you choose a file.

See Also

Name Description
jit.matrix The Jitter Matrix!
Tutorial 20: Importing and Exporting Single Matrices Tutorial 20: Importing and Exporting Single Matrices