A newer version of Max is available. Click here to access the latest version of the documentation

jit.mgraphics

2D Vector Graphics

Description

The jit.mgraphics object supports drawing 2D vector graphics with the MGraphics API.

Examples

2D Vector Graphics

Discussion

This is the Max wrapper for the JGraphics API. Documentation on JGraphics is available online http://www.cycling74.com/sdk/MaxSDK-5.1.1/html/group__jgraphics.html . They are both loosely based on the API of http://cairographics.org . When looking at the JGraphics documentation, the functions don't pass in t_jgraphics *. Otherwise arguments are similar.

Matrix Operator

matrix inputs:0, matrix outputs:1
Name IOProc Planelink Typelink Dimlink Plane Dim Type
out n/a 1 1 1 4 1 char

More about Matrix Operators

The Jitter MOP

Since the matrix is Jitter's focus, it is not surprising that the majority of Jitter objects fall in this category of Matrix Operators. Every Matrix operator has some number of matrix inputs and some number of matrix outputs. Matrix inputs are referred to by the names "in", "in2", "in3", etc., from left to right, and matrix outputs are referred to by the names "out", "out2", "out3", etc., from left to right--i.e. the names are appended by the input/output number except for the first (leftmost) input and first (leftmost) output which are simply named "in" and "out". We will refer to the input or output name names as the "I/O-name".

