本文指导插件开发人员学习如何使用 Animate CC 2014.2 创建支持自定义平台的 Animate 插件。如果您使用的是 Animate CC 2014.1(2014 年 10 月更新版),请参阅本档之前的版本。
若想构建自定义平台支持插件,开发人员必须从以下位置下载自定义平台支持开发工具包:
下载
从以下位置下载一个样例插件,将其用作构建自定义平台支持插件的参考:
下载
插件由以下几个元素构成:
- DocType:它将在 Animate 中为自定义平台添加一个新的文档类型并控制创作功能。
- Publisher(发布程序):它允许配置发布设置并将文档发布到自定义平台。
有关自定义平台支持功能的概略介绍,请参阅自定义平台支持。
Animate CC 2015 的新增功能:
- 可以查询库元件类型:对于元件,ILibraryItem::GetProperties() 将具有一个额外的条目,键为 kLibProp_SymbolType_DictKey。键值可以是 kLibProp_SymbolType_Button、kLibProp_SymbolType_MovieClip 或 kLibProp_SymbolType_Graphic。
- 可以区分按钮与影片剪辑:直至前一发行版,DOM 和 IFrameCommandGenerator 服务都是将按钮实例视为影片剪辑。从 Animate CC 2015 开始,添加了一个接口,可以支持按钮实例了。如果 IMovieClip 实例还实现 IButton 接口,它就会被视为按钮实例。按钮的四种状态,即 Up、Over、Down 及 Hit 将始终相应映射为帧 0、1、2 和 3。可参见 IButton.h 文件了解有关按钮实例的更多信息。
- 新增一个用于获取 IClassicText 对象边界的 API:ITimelineBuilder 接口中的 AddClassicText 函数如今返回 CLASSIC_TEXT_INFO_2(不是原来的 CLASSIC_TEXT_INFO)的一个对象,它包含一个新的字段“bounds”,表示 IClassicText 对象的边界。
- 样例插件经过改进后,可以重复使用形状填充所用的位图。
- 将 Mongoose Web 服务器集成到了样例插件中。
注意:Animate CC 2015 发行版提供的新 IK 骨骼工具对于自定义平台文档类型无效。Animate 将 IK 内容粘贴到自定义平台文档中时,会将其转换为逐帧动画。
2015 年 2 月份更新:IFrameCommandGenerator 服务中的“遮罩”支持--此发行版在 IFrameCommandGenerator 服务中支持“遮罩”。新的接口 ITimelineBuilder2 继承自原有的 ITimelineBuilder 接口,它包含有插件必须实施才能使此功能有效的函数。 请参阅自定义平台支持 API 文档,了解有关新接口 ITimelineBuilder2 的更多信息。
构建 Animate 自定义平台支持插件
可以使用以下一种方法来开发自定义平台支持插件:
- 使用自定义平台支持开发工具包中的 API 创建一个插件。
- 对开发工具包中附带的样例插件的设置进行定制,以满足自己的需求。
自定义平台支持插件打包为 .zxp 文件,这种文件可以使用 Animate 来安装。您可以将插件在 Adobe Add-ons 页面上进行托管,以供用户下载并使用 Creative Cloud 应用程序进行安装,也可以将插件作为 .zxp 包来分发,然后使用 Adobe Extensions Manager 安装插件。
软件要求
要使用自定义平台支持开发工具包构建插件,开发人员需要以下软件:
- Microsoft Windows 7 或更高版本,或者是 Apple Mac OS 10.8 或更高版本
- Microsoft Visual Studio 2012 (Windows) 或 XCode 4.5.2 (Mac)
- Animate CC 2014.1 和更高版本
- Eclipse IDE for C/C++ Developers
- Adobe Extension Builder 3.0
- Adobe Extension Manager 7.2.1.6
供插件开发人员阅读的 API 参考文档
自定义平台支持开发工具包包含以下元素:
- FCM(Flash 组件模型):包含在开发工具包中的标头文件,用于定义一个名为 FCM 的框架,该框架负责插件的管理。
- DocType:包含一组接口,可帮助您向 Animate 开始页面中添加一个新的文档类型,并允许您启用或禁用用于自定义文档类型的各项功能。
- DOM(文档对象模型):包含一组接口,可帮助您以 DOM 的形式访问 Animate 文档的内容。
- 发布程序:包含一组接口,用于向发布工作流提供钩子程序。
有关自定义平台支持 API 的完整信息和如何使用它们来构建自己插件的示例,请参阅自定义平台支持 API 参考。
创建自定义平台支持插件
可按如下方式创建自定义平台支持插件:
- 下载自定义平台支持开发工具包。
- 将工具包的内容提取到计算机。
- 在 VisualStudio 或 Xcode 中打开一个新项目,然后将开发工具包中的标头文件包括到您的软件开发项目中。若想快速开始创建您的自定义平台支持插件,可以使用以下样例插件(在 SampleCreateJSPlatform 目录下提供)作为您插件项目的基础代码。
- 针对您的目标平台进行必要的更改。
- 编译代码以生成一个插件(.dll 或 .plug-in)。
例如,SampleCreateJS 插件文件位于 SampleCreateJSPlatform\Plugin\SampleCreateJS\project\ 下
包装自定义平台支持插件
可按如下方式生成一个自定义平台支持插件的可分发包:
- 打开 Eclipse 样例文件或在 Eclipse New Project(新建项目)向导中,创建一个新的应用程序扩展项目。为该项目提供一个名称,然后单击 Next(下一步)。
- 在 New Adobe Application Extension Project(新建 Adobe 应用程序扩展项目)面板中,选择 Adobe Animate 作为目标应用程序,然后单击 Next(下一步)。
- 将所创建的插件文件的扩展名由 .dll 改为 .fcm (Windows) 或由 .plug-in 改为 .fcm.plug-in (Mac),然后将插件文件添加到项目中(在 Windows 中为 ExtensionContent/plugins/lib/win,在 MAC 中为ExtensionContent/plugins/lib/mac)。
- 通过修改 manifest.xml 配置扩展名。 要打开 manifest 文件,可在项目管理器中右键单击该扩展,选择 Adobe Extension Builder 3 > Bundle Manifest Editor,然后在 Bundle Manifest Editor 中选择 manifest 选项卡(位于 EclipseProject\.staged-extension\CSXS)。
- 要编辑 manifest.xml,可在窗口内部右键单击鼠标,然后选择 Open with(打开方式)> XML editor(XML 编辑器)。必须注意这两个标记:ExtensionList 和 DispatchInfoList:
典型的 ExtensionList 标记如下所示:
<ExtensionList> <Extension Id="PluginID" Version="1.0" /> <Extension Id="PublishSettingsID" Version-"1.0" /> </ExtensionList>
该标记包含最终 ZXP 包中的扩展列表,包中的每个扩展都有一个唯一的字符串作为其 ID。这时,在前一部分中创建的 .dll 或 .plugin 文件会包括在一个扩展中。然后,其他扩展用于配置发布者的发布设置 UI。在 ExtensionList 标记示例中,扩展 ID 为 PluginID 的扩展包含 .dll/.plugin 文件,扩展 ID 为 PublishSettingsID 的扩展用于配置发布者的发布设置 UI。
- DispatchInfoList 标记包含 ExtensionList 中涉及的每个扩展的详细信息。以下是 DispatchInfoList 的一个例子:
<DispatchInfoList> <Extension Id="PluginID"> <DispatchInfo > <Resources> <MainPath>./plugin/fcm.xml</MainPath> </Resources> <Lifecycle> <AutoVisible>true</AutoVisible> </Lifecycle> <UI> <Type>ModalDialog</Type> <Menu>CreateJS</Menu> <Geometry> <Size> <Height>200</Height> <Width>200</Width> </Size> </Geometry> </UI> </DispatchInfo> </Extension> <Extension Id="PublishSettingsID"> <DispatchInfo > <Resources> <MainPath>./index.html</MainPath> </Resources> <Lifecycle> <AutoVisible>true</AutoVisible> </Lifecycle> <UI> <Type>ModalDialog</Type> <Menu>Publish Settings</Menu> <Geometry> <Size> <Height>170</Height> <Width>486</Width> </Size> </Geometry> </UI> </DispatchInfo> </Extension> </DispatchInfoList>
- 对于包含 .dll 或 .plugin 文件的扩展,除 MainPath 标记外,您可以忽略所有标记。MainPath 标记包含文件 fcm.xml 相对于 ExtensionContent 文件夹的路径。必须将 .dll 文件重命名为 .fcm,并将其放在 win 文件夹内部 fcm.xml 的旁边。同样,如果是处在 Mac 环境中,则将 .plugin 文件重命名为 .fcm.plugin,并将其放在 mac 文件夹内部 fcm.xml 的旁边。
- 用来配置发布设置用户界面的 HTML 扩展是一个针对 Animate 的 HTML 扩展。若想了解有关 Animate 的 HTML 扩展的更多信息,请参阅创建 HTML 扩展。
- 确保 Host 标记中 version 属性的最低值为 14.1,这是具有自定义平台支持的 Animate 的最低(内部)版本。
<ExecutionEnvironment> <HostList> <Host Name="FLPR" Version="15.0" /> </HostList>. . . </ExecutionEnvironment>
- 切换到 Script Explorer 视图,右键单击项目并选择 Export(导出)> Adobe Extension Builder 3 > Application Extension(应用程序扩展)。将显示 Export Wizard(导出向导)。
- 您必须具有证书才能对扩展包进行签名。浏览到现有证书,或单击 Create(创建),创建一个新的证书。
- 单击 Finish(完成)编译项目。Eclipse 将生成一个扩展名为 .zxp 的插件文件,您可以将其托管在 Adobe Add-ons 网站上。
分发自定义平台支持插件
您可以通过将自定义平台支持插件托管到 Adobe Add-ons 页面然后标价的方式来分发插件。您的插件包要经过 Adobe 的审核和批准过程才能列出在页面中。可以按如下方式托管插件:
- 使用您的 Adobe ID 和密码登录到 Adobe add-ons 页面。
- 在左面板的 Become a producer(成为一名生产者)下,单击链接 Go to the producer portal(转至生产者入口)。
- 如果未作为生产者注册,可单击注册按钮。
- 有关如何作为生产者注册并托管插件的详细说明,请参阅生产者入口快速入门。
- 按照快速入门页面中的生产者入口工作流说明完成以下步骤:
- 将产品打包在一个单独的文件中。
- 输入产品的有关信息并上传该文件。
- 添加市场资源。
- 预览您的产品。
- 提交您的产品以进行审批。
- 批准之后,您的插件便会列在附加组件页面中的 Animate 产品类别下。
- 如果您是一名想安装插件、创建自定义平台文档、使用 Animate 发布插件的用户,请参阅使用自定义平台支持插件。
- 有关管理 Adobe 扩展的完整信息,请参阅下载并安装扩展。
功能需求与错误报告
若想向 Animate 产品小组发送任何问题、疑惑、产品错误或功能需求,可填写以下表单: