jit.gl.node
Create hierarchical rendering groups
Description
Use jit.gl.node to construct hierarchical rendering groups. jit.gl.node creates sub-contexts of child objects that can be modified, rendered, and captured together as a functional group.
Discussion
Child objects can be added to a jit.gl.node sub-context in one of the following ways:
The jit.gl.node name attribute is provided as the child object argument, or as the child object drawto attribute.
Any objects connected to the jit.gl.node middle outlet are added to the sub-context.
Child objects are implicitly added to a jit.gl.node in the same patcher, if not already bound to another context.
Jit.gl.node can overwrite standard OB3D attributes of its child objects. For example setting poly_mode on the jit.gl.node will overwrite the current value of poly_mode on every child object.
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
adapt[int]
Adapt the capture texture dimensions to the context window size (default = 1).
capture[int]
Capture to the internal texture (default = 0).
Possible Values:
0 = disabled. Rendering is performed according to the parent context, which can be another jit.gl.node or a jit.gl.render object.
1 = enabled. Rendering is captured to a texture and the texture name is output out the left outlet.
> 1 = outputs multiple render targets (mrt) to the left outlet in the format " ".
dim[2 ints]
Capture texture dimensions, used when adapt = 0 (default = 256 256).
erase_color[4 floats]
Background color of viewport and capture texture (default = 0.2 0.2 0.2 1.). Not compatible with non-automatic mode objects.
fsaa[int]
7.0.0
Enable full screen anti-aliasing on the texture targets when capture is enabled (default = 0)
out_name[symbol]
Capture texture name
out_names[32 symbols]
read-only8.0.0
Capture texture name list. The list length is equal to the number of capture targets enabled.
type[symbol]
Capture texture type (default = auto)
Possible values:
'auto'
(
8bit unsigned byte
)
'char'
(
8bit unsigned byte
)
'long'
(
32bit integer
)
'half'
(
16bit float
)
'float'
(
32bit float
)
'float16'
(
16bit float
)
'float32'
(
32bit float
)
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
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.
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.
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
draw
Draw the node
getscene_dict
Outputs a dictionary of scene elements out the dumpout prepended by the symbol "scene_dict". The optional argument specifies the attribute mode. If no argument is supplied only the spatial transform attributes are included.
If the arg all_attrs is supplied all object attributes are included.
If the arg modified_attrs is supplied any attributes with modified state are included.
- attribute mode
[symbol]
sendoutput
Send messages to the internal texture objects used for capture output
- message
[symbol]
- values
[list]
OB3D Messages
bang
Equivalent to the
message.
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.gridshape | Generate simple geometric shapes as a grid |
jit.gl.render | Render Jitter OpenGL objects |
jit.gl.texture | Create OpenGL textures |