jit.mgraphics
Description
The jit.mgraphics object supports drawing 2D vector graphics with the MGraphics API.
Examples
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
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.
. if these arguments are present, the 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 , , and 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]
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]
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]
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
.[in/out]_type [symbol]
The input or output matrix data type. Except in special cases, this value is equal to
.outputmode [int]
Output mode (default = 1 (calculate and output matrix))
0 = No output (no calculation)
1 = Calculate and output the matrix
2 = Pass input (no calculation)
3 = Pass output (no calculation)
type [int]
The matrix data type (default =
Supported data types are , , , or .
MOP Messages
bang
clear
exportattrs
Arguments
getattributes
getstate
importattrs
Arguments
jit_matrix
Arguments
outputmatrix
summary
Attributes
autofill [int]
Automatically fill paths when closed.
dim [2 ints]
Dimensions.
relative_coords [int]
Use relative coordinates (0.-1. rather than pixels).
textfieldvisible [int]
TEXT_HERE
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.
adds the object to the background layer, 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]
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]
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]
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
arc
Arguments
yc [float]
radius [float]
angle1 [float]
angle2 [float]
arc_negative
Arguments
yc [float]
radius [float]
angle1 [float]
angle2 [float]
attr_setfill
clear_surface
close_path
curve_to
Arguments
y1 [float]
x2 [float]
y2 [float]
x3 [float]
y3 [float]
device_to_user
Arguments
y [float]
ellipse
Arguments
y [float]
width [float]
height [float]
fill
fill_extents
fill_preserve
fill_preserve_with_alpha
Arguments
fill_with_alpha
Arguments
font_extents
get_current_point
get_line_cap
get_line_join
get_line_width
get_matrix
getfontlist
identity_matrix
image_surface_create
Arguments
source [symbol]
width [float]
height [float]
image_surface_destroy
Arguments
image_surface_draw
Arguments
image_surface_draw_fast
Arguments
image_surface_get_size
Arguments
in_fill
Arguments
y [float]
line_to
Arguments
y [float]
move_to
Arguments
y [float]
new_path
ovalarc
Arguments
yc [float]
radiusx [float]
radiusy [float]
angle1 [float]
angle2 [float]
paint
paint_with_alpha
parentpaint
path_roundcorners
Arguments
pattern_add_color_stop_rgba
Arguments
offset [float]
red [float]
green [float]
blue [float]
alpha [float]
pattern_create_for_surface
Arguments
source [symbol]
pattern_create_linear
Arguments
x0 [float]
y0 [float]
x1 [float]
y1 [float]
pattern_create_radial
Arguments
cx0 [float]
cy0 [float]
radius0 [float]
cx1 [float]
cy1 [float]
radius1 [float]
pattern_create_rgba
Arguments
red [float]
green [float]
blue [float]
alpha [float]
pattern_destroy
Arguments
pattern_get_extend
Arguments
pattern_get_matrix
Arguments
pattern_get_type
Arguments
pattern_identity_matrix
Arguments
pattern_rotate
Arguments
radians [float]
pattern_scale
Arguments
sx [float]
sy [float]
pattern_set_extend
Arguments
extend_mode [symbol]
pattern_set_matrix
Arguments
xx [float]
xy [float]
yx [float]
yy [float]
x0 [float]
y0 [float]
pattern_translate
Arguments
tx [float]
ty [float]
pop_group_to_source
push_group
rectangle
Arguments
y [float]
width [float]
height [float]
rectangle_rounded
Arguments
y [float]
width [float]
height [float]
ovalwidth [float]
ovalheight [float]
rel_curve_to
Arguments
y1 [float]
x2 [float]
y2 [float]
x3 [float]
y3 [float]
rel_line_to
Arguments
y [float]
rel_move_to
Arguments
y [float]
restore
rotate
Arguments
save
scale
Arguments
ty [float]
scale_source_rgba
Arguments
greenscale [float]
bluescale [float]
alphascale [float]
select_font_face
Arguments
slant [symbol]
weight [symbol]
set_dash
Arguments
gap-length [float]
set_font_size
Arguments
set_line_cap
Arguments
set_line_join
Arguments
set_line_width
Arguments
set_matrix
Arguments
xy [float]
yx [float]
yy [float]
x0 [float]
y0 [float]
set_source
Arguments
set_source_rgb
Arguments
green [float]
blue [float]
set_source_rgba
Arguments
green [float]
blue [float]
alpha [float]
set_source_surface
Arguments
show_text
Arguments
stroke
stroke_preserve
stroke_preserve_with_alpha
Arguments
stroke_with_alpha
Arguments
svg_create
Arguments
source [symbol]
svg_destroy
Arguments
svg_get_size
Arguments
svg_render
Arguments
svg_set
Arguments
text_measure
Arguments
text_path
Arguments
transform
Arguments
xy [float]
yx [float]
yy [float]
x0 [float]
y0 [float]
translate
Arguments
ty [float]
translate_source_rgba
Arguments
greenoffset [float]
blueoffset [float]
alphaoffset [float]
user_to_device
Arguments
y [float]
See Also
Name | Description |
---|---|
jit.lcd | QuickDraw wrapper (deprecated) |
jit.gl.sketch | Use drawing commands with OpenGL |
jsui | Javascript user interfaces and graphics |
MGraphics Quick Start Guide | MGraphics Quick Start Guide |