チュートリアル 1: VRED Python インタフェースの概要

ビデオのキャプション: VRED Pro の Python スクリプト作成に関する新しいチュートリアル シリーズへようこそ。Christopher といいます。3D グラフィックス専門のソフトウェア エンジニアとして、3D ソフトウェアのプラグインとワークフローを開発しています。次に示す 12 個のビデオでは、VRED Pro が提供する Python インタフェースの概要を示し、Python スクリプトを使用して VRED 用のツール、モジュール、プラグインを記述する方法を紹介します。また、API バージョン 2 で新しいサービスを使用する方法と、新しいデータ タイプを活用する方法について説明します。

これは、Python のコーディングに関するチュートリアルではありません。そのため、今すぐ作業を開始する場合は、これらのビデオを見ても Python 言語について詳細に学習することはできません。ただし、ユーザが Python 開発者のプロフェッショナルになれるようサポートする優れたチュートリアルやコースが多数用意されています。このチュートリアルでは代わりに、優れた価値あるツールを開発するために組み合わせることができる、高度な概念とベスト プラクティスについて説明します。皆さんは、Python スクリプトを使用して目標を実現する方法について深く理解することができます。

この最初のチュートリアルでは、Python スクリプトの可能性と開始方法についての概要を示します。また、サンプル スクリプトとこれらの機能の使用方法を紹介します。最後に、ドキュメントを効率的に使用する方法を紹介します。VRED の主な目的は 3D レンダリングですが、それ以外にも多くの機能が用意されています。特にバリアント セットを使用すると、さまざまなアクションのスクリプトを作成して、自動化することができます。VR ツールが実装されている場合は、基本的に、リモート VR コラボレーションの設定は既に行われています。

VRED でスクリプトの作成を開始するのに、Python を使用する理由について考えてみましょう。VRED には大規模な API が用意されており、皆さんは提供されているすべての機能にアクセスできます。また、すべてのデータにアクセスして、必要なデータを操作できます。Python は基本的に、これらのすべての可能性を解き放つためのツールです。皆さんはターミナルで操作を行い、関数を試して、シーンがどのように変更されるのかを確認できます。また、バリアント セットがトリガされたときに実行される小規模なスクリプトとバリアント セットをインストールしたり、スクリプト エディタで複雑なスクリプトを記述することもできます。カスタム インタフェースを備えたプラグインを開発することで、基本的に VRED の操作方法全体を変更し、ブラグインを同僚と共有することができます。また、CAD データを準備できる自動レンダリング パイプラインやデータ準備パイプラインを構築することもできます。可能性はほぼ無限に広がっています。理解しなければならないことが多いと思われるかもしれませんが、心配しないでください。これらの可能性については、いくつかのチュートリアルで説明します。VRED の Python インタフェースに関する概要、および使用方法については段階的に紹介します。

いつになったら Python ですべての操作を実行できるようになるのか、あるいはどこから始めたらよいのか、疑問に思われるかもしれません。VRED を開くと、メニュー バーの[ファイル]に、あらゆる種類のサンプルを開始するための入り口が用意されています。ここには、あらゆる種類のトピックに対応する Python サンプル スクリプトが多数配置されています。たとえば、シーンプレートの作成方法や操作方法、スクリプト プラグインの記述方法、VRED でカスタム メニューを統合する方法に関するスクリプトを見つけることができます。このサンプルでは、オブジェクトのトランスフォーム コンストレイントを作成する方法を示します。サンプルを開くと、いくつかのジオメトリ プリミティブと、シーンプレートとして追加されたテキストが表示されます。たとえば、[C]キーを押して赤い球などを移動すると、すべてのオブジェクトが何らかの方法で接続されていることがわかります。

Python の魔法のような機能は、スクリプト エディタで行われます。ここに、この動作を行うすべてのコードが示されています。このコードは、シーンを開くと自動的に実行されます。ほとんどのサンプル スクリプトでは、スクリプト エディタに独自のコードが追加されています。そのため、これらのサンプルの一部だけ見ることをお勧めします。これらのツールを試して、何が起きているのかを理解してください。サンプルを調べる際に、不明な関数およびモジュールをドキュメントで確認することができます。これらのサンプルは VRED の Web サイトで入手することもできます。このサイトには学習に役立つリソースも多数用意されており、説明の中にリンクが追加されています。これらのサンプル スクリプトを参照すると、vrnodeservice や createaimconstraint のように、馴染みのない多くの識別子があります。

VRED を操作する場合は、これらの識別子(正確に言えば、モジュール、クラス、および関数)を使用して、VRED に実行する機能を伝える必要があります。識別子の名前を見れば、想定されている動作がわかりますが、正しい関数を自分で見つけるにはどうしたらよいでしょうか。そのためには、ソフトウェア開発において比較的退屈な部分である、ドキュメントを確認して理解するという作業が必要になります。VRED Python マニュアルには、スクリプトを記述するときに使用できるすべてのモジュール、クラス、関数が含まれています。

ドキュメントにアクセスするには、メニュー バーの[ヘルプ] > [Python マニュアル]を選択します。ドキュメントは、古い API バージョン 1 のドキュメントと新しい API バージョン 2 のドキュメントの 2 つの部分に分かれています。VRED 用の Python スクリプトを開発する上で最も重要なスキルは、達成したい結果に合った機能へのアクセス方法を特定することです。API バージョン 1 では、ページの左側メニューにある[すべて]リンクをクリックして関数を検索できます。このドキュメントに記載されているすべての関数を含むリストが開きます。ここで、ブラウザの[Ctrl]+[F]を使用して全文検索を実行できます。たとえば、マテリアルを作成する場合は、「create」または「creatematerial」を検索してから、検索結果を確認します。これらの関数の中の 1 つをクリックすると、その関数のドキュメントに直接移動できます。

API バージョン 2 では、検索ページに移動してキーワードを検索できます。結果ページには多数の例が表示されますが、検索語句を含むモジュールとクラスも表示されます。VRED モジュールとクラスは、常に「vr」または「vrd」で始まります。これらのページを開いたら、全文検索を続けることができます。

VRED にはフォーラムもあり、そこで回答を見つけたり、質問を投稿したりできます。コミュニティの参加者からのサポートは実に手厚く、多数の便利な回答の中から検索することができます。質問する前に、問題に対する既存の回答があるか確認してください。既存の回答には緑色のチェック マークが付いています。コミュニティのほかに、オートデスクのスタッフも積極的に活動していて、可能な範囲でサポートを提供しています。

VRED で Python スクリプトを作成する方法は、独自のツールを構築し、必要に応じて機能を拡張する場合に便利です。このシリーズの各チュートリアルでは、VRED で Python スクリプトを作成する場合に絞って説明します。内容をすべて確認するようにしてください。これで、Python を使用したスクリプト作成の概要は終了です。この最初のチュートリアルに参加していただき、ありがとうございました。次のビデオでもう一度お会いしましょう。