オプション機能

ここでは、Choreonoidのビルド設定において選択可能なオプション機能を紹介します。

オプション機能はCMakeの設定で有効化／無効化します。この操作については、 ソースコードからのビルドとインストール (Ubuntu Linux編) の CMakeによるビルド設定 もしくは ソースコードからのビルドとインストール (Windows編) の CMakeによるビルド設定 を参照してください。

なお、各プラグインの機能や利用方法の詳細については、 プラグイン の各ページで解説していますので、そちらもあわせて参照してください。

主要なオプション

• ENABLE_GUI

ChoreonoidのGUI上で実現される機能を有効にします。デフォルトでONになっていて、Choreonoidをアプリケーションソフトとして使用する場合は必須のオプションです。GUIには依存しないライブラリの部分だけを利用したい場合は、これをOFFにすることでビルド時間を短縮することができます。

• ENABLE_PYTHON

ChoreonoidのPythonバインディグを有効にします。PythonバインディングによりC++で実装されているコレオノイドのライブラリをPythonで利用することが可能となります。例えばBodyライブラリのPythonバインディングである "cnoid.Body" モジュールをインポートすることで、Python上でBodyクラスを中心とした各種ロボティクス関連処理を記述することができます。

また、ENABLE_GUIがONの場合、ChoreonoidのGUI上でPythonを利用するためのPythonプラグインとPythonSimScriptプラグインもあわせてビルドされます。

UbuntuではデフォルトでONになっています。 Windowsでこれを有効にする場合は オプション機能のビルド をご参照ください。詳細は Pythonプラグイン を参照ください。

• ENABLE_URDF

URDF対応機能を有効にします。URDFBodyLoaderとURDFプラグインがビルドされ、URDFファイルの読み込みが可能となります。デフォルトでONになっています。詳細は URDFプラグイン を参照ください。

• ENABLE_SDF

SDF対応機能を有効にします。SDFBodyLoaderとSDFプラグインがビルドされ、Simulation Description Format (SDFormat) で記述されたモデルファイルの読み込みが可能となります。デフォルトでONになっています。詳細は SDFプラグイン を参照ください。

• ENABLE_ASSIMP

Assimp対応機能を有効にします。Assimp（ Open Asset Import Library ）は各種3Dモデルファイルを読み込むためのライブラリで、これによりBlender、X、DXF等の形式のファイルを読み込むことが可能となります。Assimpライブラリがインストールされている環境では自動で検出され、デフォルトでONになります。なお、COLLADA形式（.dae）については最近のバージョンのChoreonoidでネイティブに読み込めるようになったため、Assimpが必要となる場面は以前より少なくなっています。詳細は Assimpプラグイン を参照ください。

• ENABLE_FREE_TYPE

  FreeTypeライブラリを利用して、シーンビュー上へのテキストの描画をできるようにします。現状のChoreonoidではこのオプションがONになっていると、距離計測機能を利用する際にシーンビュー上に距離が数値表示されるようになります。UbuntuではデフォルトでONになっています。WindowsではデフォルトでOFFになっており、利用にあたっては別途FreeTypeライブラリをインストールしておく必要があります。この方法は FreeTypeライブラリの有効化 で解説しています。

• ENABLE_PHYSX / BUILD_PHYSX_PLUGIN

PhysXプラグインをビルドし、NVIDIA社の物理エンジンである PhysX をシミュレーションで利用できるようにします。PhysXのソースコードはChoreonoid本体に同梱されており、両オプションともデフォルトで ON となっているため、通常はそのままでビルドできます。詳細は PhysXプラグイン を参照ください。

• ENABLE_MUJOCO / BUILD_MUJOCO_PLUGIN

MuJoCoプラグインをビルドし、オープンソースの物理エンジンである MuJoCo をシミュレーションで利用できるようにします。MuJoCoのビルド済みライブラリはChoreonoid本体に同梱されており、両オプションともデフォルトで ON となっているため、通常はそのままでビルドできます。詳細は MuJoCoプラグイン を参照ください。

• BUILD_ODE_PLUGIN

ODEプラグインをビルドします。このプラグインにより、オープンソースの動力学計算ライブラリである Open Dynamics Engine (ODE) を、シミュレーションのための物理エンジンとして利用できるようになります。利用の際にはODEをインストールしておく必要があります。ODEがインストールされている環境では自動で検出され、デフォルトでONになります。UbuntuのパッケージインストールスクリプトではODEもインストールされます。詳細は ODEプラグイン を参照ください。

• BUILD_BULLET_PLUGIN

Bulletプラグインをビルドします。このプラグインにより、オープンソースの物理計算ライブラリである Bullet Physics を、シミュレーションのための物理エンジンとして利用できるようになります。利用の際にはBulletをインストールしておく必要があります。ODEと同様に、UbuntuのパッケージインストールスクリプトではBulletもインストールされます。Bulletがインストールされている環境では自動で検出され、デフォルトでONになります。詳細は Bulletプラグイン を参照ください。

