Introduction Éléments
principaux
Scripts Référence
Version française

Documentation

Les commandes IanniX doivent spécifier une cible à chaque exécution :


IanniX Commands

add — Add an object

Adds an object on the score. The keyword auto automatically assigns an ID to your object.

add <trigger|curve|cursor> <id>
add <trigger|curve|cursor> auto


Exemple : add trigger 1

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add trigger 1
add cursor auto

remove — Remove an object

Removes an object in the score thanks to its ID.

remove <id>

Exemple : remove 1

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add trigger 1
setPos current 1 2 0
remove 1

trig — Force object to send its message(s)

Forces an object to send its message(s).

trig <target>

Exemple : trig 1

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add trigger 1
trig 1

clear — Erase a score

Erase all objects into the score

clear

Exemple : clear

setGroup — Defining a group

Groups are identified by a word you are free to choose. Objects are not required to be part of a group.

setGroup <target> <group name>

Exemple : setGroup current triggers

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add trigger 1
setGroup current triggers

setActive — Enable/disable an object

An object is enable by default, but you can disable it. Disabled objects will not send messages.

setActive <target> <0|1>

Exemple : setActive 1 0

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add trigger 1
setActive current 0

setTriggerOff — Time before release (note off) of a trigger

When a note is played thanks to a trigger, you can configure it to turn the note off automatically after a configurable delay. The time before release should normally be set to zero when note-off time is not being sent in the messages of this trigger.

setTriggerOff <target> <delay>

Exemple : add trigger 1
setTriggerOff current 0.5

setCurve — Assign a cursor to a curve

After creating your cursor, make sure you have assigned the curve you want it to follow. You can use the keyword lastCurve to designate the last curve added.

setCurve <cursor target> <curve target>

Exemple : setCurve 2 lastCurve

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPointsEllipse current 2 2
add cursor 2
setCurve 2 lastCurve

setWidth — Width of the cursor play head

You can edit in real time the width of a cursor in order to enable or disable triggers nearby.

setWidth <target> <width>

Exemple : setWidth current 3.5

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add cursor 1
setWidth current 3.5

setDepth — Depth of the cursor play head

You can edit in real time the depth of a cursor in order to enable or disable triggers nearby.

setDepth <target> <depth>

Exemple : setDepth current 3.5

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add cursor 1
setDepth current 3.5

setPattern — Cursor loop pattern

This parameter refers to the direction and the number of cycles. For example, with 1 1 0, the cursor will perform two cycles in the positive direction before stopping.

setPattern <target> <easing> 0 <pattern>

Exemple : setPattern current 0 0 1 -1

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPointsEllipse current 2 2
setPos current 0 0 0
add cursor 10
setCurve 10 1
setPattern current 0 0 1 -1

setSpeed — Speed of a cursor

Cursors have a speed factor independent of each other. The travel time of a curve is also configurable. The cursor will evolve in the negative direction if the speed is negative, but time will continue to flow naturally.

setSpeed <target> auto <duration>
setSpeed <target> <speed factor>


Exemple : setSpeed current 4

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPointsEllipse current 1 1
setPos current -1 0 0
add cursor 10
setCurve 10 1

add curve 2
setPointsEllipse current 1 1
setPos current 1 0 0
add cursor 11
setCurve 11 2
setSpeed 11 4

setSpeedf — Instantaneous speed of a cursor

Cursors have an instantaneous speed factor independent, very useful for real-time performances. As setSpeed, a negative speed is possible without affecting the global speed of the score.

setSpeedF <target> <speed factor>

Exemple : setSpeedF 11 1

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 2
setPointsEllipse current 1 1
setPos current 1 0 0
add cursor 11
setCurve 11 2
setPattern current 0 0 1

add curve 1
setPointAt current 1 0 4
setPos current -1 0 0
add cursor 10
setCurve 10 1
setMessage current 20, direct:// setSpeedF 11 cursor_yPos

