Modulate

Intro

Output repeating sequences of numbers using the modulus function.

UI

Common Attributes +

Mode:

• Remainder - Create a sequence based on a Divisor value.
• Pass /Fail - Create a sequence based on whether the remainder is 0 (pass) or not (fail).
• Custom Pattern - Create a custom sequence.

Divisor - Setting a value of n will create a sequence of numbers from 0:n-1. e.g. a value of 3 will create a sequence of 0,1,2,0,1,2,0... (see below).

Index Offset - Offset the order of the pattern. e.g. if the pattern is 0, 1, 2, 0, 1, 2... an Index Offset of 1 will result in 1, 2, 0, 1, 2, 0...

Offset - Offset the start value. e.g. if the pattern is 0, 1, 2, 0, 1, 2... an Offset of 2 will result in 2, 3, 4, 2, 3, 4...

Pass Value - When the remainder is 0, output this value.

Fail Value - When the remainder is not 0, output this value.

Custom Pattern - Enter a pattern of values separated by commas.

Example (Remainder)

1. Create 3 Basic Shapes (circle, rectangle, polygon).
2. With all 3 Shapes selected, click the Duplicator icon in the Shelf.
3. Set Count to x = 5, y = 5 on the Duplicator.
4. Create a Modulate.
5. Set Divisor to 3.
6. Connect modulate.id→duplicator.shapeId.

With a Divisor of 3 Modulate is outputting values of 0, 1, 2, 0, 1, 2, 0... so the Duplicator outputs circle, rectangle, polygon, circle, rectangle, polygon, circle... (depending on the order they were added).

Example (Pass/ Fail)

1. Create a Basic Shape.
2. With the Shape selected, click the Duplicator icon in the Shelf.
3. Set the Distribution to Linear on the Duplicator.
4. Set Count to 9 and Size to 900.
5. Create a Color Array.
6. Add a second index and set a different color.
7. Connect colorArray.id→basicShape.FillColor.
8. Create a Modulate Behaviour.
9. Set Mode to Pass/ Fail.
10. Set Divisor to 3.
11. Connect modulate.id→colorArray.index.

The resulting sequence is 0,1,1,0,1,1,0... (see below for the math). If the Pass Value = 0 and Fail Value = 1 then that translates to pass, fail, fail, pass, fail, fail, pass... If the colors on the Color Array are red and green the resulting sequence of colors will then be red, green, green, red, green, green, red, green...

info

The Remainder and Pass/ Fail modes use Modular Math.

Here we're dividing a number using a Divisor of 3. Observe what happens to the remainder value as the number increments by one.

• $0 \div 3 = 0$ remainder 0
• $1 \div 3 = 0$ remainder 1
• $2 \div 3 = 0$ remainder 2
• $3 \div 3 = 1$ remainder 0
• $4 \div 3 = 1$ remainder 1
• $5 \div 3 = 1$ remainder 2
• $6 \div 3 = 2$ remainder 0
• ...

The remainders start at 0 and increase by 1 each time until the number reaches one less than the Divisor. After that, the sequence repeats. So to create the sequence 0,1,2,3,0,1,2,3,... a Divisor of 4 is required.