• BUILD_AGX_DYNAMICS_PLUGIN

AGX Dynamicsプラグインをビルドします。AGX DynamicsはスウェーデンのAlgoryx社が開発した商用の物理エンジンで、これを用いたシミュレーションを利用できるようにします。詳細は AGX Dynamicsプラグイン を参照ください。

• BUILD_MULTICOPTER_PLUGIN

マルチコプタプラグインをビルドします。このプラグインによりマルチコプタのシミュレーションが可能となります。詳細は マルチコプタプラグイン を参照ください。

• BUILD_GL_VISION_SIMULATOR_PLUGIN

  視覚センサのシミュレーションを行うためのGLビジョンシミュレータプラグインをビルドします。デフォルトでONになっています。詳細は 視覚センサのシミュレーション を参照ください。

• BUILD_GL_CAMERA_EFFECT_PLUGIN

  GLビジョンシミュレータプラグインを拡張し、シミュレートするカメラ画像に様々なエフェクトをかけられるようにするGLカメラエフェクトプラグインをビルドします。詳細は GLカメラエフェクトプラグイン を参照ください。

• BUILD_LIVOX_MID360_PLUGIN

  Livox社のLiDARであるMID360に対応するためのLivoxMID360プラグインをビルドします。MID360をデバイスとして利用できるようにし、シミュレーションにも対応します。詳細は LivoxMid360プラグイン を参照ください。

• BUILD_SCENE_EFFECTS_PLUGIN

シーンエフェクトプラグインをビルドします。このプラグインにより、シーン上に炎や煙等のエフェクトを描画できるようになります。詳細は シーンエフェクトプラグイン を参照ください。

• BUILD_POSE_SEQ_PLUGIN

PoseSeqプラグインをビルドします。このプラグインはキーポーズによる振り付け機能を提供します。詳細は PoseSeqプラグイン を参照ください。

• BUILD_BALANCER_PLUGIN

バランサープラグインをビルドします。このプラグインにより、振り付け機能において自動バランス補正を行うことが可能となります。二足歩行ロボットの振り付けを行う際にこの機能を使うことで（理論上）転倒しない動作を作成できます。詳細は Balancerプラグイン を参照ください。

• BUILD_MOCAP_PLUGIN

モーションキャプチャの動作データを読み込んだり表示したりするためのプラグインです。現在BVH形式のモーションキャプチャデータに対応しています。詳細は Mocapプラグイン を参照ください。

• BUILD_MEDIA_PLUGIN

メディアプラグインをビルドします。このプラグインによりChoreonoid上で動画や音声の各種メディアファイルを再生することが可能となります。詳細は メディアプラグイン を参照ください。

• BUILD_TRAFFIC_CONTROL_PLUGIN

TrafficControlプラグインをビルドします。このプラグインにより、通信遅延、帯域制限、パケットロス等の各種通信障害を模擬することが可能となります。詳細は TrafficControlプラグイン を参照ください。

サンプル関連オプション

以下はサンプルのデータやプログラムをビルドするためのオプションです。

• ENABLE_SAMPLES

サンプルを有効化します。これにより、基本的なサンプルのビルドに加えて、以下のオプションで追加のサンプルもビルドできるようになります。デフォルトでONになっています。

• BUILD_SIMPLE_CONTROLLER_SAMPLES

シンプルコントローラで実現される各種シミュレーションサンプルをビルドします。デフォルトでONになっています。

• BUILD_HRP4C_HANDLER

HRP-4Cモデルの逆運動学解析解を計算するボディハンドラをビルドします。

• BUILD_SUBMERSIBLE_SAMPLE

水中型ロボットの簡易シミュレーションを行うサンプルです。

• BUILD_WRS2018

2018年に開催された国際ロボット競技会 World Robot Summit 2018における「トンネル事故災害対応・復旧チャレンジ」の競技用モデルをサンプル化したものです。詳細は World Robot Summit 2018 を参照ください。

その他のオプション

Choreonoidには上に挙げた以外にも、以下のようなオプションがあります。一部のオプションはメニュー形式のCMake設定ツールでは通常表示されず、Advanced Modeに切り替えることで表示されるようになります。

• BUILD_MANIPULATOR_PLUGIN

• BUILD_COMPETITION_PLUGIN

• BUILD_PCL_PLUGIN

• BUILD_OMPL_PLUGIN

• BUILD_FCL_PLUGIN

• BUILD_FFMPEG_PLUGIN

• BUILD_BODY_MOTION_FILTER_PLUGIN

• BUILD_SCENEEDIT_PLUGIN

• ENABLE_CORBA

これらは実験／開発段階の機能や、特定用途向けの基盤機能などに対応するオプションです。これらも含めて、何であるかが分からないオプションについては基本的にONにしないようにしてください。