はじめてのBlenderアドオン開発

Last Update: 2021.12.23

Blender 2.8~3.0

はじめてのBlenderアドオン開発

Blender 2.8~3.0

Last Update: 2021.12.23

4-1. Blenderが提供するAPIを調べる

2章3章 で紹介したサンプルアドオンでは、Blenderが提供するさまざまなAPIが使われていました。 サンプルアドオンで利用したAPIは、どのように見つけたのでしょうか? また、サンプルアドオンで紹介していないその他のAPIは、どのように調べたらよいのでしょうか? 本節ではこの疑問に答えるため、Blenderが提供するAPIについて調べる方法を紹介します。

Blenderが提供するAPIの情報源

Blenderが提供するAPIの情報を収集する主な方法としては、次の方法があります。

Blender公式のAPIリファレンスを読む

Blenderの情報を収集するのであれば、やはり公式のAPIリファレンス(https://docs.blender.org/api/)が一番信頼性があり、おすすめです。

Blenderは、過去のBlenderのバージョン含めたすべてのバージョンのAPIについて、リファレンスとして公開しています。 Blenderのバージョンに応じて提供されるAPIが変わるため、対象とするバージョンのドキュメントを参照する必要があります。 例えば、Blenderのバージョンが2.80のAPIドキュメントは、https://docs.blender.org/api/2.80/) から参照できます。

仮に bpy.context で提供されているAPIを調べたい場合は、左側のメニューより [APPLICATION MODULES] > [Context Access (bpy.context)] のページ(https://docs.blender.org/api/2.80/bpy.context.html)を開くとよいでしょう。

BlenderからAPIリファレンスへ移動する

Blenderの機能に対応したAPIのリファレンスに、Blenderから直接移動することもできます。 ここでは、[3Dビューポート] スペースのメニュー [オブジェクト] > [トランスフォーム] > [移動] のAPIドキュメントを表示する方法を説明します。

1 [3Dビューポート] スペースのメニュー [オブジェクト] > [トランスフォーム] > [移動] を右クリックして表示されるメニューから、[Blender PythonAPI リファレンス] をクリックします。
2 クリックした機能に関するAPIドキュメントが存在する場合、該当するAPIのドキュメントページが表示されます。

Blenderに付随するスクリプトのテンプレートを読む

Blenderは、各テーマに関して、Pythonスクリプトのテンプレートを提供しています。 テンプレートは、Blender本体が提供しているため、正常に動作することが保証されています。

Blenderが提供するAPIの概要を一通り学んでおきたい場合に、これらのテンプレートが参考になります。 テンプレートは、[テキストエディター] スペースのメニュー [テンプレート] > [Python] から参照できます。

提供されているテンプレートの中で最も簡単なテンプレートは、図に示す [Operator Simple] です。 [Operator Simple] は、[3Dビューポート] スペースに配置されたオブジェクトの一覧を、コンソールウィンドウに表示するスクリプトです。

BlenderのUIからAPIを調べる

BlenderのUIを構築する処理は、Pythonで記述されています。 このため、BlenderのUIからもAPIを調べることができます。 APIを調べる具体的な方法は、2-7節 に記載されています。

Blenderアドオン開発の参考サイトを読む

Blenderのアドオン開発について解説したWebページを見ることでも、新たなAPIを知るきっかけとなります。 ここでは、アドオン開発の参考になる日本語のサイトをいくつか紹介します。

サイト 概要
Blender Wiki Blenderの公式Wikiページです。
BlenderのWiki BLUG.jpさんが管理されているWikiページです。アドオンのページに、アドオン開発に関する情報があります。
blugjpまとめサイト BLUG.jpさんが管理されているサイトです。BlenderでPythonを使うときの情報が公開されていますが、2.80へ移行中であるために不完全なページがあります。
Qiita プログラマ向けの情報共有サイトです。Blender専用のタグもあります。
YouTube BlenderのPythonに関するチュートリアル動画がアップロードされています。[blender][python] などで検索しましょう。

他者が作成したアドオンのソースコードを読む

他者が作成したアドオンのソースコードを読むことでも、Blenderが提供するAPIを調べることができます。 なお、ソースコードを参照して処理を流用する場合は、4-4節 で説明するアドオンのソースコードに適用されているライセンスに気をつけてください。 ライセンスによっては流用できない場合もありますし、流用に必要な条件が定められている場合もあります。

インストール済みのアドオンのソースコードが置かれている場所は、トップバーのメニュー項目 [編集] > [プリファレンス...] で開いたプリファレンスにおいて、左の [アドオン] を選択したときに表示されるアドオンの情報から確認できます。 Web上に公開されているアドオンなど、非公式に提供されるアドオンの場合は、ソースコードがそのまま提供されていることが多いため、直接ソースコードを読むことができるかもしれません。

Googleで検索する

実現したいことや発生した問題が明らかである場合は、Google検索が問題解決のために役立ちます。 例えば、検索ワードとして「bpy」や「blender」、「python」を指定すると、BlenderのAPIに関して調べることができます。 また、問題が発生したときに、コンソールウィンドウやオペレータメッセージにエラーメッセージが出力されているのであれば、エラーメッセージをそのまま検索ワードに指定することで、発生した問題に対する解決方法が見つかるかもしれません。

Googleの検索はとても強力であるため、アドオン開発時に生じるほとんどの問題は、この方法で解決できます。 ただし、発生した問題があまり一般的ではなかったり、Blenderから提供され始めたばかりのAPIに関する問題であったりした場合は、Google検索を利用しても解決できないことがあります。

Blenderのコミュニティサイトで質問する

APIドキュメントを調べたり、他のアドオンを参考にしたりしても問題が解決しないときは、コミュニティサイトで質問してみましょう。 幸いなことに、Blenderアドオンの開発に関して質問できるサイトはいくつかあります。

ここでは、Blenderのアドオン開発について質問できるコミュニティサイトを紹介しますが、いずれも海外のサイトであるため、英語で質問を投稿する必要があります。

サイト 概要
Blender Artists Community 海外最大のBlenderコミュニティサイトです。アドオン開発に関して質問する場合は、[Coding] > [Python Support] にトピックを立てましょう。
Blender Stack Exchange Stack Overflow(http://stackoverflow.com)という、プログラマの間で有名な情報共有サイトがありますが、Blender Stack Exchangeはその派生サイトで、Blenderに関する話題に特化されています。 アドオン開発に関して質問する場合、[Python][add-on][scripting] のタグを追加しましょう。
reddit ニュース記事などのトピックを立てて、コメントをもらうためのWebサービスです。BlenderのPythonに関する投稿は、/r/blenderpython で行いましょう。

PythonコンソールでAPIを検索・実行する

2-2節 で紹介したように、Pythonコンソールを活用し、Blenderが提供するAPIを検索して実行できます。

APIリファレンスだけではわからなかった、APIの動作を確認できる点が、Pythonコンソールを利用するメリットになります。 APIを使ったときに、リファレンスから期待した動作と異なることはよくあることですし、そもそもAPIのリファレンスが存在しないこともあります。 Pythonコンソールを活用することで、よりAPIへの理解が深まると思いますので、積極的に活用していきましょう。

まとめ

本節では、Blenderが提供するPython APIを調べる方法について紹介しました。 筆者がAPIを調べるときは、基本的にGoogleで似たような処理を行っているアドオンを検索し、そのアドオンのソースコードを参考にします。 そして次に、公式のAPIリファレンスで仕様を確認したあと、Pythonコンソールを使って動作確認します。 もし欲しい情報が得られなかった場合は、コミュニティサイトで質問します。

アドオン開発に限ったことではなく、プログラミング全般に言えることですが、アドオン開発において、他者が作成したプログラムは最も参考になります。 さまざまなアドオンのソースコードを読んで真似して改造しつつ、わからないところを調べるという流れを繰り返すことで、独自のアドオンが作れるようになってきます。 ただし、他者のソースコードを扱う場合、4-4節 で説明するソースコードのライセンスには注意しましょう。

ポイント