APEX Scriptは、APEXグラフを構築するためのコードインターフェースです。 Pythonライクな構文を使用して、コードロジックを表現したグラフを生成することができます。 APEX Scriptスニペットは、APEX Script SOP内で記述することができます。 そのAPEX Script SOPは入力を受け取り、コードスニペットを実行し、その結果を出力します。 APEX Autorig Component SOPにも、APEX Scriptスニペットを記述するためのインターフェースが用意されています。

APEX Scriptスニペットは、APEXグラフとして直接的に表現されます。 APEX Scriptコードを入力すると、そのグラフ表現がAPEXネットワークビューで生成されるのを確認することができます:

APEX Scriptは、新しいグラフを構築したり、既存のグラフを修正したり、グラフデータを取得するためのツールとして使用することができます。 詳細は、以下のページを参照してください:

• グラフの扱い方では、APEX Scriptを使用してグラフ要素にアクセスおよび操作する方法、グラフロジックを別のグラフに直接追加する方法、グラフ内から他のグラフを呼び出す方法を説明しています。

• コードスニペット内ではAPEX Scriptの関数を独自に作成したり、ビルトインのAPEX関数を使用することができます。

• APEX Scriptを使用することで、グラフ用のインターフェースを作成してカスタマイズすることができます。

• APEX Script言語リファレンスでは、APEX Scriptの構文および言語要素(用意されている型、演算、ステートメントなど)を説明しています。

APEX Scriptでは、BindInput()はグラフの入力を定義する特殊関数です。 BindInput()関数は、グラフ入力を表現したポートを持つparmsノードを作成します。 BindOutput()関数は、グラフ出力を定義し、グラフから出力される値を表現したポートを持つoutputノードを作成します。

この例では、入力として値を受け取り、同じ値を出力するAPEX Scriptスニペットを記述します:

1. 以下のスニペットを、APEX Script SOPの Snippet パラメータに配置します:

   a = BindInput(3.5)
   
   BindOutput(a)
   

2. グラフとして表現されたAPEX Scriptスニペットを確認するために、APEXネットワークビューを開きます。 ペインの上部で New Tabアイコンをクリックして、 New Pane Tab Type ▸ Animation ▸ APEX Network View を選択します。

3. APEX Script SOPの Visualizer セクションで、 Show を Component Script に設定します。

   

この例では、APEX Scriptを使用して単一のTransformObjectノードを含む新規グラフを作成します:

1. APEX Script SOPで、 Snippet パラメータに以下のコードを追加します:

   # グラフを初期化します
   graph = ApexGraphHandle()
   
   # 新しいグラフにTransformObjectノードを追加します
   graph.addNode('test_a', 'TransformObject')
   
   # グラフをジオメトリとして書き出します
   geo = graph.saveToGeometry()
   BindOutput(geo)
   

2. APEXネットワークビューでAPEX Scriptスニペットのグラフ表現を確認します。APEX Script SOPの Visualizer セクションで、 Show を Component Script に設定します:

   

3. ジオメトリとしてグラフを出力するには、 Bind Output Geometry を<output_node>:<output_port>に設定します。この場合は、output:geoです。

4. APEX Scriptスニペットによって作成された新しいグラフを確認するには:

   • APEX Script SOPの Visualizer セクションで、 Show を Output 1 に設定します。

     または

   • APEX Script SOPの1番目の出力をNull SOPに接続し、Null SOPを選択します。

     

この例では、APEX Scriptを使用して既存のグラフにTransformObjectノードを追加します:

1. APEX Graph SOPで、入力ノードと出力ノードのみを含むグラフを作成します:

   

2. グラフを入力としてAPEX Script SOPに接続します:

   

3. APEX Script SOPで、定義済みのヘッダを使用して、入力グラフを受け取って修正するAPEX Scriptコマンドを自動的に追加します:

   • Header パラメータをオンにします。

   • Header セクションで、 Template を Graph に設定します。すると、以下のコードがAPEX Scriptスニペットの先頭と末尾に追加されます:

     ヘッダ

     geo: Geometry = BindInput()
     graph = geo.loadFromGeo()
     

     フッタ

     geo = graph.saveToGeometry()
     BindOutput(geo)
     

4. APEX Script SOPの入力を指定します。 Invocation セクションの Input1 Bindings で、 Bind To Geometry Parameter をオンにして、そのパラメータをgeoに設定します。 geoは、APEX Script SOPに入力されるグラフジオメトリで、前の手順のヘッダで指定されています。

5. 更新されたグラフを出力するには、 Bind Output Geometry をoutput:geoに設定します。

6. APEX Script SOPは入力グラフを受け取り、それを変更せずに出力するようになりました。 APEX Script SOPによって出力されるグラフを確認するには:

   • APEX Script SOPの Visualizer セクションで、 Show を Output 1 に設定します。

     または

   • APEX Script SOPの1番目の出力をNull SOPに接続し、Null SOPを選択します。

7. TransformObjectノードを入力グラフに追加するには、以下のコードを Snippet パラメータに配置します:

   graph.addNode('test_a', 'TransformObject')