setOffset — Cursor offsets

You can choose to start your cursor at a certain point of the curve (marked in seconds) and limit it between certain values (also in seconds).
For example, the 2 4 6 offset means that your cursor will start your curve at the position t=2s then will travel to point t=6s to start again at the point t=4s.

setOffset <target> <initial> <start> <end>

Exemple : setOffset current 3 1 7

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPointAt current 1 6 6
setPos current -3 -3 0
add cursor 10
setCurve 10 1
setPattern current 0 0 1
setOffset current 3 1 7

setTime — Instantaneous position (in seconds)

The position of a cursor can be modified in real time. This instruction does not work if you include it directly in your script, because at each execution, IanniX does a fastrewind.

setTime <target> <time>

Exemple : setTime 11 0

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPointsEllipse current 2 2
setPos current 0 0 0

add cursor 11
setCurve 11 1

add trigger 21
setPos current -2 0 0
setMessage current 10, direct:// setTime 11 0

setTimePercent — Instantaneous position (in percentages)

The position of a cursor can be modified in real time. This instruction does not work if you include it directly in your script, because at each execution, IanniX does a fastrewind.

setTimePercent <target> <time>

Exemple : setTime 11 0

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPointsEllipse current 2 2
setPos current 0 0 0

add cursor 11
setCurve 11 1

add trigger 21
setPos current -2 0 0
setMessage current 10, direct:// setTime 11 0

setBoundsSource — Mapping values

You can set your cursor to send values within a chosen interval. For example, if it is operating in a 3x3 square, it can still send coordinates as values between 0 and 1.
Use setBoundsSource to indicate to IanniX the interval in which your cursor is located and setBoundsTarget to set the range of your sent values. Generally BoundsSource is correctly set by default.
You must use the variables cursor_value_x, cursor_value_y, trigger_value_x, trigger_value_y, collison_value_x or collison_value_y that values sent are those of boundsTarget.

setBoundsSource <target> <x-top-left-corner> <y-top-left-corner> <x-bottom-right-corner> <y-bottom-right-corner>
setBoundsTarget <target> <x-top-left-value> <y-top-left-value> <x-bottom-right-value> <y-bottom-right-value>


Exemple : setBoundsSource 2 0 3 3 0
setBoundsTarget 2 0 1 1 0

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPointAt 1 1 3 3
add cursor 2
setCurve 2 1
setBoundsSource 2 0 3 3 0
setBoundsTarget 2 0 1 1 0
setMessage 2 250, direct:// cursor_value_x cursor_value_y

setBoundsTarget — Mapping values

You can set your cursor to send values within a chosen interval. For example, if it is operating in a 3x3 square, it can still send coordinates as values between 0 and 1.
Use setBoundsSource to indicate to IanniX the interval in which your cursor is located and setBoundsTarget to set the range of your sent values. Generally BoundsSource is correctly set by default.
You must use the variables cursor_value_x, cursor_value_y, trigger_value_x, trigger_value_y, collison_value_x or collison_value_y that values sent are those of boundsTarget.

setBoundsSource <target> <x-top-left-corner> <y-top-left-corner> <x-bottom-right-corner> <y-bottom-right-corner>
setBoundsTarget <target> <x-top-left-value> <y-top-left-value> <x-bottom-right-value> <y-bottom-right-value>


Exemple : setBoundsSource 2 0 3 3 0
setBoundsTarget 2 0 1 1 0

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPointAt 1 1 3 3
add cursor 2
setCurve 2 1
setBoundsSource 2 0 3 3 0
setBoundsTarget 2 0 1 1 0
setMessage 2 250, direct:// cursor_value_x cursor_value_y

shiftPoints — Shifting points of a curve

Shfit points from left to right or right to left

shiftPoints <target> <start point index> <-1|1>

translatePoints — Translating a curve

Translates a curve

translatePoints <target> <dX> <dY> <dZ>

