jit.bang
Outputs float time values using specified mode for realtime animation
Description
Outputs float time values using specified mode for realtime animation. Can be used to generate control functions in sync with other jit.world and jit.mo objects, time delta between frames, or accumulated running time.
Arguments
None.
Attributes
timevalue[float64]
read-only
The current time or function value (readonly).
start[float64]
Line function start (default = -1.0).
offset[float64]
Output offset (default = 0.0).
loop[long]
Enable and disable phase looping when animating (default = 1). Animation can be reset by setting phase to 0
phase[float64]
Output phase offset (default = 0.0). Setting this to 0 will restart an animation
fixed_delta[float64]
Fixed frame delta time for calculating time output (default = 0.0). When non-zero, time functions will use this value to calculate output, rather than the delta time since last update.This can be useful when animating at a fixed rate regardless of the actual update rate.
freq[float64]
Function frequency (default = 1.0). Specified in Hz
delta[float64]
Frame delta time for animating graph (default = 0.0). When automatic enabled this value is set automatically by the render context.
function[symbol]
The fuction type used when mode = function (default = line). Line generates linear interpolated values between start and end values, sin outputs a sine function, saw gives a phasor-like repeating ramp, and perlin uses a Perlin Noise function
period[long]
The period length for the perlin noise function (default = 8).
end[float64]
Line function end (default = 1.0).
scale[float64]
Output multiplier (default = 1.0).
interval[time]
Animation interval (default = 0 ms). This attribute uses the Max time format syntax, so the interval can be either fixed or tempo-relative.When set to a non-zero value, the speed attribute is no longer user settable, and will be automatically set based on the interval value.
speed[float64]
Animation speed multiplier (default = 1.0).
loopreport[long]
Enable animation loop reporting (default = 0). When enabled the symbol loopnotify is sent out the dumpout when the animation loops.
rand_amt[float64]
Scales the random offset value (default = 0.0).
mode[symbol]
How time output is calculated (default = accum). The different modes are accum, function, and delta. Accum provides accumulated running time. Function uses the specified function attribute to generate a periodic function and can be used to generate float LFOs and ramps in sync with the animation graph. Delta gives the amount of time between frames, which is useful for driving smooth realtime animations.
enable[long]
Enable function output (default = 1).
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
update
Update and output the time or function value when in non-automatic mode.
reset
Reset the accumulated time to 0.
See Also
| Name | Description |
|---|---|
| jit.mo.join | Combine jit.mo streams and output a multi-plane matrix |
| jit.mo.field | Field manipulator for 3 plane jit.mo streams |
| jit.mo.func | Generate animated single dim matrices using a specified function |
| jit.anim.drive | Animate a 3D transform |