Authoring guide Rig FX

Purpose

Rig FX is one authored node with two faces. A .rig source that declares states, clocks and lanes is a control machine stepping on the transport, with its state and events on control rows for the rest of the graph. A source that also declares an artboard is a surface: the same machine plus a drawn picture with pads, faders, readouts or text, driven by pointer, key and gamepad rows, drawn to an image output, and served to any phone or tablet that scans its QR code.

Use

Place Rig FX from the Rig view of the Voro menu, under Voro. The docked DAT rig_source holds the source; the default is the smallest running machine. Edit it and press Reload. For a surface, add an artboard and lay out the picture, then turn on Serve on the Serve page and show the QR code.

Inputs and outputs

• go. A control row that fires the default machine’s transition. A source declares its own ports: control rows, named channels, transport, pointer, key, gamepad, image and tables.
• state. The machine’s state as a control row.
• events. The events the machine emits, as a control row.
• A surface adds pointer and image in and out, and by convention a control output.

Controls

• Reload compiles the source off-thread and adopts it at once or at the declared beat, bar or section. A failed compile keeps the last good document, artboard and declaration running.
• params rows in the source become parameters on the node and apply live.
• On a surface, Serve, Serve URL, Show QR, Connected, Serve Mode, Serve Link, Serve Name, Turn (minutes) and Controller appear on the Serve page.

Notes

• State ids that survive an edit keep their values across a Reload.
• The walkthrough is Serve a surface.

Examples

The examples that ship with Rig FX run live on the Rig page.

Ports

Inputs

• go row
  control_f32_v1

Outputs

• state row
  rig_state_v1
• events row
  show_event_v1

Parameters

Rig

Reload (Reload) Pulse op('rig_fx').par.Reload

Default:

None

Rig Source (Doc) Str op('rig_fx').par.Doc

Default:

"" (Empty String)