translatePoint — Translating a point of a curve

Translates a point of a curve

translatePoint <target> <point index> <dX> <dY> <dZ>

setPointAt — Setting or modifying points of a curve (straight or Bezier)

A curve must be defined by a sequence of points. The points index starts at 0.

setPointAt <target> <point index> <x> <y>
setPointAt <target> <point index> <x> <y> <c1x> <c1y> <c2x> <c2y>
setPointAt <target> <point index> <x> <y> <z>
setPointAt <target> <point index> <x> <y> <z> <c1x> <c1y> <c1z> <c2x> <c2y> <c2z>


Exemple : setPointAt current 1 3 3

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPos current -1 -1 0
setPointAt current 0 0 0
setPointAt current 1 3 3

setSmoothPointAt — Setting or modifying points of a curve (with automatic smoothing)

A curve must be defined by a sequence of points. The points index starts at 0.

setSmoothPointAt <target> <point index> <x> <y>
setSmoothPointAt <target> <point index> <x> <y> <z>


Exemple : setSmoothPointAt current 1 3 3

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPos current -1 -1 0
setSmoothPointAt current 0 0 0
setSmoothPointAt current 1 3 3
setSmoothPointAt current 2 0 -2

setPointXAt — Modifying x-coordinate of a point of a curve

Description

setPointXAt <target> <point index> <x>

setPointYAt — Modifying y-coordinate of a point of a curve

Description

setPointYAt <target> <point index> <y>

setPointZat — Modifying z-coordinate of a point of a curve

Description

setPointZAt <target> <point index> <z>

removePointAt — Removing a point of a curve

Description

removePointAt <point index>

setPointsTxt — Text curves

A character can also be played like a curve.

setPointsTxt <target> <scaling> <font> <text>

Exemple : setPointsTxt current 0.1 Arial a

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPointsTxt current 0.1 Arial a

setPointsPath — Manual SVG curve — cubic path

A SVG curve is defined by a path that you can directly import from another software by copy / paste.

setPointsPath <target> <scale> <svg path>

Exemple : setPointsPath current 0.01 M637.599,1569.972c0,0,89.127,0,222.818,0c8.913,0,18.023,0,27.381,0.113C901,1570,913,1573,926,1576c67,15,128,43,198,28c9-2,17.833-4.277,26.554-6.685c8.72-2.407,17.255-5.074,25.247-8.562C1224,1567,1239,1514,1256,1469c18-48,69-29,101-9c81.375,48.125,161.219,103.141,254.032,110.08c13.259,0.991,26.782,1.001,40.616-0.129C1716,1574,1788,1562,1842,1606c39,32,62,97,119,90c44-6,70-47,101.551-72.846

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve auto
setPointsPath current 0.01 M637.599,1569.972c0,0,89.127,0,222.818,0c8.913,0,18.023,0,27.381,0.113C901,1570,913,1573,926,1576c67,15,128,43,198,28c9-2,17.833-4.277,26.554-6.685c8.72-2.407,17.255-5.074,25.247-8.562C1224,1567,1239,1514,1256,1469c18-48,69-29,101-9c81.375,48.125,161.219,103.141,254.032,110.08c13.259,0.991,26.782,1.001,40.616-0.129C1716,1574,1788,1562,1842,1606c39,32,62,97,119,90c44-6,70-47,101.551-72.846
setPos current -14 15 0

setPointsLines — Manual SVG curve — polylines

The SVG path of these curves is simply a set of points .

setPointsLines <target> <scale> <svg polyline>

Exemple : setPointsLines current 1 1,1 1,2 -1,2 -1,-2 -2,0

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve auto
setPointsLines current 1 1,1 1,2 -1,2 -1,-2 -2,0

setPointsImg — Automatic vectorization

A curve can be directly constructed from an image by an automatic vectorization.

setPointsImg <target> <scaling> <filename>

