jit.gl.sketch
Use drawing commands with OpenGL
Description
Records and draws based on 3-D drawing commands. These commands range from simple turtle graphics to the majority of the OpenGL API.
Discussion
The jit.gl.sketch object requires one argument: the name of a drawing context. A named drawing context is a named instance of a jit.window, jit.pwindow, or jit.matrix object that has an instance of the jit.gl.render object associated with it. Additionally it can reference the name of a jit.gl.node sub-context. This value may also be set via the OB3D drawto attribute. If no argument is present, the object is implicitly added to the first valid drawing context or sub-context found in the current patch or by searching up the patcher hierarchy.
Attributes
OB3D Attributes
anim[symbol]
The name of a jit.anim.node object that handles all spatial transforms for this instance (default = UID). The default value references an internal object, but can be overridden by setting to the name of an existing external jit.anim.node instance. This allows for more advanced control of the spatial transform.
anchor[3 floats]
The anchor position in local space (default = 0. 0. 0.). Allows for offsetting the local 3D origin around which transforms are applied.
animmode[symbol]
Determines which space the
local = Rotate relative to local axis
parent = Rotate relative to parent axis
world = Rotate relative to world axis
antialias[int]
Antialiasing flag (default = 0) On some hardware, the blend_enable attribute must also be enabled for antialiasing to work.
automatic[int]
Automatic rendering flag (default = 1) When the flag is set, rendering occurs when the associated jit.gl.render object receives a bang message
auto_material[int]
Automatic material attributes flag (default = 1) When the flag is set, and lighting is enabled for the object, the diffuse and ambient material components for the object will be set to the object's color, and the specular and emissive lighting components are disabled.
aux_color[4 floats]
The auxiliary color in the form red green blue alpha (default = 0. 0. 0. 0.) The list elements should be in the range 0.-1.
axes[int]
x/y/z axis rendering off/on (default = 0)
blend[symbol]
The named blending mode. The possible values are:
add = 1 1
multiply = 2 1
screen = 4 1
exclusion = 4 5
colorblend = 3 4
alphablend = 6 7
coloradd = 3 1
alphaadd = 6 1
blend_enable[int]
Blending flag (default = 0) When the flag is set, blending is enabled for all rendered objects.
blend_mode[2 ints]
The source and destination planes associated with the blend mode (default = 6 7) Blend modes are specified in the form src_blend_mode dst_blend_mode. The supported modes are:
0 = zero
1 = one
2 = destination color
3 = source color
4 = one minus destination color
5 = one minus source color
6 = source alpha
7 = one minus source alpha
8 = destination alpha
9 = one minus destination alpha
10 = source alpha saturate
capture[symbol]
The name of a texture to be rendered to - e.g.
will capture to .
cull_face[int]
Face culling mode (default = 0 (no culling))
0 = no culling
1 = cull back faces
2 = cull front faces
depth_clear[int]
Depth buffer clear flag (default = 0) When the flag is set, the depth buffer is cleared before rendering the object.
depth_enable[int]
Depth buffering flag (default = 1) When the flag is set, depth buffering is enabled.
depth_write[int]
Depth write flag (default = 1). When the flag is set, writing to the depth buffer is enabled. This will have no effect if depth_enable is turned off.
drawto[symbol]
The named drawing context in which to draw (default = none) A named drawing context is a named instance of a jit.window, jit.pwindow, or jit.matrix object that has an instance of the jit.gl.render object associated with it.
enable[int]
Enable flag (default = 1) When the flag is set, drawing is enabled.
filterclass[symbol]
The name of this object's pick filter class (default = default). This controls the visibility of objects to the jit.gl.handle and jit.gl.picker objects. In order to select this object, the filterclass value must be in the picking object's filters list.
fog_params[7 floats]
The fog parameters in the form red green blue alpha density start end (default = 0. 0. 0. 0. 0. 0. 0.) The list's color elements should be in the range 0.-1.
fog[float]
The amount of fog effect (default = 0.)
layer[int]
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.
lighting_enable[int]
Lighting enabled flag (default = 0) When the flag is set, lighting is calculated.
line_width[float]
The drawing line width (default = 1.)
mat_ambient[4 floats]
The ambient light material property in the form red green blue alpha (default = 0. 0. 0. 0.) The list elements should be in the range 0.-1.
mat_diffuse[4 floats]
The diffuse light material property in the form red green blue alpha (default = 0. 0. 0. 0.) The list elements should be in the range 0.-1.
mat_emission[4 floats]
The material emission property in the form red green blue alpha (default = 0. 0. 0. 0.) The list elements should be in the range 0.-1.
mat_specular[4 floats]
The specular light material property in the form red green blue alpha (default = 0. 0. 0. 0.) The list elements should be in the range 0.-1.
matfile[symbol]
The Jitter material file to apply (.jitmtl)
name[symbol]
The instance name (default = UID)
point_mode[symbol]
Point drawing mode to use when points drawing primitive (poly_mode 2) is enabled (default = circle).
Possible values:
'square'
(
Draw point as square
)
'circle'
(
Draw point as circle
)
'square_depth'
(
Draw point as square with depth scaling
)
'circle_depth'
(
Draw point as circle with depth scaling
)
'user_shader'
(
Allow writing to gl_PointSize in custom vertex shader
)
point_size[float]
The draw point size (default = 1.)
poly_mode[2 ints]
Polygon rendering modes (default 0 0) Rendering modes are expressed in the form frontface backface. Supported rendering modes are:
0 = render as filled polygons
1 = render as lines
2 = render as points
position[3 floats]
The 3D origin in the form x y z (default = 0. 0. 0.)
quat[4 floats]
The current rotation as a quaternion(default = 0. 0. 0. 1.). A quaternion is a mathematical construct that is a four dimensional vector, and can be visualized as a rotation around an arbitrary axis. Quaternions are a useful representation of an orientation in 3D space.
rotate[4 floats]
The angle of rotation and the xyz vector about which the rotation is performed in the form rotation-angle x y z (default = 0. 0. 0. 1.)
rotatexyz[3 floats]
Sets the current rotation to the concatenation of rotations about the positive x, y, and z axes, also known as Euler angles (default = 0. 0. 0.). The default order is yzx and can be changed with the jit.gl.render rotate_order attribute. Angles are expressed in degrees.
scale[3 floats]
The 3D scaling factor in the form x y z (default = 1. 1. 1.)
shadow_caster[int]
Shadow caster flag (default = 0) When the flag is set, object will cast shadows.
shininess[float]
The material shininess value (default = 16.0) The value should be a float in the range 0.-255.
smooth_shading[int]
Smooth shading flag (default = 0) When the flag is set, smooth shading is used when rendering.
tex_map[int]
Mode for automatic generation of texture coordinate controls (default = 0)
0 = no coordinates are generated.
1 = OpenGL's texture generation is used with mode GL_OBJECT_LINEAR. This applies the texture in a fixed orientation relative to the object.
2 = OpenGL's texture generation is used with mode GL_SPHERE_MAP. This can be used to create a reflection effect.
3 = OpenGL's texture generation is used with mode GL_EYE_LINEAR. This applies the texture in a fixed orientation relative to OpenGL's eye coordinates.
Modes 1 and 3 are affected by the value of the tex_plane_s and tex_plane_t attributes listed below.
tex_plane_s[4 floats]
The texture generation coefficients a b c d that apply to tex_map modes 1 and 3. (default = 1. 0. 0. 0.)
The four coefficients define a plane used to generate the s texture coordinate, which corresponds to the x axis of the texture image. If the tex_map mode is 1, s = ax + by + cz + dw, where x, y, z, and w are the homogeneous coordinates of the vertex.
tex_plane_t[4 floats]
The texture generation coefficients a b c d, which apply to tex_map modes 1 and 3. (default = 0. 1. 0. 0)
The four coefficients define a plane which is used to generate the t texture coordinate, which corresponds to the y axis of the texture image.
shader[symbol]
The name of the shader to be applied (default = none)
texture[8 symbols]
The name of the texture to be applied (default = none). If multiple textures are specified, uses multi-texturing.
transform_reset[int]
Modelview and projection transform reset flag (default = 0) When the flag is set, the modelview and projection transforms are set to the identity transform before rendering the object. This is useful for sprite or billboard overlays, or automatic scaling to window size. The transform_reset flag modes are:
0 = do nothing (default)
1 = proportional orthographic glOrtho(-aspect, aspect, -1.0, 1.0, near_clip, far_clip);
2 = orthographic normalized glOrtho(-1.0, 1.0, -1.0, 1.0, near_clip, far_clip);
3 = proportional perspective with near clip = 0.001 gluPerspective(lens_angle, aspect, 0.001/*near_clip*/, far_clip);
4 = normalized perspective with near clip = 0.001 gluPerspective(lens_angle, 1.0, 0.001/*near_clip*/, far_clip);
viewalign[int]
View aligned transformation flag (default = 0)
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]: 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'
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]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
JS Painter File
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
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]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 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]
write-only
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]
write-only
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
beginstroke
Begin definition of a stroked path of the style specified by a following stroke_style argument. Currently supported stroke styles are "
basic2d
line
circle
Draws a circle with radius specified by radius and center point at the current drawing position. If theta-start and theta-end are specified, then an arc will be drawn instead of a full circle. The theta-start and theta-end arguments are in terms of degrees (0-360). The current
and values will also affect the drawing.- radius
[float]
- theta-start
[float]
- theta-end
[float]
cmd_delete
Deletes index or all instances of the command specified by the command argument from the command list.
cmd_enable
Enables/disables command in the command list.
- mutex
group
index [int]
command [symbol]
endmutex group - 0/1
[int]
cmd_insert
Inserts command at position index in the command list.
- index
[int]
- command
[symbol]
- command-args
[variable]
cmd_replace
Replaces position index in the command list with command .
- index
[int]
- command
[symbol]
- command-args
[variable]
cube
Draws a box with width 2* scale-x , height 2* scale-y , depth 2* scale-z , and center point at the current drawing position. If scale-y and scale-z are not specified, they will assume the same value as scale-x . The current shapeorient , shapeslice , and shapeprim values will also affect the drawing.
- scale-x
[float]
- scale-y
[float]
- scale-z
[float]
cylinder
Draws a cylinder with top radius specified by radius1 , bottom radius specified by radius2 , length specified by mag , and center point at the current drawing position. If theta-start and theta-end are specified, then a patch will be drawn instead of a full cylinder. The theta-start and theta-end arguments are in terms of degrees (0-360). The current
, , and values will also affect the drawing.- radius1
[float]
- radius2
[float]
- mag
[float]
- theta-start
[float]
- theta-end
[float]
drawmatrix
Draws a matrix. The format of the message is
<matrixname> <drawing primitive> <texflag> <normalflag> <colorflag>
texflag values are specified as follows: 0=use, 1=ignore, 2=auto
normalflag values are specified as follows: 0=use, 1=ignore, 2=auto
colorflag values are specified as follows: 0=use, 1=ignore
edgeflag values are specified as follows: 0=use, 1=ignore
drawobject
The word
, followed by a symbol that specifies an object name and a 0/1 flag that specifies whether or not to ignore the OB3D attributes, draws a named jit.gl object.
ellipse
Draws the ellipse specified by radius1 , radius2 and center point at the current drawing position. If theta-start and theta-end are specified, then an arc will be drawn instead of a full ellipse. The theta-start and theta-end arguments are in terms of degrees (0-360). The current
and values will also affect the drawing.- radius1
[float]
- radius2
[float]
- theta-start
[float]
- theta-end
[float]
endstroke
Ends the definition of a stroked path and renders the path.
framecircle
Draws the circumference of the circle with radius specified by radius and center point at the current drawing position. If theta-start and theta-end are specified, then an arc will be drawn instead of a full circle. The theta-start and theta-end arguments are in terms of degrees (0-360). The current
and values will also affect the drawing.- radius
[float]
- theta-start
[float]
- theta-end
[float]
frameellipse
Draws the circumference of the ellipse specified by radius1 , radius2 and center point at the current drawing position. If theta-start and theta-end are specified, then an arc will be drawn instead of a full ellipse. The theta-start and theta-end arguments are in terms of degrees (0-360). The current
and values will also affect the drawing.- radius1
[float]
- radius2
[float]
- theta-start
[float]
- theta-end
[float]
framequad
Draws the frame of the quadrilateral specified by the four points x1 y1 z1 x2 y2 z2 x3 y3 z3 x4 y4 z4 .
- x1
[float]
- y1
[float]
- z1
[float]
- x2
[float]
- y2
[float]
- z2
[float]
- x3
[float]
- y3
[float]
- z3
[float]
- x4
[float]
- y4
[float]
- z4
[float]
frametri
Draws the frame of the triangle specified by the three points x1 y1 z1 x2 y2 z2 x3 y3 z3 .
- x1
[float]
- y1
[float]
- z1
[float]
- x2
[float]
- y2
[float]
- z2
[float]
- x3
[float]
- y3
[float]
- z3
[float]
getcamera
Returns the x, y, and z coordinates of the camera location.
getcmd_index
Sends the command list item at index as a message out the object's right outlet.
- index
[int]
getcmdlist
Sends the command list as a series of messages out the object's right outlet. The command list is bracketed by max messages that indicate the beginning and the of the current command list, and the command list is output between these two lines, one line per command. The output takes the form:
index
index command-name command-arg1 ... command-argN
index ....
glbegin
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- draw-prim
[symbol]
glcolor
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- near
[float]
- far
[float]
glcullface
Please see the OpenGL "Red Book" or "Blue Book" for more information.
gldisable
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- capability
[symbol]
glenable
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- capability
[symbol]
glend
Please see the OpenGL "Red Book" or "Blue Book" for more information.
glget
Please see the OpenGL "Red Book" or "Blue Book" for more information.
gllinestipple
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- factor
[int]
- bit-pattern
[int]
gllinewidth
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- width
[float]
glnormal
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- x
[float]
- y
[float]
- z
[float]
glpointsize
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- size
[float]
glpolygonmode
Please see the OpenGL "Red Book" or "Blue Book" for more information.
glpolygonoffset
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- factor
[float]
- units
[float]
glpopmatrix
Please see the OpenGL "Red Book" or "Blue Book" for more information.
glpushmatrix
Please see the OpenGL "Red Book" or "Blue Book" for more information.
glrect
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- x1
[float]
- y1
[float]
- x2
[float]
- y2
[float]
glrotate
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- angle
[float]
- x
[float]
- y
[float]
- z
[float]
glscale
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- x-scale
[float]
- y-scale
[float]
- z-scale
[float]
glshademodel
Please see the OpenGL "Red Book" or "Blue Book" for more info.
gltexcoord
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- s
[float]
- t
[float]
gltranslate
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- delta-x
[float]
- delta-y
[float]
- delta-z
[float]
glvertex
Please see the OpenGL "Red Book" or "Blue Book" for more information.
- x
[float]
- y
[float]
- z
[float]
line
Draws a line from the current drawing position to the location delta-x delta-y delta-z relative to the current drawing position.
- delta-x
[float]
- delta-y
[float]
- delta-z
[float]
linesegment
Draws a line from the location specified by x1 y1 z1 to the location specified by x2 y2 z2 .
- x1
[float]
- y1
[float]
- z1
[float]
- x2
[float]
- y2
[float]
- z2
[float]
lineto
Draws a line from the current drawing position to the location specified by x y z .
- x
[float]
- y
[float]
- z
[float]
move
Moves the drawing position delta-x delta-y delta-z relative to the current drawing position.
- delta-x
[float]
- delta-y
[float]
- delta-z
[float]
moveto
Moves the drawing position to the location specified by x y z .
- x
[float]
- y
[float]
- z
[float]
plane
Draws a plane with top width 2* scale-x1 , left height 2* scale-y1 , bottom width 2* scale-x2 , right height 2* scale-y2 , and center point at the current drawing position. If scale-y1 is not specified, it will assume the same value as scale-x1 . If scale-x2 and scale-y2 are not specified, they will assume the same values as scale-x1 and scale-y1 respectively. The current
, , and values will also affect the drawing.- scale-x1
[float]
- scale-y1
[float]
- scale-x2
[float]
- scale-y2
[float]
point
Draws a point at the location specified by x y z .
- x
[float]
- y
[float]
- z
[float]
quad
Draws the quadrilateral specified by the four points x1 y1 z1 x2 y2 z2 x3 y3 z3 x4 y4 z4 .
- x1
[float]
- y1
[float]
- z1
[float]
- x2
[float]
- y2
[float]
- z2
[float]
- x3
[float]
- y3
[float]
- z3
[float]
- x4
[float]
- y4
[float]
- z4
[float]
reset
Delete all elements of the command list.
roundedplane
The message
round_amount scale_x scale_y draws a rounded plane with width 2 * scale_x , and height 2 * scale_y and center point at the current drawing position. The size of the rounded portion of the plane is determined by the round_amount argument. If scale_y is not specified, it will assume the same value as scale_x .
screentoworld
The word
, followed by a pair of numbers that specify x and y coordinates, returns an array containing the x , y , and z world coordinates associated with a given screen pixel using the same the depth from the camera as 0,0,0. Optionally a third depth arg may be specified, which may be useful for hit detection and other applications. The depth value is typically specified in the range 0.-1. where 0 is the near clipping plane, and 1. is the far clipping plane.
shapeorient
Sets the current orientation for shape drawing commands (
, , , , , , , , and ). The rot-x , rot-y , and rot-z arguments are in terms of degrees (0-360). The order in which the orientation is applied is first rotate about x axis rot-x , then rotate about y axis rot-y , and finally rotate about z axis rot-z .- rot-x
[float]
- rot-y
[float]
- rot-z
[float]
shapeprim
Sets the current drawing primitive for shape drawing commands (
- draw-prim
[symbol]
shapeslice
Sets the current level of decimation (resolution) for shape drawing commands (
, , , , , , , , and ).- slice-a
[int]
- slice-b
[int]
sphere
Draws a sphere with radius specified by radius and center point at the current drawing position. If theta1-start , theta1-end , theta2-start , and theta2-end are specified, then a patch will be drawn instead of a full sphere. The theta1-start , theta1-end , theta2-start , and theta2-end arguments are in terms of degrees (0-360). The current
, , and values will also affect the drawing.- radius
[float]
- theta1-start
[float]
- theta1-end
[float]
- theta2-start
[float]
- theta2-end
[float]
strokeparam
The word
, followed by a parameter name argument and a list of parameter values, sets the current value of the parameter specified by the parameter_name argument to be the value specified by parameter_value argument(s). Some parameters are global for the extent of a stroked path definition, while others may vary on a point by point basis.
strokepoint
The word
, followed by three numbers that specify x , y , z coordinates, defines an anchor point at the location specified by those coordinates. Some stroke styles (such as basic2d) will ignore the z coordinate.
torus
Draws a torus with major radius specified by radius1 , minor radius specified by radius1 , and center point at the current drawing position. If theta1-start , theta1-end , theta2-start , and theta2-end are specified, then a patch will be drawn instead of a full torus. The theta1-start , theta1-end , theta2-start , and theta2-end arguments are in terms of degrees (0-360). The current
, , and values will also affect the drawing.- radius1
[float]
- radius2
[float]
- theta1-start
[float]
- theta1-end
[float]
- theta2-start
[float]
- theta2-end
[float]
tri
Draws the triangle specified by the three points x1 y1 z1 x2 y2 z2 x3 y3 z3 .
- x1
[float]
- y1
[float]
- z1
[float]
- x2
[float]
- y2
[float]
- z2
[float]
- x3
[float]
- y3
[float]
- z3
[float]
worldtoscreen
The word
, followed by three numbers that specify x , y , z coordinates, returns an array containing the x , y , and depth screen coordinates associated with a given world coordinate. The depth value is typically specified in the range 0.-1. where 0 is the near clipping plane, and 1. is the far clipping plane.OB3D Messages
bang
Equivalent to the
message.
draw
Draws the object in the named drawing destination. If the matrixoutput attribute is supported and set to 1, the geometry matrices are sent out the object's left outlet.
drawraw
Equivalent to inherit_all attribute set to 1.
with the
drawimmediate
Equivalent to
but ignoring any potential renderer setup
anim_move
Move the object along the axis provided, relative to the space indicated by animmode.
- x
[float]
- y
[float]
- z
[float]
anim_turn
Rotate the object along each axis by the amount provided, relative to the space indicated by animmode.
- x
[float]
- y
[float]
- z
[float]
anim_grow
Scale the object along each axis by the amount provided.
- x
[float]
- y
[float]
- z
[float]
anim_reset
Reset the local transformation attributes to their default values (position = 0 0 0, rotatexyz = 0 0 0, and scale = 1 1 1)
update_node
Update the node transformation attributes.
import_material
Import a Jitter material file (.jitmtl).
export_material
Export material state as a material file (.jitmtl).
jit_gl_texture
Binds the texture specified by texture-name to this object. Equivalent to setting the texture attribute to texture-name .
- texture-name
[symbol]
get_shader
Open an editor window containing the object's current JXS shader.
See Also
Name | Description |
---|---|
jit.gl.graph | Graph floats into 3D space |
jit.gl.gridshape | Generate simple geometric shapes as a grid |
jit.gl.handle | Use mouse movement to control position/rotation |
jit.gl.isosurf | Generate a GL based surface extraction |
jit.gl.mesh | Generate GL geometry from matrices |
jit.gl.model | Read and draw various 3D model formats |
jit.gl.nurbs | Generate NURBS surface |
jit.gl.plato | Generate platonic solids |
jit.gl.render | Render Jitter OpenGL objects |
jit.gl.shader | Manage a GL shader |
jit.gl.slab | Process texture data |
jit.gl.text2d | Render bitmap text |
jit.gl.text3d | Render vector text |
jit.gl.texture | Create OpenGL textures |
jit.gl.videoplane | Display video in OpenGL |
jit.gl.volume | Create a volume visualization |