mira.frame Reference

Mirror your Max patcher on your iPad

mira.frame

Description

Mira.frame defines a rectangle in the Max patcher that will be mirrored on connected iPad devices. Any Mira-supported objects that fall within the rectangle will be visible on the iPad. Multiple mira.frame objects will be rendered on the iPad as separate tabs. When a mira.frame object exists in a patcher, all Mira-supported objects in the patcher are automatically assigned a scripting name.

Arguments

None.

Attributes

aspect [atom_long] (default: 0)

Device Aspect Ratio Possible values:

0 = 'Mira App'
1 = '4:3'
2 = '3:2'
3 = '16:10'
4 = '17:10'
5 = '16:9'
6 = 'Free'

draw_tab_name [atom_long] (default: 1)

When enabled, mira.frame draws its tab name at the top of the frame rectangle.

miraweb_aspect [atom_long] (default: 1)

Adjust Aspect Ratio for Miraweb

orientation [atom_long] (default: 1)

In portrait mode, mira.frame is taller than it is wide. In landscape mode, mira.frame is wider than it is tall. Possible values:

0 = 'Portrait'
Portrait orientation

1 = 'Landscape'
Landscape orientation

tabname [symbol] (default: )

The name of the tab

taborder [atom] (default: <none>)

The index of the tab. Tabs with a lower index will appear to the left of tabs with a higher index.

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

focus

Cause all connected iPads to bring this mira.frame to the front. If mira.frame has no inlet, you can still send it a message using a thispatcher object.

See Also

Name Description
mira.motion Receive data from iPad accelerometer, gyroscope and magnetometer.
mira.multitouch Receive touch and gesture data from touchscreen.
mira.status