Exemple : setPointsImg current 0.1 ./Examples/trigger_speaker.png

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPointsImg current 0.1 ./Examples/trigger_speaker.png

setPointsEllipse — Elliptical or circular curves

Ellipses are defined by a major axis and a minor axis. To construct circles, the two axes must have the same value.

setPointsEllipse <target> <width> <height>

Exemple : setPointsEllipse current 2 1

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPointsEllipse current 2 1
setPos current 1 1 0

setSize — Size of objects

This function modifies the thickness of a curve or a cursor and the size of a trigger.

setSize <target> <size>

Exemple : setSize 1 10

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
add trigger 2
add cursor 3
setCurve 3 1
setPos 2 1.5 1.5 0
setPointsEllipse 1 2 2
setSize 1 10
setSize 2 5
setSize 3 7

setResize — Curve size (width/height)

The size of objects can be changed directly.

setResize <target> <width> <height>

Exemple : setResize current 2 1

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPointsEllipse current 2 1
setPos current 1 1 0
setResize current 2 1

setResizeF — Curve size (scale factor)

The size of objects can be changed directly.

setResizeF <target> <scale factor>

Exemple : setResizeF current 0.5

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPointsEllipse current 2 1
setPos current 1 1 0
setResizeF current 0.5

setLine — Paths format

Sets a style dotted with dash pattern which must be a sequence of 0 and 1, dash style defines the space between each dot.

setLine <target> <dash style> <dash pattern>

Exemple : setLine 1 2000 1

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve 1
setPointsEllipse 1 2.5 2.5
setLine 1 2000 1

setPos — Space position

Sets an object on the score via the coordinates (x, y, z).

setPos <target> <x> <y> <z>

Exemple : setPos 1 1 2 0

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add trigger 1
setPos current 1 2 0

setLabel — Adding text

You can add a text description of your items on the score.

setLabel <target> <label>

Exemple : setLabel current Hello World !

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add trigger auto
setLabel current Hello World !

setMessage — Assigning a message

This command sets the message that an object must send (please refer to Messages Syntax help).

setMessage <target> <period>, <message1> <variables>, <message2>,message2, message3, …

Exemple : setMessage current 1, osc://127.0.0.1:57120/trigger trigger_id

setGroup

sendOsc — Send a message

You can send manually a message (please refer to Messages Syntax help).

sendOsc <message>

Exemple : sendOsc osc://127.0.0.1:57120/trigger 1 2 3

solo — Solo/un-solo

Solo/un-solo an object or a group (exactly like in Objects of inspector tab)

solo <target> <0|1>
solo myGroup 1


mute — Mute/un-mute

Mute/un-mute an object or a group (exactly like in Objects of inspector tab)

mute <target> <1|0>
mute myGroup 0


registerTexture — Creating a variable texture

Save your texture as a variable. If you are using the following variables, the display is directly modified because native textures are saved under those variables. Use the tool "restore triggers original shapes" from the inspector "scripts & styles" to find the original textures.

registerTexture <variable> <x-top-left-corner> <y-top-left-corner> <x-bottom-right-corner> <y-bottom-right-corner> <file name>

Exemple : registerTexture trigger_active_message -1 1 1 -1 ./Examples/trigger_triangle.png

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
registerTexture trigger_active_message -1 1 1 -1 ./Examples/trigger_triangle.png
add trigger 1
add trigger 2
add trigger 3
setPos 1 1 1 0
setPos 3 -1 -1 0
setActive 3 0
setLabel 1 1
setLabel 2 2
setLabel 3 3

setTexture — Texture of an object

Modify the texture of an object or a group with a preloaded texture (refer to registerTexture).

setTexture <target> <variable>

setTextureActive — Texture of an active object that does not send any messages

Modify the texture of an object or a group with a preloaded texture (refer to registerTexture).

setTextureActive <target> <variable>

setGroup

setTextureInactive — Texture of an inactive object that does not send any messages

