OrangeFilter Designer

OrangeFilter Designer is a visual effect design tool specially provided for the OrangeFilter SDK running Windows. With this design tool, you can create new effect packages or modify the performance of existing effect packages and input these as materials for the OrangeFilter SDK. Specific adjustment parameters will vary according to different packages' actual effects. See specific parameter descriptions in the effect document.

Before using OrangeFilter Designer, it needs to be activated with Windows SN, which is provided at the time of purchase.

Introduction

• Create a new effect (and keep it open after creation) or open an existing effect.
• Adjust the effect's period of existence and set its common properties (cycle/no cycle, fade, etc.).
• Select an image to add effects to (camera capture, video input or picture input, used for effect preview).
• Add an effect package (refer to the sticker filters below) or modify filters (each filter represents an effect; the effect package is a collection of single or multiple filter effects).
• Adjust each filter's parameters (feel free to change the current filter's performance to achieve desired effects).
• Save and bundle the effect material package. The result can be used as input for the OrangeFilter SDK.

Note:

The effect package is a combination of multiple filter effects, each of which may be modified, deleted, or supplemented with a newly added filter. The final effect is the superposition of all the filter effects in an effect package (note that the order of filters may affect final performance and that order is adjustable).

Designer's Homepage Preview:

1. Create an Effect

On the Homepage, create a new effect by clicking the button on the Toolbar in the upper left corner or "File/New Effect" in the top Menu; you can also press Ctrl+N. A small window will appear:

In this window you can change the effect name and save path. Then click OK. An effect folder will be created:

2. Open an Effect

Once created, Designer opens the effect by default. You do not need to open it manually. To manually open an effect (.ofeffect file), click the button on the Toolbar or the "File/Open Effect" button in the Menu Bar; you can also press Ctrl+O.

With an effect already opened in Designer, you can choose "Effect Properties" > "Position" on the Homepage and open the effect's folder on your disk.

3. Set an Effect Cycle

On the Homepage, select "Effect Properties" (left side of the page by default) to set the effect cycle.

1. The default cycle is 1,000 ms loop playback.
2. Fade: The unit is a percentage. When checked, it indicates the percentage of cycle time over which the effect fades.

4. Play an Effect

1. Select a picture or video as input.
2. Select a camera as input.

Click the button on the Toolbar to turn on the camera. Click the button on the Toolbar to turn off the camera.

5. Add Filters to an Effect

1. Add a Filter

On the Homepage, click the button on the Toolbar or the "Filter/New LuaFilter" button in the Menu to create a new LuaFilter. A "Filter Name" page will appear:

Click "OK". The filter is added to the effect. As shown below, the added filter appears on the "Filter Timeline Editor" page. Click the filter and view its parameters on the "Filter Editor" page. The editor page in the example only shows the path configuration of the filter's Lua script (because there is no need to edit parameters for a newly created default filter).

To save the effect with added filters, click the button on the Toolbar or "File/Save Effect" in the Menu; you can also press Ctrl+S.

2. Filter Timeline Editor

If you have inserted multiple filters, they will queue in the "Filter Timeline Editor" from top to bottom in the order of their addition (rendering will follow the same sequence when multiple filters are added). When you right-click a filter in the "Filter Timeline Editor", the following page will appear.

Wherein,

• Up and Down: adjust filter sequence
• Delete: remove the selected filter
• Freeze: freeze the selected filter (no rendering)
• Copy: copy a filter
• Paste: paste a filter
• Rename: change a filter's name

6. Sticker Filter

The file for the sticker filter is "face3dplane.oflua".

1. Add a Sticker Filter to an Effect

You can replace a filter in your effect with our provided face3dplane sticker filter (create a new LuaFilter file in your effect [see "Add a filter" above], then replace it). Specific steps:

1. First, copy the "face3dplane.oflua" file to your effect folder:

2. In Designer's "Filter Editor", replace the original Lua script with the Lua script of the sticker filter. The steps are as follows:

As shown below, on the "Filter Timeline Editor" page, select the filter to be replaced. In the "Filter Editor", you can see this filter's configuration. Here, replacement refers to replacing the path of the Lua script mapping to this filter.

Click "Browse" and select the "face3dplane.oflua" option. Click OK. Now filter replacement is complete.

2. Edit a Sticker Filter

Sticker filter parameters on the "Filter Editor" page are as shown below:

Sticker filter editor parameter descriptions:

1. Trigger

   • Open Mouth Trigger: Effect triggers upon mouth opening (when checked).
   • Close Mouth Trigger: Effect triggers upon mouth closing (when checked).
   • Open Mouth Threshold: mouth opening threshold sensitivity.
   • Triggers for mouth opening and mouth closing are both checked by default.

2. Position settings

   • Size: sticker size.
   • TranslateX: Move sticker along X-axis.
   • TranslateY: Move sticker along Y-axis.
   • TranslateZ: Move sticker along Z-axis.
   • Rotate: Set the rotation angle of the sticker in the Z direction (unit: degree).
   • Fixed Rotate X: Rotation of the X-axis is fixed (when checked).
   • Fixed Rotate Y: Rotation of the Y-axis is fixed (when checked).
   • Fixed Rotate Z: Rotation of the Z-axis is fixed (when checked).

3. Animation file

   • Svga: svga animation file
   • Images: sequence frame animation file
   • Note: You may only select one among svga animation and sequence frame animation. If both selected, the svga animation will be used.

4. Other effect settings

   • Blend Mode: Set sticker fusion mode.
   • Opacity: Set sticker transparency (as a percentage).
   • Time Interval: Set the frame interval (in ms) of sticker animation.
   • Hold On: Sticker animation is rendered to the middle if no face is detected (when checked).

7. Bundle Effects

Once you have designed all your effects, you can bundle them up (remember to save the effects). To bundle effects, click the button on the Toolbar or "Release/Pack-Up" in the Menu. The bundling page is shown below.

You can set package name and save path, leaving other settings unchanged. Click the "Bundle" button. Effects are now packaged together.