Package Jitter

jit.gl.physdraw

A physics opengl debug drawer

Description

The jit.gl.physdraw object performs debug drawing of the objects in a physics simulation, including jit.phys.body, jit.phys.multiple, and constraint objects such as jit.phys.hinge and jit.phys.6dof. A valid opengl context and a valid jit.phys.world context are required for debug drawing of the physics world.

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

constraintsize[float]

Set the size for drawing contraints in the physics world (default = 2).

contactsize[float]

Set the size for drawing contact points and vectors in the physics world (default = 6).

draw_aabb[int]

Enable drawing of the physics object's aabb (axis-aligned bounding box) (default = 0).

draw_bodies[int]

Enable rigid body drawing (default = 1).

draw_worldbox[int]

Enable worldbox drawing (default = 1).

rgb[int]

Drawer color flag (default = 1). When the flag is set, drawer uses RGB colors. Otherwise, the color attribute determines the color used.

worldname[symbol]

The name of a jit.phys.world context this drawer is bound to.

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.

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

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.

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.

line_width[float]

The drawing line width (default = 1.)

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

smooth_shading[int]

Smooth shading flag (default = 0) When the flag is set, smooth shading is used when rendering.

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

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. 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]: 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]: 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

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

Move the object along the axis provided, relative to the space indicated by animmode.

Arguments:
  • 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.

Arguments:
  • x [float]
  • y [float]
  • z [float]

anim_grow

Scale the object along each axis by the amount provided.

Arguments:
  • 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.

See Also

Name Description
jit.phys.body A rigid body and collision shape
jit.phys.world Collision detection and rigid body dynamics
jit.phys.multiple Uses matrices to simulate multiple rigid bodies