jit.gl.meshwarp Reference

Video mapping tool

jit.gl.meshwarp

Examples

Arguments

drawto [message]

The named drawing context in which to draw (default = none). A named drawing context is a named instance of a jit.world, jit.pworld or jit.gl.node object. If no argument is provided the object will find a context implicitly.

Attributes

color []

The color of the mesh (default = 1. 1. 1. 1.)

curvature []

A quick way to set both the X and y NURBS order, which determines the curvature of the underlying canvas mesh (range 0. to 1.) Sets both dims of nurbs_order, based on the current mesh_dim. The attribute is float type, however output is clamped to int values and therefore may look choppy when adjusting.

enable []

Enable flag (default = 1) When the flag is set, drawing is enabled.

layer []

Object layer number (default = 0) When in automatic mode, the layer number determines the rendering order (low to high). Objects in the same layer have no guarantee which will be rendered first.

lock_to_aspect []

Locks the scale to match the proportions of the input texture (default = 0). When set to active, the scale attribute will only respond to the second attribute argument (y scale).

meshdim []

Dimension of the UI mesh. Sets the number of clickable vertices displayed (default = 4 4)

nurbs_order []

Set the X and Y order of the underlying NURBS canvas mesh. The order determines the curvature of the canvas mesh (default = 1 1).

position []

The 3D origin in the form x y z (default = 0. 0. 0.)

rotatez []

Sets the current rotation about the positive z axes (default = 0.). Angles are expressed in degrees.

scale []

The 3D scaling factor in the form x y z (default = 1. 1. 1.)

show_position_handle []

Show / Hide position handle circle flag (default = 1)

show_scale_handles []

Show / Hide scale handle circles flag (default = 1)

show_ui []

Show or hide the interactive user interface for the jit.gl.meshwarp (default = 1). When the flag is set, the object will be highlighted if not currently selected.

texture []

The name of the texture to be applied (default = none).

grid_color []

Set the color of the UI mesh grid (default = random);

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

jit_gl_texture

Binds the texture specified by texture-name to this object. Equivalent to setting the texture attribute to texture-name.

read

Read the complete current state of the jit.gl.meshwarp object from a JSON file (.json). If no filename is specified, a file dialog will open to let you choose a file.

redo

Redo latest undone UI changes. Can be also called by pressing "ctrl + y/cmd + shift + z" on the keyboard.

reset

Reset the jit.gl.meshwarp to the default state. It will reset the scale, position, rotation and color attributes.

save

Save the complete current state of the jit.gl.meshwarp object to a JSON file (.json). If no filename is specified, a file dialog will open to let you choose a file.

undo

Undo latest UI changes. Can be also called by pressing "ctrl/cmd + z" on the keyboard.

See Also

Name Description
jit.gl.mesh Generate GL geometry from matrices