エディタを拡張する

Stingray エディタに新しいコンテンツ オーサリング ツールおよびワークフローを追加するプラグインを記述できます。オートデスクの目標は、文字どおりすべてのプロジェクト編集作業に対応できるように、エディタのプラグイン システムを柔軟にすることです。この目標にはまだ到達していませんが、このフレームワークでは既に優れた操作を実行できます。エディタに新しい機能を追加する場合は、他のユーザ コミュニティと作業を共有すること、および自分の体験に関するフィードバックを以下の URL でオートデスクと共有することを検討してください。

このセクションでは、独自のプラグインでエディタを拡張するためのヒントをいくつか示します。

http://www.autodesk.com/stingray-forums

スタートアップ

  1. Stingray エディタのほとんどのウィジェットとパネルは、自分で作成できるウィジェットやパネルと同様に、プラグインで作成されています。これらの .stingray_plugin 記述ファイルや、その他のすべての JavaScript ファイルとその従属リソースは、Stingray インストール フォルダ内の editor/plugins フォルダに格納されています。独自のプラグインを作成するときに、この豊富な作業例を参考にして描画することができます。Stingray インストール内のこれらの格納場所の詳細については、「サンプル プラグイン」を参照してください。

  2. まず、プラグインに設定できる「拡張機能」について理解を深めましょう。これらの拡張機能は、プラグインとエディタ間の統合ポイント、つまりエディタ内のプラグインのフック方法を定義します。プラグインで必要な機能の実現方法を特定するには、エディタでサポートされている拡張機能を把握する必要があります。詳細については、「拡張機能を使用してプラグインの動作を定義する」に記載されている各拡張機能の詳しい説明を参照してください。

  3. Stingray エディタは大半が JavaScript で記述されていて、独自の JavaScript コードを使用環境内で実行する方法がいくつか用意されています。このコードを実行すると、広範な JavaScript サービス、およびこの環境内で使用可能なその他のユーティリティを呼び出すことができます。

    エディタの JavaScript 環境内でのプログラミングの詳細については、「プラグインの開発に関するヒント」および「組み込みのエディタ サービスを使用する」を参照してください。

  4. 多くのプラグインでは、エディタ内で作業しているユーザが操作するための UI をいくつか作成する必要があります。エディタの拡張機能を使用すると、JavaScript モジュールでデータおよび相互作用がコントロールされる HTML パネルを比較的簡単に設定することができます。このパネルは希望どおりに設定できます。Web フロントエンド開発フレームワークを使用してページ UI 間のバインディングを設定することに慣れているユーザは、好みの技術を使用することができます。

    Stingray エディタのパネルおよびビューには通常、Mithril が使用され、場合によっては Angular.js が使用されることもあります。独自プラグインを作成する際は可能な限り Mithril を使用することを強くお勧めします。Mithril の場合は、既存プラグインから自由に利用できるからです。また、editor/core/components フォルダ内にある共有 UI ウィジェットを再利用することもできます。