Modify the texture of an object or a group with a preloaded texture (refer to registerTexture).

setTextureInactive <target> <variable>

setGroup

setTextureActiveMessage — Texture of an active object that send messages

Modify the texture of an object or a group with a preloaded texture (refer to registerTexture).

setTextureActiveMessage <target> <variable>

setGroup

setTextureInactiveMessage — Texture of an inactive object that send messages

Modify the texture of an object or a group with a preloaded texture (refer to registerTexture).

setTextureInactiveMessage <target> <variable>

setGroup

registerColor — Creating a variable color (RGB)

IanniX can also save a color as a variable for reusing it more easily.

registerColor <variable> <r> <g> <b> <a>

Exemple : registerColor rougeRGB 255 0 0 255

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
registerColor rougeRGB 255 0 0 255
add trigger auto
setColor current rougeRGB

registerColorHue — Creating a variable color (HSB)

IanniX can also save a color as a variable for reusing it more easily.

registerColor <variable> <h> <s> <b> <a>

Exemple : registerColorHue orangeHUE 32 255 255 255

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
registerColorHue orangeHUE 32 255 255 255
add trigger auto
setColor current orangeHUE

setColor — Color of an object (RGB)

Modify the color of an object or a group with a specific color or a preloaded color (refer to registerColor or registerColorHur).

setColor <target> <r> <g> <b> <a>
setColor <target> <variable>


setColorHue — Color of an object (HSB)

Modify the color of an object or a group with a specific color or a preloaded color (refer to registerColor or registerColorHur).

setColorHue <target> <h> <s> <b> <a>
setColorHue <target> <variable>


setColorActive — Color of an active object that does not send any messages (RGB)

Modify the color of an object or a group with a specific color or a preloaded color (refer to registerColor or registerColorHur).

setColorActive <target> <r> <g> <b> <a>
setColorActive <target> <variable>


setGroup

setColorInactive — Color of an inactive object that does not send any messages (RGB)

Modify the color of an object or a group with a specific color or a preloaded color (refer to registerColor or registerColorHur).

setColorInactive <target> <r> <g> <b> <a>
setColorInactive <target> <variable>


setGroup

setColorActiveMessage — Color of an active object that send messages (RGB)

Modify the color of an object or a group with a specific color or a preloaded color (refer to registerColor or registerColorHur).

setColorActiveMessage <target> <r> <g> <b> <a>
setColorActiveMessage <target> <variable>


setGroup

setColorInactiveMessage — Color of an inactive object that send messages (RGB)

Modify the color of an object or a group with a specific color or a preloaded color (refer to registerColor or registerColorHur).

setColorInactiveMessage <target> <r> <g> <b> <a>
setColorInactiveMessage <target> <variable>


setGroup

setColorActiveHue — Color of an active object that does not send any messages (HSB)

Modify the color of an object or a group with a specific color or a preloaded color (refer to registerColor or registerColorHur).

setColorActiveHue <target> <h> <s> <b> <a>
setColorActiveHue <target> <variable>


setColorInactiveHue — Color of an inactive object that send messages (HSB)

Modify the color of an object or a group with a specific color or a preloaded color (refer to registerColor or registerColorHur).

setColorInactiveHue <target> <h> <s> <b> <a>
setColorInactiveHue <target> <variable>


setColorActiveMessageHue — Color of an inactive object that does not send any messages (HSB)

Modify the color of an object or a group with a specific color or a preloaded color (refer to registerColor or registerColorHur).

setColorActiveMessageHue <target> <h> <s> <b> <a>
setColorActiveMessageHue <target> <variable>


setColorInactiveMessageHue — Color of an inactive object that send messages (HSB)

Modify the color of an object or a group with a specific color or a preloaded color (refer to registerColor or registerColorHur).

setColorInactiveMessageHue <target> <h> <s> <b> <a>
setColorInactiveMessageHue <target> <variable>


