scenery_builder

Installation

Install all the requirements:

sudo apt-get install blender python3-pip python3-venv -y

First, create a virtual environment and activate it:

python -m venv .venv
source .venv/bin/activate

For Blender to regonize the virtual environment, add it to your PYTHONPATH:

export PYTHONPATH=<Path to .venv directory>/lib/python3.11/site-packages   

From the root directory of the repo, install the python packages by running:

pip install -e .

Usage

This module adds floorplan as a command line interface. You can use the generate command as shown below:

floorplan generate <path to config file> -i <path to input folder>

Where the input folder must contain:

• the composable models generated from the FloorPlan DSL
  • coordinate.json
  • floorplan.json
  • polyhedron.json
  • shape.json
  • skeleton.json
  • spatial_relations.json
• the door object models (optional)
  • object-door.json
  • object-door-states.json
• any object instance models (optional), e.g. object-door-instance-X.json where X is a unique numeric ID.

For more information on the parameters that can be used to customize the generation simply call

floorplan generate --help

The command above currently generates the following artefacts:

• 3D mesh in .stl format
• Gazebo models and worlds (.sdf, .config)
• Launch files for ROS1 and/or ROS2 (.launch)
• Occupancy grid map for the ROS map_server (.pgm and .yaml)
• Tasks with a list of waypoints in .yaml
• A 3D polyline representation for the SOPRANO project (.poly)

Docker

To use the scenery_builder via Docker, simply mount the input and output paths as volumes and pass any arguments to the container:

docker run -v <local input path>:/usr/src/app/models -v <local output path>:/usr/src/app/output  -it scenery_builder:latest <optional arguments>

Example

An example model for a building is available here. After transforming the floorplan model into its composable representation, generate the artefacts by passing the folder with the JSON-LD models as inputs:

floorplan generate -i hospital/json-ld --output-path hospital/gen

That should generate the following files:

.
├── 3d-mesh
│   └── hospital.stl
├── gazebo
│   ├── models
│   │   └── hospital
│   │       ├── model.config
│   │       └── model.sdf
│   └── worlds
│       └── hospital.sdf
├── maps
│   ├── hospital.pgm
│   └── hospital.yaml
├── polyline
│   └── hospital.poly
├── ros
│   └── launch
│       └── hospital.ros2.launch
└── tasks
    ├── hallway_task.yaml
    ├── reception_task.yaml
    ├── room_A_task.yaml
    └── room_B_task.yaml

Task generator

It uses the FloorPlan corners to generate a task specification to visit all corners in a space. The option --waypoint-dist-to-corner is a float value representing the distance between the corner of a space and its center.

Object placing

This tool places objects (e.g. doors) in indoor environments. By using the composable modelling approach, a scenery can compose the static FloorPlan models with objects such as doors.

Models that can be composed into a scenery

• Model objects with movement constraits: composition of objects with revolute, prismatic, or fixed joints into a scenery.
• Model object states: composition of objects with motion constraints defined as finite state machines, and their intial state in the scene.

Gazebo world generation

The tool generates SDF format world files for Gazebo. The initial state plugin sets up the scene as determined by the initial state for each object included in the world file.

Tutorials

Tutorials on how to model objects with movement constraints, and how to place them in floor plan models is available here.

Acknowledgments

This work has been partly supported by the European Union’s Horizon 2020 projects SESAME (Grant No. 101017258) and SOPRANO (Grant No. 101120990).