jit.gl.camera
Set a rendering view
Description
Sets the properties needed to define a view in OpenGL. These include field of view, clipping planes, and perspective or orthographic projection modes. In addition a position and orientation can be defined for a virtual camera in 3D space, and the proper view will be generated from these transforms.
Discussion
Multiple jit.gl.camera objects can be added to a single drawing context, and switched between using the enable attribute.
Jit.gl.camera can override standard OB3D attributes of objects in the context it is drawing to. For example setting poly_mode on the jit.gl.camera will override the current value of poly_mode on every OB3D for that camera's draw pass. To reset this action send the attribute name with no arguments.
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 a 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 " jit_gl_texture <texture_name> <texture_name> ".
colormask[4 ints]
Color mask values for red, green, blue, and alpha channels. When set to 0, the corresponding color component is ignored by OpenGL. See glColorMask for more detail.
dim[2 ints]
Capture texture dimensions, used when adapt = 0 (default = 256 256).
direction[3 floats]
Direction
drawto[symbol]
Drawing context
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.
far_clip[float]
The far clipping plane distance in 3D world (default = 100.)
frustum[6 floats]
Camera frustum values (left, right, bottom, top, near, far). projection_mode must be set to frustum for these values to have an effect. The camera's frustum values entirely specify the geometry of the viewing frustum. For more technical documentation on what the six parameters to the frustum attribute mean, see the OpenGL documentation for glFrustum
fsaa[int]
Enable full screen anti-aliasing on the texture targets when capture is enabled (default = 0)
layer[int]
The camera layer controls the order a context or jit.gl.node sub-context will render this camera viewport when in automatic mode (default = 0). Lower values draw first. Objects in the same layer have indeterminate ordering.
lens_angle[float]
The lens angle of the OpenGL camera (default = 45.)
locklook[int]
Force the camera to remain pointed at the lookat value, ignoring orientation messages and attributes (default = 0).
lookat[3 floats]
3D position at which the camera is pointed (default = 0. 0. 0.)
near_clip[float]
The near clipping plane distance in 3D world (default = 0.1)
ortho[int]
Orthographic projection mode (default = 0)
Possible values:
0 = 'Off (Perspective)'
(
orthographic projection off (perspective projection)
)
1 = 'Orthographic (Lens Angle)'
(
orthographic projection on, using lens angle
)
2 = 'Orthographic (No Lens Angle)'
(
orthographic projection on, ignoring lens angle
)
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.
proj_matrix[16 floats]
read-only7.0.0
Current projection matrix
projection_mode[symbol]
Camera projection mode sets how the projection matrix is generated. In standard mode, the camera uses the ortho setting an related attributes such as near, far, lens_angle, etc. to generate the projection matrix. In frustum mode, only the frustum attribute is used to calculate the projection matrix.
Possible values:
'standard'
'frustum'
tripod[int]
Force the camera to orient itself as if mounted on a tripod. Y-axis turn values are applied in world-space regardless of animmode (default = 0).
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
)
view_matrix[16 floats]
read-only7.0.0
Current view matrix
viewport[4 floats]
Viewport coordinates which set the left, bottom, width, and height of the viewport (default = 0. 0. 1. 1.)
viewproj_matrix[16 floats]
read-only7.0.0
Current view projection matrix
vp_mode[symbol]
Viewport coordinate mode (default = normalized). Determines if the viewport values are absolute or normalized coordinates.
Possible values:
'normalized'
'absolute'
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.
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.
axes[int]
x/y/z axis rendering off/on (default = 0)
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.
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.
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.
name[symbol]
The instance name (default = UID)
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.)
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.
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. 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'
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
getviewportray
Return 6 values representing the world-space endpoints of a ray cast from the screen-x and screen-y arguments.
- screen-x
[int]
- screen-y
[int]
screentoworld
TEXT_HERE
sendoutput
Send messages to the internal texture objects used for capture output
- message
[symbol]
- values
[list]
worldtoscreen
TEXT_HERE
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.
- 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.
See Also
| Name | Description |
|---|---|
| jit.gl.render | Render Jitter OpenGL objects |
| jit.gl.sketch | Use drawing commands with OpenGL |
| jit.anim.node | Perform hierarchical transformation |
| jit.anim.drive | Animate a 3D transform |