ayon-core/openpype/hosts/aftereffects/api
Petr Kalis 83242487fd
AfterEffects: support for workfile template builder (#5163)
* OP-5661 - added new menu item to AE extension

* OP-5661 - added support for addPlaceholder into extension

* OP-5661 - fix broken abstract loader

In some cases discover couldn't recognize that base plugin is abstract. Handled properly

* OP-5661 - WIP of implementing workfile template builder

* OP-5661 - added route to add placeholder

* OP-5661 - added route to build workfile

* OP-5661 - refactored arguments

* OP-5661 - implemented build workfile operation

moved from wrong position

* OP-5661 - removed wrong base plugin

* OP-5661 - implemented update placeholder logic

* OP-5661 - fix update placeholder metadata

* OP-5661 - added Creator placeholder plugin

* OP-5661 - pre_create_data could be passed into Creator

This allow to modify `pre_create_data` before automatically creating an instance. (Useful for overridding defaults.)

* OP-5661 - implemented populate of Create placeholder

* OP-5661 - implemented import of template

* OP-5661 - fix to populate correct create placeholder

Implemented function to select item(s) by their id. (CreateRender expects selected composition.)

* OP-5661 - fix workfile builder schema to multiplatform path

Path should be separated by platform.

* OP-5661 - implemented adding loaded items instead of placeholders

* OP-5661 - add Create Placeholder plugin to dropdown

* OP-5661 - add templated workfile to Settings

* OP-5661 - fix to choose template file from multiplatform

* OP-5661 - added documentation
2023-06-27 10:58:55 +02:00
..
extension AfterEffects: support for workfile template builder (#5163) 2023-06-27 10:58:55 +02:00
__init__.py AfterEffects: set frame range and resolution (#4983) 2023-05-22 10:45:20 +02:00
extension.zxp AfterEffects: support for workfile template builder (#5163) 2023-06-27 10:58:55 +02:00
launch_logic.py AfterEffects: support for workfile template builder (#5163) 2023-06-27 10:58:55 +02:00
lib.py AfterEffects: set frame range and resolution (#4983) 2023-05-22 10:45:20 +02:00
panel.PNG moved implementation from avalon to openpype 2022-01-16 16:13:10 +01:00
panel_failure.PNG moved implementation from avalon to openpype 2022-01-16 16:13:10 +01:00
pipeline.py AfterEffects: support for workfile template builder (#5163) 2023-06-27 10:58:55 +02:00
plugin.py AfterEffects: support for workfile template builder (#5163) 2023-06-27 10:58:55 +02:00
README.md Small rename in readme 2022-01-17 11:24:37 +01:00
workfile_template_builder.py AfterEffects: support for workfile template builder (#5163) 2023-06-27 10:58:55 +02:00
ws_stub.py AfterEffects: support for workfile template builder (#5163) 2023-06-27 10:58:55 +02:00

AfterEffects Integration

Requirements: This extension requires use of Javascript engine, which is available since CC 16.0. Please check your File>Project Settings>Expressions>Expressions Engine

Setup

The After Effects integration requires two components to work; extension and server.

Extension

To install the extension download Extension Manager Command Line tool (ExManCmd).

ExManCmd /install {path to avalon-core}\avalon\photoshop\extension.zxp

OR download Anastasiys Extension Manager

Server

The easiest way to get the server and After Effects launch is with:

python -c ^"import avalon.photoshop;avalon.aftereffects.launch(""c:\Program Files\Adobe\Adobe After Effects 2020\Support Files\AfterFX.exe"")^"

avalon.aftereffects.launch launches the application and server, and also closes the server when After Effects exists.

Usage

The After Effects extension can be found under Window > Extensions > OpenPype. Once launched you should be presented with a panel like this:

Avalon Panel

Developing

Extension

When developing the extension you can load it unsigned.

When signing the extension you can use this guide.

ZXPSignCmd -selfSignedCert NA NA Avalon Avalon-After-Effects avalon extension.p12
ZXPSignCmd -sign {path to avalon-core}\avalon\aftereffects\extension {path to avalon-core}\avalon\aftereffects\extension.zxp extension.p12 avalon

Plugin Examples

These plugins were made with the polly config. To fully integrate and load, you will have to use this config and add image to the integration plugin.

Expected deployed extension location on default Windows: c:\Program Files (x86)\Common Files\Adobe\CEP\extensions\com.openpype.AE.panel

For easier debugging of Javascript: https://community.adobe.com/t5/download-install/adobe-extension-debuger-problem/td-p/10911704?page=1 Add (optional) --enable-blink-features=ShadowDOMV0,CustomElementsV0 when starting Chrome then localhost:8092

Or use Visual Studio Code https://medium.com/adobetech/extendscript-debugger-for-visual-studio-code-public-release-a2ff6161fa01

Resources