Using the Patch Editor

To open the Patch Editor, go to the menu bar and then:

  1. Click View.
  2. Select Show Patch Editor.

You can also hold down ⌘+Option+P to toggle Patch Editor visibility.

The Patch Editor will also open automatically when you insert patches from the Inspector panel.

It'll open under the Viewport, like this:

Inserting Patches

Inserting Producers

Drag the object from the Scene tab and drop it in to the Patch Editor, right-click on the object in Scene tab, and select Create Patch. Or:

  1. Go to the Scene tab and select your object.
  2. Click + next to Actions in the Inspector panel.
  3. Select the patch or combination of patches you want from the menu.

Inserting Consumers

To insert a consumer patch:

  1. Go to the Scene tab and select the object you want to affect.
  2. Go to Properties in the Inspector panel. Click the dot next to the property you want to drive.

This is what you'll see once your patch has been created:

Inserting Intermediaries

To insert an intermediary patch, right click in an empty space in the Patch Editor:

You'll see a menu of all the intermediary patches in Spark AR Studio:

Search for the patch you want to insert from the menu - there's a description of every patch, to help you choose.

Then, click Insert.

Inserting Asset Patches

To insert an asset patch, either:

  1. Drag an asset into the Patch Editor.
  2. Right click on the asset in the Scene tab, and select Create Asset Instance Patch.

Connecting Patches

Connect patches using their ports - the small dots on each patch.

Patches can only be connected from left to right. This means you'd always connect a port on right side of a patch - known as an output port - to a port on the left side of another patch - known as an input port.

To connect patches together:

  1. Click and hold the first port.
  2. Drag the connector across to the second port.

You should see a blue line appear, which will turn green once it has found a connection. If you let go, you should see a connection made between your patches.

To disconnect patches, either:

  1. Select one of the ports and press delete on your keypad.
  2. Select the output port, drag the connection into an empty space and let go.

Making Multiple Connections

An output can have more than one outgoing connection, but an input can only have one incoming connection. This means that the result of an output port can be applied to more than one patch.

In the example below, we've connected the Mouth Open output port in the Mouth Open patch to three different consumer patches. Each of these patches represent the Visibility property of an object:

Grouping Patches

Group patches by selecting two or more patches, and either:

  1. Right-clicking on them - you'll see a menu, with an option to Group Patches.
  2. Pressing ⌘ + G - you'll need to add this as a keyboard shortcut first.

Previewing an effect

Your effect will play automatically if your graph is connected properly. You'll see port values updated in real time.