Effects Interface

In Forest Pack 6 and onwards you'll find a revamped Effects rollout. Using this simple interface you can control the parameters of any effects loaded into the FP object. From here it is also possible to open the Effects Browser to load presets or open the Editor to create or edit effects. The interface comprises of three parts:

1 - The Effects Rollout

Use this interface to control effects parameters, and open the library and editor windows.

  1. The Effects List. Lists all of the effects in the current object. Select an effect to see it's properties
  2. Add Effect. Click this button to create a new empty effect.
  3. Delete Effect. Click this button to delete the selected effect. 
  4. The Effects Library. Click this button to open the Library and load pre-built effects.
  5. The Effects Editor. Click this button to open the Effects Editor used to create and edit effects scripts.
  6. On/Off. Use this checkbox to toggle all effects on or off.
  7. Effect Name. Used to name effects for easy identification
  8. Parameters List. This list contains all the user editable values in the loaded effects.
  9. Parameter Value. Used to enter a value for the parameter highlighted in the Parameters List.
  10. Parameter Help. Displays an explanation of the parameter highlighted in the Parameters List.
  11. Apply Only at Render Time. Activate this to apply the effect only at render time - this can speed up editing FP objects with complex processor intensive effects.

2 - The Effects Library

  1. Library Menu. A drop down list to Select the library. By default you have two libraries, the Default library for built in effects and a User's library for your own effects.
  2. Refresh. Click to refresh the effects navigator. This is usefully if you've made changes to the library manually in a file manager and you'd like to see these updates in the Effects Browser.
  3. Effects Navigator. Displays a tree view of your selected library
  4. Category. A category is a way of organising your effects. Categories can be nested.
  5. Effect. An individual .eff file. Click to see more information about the effect.
  6. Description. Shows a text description and instructions of the selected effect.
  7. Preview Image. A image to illustrate the selected effect
  8. Click for additional help. Click this button to go to online help for more information about the selected effect. For iToo effects this takes you to our documentation server.
  9. Load. Click this button to load the selected effect.
  10. Cancel. Click this button to close the Effects Browser without making any changes.

3 - The Effects Editor

Use the Effects Editor to author new effects.

  1. Command List. This 3 tabbed directory contains all the commands that are available to be used to create effects expressions. Click a command in this list one to show the help (5) or double click to insert the command at the current cursor point.
  2. Expression Window. Use this window to create and edit a new effect,
  3. Output Window. Shows the results of the expression, and any error or other system messages.
  4. Toolbar: Contains buttons to save, evaluate and manage effects. Includes the following buttons:
    1. Evaluate. Click to run the script in the expressions window.
    2. OK. Click to run the script in the expressions window and close the editor.
    3. Cancel. Close the editor without running or saving the script.
    4. Clear. Delete the contents of the Expression Windows.
    5. Data. Open the Additional Data Menu to add a name, description and thumbnail image (see below for more details).
    6. Import. Open an effects file (.eff) replacing the contents of the expressions window.
    7. Export. Save an effects file (.eff). 
  5. Help. Shows help and information for the item selected in the command list.

3.1 - The Parameters Tab

Use the Parameters tab in the Effects Editor to create variables whose values are assigned and edited from the Effects Rollout. 

  1. Parameters List. Contains all the parameters for this Forest object.
  2. Add new Numeric Parameter. Create a new Numeric Parameter. The value for this is edited in the Effects rollout.
  3. Add new Object Parameter. Create a new Object Parameter. Allows you to use the position of other objects in the scene to influence Forest's properties. Assigned from the the Effects rollout.
  4. Add new Controller Parameter. Create a new Controller Parameter. Allows you to use any other object's controller to influence Forest's properties. Assigned from the the Effects rollout.
  5. Add new Texture Parameter. Create a new Texture Parameter. Allows you to use any a map to influence Forest's properties. Assigned from the the Effects rollout.
  6. Add new Curve Parameter. Create a new Curve Parameter. Allows you to use a curve to influence Forest's properties. Assigned and edited from the the Effects rollout.
  7. Delete Parameter. Delete the item highlighted in the Parameters List.
  8. Properties Tab. Show the properties and attributes of the item highlighted in the Parameters List.
  9. Parameter Name. Name of the Parameter selected in the Parameters List.
  10. Parameter Type. Changes the type of value used for Numeric Parameters.
  11. Default Value. The default value used for Numeric Parameters.
  12. Limits. Limit the values that can be entered within the minimum and maximum values
  13. Description. This description can be viewed in the Effects rollout by clicking the Help button. Add instructions here to help explain an effects parameters for new users.

Additional Data menu

  1. Thumbnail. Displays a preview of the selected effect. The browser does not rescale images so it's recommended to save them in a size that's appropriate.
  2. Title. The name of the effect to be displayed in the Effects Navigator. If you leave this field blank the file name will be used.
  3. Description. Add additional information about the effect such as a description and instructions for use.
  4. Load. Click to select a preview image file in the format png, jpg, or xpm. The image is encoded in the .eff file so there's no need to include it if you share your files.
  5. Clear. Click to remove the current preview image.
  6. Additional Help (URL). Used to add a URL that can provide additional online help or information about the author.
  7. OK. Click OK to save changes to the effect and return to the browser.
  8. Cancel.Click Cancel to return to the browser without saving any changes.