Sample Repository

The source code for the sample plugins created in this guide is publicly available as a repository on Github. The address is https://github.com/choreonoid/plugin-dev-guide.git. We will call this repository the “sample repository”. It contains the source code for all samples created in this guide, stored in separate directories corresponding to each serial number.

In this repository, all samples use the same plugin name “DevGuidePlugin”. This is because if each sample becomes a separate plugin and they accumulate as you progress through the guide, conflicts would occur between plugins. For this reason, we use the same plugin name and ensure that only one sample is built and executed at a time.

The samples can be built in the Choreonoid build environment. In that case, clone the repository into the ext directory of Choreonoid. This will add the following item to Choreonoid’s CMake configuration:

• DEV_GUIDE_SAMPLE_INDEX

Set the serial number of the sample you want to build and execute here. Then the sample with that serial number will be built and installed.

The serial numbers for each sample are shown below:

• 01: Minimum Plugin Sample (S01)

• 02: Signal Usage Sample (S02)

• 03: Project Item Operation Sample (S03)

• 04: Custom Toolbar Sample (S04)

• 05: Custom Project Item Type Sample (S05)

• 06: Scene Display Sample (S06)

• 07: Project Item Property Implementation Sample (S07)

• 08: Project Item State Saving Sample (S08)

• 09: File I/O Sample for Project Items (S09)

• 10: Item Creation and File I/O Customization Sample (S10)

• 11: Custom View Sample (S11)

The heading of each section introducing a sample includes “(S serial number)” notation to indicate the sample number.