UM:Appendix Effect Selector Configuration

From DigitalVision
Revision as of 11:28, 24 June 2014 by Alastair (talk | contribs) (Upload page Appendix_Effect_Selector_Configuration)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Darrow-up.png     Previous Next

Effect Selector Configuration

The Effect Selector is the drop-down list that displays all available effects. These can be selected and added to a segment on the current composition.

 

app-effect-selector1

 

The Effect Selector drop-down list.

app-effect-selector2

 

Interacting with the Effect Selector drop-down list and choosing an effect to add to the current composition.

 

Effects are placed within Effect Groups. Above, we see the group Colour containing the effects Channel Mixer, Saturation, SOP and other tools.

 

The order of the top-level effect groups, the effects within each group and the order the effects appear inside a group are controlled by configuration files.

Configuration Files

There are two possible configuration files.

 

One is the default configuration and exists in the application C:\Nucoda\2014_1\root. The other user file will override the defaults if you create it and place it in the same folder. By default, this user configuration file does not exist.

Default Configuration File

Name :

defaultEffectList.prefs

Location :

C:\Nucoda\2014_1\root

 

This is the main configuration file for the drop-down list and defines the effect groups and the effects that appear in each group by default.

 

dv_alert

Do not edit or modify this file. It will be over-written every application install. If you want to modify the effect selector, edit the userEffectList.prefs file.

User Configuration File

Name :

userEffectList.prefs

Location :

C:\Nucoda\2014_1\root

 

This file does not exist by default.

 

If it exists, it will over-ride the default settings in the defaultEffectList.prefs file.

 

dv_note

An example userEffectList.prefs file exists in the example_files folder.

Configuration File Format

A high-level overview of the file format is shown below :

 

effectList

[  

   // These effects appear in top-level

   effects "effect1" "effect2"

 

    // Multiple "GROUPS" allowed

   GROUP

   {

       // As displayed as menu name

       name "NAME"

       // As appearing in sub-menu

       effects "effect1" "effect2"

   }

 

    // Add more effects to top-level here

   effects "effect3" "effect4"

 

    // or false. Insert default effects?

   insertDefault true

 

    // Do not show these effects

   Hidden

   {

       effects "effectA" "effectB"

   }

]

 

dv_note

Note that the entire effectList content is wrapped in SQUARE ([,]) brackets.

 

effects

List effects to use (to display, or to hide).

 

Each is quoted and separated with spaces.
The effect names used are the "effect id". You can list all the "effect id"'s by running the application with the argument --effect-ids e.g.

 
cd \Program Files\Nucoda\2014_1\

nucoda_fuse.exe --effect-ids</br></br></br>

 

You can have multiple "effects" lines.
You can use multiple "effects" tags.
An "effects" tag at the top-level is displayed at the top-level of the Effect Selector. An "effects" tag in a GROUP is displayed within the named ("name") GROUP.

 

Example :

 

effects "Blur" "ChannelExtract" "Saturation"

 

GROUP

 

A GROUP groups a set of effects together as a unit with a "name".

 

The "name" will be displayed in the GUI.
The listed effects are given inside the "effects" tag within the GROUP.
You can have multiple GROUP sections.

 

Example :

 

MainEffects

{

 effects "Blur" "ChannelExtract" "Saturation"

}

insertDefault

 

This tag will insert the default effects list (in its entirety) where this tag is placed.

 

true - Insert the default effects list. The list inserted is as per the defaultEffectList.prefs file and inserted where this tag is placed.
false - Do not insert the default list of effects. This may have the effect of minimising and simplifying the effects list.

 

If "insertDefault" is omitted, this is equivalent of "insertDefault true" being added at the end.

 

Example :

 

insertDefault true

 

Hidden

Hide the effects set in the "effects" list given.

 

This means they do not appear anywhere in the Effect Selector, even if placed in a GROUP or a top-level "effects" list.
This means they cannot be added.

 

Example :

 

Hidden

{

 effects "FieldSwap" "LiftGammaGain"

}

 

Example Configuration

The example shown below will result in an Effect Selector drop-down that looks like :

 

   Channel Extract

   Saturation

   My Favourites >

       DVO Clarity

       DVO Grain

       DVO Regrain

   Balance

   Bob's favourites >

       DVO Dust+Fix

       DVO Fix

       DVO Flicker

app-effect-selector3

 

effectList

[

   effects "ChannelExtract" "Saturation"

 

   MyFavorites // This is a comment

   {

       name "My Favourites"

       effects "DvoClarity" "AGR4" "DvoRegrain"

   }

 

   effects "Balance" "Saturation"

 

   BobsFavorites

   {

       name "Bob's Favourites"

       effects "Dust+Fix" "Deblotch" "DvoDeflicker"

   }

 

   insertDefault false

 

   Hidden

   {

       effects "FieldDomCorrect" "FieldRemove" "FieldSwap"

   }

]

 

Darrow-up.png     Previous Next