autoSize — Resizing objects regardless of zoom

Enabled by default, can automatically increase or decrease the size of the triggers and cursors when you zoom in / out the score in order to facilitate reading. Only the visual aspect is affected, the actual size of the objects is not changed.

autoSize <0|1>

Exemple : autoSize 0

setGroup
Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add trigger 1
zoom 200
autosize 0

zoom — Zoom in score

Adjust the zoom using the script. The factor is in percent. e.g. A factor of 200 doubles the size of the display area.

zoom <zoom factor>

Exemple : zoom 200

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add trigger 1
zoom 200

center — Center score

Placing the point (x,y) in the center of the workspace

center <x> <y>

Exemple : center 2 2

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add trigger 1
zoom 200
center 2 2

viewport — Resize the viewport

Resize the viewport

viewport <width> <height>

Exemple : viewport 400 400

snapshot — Export as an image snapshot

Make a snapshot of current score

snapshot <scale> <filename,optional>

Exemple : snapshot 4

rotate — Rotate score

Rotate the view about the x, y and z axes

rotate <x-axis> <y-axis> <z-axis>

Exemple : rotate 45 0 0

rotate — Rotate score

Rotate the view about the x, y and z axes

rotate <x-axis> <y-axis> <z-axis>

Exemple : rotate 45 0 0

play — Playing the score

Enabling the playback

play <score speed>

Exemple : play 1

setGroup

stop — Stopping the score

Disabling the playback

stop

Exemple : stop

fastrewind — Fastrewinding the score

Go back to the begging of score

fastrewind

Exemple : fastrewind

setGroup

speed — Speed of the score

You can set the global speed of the score. A negative speed will evolve over time in the negative direction.

speed <speed>

Exemple : speed 5

Copier/coller cet exemple dans IanniX pour voir son fonctionnement !
add curve auto
setPointsEllipse current 1 1
setPos current 1 0 0
add cursor auto
setCurve current lastCurve
speed 5

load — Load a score or a script

Load a score or a script of the current project folder

load <score name>

Exemple : load Script sample - IanniX logo

log — Log information to console

Log information to IanniX console (network tab)

log <text>

Exemple : log is really useful to debug

goto — Go to a specific timecode

Go to a specific timecode in seconds

goto <time in seconds>

Exemple : goto 4.5

mouse — Control mouse

Enable to move cursor of the mouse

mouse <x> <y>

Exemple : mouse 50 50

title — Get IanniX window title

Returns IanniX window title (scripts only)

title

Exemple : title

sleep — Make IanniX script sleeping (scripts only)

Set a sleep time. BE CAREFUL, IanniX will not respond during sleeping

sleep <duration>

Exemple : sleep 5


Valeurs

trigger_id

ID of the triggered trigger

trigger_group_id

Group name of the triggered trigger

trigger_document_id

Document name of the triggered trigger

trigger_label

Label of the triggered trigger

trigger_xPos

x coordinate of the triggered trigger

trigger_yPos

y coordinate of the triggered trigger

trigger_zPos

z coordinate of the triggered trigger

trigger_value_x

x mapped coordinate of the triggered trigger

trigger_value_y

y mapped coordinate of the triggered trigger

trigger_value_z

z mapped coordinate of the triggered trigger

trigger_value

When trigger off-time is set, returns 127 when the trigger is trigged and 0 when the trigger is released

trigger_distance

Distance between the triggered trigger and the cursor that triggers the trigger

trigger_side

0 if trigger is triggered from left to right and 1 for the other side

trigger_message_id

ID of the message (each message generates an ascending ID)

cursor_id

ID of the running cursor

cursor_group_id

Group name of the running cursor

cursor_document_id

Document name of the running cursor

cursor_label

Label of the running cursor

cursor_xPos

x coordinate of the running cursor

cursor_yPos

y coordinate of the running cursor

cursor_zPos

z coordinate of the running cursor

cursor_value_x

