Eyeon:Script/Reference/Applications/Fusion/Classes/Fusion/NewComp
From VFXPedia
Contents |
Fusion : NewComp
Arguments
NewComp( locked, auto-close, hidden )
- locked (optional, boolean)
A true or false value to determine if the composition opens as locked, or unlocked. Defaults to false.
- auto-close (optional, boolean)
A true or false value to determine if the composition will close automatically when the script exits. Defaults to false.
- hidden (optional, boolean)
If this value is true, the comp will be created invisibly, and no UI will be available to the user. Defaults to false.
Returns
Composition Object.
Remarks
The NewComp function loads a blank new composition in Fusion. If the first argument is not provided, or is set as false then the composition opens normally (Unlocked). The user can manipulate the composition using the GUI. including changing controls, creating previews, and dialog boxes will display normally. If the argument is set to true, then the composition is loaded in Locked mode. Locked mode prevents the display of any dialog boxes, and the user cannot manipulate the composition directly through the GUI.
The second argument specifies if the composition should be closed or not when the script terminates. A value of true will cause the composition to close automatically when the script terminates.
The third argument is used to create a completely hidden and invisible comp. It can be manipulated and rendered normally by scripts, but not accessed by the user. This is similar to how background network renders are managed.
This function returns a handle to the newly created composition.
Requirements
- eyeonScript 5.0
- Fusion 5.0
Examples
fusion = Fusion("localhost")
-- creates a new composition and sets it to interactive mode
composition = fusion:NewComp()
composition:Close()
-- exactly as above - creates a style='font-size:composition in interactive mode composition = fusion:NewComp(False)
composition:Close()
-- creates a new composition and sets it to non-interactive mode
composition = fusion:NewComp(True)
composition:Close()
Tips for NewComp (edit)
EyeonTips:Script/Reference/Applications/Fusion/Classes/Fusion/NewComp