Matrix inputs and outputs typically each have their own matrices internally where information is kept. This is necessary because Jitter is an asynchronous framework (i.e. all the matrices don't arrive at all inputs at the same time). Various aspects of matrix inputs and outputs can be set using the command [I/O-name] combined with one of the following suffixes: "_dim" which will set the dimensions of the specified I/O matrix, "_type" which will set the type of the specified matrix, "_planecount" which will set the plane of the specified matrix, or "_name" which will set the name of the specified matrix. There is one special case which does not have an internal matrix and this is the first input "in". This is the case since this special input actually triggers the calculation of the matrix operator, so it doesn't need to be cached until a calulation takes place, unlike the other inputs. Therefore there is no mechanism to set the dim, planecount, type, or name of "in".

Matrix operators accept what we'll refer to as "matrix args"--i.e. [planecount (int)] [ type (symbol)] [dim (int list)]. if these arguments are present, the adapt attribute will be turned off, otherwise it will be turned on. If adapt mode is turned on, each time a matrix is received in the first input, there will also be the equivalent of setting the dim, planecount, and type attributes to that of the input matrix. If the other inputs and outputs are linked to these attributes, this will affect their linked attributes as well. See the "MOP" table to determine which inputs and outputs will be linked to which attributes when adapt mode is turned on. For the leftmost input this is not applicable, and hence all columns are labelled "n/a".

The jit.matrix object is a named matrix which may be used to matrix data storage and retrieval, resampling, and matrix type and planecount conversion operations.

MOP Arguments

planecount [int]

Optional

Explicitly sets the number of planes for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.

type [symbol]

Optional

Explicitly sets the type of the matrix for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.

dimensions [list]

Optional

Explicitly sets the dimensions of the matrix for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.

MOP Attributes

adapt [int]

Matrix adaptation flag (default = 0 if matrix arguments are present, otherwise 1) When the flag is set, the jit.matrix object will adapt to the incoming matrix planecount, type, and dimensions.

[in/out]_dim [32 ints]

The matrix data dimensions (default = 1 1)

[in/out]_name [symbol]

The input or output name of the matrix (default = UID)

[in/out]_planecount [int]

The number of planes in matrix input our output data. Except in special cases, this value is equal to the planecount.

[in/out]_type [symbol]

The input or output matrix data type. Except in special cases, this value is equal to type.

outputmode [int]

Output mode (default = 1 (calculate and output matrix))
0 = No output
1 = Calculate and output the matrix
2 = Pass input (no calculation)
3 = Pass output (no calculation)

type [int]

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

MOP Messages

bang

Equivalent to the outputmatrix message.

clear

Sets all cell values in a matrix to zero.

exportattrs

Arguments

filename [symbol]
Exports an object's current attributes values in XML format. If no filename is specified, a file dialog will open to let you choose a file.

getattributes

Sends a sequence of lists out the object's right outlet describing the object's attributes, one line per attribute. Each line listing line takes the form attribute attribute-name get get-value set foo set-value data-type(s) number-of-values .

getstate

Sends a sequence of lists describing the object's state out the object's right outlet, one line per attribute. Each line listing line takes the form attribute-name attribute-value1 attribute-value2 ... attribute-valueN .

importattrs

Arguments

filename [symbol]
Imports attributes specified in XML format to set the object's attributes. If no filename is specified, a file dialog will open to let you choose a file.

jit_matrix

Arguments

matrix-name [symbol]
Handles input for the named matrix. If this messages is received in the left inlet, output is typically triggered. If this message is received in any other inlet, the data is typically cached until the jit_matrix message is received in the left inlet.

outputmatrix

Sends the matrix out the left outlet.

summary

Sends a sequence of lists describing the object and it attributes and messages out the rightmost outlet of the object. The first output line takes the form summary objectname object-name . The second and third lines describe the number of inlets and outlets for the object in the form summary (matrixinputcount/matrixoutletcount) number-of-(inlets/outlets) . The fourth line describes the matrixoutput in the form summary matrixoutput descriptor planelink planelink-value typelink typelink-value dimlink dimlink-value types data-type(s) . Each attribute for the object is then listed, one attribute per line. Each line listing takes the form summary attribute attribute-name attribute-value1 attribute-value2 ... attribute-valueN .

Attributes

autofill [int]

Automatically fill paths when closed.

dim [2 ints]

Dimensions.

relative_coords [int]

Use relative coordinates (0.-1. rather than pixels).

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 [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

append_path

Arguments

path [symbol]
Add a path to a graphics context.

arc

Arguments

xc [float]
yc [float]
radius [float]
angle1 [float]
angle2 [float]
Add a circular, clockwise, arc to the current path.

arc_negative

Arguments

xc [float]
yc [float]
radius [float]
angle1 [float]
angle2 [float]
Add a circular, counter-clockwise, arc to the current path.

attr_setfill

Fill a pattern with a named style color

clear_surface

Clear the drawing surface and reset to it's initial state.

close_path

Close the current path in a context.

curve_to

Arguments

x1 [float]
y1 [float]
x2 [float]
y2 [float]
x3 [float]
y3 [float]
Add a cubic Bezier spline to the current path.

device_to_user

Arguments

x [float]
y [float]
Converts device coordinates to user coordinates. User coordinates are those passed to drawing functions. Device coordinates are those of the display device. The result is sent out the dumpout outlet with a device_to_user prefix.

ellipse

Arguments

x [float]
y [float]
width [float]
height [float]
Add a closed elliptical path in the context.

fill

Fill the current path, discarding the path once filled.

fill_extents

Return the current path's extents if filled. The result is 4 floating point numbers of the form x1, y1, x2, y2, and is sent out the dumpout outlet with a fill_extents prefix.

fill_preserve

Fill the current path, preserving the path for further path operations.

fill_preserve_with_alpha

Arguments

alpha [float]
Fill the current path, applying a global alpha, and preserving the path for further path operations.

fill_with_alpha

Arguments

alpha [float]
Fill the current path, applying a global alpha, and discarding the path once filled.

font_extents

Return the extents of the currently selected font. The result is 3 floating point numbers of the form ascent, descent, height, and is sent out the dumpout outlet with a font_extents prefix.

get_current_point

Get the current location of the cursor in a graphics context. The result is sent out the dumpout outlet with a get_current_point prefix.

get_line_cap

Return the current line cap style. The result is a symbol, and is sent out the dumpout outlet with a get_line_cap prefix.

get_line_join

Return the current line join style. The result is a symbol, and is sent out the dumpout outlet with a get_line_join prefix.

get_line_width

Return the current line width. The result is a floating point number, and is sent out the dumpout outlet with a get_line_width prefix.

get_matrix

Return the transform matrix. The result is 6 floating point numbers of the form xx, yx, xy, yy, x0, y0, and is sent out the dumpout outlet with a get_matrix prefix.

getfontlist

Return the current font list. The result is a list of symbols, and is sent out the dumpout outlet with a getfontlist prefix.

identity_matrix

Set the current transform to be the identity matrix.

image_surface_create

Arguments

name [symbol]
source [symbol]
width [float]
height [float]
Create a named image surface, filling with the contents of specified source. Source can be a file name or a matrix name.

image_surface_destroy

Arguments

name [symbol]
Destroy a named image surface.

image_surface_draw

Arguments

source [symbol]
Draw an image surface. Supports zoom, but not rotations. Source can be a surface name, file name or a matrix name.

image_surface_draw_fast

Arguments

source [symbol]
Draw an image surface quickly. Does not support zoom or rotations. Source can be a surface name, file name or a matrix name.

image_surface_get_size

Arguments

name [symbol]
Return the size of an image surface. The result is sent out the dumpout outlet with a image_surface_get_size prefix.

in_fill

Arguments

x [float]
y [float]
Check if a point is in the current path's fill region. The result is sent out the dumpout outlet with a in_fill prefix.

line_to

Arguments

x [float]
y [float]
Add a line segment to the current path.

move_to

Arguments

x [float]
y [float]
Move the cursor to a new point and begin a new subpath.

new_path

Begin a new path.

ovalarc

Arguments

xc [float]
yc [float]
radiusx [float]
radiusy [float]
angle1 [float]
angle2 [float]
Add a non-circular arc to the current path.

paint

Paint current source in entire current clip region.

paint_with_alpha

Paint current source with alpha in entire current clip region.

parentpaint

This is primarily used for jspainter functionality to tell the parent object to call it's native paint method.

path_roundcorners

Arguments

corner_radius [float]
Round out any corners in a path.

pattern_add_color_stop_rgba

Arguments

pattern_name [symbol]
offset [float]
red [float]
green [float]
blue [float]
alpha [float]
Add a color stop to a gradient pattern.

pattern_create_for_surface

Arguments

pattern_name [symbol]
source [symbol]
Create a named image pattern, filling with the contents of specified source. Source can be an image surface name, a file name, or a matrix name.

pattern_create_linear

Arguments

pattern_name [symbol]
x0 [float]
y0 [float]
x1 [float]
y1 [float]
Create a named linear gradient pattern.

pattern_create_radial

Arguments

pattern_name [symbol]
cx0 [float]
cy0 [float]
radius0 [float]
cx1 [float]
cy1 [float]
radius1 [float]
Create a named radial gradient pattern.

pattern_create_rgba

Arguments

pattern_name [symbol]
red [float]
green [float]
blue [float]
alpha [float]
Create a named solid color pattern.

pattern_destroy

Arguments

pattern_name [symbol]
Destroy a named pattern.

pattern_get_extend

Arguments

pattern_name [symbol]
Get the pattern's extend mode. The result is sent out the dumpout outlet with a pattern_get_extend prefix.

pattern_get_matrix

Arguments

pattern_name [symbol]
Get the pattern's transform matrix. The result is sent out the dumpout outlet with a pattern_get_matrix prefix.

pattern_get_type

Arguments

pattern_name [symbol]
Get the pattern's type. The result is sent out the dumpout outlet with a pattern_get_type prefix.

pattern_identity_matrix

Arguments

pattern_name [symbol]
Set the pattern's transform matrix to the identity matrix.

pattern_rotate

Arguments

pattern_name [symbol]
radians [float]
Rotate the pattern's transform matrix.

pattern_scale

Arguments

pattern_name [symbol]
sx [float]
sy [float]
Scale the pattern's transform matrix.

pattern_set_extend

Arguments

pattern_name [symbol]
extend_mode [symbol]
Set a pattern's extend mode. Values can be: none, repeat, reflect, or pad. However, many of these are not implemented for various pattern types.

pattern_set_matrix

Arguments

pattern_name [symbol]
xx [float]
xy [float]
yx [float]
yy [float]
x0 [float]
y0 [float]
Set the pattern's transform matrix.

pattern_translate

Arguments

pattern_name [symbol]
tx [float]
ty [float]
Translate the pattern's transform matrix.

pop_group_to_source

Pops the current group to the current source pattern.

push_group

Temporarily redirects drawing to an intermediate surface known as a group. Use pop_group, pop_group_to_source, or pop_group_to_surface to use it.

rectangle

Arguments

x [float]
y [float]
width [float]
height [float]
Add a closed rectangle path in the context.

rectangle_rounded

Arguments

x [float]
y [float]
width [float]
height [float]
ovalwidth [float]
ovalheight [float]
Add a closed rounded-rectangle path in the context.

rel_curve_to

Arguments

x1 [float]
y1 [float]
x2 [float]
y2 [float]
x3 [float]
y3 [float]
Add a cubic Bezier spline to the current path, using coordinates relative to the current point.

rel_line_to

Arguments

x [float]
y [float]
Add a line segment to the current path, using coordinates relative to the current point.

rel_move_to

Arguments

x [float]
y [float]
Move the cursor to a new point and begin a new subpath, using coordinates relative to the current point.

restore

Restores the saved graphics settings ("pops" the graphics state stack).

rotate

Arguments

radians [float]
Rotate the transform matrix.

save

Saves the current graphics settings to be restored later ("pushes" the graphics state stack).

scale

Arguments

tx [float]
ty [float]
Scale the transform matrix.

scale_source_rgba

Arguments

redscale [float]
greenscale [float]
bluescale [float]
alphascale [float]
Set the source color transform's scale factor.

select_font_face

Arguments

fontfamily [symbol]
slant [symbol]
weight [symbol]
Specify a font for a graphics context. The slant may be normal or italic, and The weight may be normal or bold.

set_dash

Arguments

dash-length [float]
gap-length [float]
Sets the line drawing style to a dash. The first argument sets the dash length, and the second sets the gap length.

set_font_size

Arguments

size [float]
Specify the font size.

set_line_cap

Arguments

style [symbol]
Set the current line cap style. Values can be: butt, round, or square.

set_line_join

Arguments

style [symbol]
Set the current line join style. Values can be: miter, round, or bevel.

set_line_width

Arguments

width [float]
Set the current line width.

set_matrix

Arguments

xx [float]
xy [float]
yx [float]
yy [float]
x0 [float]
y0 [float]
Set the transform matrix.

set_source

Arguments

source [symbol]
Set the current source to the named pattern or image surface.

set_source_rgb

Arguments

red [float]
green [float]
blue [float]
Set the current source color.

set_source_rgba

Arguments

red [float]
green [float]
blue [float]
alpha [float]
Set the current source color.

set_source_surface

Arguments

source [symbol]
Set the current source to the named image surface or file name.

show_text

Arguments

text [symbol]
Display text at the current position.

stroke

Stroke the current path, discarding the path once filled.

stroke_preserve

Stroke the current path, preserving the path for further path operations.

stroke_preserve_with_alpha

Arguments

alpha [float]
Stroke the current path, applying a global alpha, and preserving the path for further path operations.

stroke_with_alpha

Arguments

alpha [float]
Stroke the current path, applying a global alpha, and discarding the path once filled.

svg_create

Arguments

svg_name [symbol]
source [symbol]
Create a named svg object, filling with the contents of specified source. Source can be a file name, or an XML svg string.

svg_destroy

Arguments

svg_name [symbol]
Destroy a named svg object.

svg_get_size

Arguments

svg_name [symbol]
Get a named svg object's size. The result is sent out the dumpout outlet with a svg_get_size prefix.

svg_render

Arguments

svg_name [symbol]
Render a named svg object.

svg_set

Arguments

svg_name [symbol]
Reuse an existing SVG object that was created with svg_create.

text_measure

Arguments

text [symbol]
Return the width and height of a string given current graphics settings in a context. The result is sent out the dumpout outlet with a text_measure prefix.

text_path

Arguments

text [symbol]
Add a path of text to the current path.

transform

Arguments

xx [float]
xy [float]
yx [float]
yy [float]
x0 [float]
y0 [float]
Multiply the transform matrix by another matrix.

translate

Arguments

tx [float]
ty [float]
Translate the transform matrix.

translate_source_rgba

Arguments

redoffset [float]
greenoffset [float]
blueoffset [float]
alphaoffset [float]
Set the source color transform's offset values.

user_to_device

Arguments

x [float]
y [float]
Converts user coordinates to device coordinates. User coordinates are those passed to drawing functions. Device coordinates are those of the display device. The result is sent out the dumpout outlet with a user_to_device prefix.

See Also

Name Description
jit.lcd QuickDraw wrapper
jit.gl.sketch Use drawing commands with OpenGL
jsui Javascript user interfaces and graphics
MGraphics Quick Start Guide MGraphics Quick Start Guide