![license](https://camo.githubusercontent.com/b8fe320573fc32c75511213a539f5c7ec66a55eaa7d9e72f809be6a3f9ef31ea/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f67726562747365772f466c6f6f72706c616e546f426c656e6465723364) ![dockerhub](https://camo.githubusercontent.com/e201b7b589e3d40963d422b220dd23181b04d8f5a4f4068e04cd83170b8abbd2/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f646f636b65726875622d6163746976652d677265656e) ![size](https://camo.githubusercontent.com/fb9560a4af7a8639ea08121199934cc72415df8cc9af891fc871abf4c1bcfa00/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f7265706f2d73697a652f67726562747365772f466c6f6f72706c616e546f426c656e6465723364) ![commit](https://camo.githubusercontent.com/da430857b72a30b350318c200a7a40c753f24a6de5c2f7231da712ae95172724/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6173742d636f6d6d69742f67726562747365772f466c6f6f72706c616e546f426c656e6465723364) ![Demo](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/Images/Demos/powerpoint.gif)

Table of Contents (click to expand)

- [About](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/#about) - [How-To](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/#how-to) - [Run on Docker](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/#run-on-docker) - [Run locally on OS](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/#run-locally-on-os) - [Run Tutorial](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/#run-tutorial) - [ConfigFile](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/#configfile) - [StackingFile](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/#stackingfile) - [Demos](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/#demos) - [Documentation](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/#documentation) - [Testing](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/#testing) - [Contribute](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/#contribute) - [Known Issues](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/#Known-Issues) - [License](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/#license)

# About The virtualization of real life objects has been a hot topic for several years. As I started learning about 3d modelling in [Blender3d](https://www.blender.org/) I thought of the idea to use simple imaging on floorplans to automatically create corresponding 3d models. It is much easier than it sounds and uses a low amount of resources, enabling it to be used on low hardware. By utilizing Blender3d, all created objects will be easy to transfer to any other 3d rendering program. Such as [Unity](https://unity.com/), [Unreal Engine](https://www.unrealengine.com/en-US/) or [CAD](https://www.autodesk.com/solutions/cad-software). # Contents This repository contains the floorplan to blender library **FTBL** along with example scripts for converting an image to a 3d model **./create_blender_project_from_floorplan.py**. The repository also contains a server that receives images and converts them into 3d models using the **FTBL** library. The Server contains a [Swagger API](https://swagger.io/) gui and is monitored using a [weavescope](https://github.com/weaveworks/scope) container. Read more about the server implementation [here](https://github.com/grebtsew/FloorplanToBlender3d/blob/master/Server/README.md). To allow developers to utilize more functionality a Jupyter tutorial has been added to the project, explaining some of the development steps and functions of the library. Read more about the tutorial [here](https://github.com/grebtsew/FloorplanToBlender3d/blob/master/Docs/README.md). Stacking is now also added as a core feature read more about how to use stacking below. # How-To This part contains information about how to setup and execute the example script. **NOTE** : Using other versions of the required programs and libraries than specified in Dockerfiles might require changes in the implementation. It is only guaranteed that this implementation will work if the assigned versions and all requirements are met. **NOTE** : To avoid any version related problems use the Docker implementation. ## Run on Docker Firstly you need to install a suitable [Docker](https://www.docker.com/) environment on your device. This project contains a `DockerFile` which uses the `Ubuntu 18.04` image so make sure your docker environment is set to linux containers. This project is linked to [Docker Hub](https://hub.docker.com/r/grebtsew/floorplan-to-blender) which means a maintained and prebuilt container can be pulled directly by running: ```bash docker pull grebtsew/floorplan-to-blender ``` The dockerfile is divided into three modes. The script mode where the example script can be tested. The server which starts a hosting server instance with a Swagger Api. The jupyter notebook where some tutorials and examples are further explained. By using the different docker-compose files these modes are automatically selected for you. **NOTE** : For more information about how the dockerfile and docker-compose files can be used to build and run the image to add your own content read more [here](https://github.com/grebtsew/FloorplanToBlender3d/blob/master/Docs/README.md). To pull and run the container together in a one line command run: ```bash # For Script mode: docker-compose run ftb # For Server mode: Read more "./Server/README.md" docker-compose -f docker-compose.server.yml up # For jupyter mode: Read more "./Docs/README.md" cd ./Docs docker-compose up ``` **NOTE**: When changing between modes the container sometimes need to be rebuild, that can be done by adding the --build flag to the commands above. ## Run locally on OS This tutorial will describe how to install this implementation directly on your device. If you are a `Linux/Ubuntu` user, look at `Dockerfile` for better instructions. These are the programs that are required to run this implementation. * [Blender3d > 2.93](https://www.blender.org/) * `Python >== 3.8.0` Clone or download this repo: ```git git clone https://github.com/grebtsew/FloorplanToBlender3d.git ```` With a suitable `blender`, `python` and `python pip` installed you can have `Python3 pip` install all required packages by running: ```bash pip install -r requirements.txt ``` ### Run Tutorial This tutorial takes you through the execution of this program. 1. Receive floorplan as image, from pdf or by using other method (for example paint) 2. (Optional) create a new ConfigFile in `Configs` folder or StackingFile in `Stacking` folder. 2. Run python script `create_blender_project_from_floorplan.py` 3. Follow instructions 4. Created `floorplan.blender` files will be saved under `./target` **NOTE** : For more information about alternative ways of executing the implementation read more [here](https://github.com/grebtsew/FloorplanToBlender3d/blob/master/Docs/README.md). ## Update Settings in Config files When the implementation run the first time a `system.ini` and ``default.ini` file is created. ## ConfigFile With the new update of the implementation `ConfigFiles` are added. These files describe information about each floorplan class instance. In this file model transform can be changed. If no config is added, default will be used. To generate a new default file remove or move the old one. Next to the default config file is the system default config file containing additional settings for the entire system. All configs are placed inside the `Configs` folder. ## StackingFile With the new update the `StackingFile` was added. StackingFiles are used to create worlds of floorplans at once. Using a self developed parsing language. See the example files in the `Stacking` folder. # Demos ## Create Floorplan in Blender3d Here we demo the program. First of we need a floorplan image to process. We use `example.png`, see below: ![Floorplanexample](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/Images/Examples/example.png) Next up we execute our script and answer the questions: ![RunScriptDemo](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/Images/Demos/RunScriptDemo.gif) Finally we can open the newly created floorplan.blender file and see the result: ![OpenFiledemo](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/Images/Demos/OpenFiledemo.gif) **NOTE**: This demo only uses default settings. For instance coloring is by default random. ## Create several floorplans using Stacking Here we instead use StackingFiles to create a world containing several floorplans. ![RunScriptDemo](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/Images/Demos/demoStacking1.gif) Show the result. ![RunScriptDemo](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/Images/Demos/demoStacking2.gif) ## Floorplan To Blender Server with Swagger API The server implementation comes with an automatically generated [Swagger API](https://swagger.io/) page. ![swagger](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/Images/Demos/swaggerdemo.gif) ## Usages in other applications If you are interested in code for these demos they are accessable in another repository [here](https://github.com/grebtsew/ARFloorplanDemo). ### AR foundation place floorplans in world

### AR foundation real life scaling of floorplans

### AR foundation interior design of floorplans

### AR foundation with MediaPipe Hands interactions

# Documentation For more information and tutorial of how to use the ftb library do checkout [docs](https://github.com/grebtsew/FloorplanToBlender3d/blob/master/Docs/README.md)! # Testing Vital and core functionality are tested with pytest. To run tests yourself enter `Testing`-folder and run: ```cmd pytest ``` # Contribute Let me know if you want to contribute to this project, also if you want me to add more functions or answer questions, let me know! # Known Issues These are some known and relevant issues with the current implementation: * Floorplan images needs to be quite small for detections to work at this time. If you plan on using a large image, consider downsizing it. * Required programs and libraries might change in future versions, this might require some changes in this implementation for it to work. If you insist on not using the versions specified in Dockerfile, a coding effort might be required. # License [GNU GENERAL PUBLIC LICENSE](https://github.com/grebtsew/FloorplanToBlender3d/raw/master/license) Version 3, 29 June 2007 COPYRIGHT @ Grebtsew 2021