Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
parameter_properties_and_mappings [2013/02/26 22:19]
gds [Properties]
parameter_properties_and_mappings [2013/08/22 21:09] (current)
Line 13: Line 13:
 The **Animatable via keyframes** option lets you decide whether the user should be allowed to animate the parameter via keyframes. This option is available only if the parameter expresses values that may be animated. The **Animatable via keyframes** option lets you decide whether the user should be allowed to animate the parameter via keyframes. This option is available only if the parameter expresses values that may be animated.
  
-The **Display in parameter inspector** option lets you control whether the parameter ​will appear, by default, ​inside the parameter inspector of all hosts.\\ The visibility of a parameter can be further ​specified with per-host settings (**...and in Final Cut Pro**, **...and in Motion**, etc.) and via [[dynamic_ui|dynamic parameter UI]].\\ Although dynamic UI settings can override the initial visibility of a parameter, it is important to notice that dynamic UI settings //cannot// override per-host settings. For example, if the option **...and in After Effects** is disabled, the parameter will never be available in After Effects whether or not the dyamic UI conditions are met.+The **Display in parameter inspector** option lets you control whether the parameter ​appears ​inside the parameter inspector of all supported video applications.\\ The visibility of a parameter can be further ​determined by per-host settings (read below for more information) and via [[dynamic_ui|dynamic parameter UI]].
  
 Per-host visibility is based on the //video application//​ that is hosting your plug-in, and not on the underlying library used by the video application to load the plug-in. This remark will sound confusing until you remember that Final Cut Pro X, Motion 5 and Compressor all use a common "​Motion engine"​ to render effects. Per-host visibility is based on the //video application//​ that is hosting your plug-in, and not on the underlying library used by the video application to load the plug-in. This remark will sound confusing until you remember that Final Cut Pro X, Motion 5 and Compressor all use a common "​Motion engine"​ to render effects.
 +
 +Although dynamic UI settings can override the initial visibility of a parameter, it is important to notice that dynamic UI settings //cannot// override per-host settings. For example, if the option **...and in After Effects** is disabled, the parameter will never be available in After Effects whether or not the dyamic UI conditions are met.
  
 The **...and in Motion'​s HUD** option lets you designate the parameter to be displayed both in the parameter inspector and in a separate overlay window, the HUD. Motion is the only host that sports a HUD window. Only certain parameter types, such as sliders, angles and popup menus, can be displayed in the HUD.  The **...and in Motion'​s HUD** option lets you designate the parameter to be displayed both in the parameter inspector and in a separate overlay window, the HUD. Motion is the only host that sports a HUD window. Only certain parameter types, such as sliders, angles and popup menus, can be displayed in the HUD. 
Line 36: Line 38:
 Suppose, for example, that in the initial revisions of your plug-in you forgot to disable this option for certain ​ parameters. This would mean that a value was in fact saved to preset files.\\ Suppose, for example, that in the initial revisions of your plug-in you forgot to disable this option for certain ​ parameters. This would mean that a value was in fact saved to preset files.\\
 Later on, when you realize your mistake, you can still disable this option to exclude the parameter from being saved to (or read from) presets. Later on, when you realize your mistake, you can still disable this option to exclude the parameter from being saved to (or read from) presets.
- 
 ==== Mappings ==== ==== Mappings ====
  
Trace: