jit.gl.path
Jitter Reference
Open Help

jit.gl.path

Generate and render a path in OpenGL

Description

The jit.gl.path object generates and renders a 3D path. See the jit.path object for more information on the underlying path structure. The 3D visualization can be rendered as either a line, an extruded line (ribbon), an extruded circle (tube), or an extruded 2D contour. The path stores 10 values: position x/y/z, color r/g/b/a, scale x/y, and orient angle.
For more information on how the extrusion is handled, see the GLE library: http://www.linas.org/gle

Examples

Generate and render a path in OpenGL

Discussion

This 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

autohandles [int]

Enable the calculation of handle values every time the path is edited (default = 1).

closed [int]

g/s(get)

Indicates the path is closed (first and last points are equal).

displaylist [int]

Cache in displaylist flag (default = 0) This feature may be used to speed up rendering time by creating and storing a list of gl drawing commands on the graphics card.

drawhandles [int]

Enable drawing of path handles, for debugging (default = 0).

endcap [int]

Enable the closing of extruded path endpoints. (default = 0)

evalin [float]

A parameter between 0 and 1 to determine where in the path rendering starts (default = 0.).

evalout [float]

A parameter between 0 and 1 to determine where in the path rendering ends (default = 1.).

extrudescale [2 floats]

2D scaling factor for extrusion contours in the form x y (default = 1. 1.).

interpmode [symbol]

Path interpolation method (default = linear).

Possible values:

'linear' ( Linear interpolation )
'spline' ( Hermite interpolation )

joinstyle [symbol]

Extrusion segment join method (default = angle). See the GLE library for more information.

Possible values:

'raw'
'angle'
'cut'
'round'

normgen [symbol]

Normal generation method for extruded paths (default = none). See the GLE library for more information.

Possible values:

'none' ( No generation )
'facet' ( Normal vector per facet )
'edge' ( Normal vectors lie along edges )
'pathedge' ( Normal vectors lie along edges and interpolate between segments )

pathstyle [symbol]

Path drawing method (default = line).

Possible values:

'line'
'ribbon'
'tube'
'contour'

pointcount [int]

g/s(get)

Number of path points (default = 0).

segments [int]

Number of segments between points (default = 20).

texscale [3 floats]

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

texturemode [int]

Texturing coord generation method for extruded paths (default = 1). See the GLE library for more information.

Possible values:

0 = 'none' ( No texture coord generation )
1 = 'vertex_flat' ( Vertex X is U, accumulated segment length is V )
2 = 'normal_flat' ( Normal vector X is U, accumulated segment length is V )
3 = 'vertex_cylinder' ( Vertex cylinder mapping for U, accumulated segment length for V )
4 = 'normal_cylinder' ( Normal cylinder mapping for U, accumulated segment length for V )
5 = 'vertex_sphere' ( Vertex sphere mapping )
6 = 'normal_sphere' ( Normal sphere mapping )
7 = 'vertex_model_flat' ( same as vertex_flat but with untransformed vertices )
8 = 'normal_model_flat' ( same as normal_flat but with untransformed vertices )
9 = 'vertex_model_cylinder' ( same as vertex_cylinder but with untransformed vertices )
10 = 'normal_model_cylinder' ( same as normal_cylinder but with untransformed vertices )
11 = 'vertex_model_sphere' ( same as vertex_sphere but with untransformed vertices )
12 = 'normal_model_sphere' ( same as normal_sphere but with untransformed vertices )

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

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

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.

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 anim_move and anim_turn messages will affect the position and orientation of this object (default = parent).
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 = blend_mode 1 1
multiply = blend_mode 2 1
screen = blend_mode 4 1
exclusion = blend_mode 4 5
colorblend = blend_mode 3 4
alphablend = blend_mode 6 7
coloradd = blend_mode 3 1
alphaadd = blend_mode 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

camera [3 floats]

The camera position in 3D space (default = 0. 0. 2.) Camera position is specified as a set of floating point numbers that correspond to a camera position with respect to the x, y, and z axes.

capture [symbol]

The name of a texture to be rendered to - e.g. jit.gl.nurbs @capture mytex will capture to jit.gl.texture @name mytex .

color [4 floats]

The draw color in the form red green blue alpha (default = 1. 1. 1. 1.) The list elements should be in the range 0.-1.

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.

dest_dim [2 ints]

Destination dimensions width height (default = jit.gl.render destination dimensions)

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.

far_clip [float]

The far clipping plane distance in 3D world (default = 100.)

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.)

inherit_all [int]

Inherit all flag (default = 0) When the flag is set, all GL attributes from named drawing context are inherited.

inherit_color [int]

Inherit color flag (default = 0) When the flag is set, all color attributes from the named drawing context are inherited.

inherit_depth [int]

Inherit depth buffer flag (default = 0) When the flag is set, all depth buffer attributes from the named drawing context are inherited.

inherit_fog [int]

Inherit fog attributes flag (default = 0) When the flag is set, all fog attributes from the named drawing context are inherited.

inherit_material [int]

Inherit material attributes flag (default = 0) When the flag is set, all lighting and material attributes from the named drawing context are inherited.

inherit_poly [int]