x mapped coordinate of the running cursor

cursor_value_y

y mapped coordinate of the running cursor

cursor_value_z

z mapped coordinate of the running cursor

cursor_time

Current progression of the cursor on the curve (in seconds)

cursor_time_percent

Current progression of the cursor on the curve (in percentages, from 0.0 to 1.0)

cursor_angle

Angle of the cursor

cursor_nb_loop

Number of loops done by the cursor on the curve

cursor_message_id

ID of the message (each message generates an ascending ID)

curve_id

ID of curve where the cursor runs on

curve_group_id

Group name of curve where the cursor runs on

curve_document_id

Document name of curve where the cursor runs on

curve_label

Label of curve where the cursor runs on

curve_xPos

x coordinate of curve where the cursor runs on

curve_yPos

y coordinate of curve where the cursor runs on

curve_zPos

z coordinate of curve where the cursor runs on

collision_curve_id

ID of the collided curve

collision_curve_group_id

Group name of the collided curve

collision_curve_document_id

Document name of the collided curve

collision_curve_label

Label of the collided curve

collision_curve_xPos

x coordinate of the collided curve

collision_curve_yPos

y coordinate of the collided curve

collision_curve_zPos

z coordinate of the collided curve

collision_xPos

x coordinate of the collision between the cursor and the curve

collision_yPos

y coordinate of the collision between the cursor and the curve

collision_value_x

x mapped coordinate of the collision between the cursor and the curve

collision_value_y

y mapped coordinate of the collision between the cursor and the curve

collision_distance

Distance between the collision and the cursor

timetag

Set an OSC Timetag (compliant with Internet NTP timestamps) to message

status

Playback status of score ("play"), "stop" or "fastrewind")

nb_triggers

Number of triggers in the current score

nb_cursors

Number of cursors in the current score

nb_curves

Number of curves in the current score

global_time

Elapsed time in seconds

global_time_verbose

Elapsed time as displayed in Transport bar


JavaScript useful functions

abs(x)

Absolute value of x

acos(x)

Arccosine of x

asin(x)

Arcsine of x

atan(x)

Arctangent of x

atan2(x,y)

Arctangent of x divided by y

ceil(x)

Next higher integer above x

cos(x)

Cosine of x

exp(x)

e to the power x

floor(x)

Next lower integer below x

log(x)

Logarithm to the base 2 of x

min(x,y)

Minimum of x and y

max(x,y)

Maximum of x and y

pow(x,y)

x raised to the power y

round(x)

x rounded nearest integer, higher or lower

sin(x)

Sine of x

sqrt(x)

Square root of x

sq(x)

x squared

tan(x)

Tangent of x

degrees(x)

Radian angle x converted into degrees

radians(x)

Degree angle x converted into radians

random(low, high)

Random number between low and high

constrain(x, min, max)

Values of x below min and above max are discarded

dist(x1, y1, z1, x2, y2, z2)

Distance between the points (x1, y1, z1) and (x2, y2, z2)

angle(x1, y1, x2, y2)

Angle between the points (x1, y1) and (x2, y2)

norm(x, low, high)

Scale x to cover the range from low to high, assuming x ranges between 0.0 and 1.0:

rangeMid(x, low, mid, high)

Scale x to cover the range from low to high, assuming x ranges between 0.0 and 1.0, with mid being returned as the value for x=0.5

map(x, low1, high1, low2, high2)

Scale x to cover the range from low2 to high2, assuming x ranges between low1 and high1

E

Mathematical constant e

LN2

Natural logarithm of 2

LN10

Natural logarithm of 10

LOG2E

Base 2 logarithm of e

LOG10E

Logarithm to the base 10 of e

PI

Constant PI

TWO_PI

Two times PI

THIRD_PI

PI over 3

QUARTER_PI

PI over 4

HALF_PI

PI over 2

SQRT1_2

One over the square root of two

SQRT2

Square root of two