Pythonプラグイン

概要

Pythonプラグイン(PythonPlugin)は、Choreonoid上でプログラミング言語Pythonを利用できるようにするプラグインです。

ChoreonoidのC++ライブラリにはPythonバインディングが用意されており、Pythonから cnoid.Basecnoid.Body 等のモジュールをインポートすることで、プロジェクトアイテムの操作やボディモデルを用いた各種処理をPythonで記述することができます。本プラグインはそのようなPythonスクリプトをChoreonoid上で実行するための以下の機能を提供します。

  • Pythonスクリプトアイテム(PythonScriptItem)

Pythonスクリプトファイル(.py)に対応するアイテムです。スクリプトをプロジェクトのアイテムとして管理し、GUI上の操作で実行することができます。

  • Pythonコンソールビュー(PythonConsoleView)

Choreonoid上で対話的にPythonを実行できるコンソールです。

また、関連するプラグインとして PythonSimScriptプラグイン (PythonSimScriptPlugin)もあわせてビルドされます。これはシミュレーションと連動して実行されるPythonシミュレーションスクリプト(PythonSimScriptアイテム)を提供するもので、シミュレーション開始等のタイミングに合わせてスクリプトを実行させることができます。

これらの機能の詳細な使用方法については、 Pythonスクリプト機能 の章を参照してください。

ビルド方法

Python対応機能はCMakeオプション ENABLE_PYTHON に対応しており、UbuntuではデフォルトでONになっています。ビルドにはPython本体(開発用ライブラリ含む)とNumPyが必要です。

Windowsでのビルド方法については、 ソースコードからのビルドとインストール (Windows編)オプション機能のビルド にあるPythonプラグインの節を参照してください。