Inherit polygon attributes flag (default = 0) When the flag is set, all polygon attributes from the named drawing context are inherited.

inherit_texture [int]

Inherit texture attributes flag (default = 0) When the flag is set, all texture attributes from the named drawing context are inherited.

inherit_transform [int]

Inherit transform attributes flag (default = 0) When the flag is set, all transform attributes from the named drawing context are inherited.

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.

lens_angle [float]

The lens angle of the OpenGL camera (default = 45.)

lighting_enable [int]

Lighting enabled flag (default = 0) When the flag is set, lighting is calculated.

light_ambient [4 floats]

The color and opacity of the ambient light component in the form red green blue opacity (default = 0. 0. 0. 1. (opaque black)) All values should be in the range 0.-1.

light_diffuse [4 floats]

The color and opacity of the diffuse light component in the form red green blue opacity (default = 1. 1. 1. 1. (opaque white)) All values should be in the range 0.-1.

light_global_ambient [4 floats]

The color and opacity of the global ambient light component in the form red green blue opacity (default = 0.2 0.2 0.2 1.) All values should be in the range 0.-1.

light_position [4 floats]

The position of the light source in XYZ coordinates and the light type (default = 1. 1. 1. 0.)
When the last number is 0., t The light is treated as a directional source if 0. is the final number. Otherwise, diffuse and specular lighting calculations are based on the actual location of the light in eye coordinates, and attenuation is enabled.

light_specular [4 floats]

Color and opacity of specular light component (default = 1. 1. 1. 1. (opaque white)) The first three floats in the range 0.-1. specify the RGB components of the specular light color. The fourth float (also in the range 0.-1.) specifies opacity.

line_width [float]

The drawing line width (default = 1.)

lookat [3 floats]

3D position at which the camera is pointed (default = 0. 0. 0.)

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)

matrixoutput [int]

Matrix output mode (default = 0)
0 = issue render commands
1 = output geometry matrices
2 = output geometry matrices with local transform applied

name [symbol]

The instance name (default = UID)

near_clip [float]

The near clipping plane distance in 3D world (default = 0.1)

ortho [int]

Orthographic projection mode (default = 0)
0 = orthographic projection off (perspective projection)
1 = orthographic projection on, using lens angle
2 = orthographic projection on, ignoring lens angle

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);

up [3 floats]

The 3D vector towards which the top of the camera points (default = 0. 1. 0.)

verbose [int]

Toggles printing messages to the Max Console.

viewalign [int]

View aligned transformation flag (default = 0)

Messages

addcolor

Arguments

r [float]
g [float]
b [float]
a [float]
Add color values to the last point in the path.

addcontour

Arguments

contour-vals [list]
Set the contour to be used for pathstyle contour . The contour-vals are a list of X and Y position values describing a contour in 2D space. A minimum of 4 are required.

addorient

Arguments

orient [float]
Add an orientation value to the last point in the path.

addscale

Arguments

scale-x [float]
scale-y [float]
Add scale values to the last point in the path.

append

Arguments

x [float]
y [float]
z [float]
r [float]
g [float]
b [float]
a [float]
scale-x [float]
scale-y [float]
orient [float]
Append point values to the end of the path.

clear

Remove all points from the path

delete

Arguments

index [int]
Delete the point at index

calchandles

Calculate the path handles of each point in the path using the Catmull-Rom method. This will overwrite any previously stored handles.

closepath

Close the path by adding a point to the end equal to the first point.

edit

Arguments

index [int]
x [float]
y [float]
z [float]
r [float]
g [float]
b [float]
a [float]
scale-x [float]
scale-y [float]
orient [float]
Edit the point at index

edithandle

Arguments

index [int]
x [float]
y [float]
z [float]
r [float]
g [float]
b [float]
a [float]
scale-x [float]
scale-y [float]
orient [float]
Edit the point handle at index

gethandle

Arguments

index [int]
Get handle values at index and output through dump outlet.

getpoint

Arguments

index [int]
Get point values at index and output through dump outlet.

insert

Arguments

index [int]
x [float]
y [float]
z [float]
r [float]
g [float]
b [float]
a [float]
scale-x [float]
scale-y [float]
orient [float]
Insert a new point at index

setcolor

Arguments

index [int]
r [float]
g [float]
b [float]
a [float]
Set color values at index

setorient

Arguments

index [int]
orient [float]
Set orientation value at index

setscale

Arguments

index [int]
scale-x [float]
scale-y [float]
Set scale values at index

OB3D Messages

bang

Equivalent to the draw 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 draw with the inherit_all attribute set to 1.

drawimmediate

Equivalent to draw but ignoring any potential renderer setup

anim_move

Arguments

x [float]
y [float]
z [float]
Move the object along the axis provided, relative to the space indicated by animmode.

anim_turn

Arguments

x [float]
y [float]
z [float]
Rotate the object along each axis by the amount provided, relative to the space indicated by animmode.

anim_grow

Arguments

x [float]
y [float]
z [float]
Scale the object along each axis by the amount provided.

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).

See Also

Name Description
jit.path Evaluates a series of N-dim points as a path
jit.anim.path Evaluate a path of 3D transform points
jit.gl.sketch Use drawing commands with OpenGL