Version 1.0.0

Author: oskip0906

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+docstring-convention = google
+extend-ignore = E501, E731

.github/workflows/documentation.yml

@@ -0,0 +1,64 @@
+# Credit: https://github.com/niketagrawal
+
+name: Build-sphinx-docs
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs: 
+  # This workflow contains a single job called "build"
+  build: 
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v2
+        with:
+           python-version: "3.10"
+      # Runs a single command using the runners shell
+      - name: Run a one-line script
+        run: echo Hello, world!
+        
+      - name: Install dependencies
+        run: | 
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          
+      - name: Install ghp-import
+        run: |
+          pip install ghp-import
+
+      - name: Build HTML
+        run: | 
+          cd docs/
+          make html
+
+      - name: Configure Git for push
+        run: |
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "github-actions[bot]"
+          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
+        
+      - name: Run ghp-import
+        run: | 
+          ghp-import -n -p -f docs/_build/html
+
+      # Runs a set of commands using the runners shell
+      - name: Run a multi-line script
+        run: |
+          echo Add other actions to build,
+          echo test, and deploy your project.

.gitignore

@@ -0,0 +1,182 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc
+
+# Output files
+output/**
+
+# Experiments
+experiments/train.py
+experiments/train.sh
+experiments/requirements.txt
+
+# Data
+data/objaverse/

.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: check-symlinks
+  - id: trailing-whitespace
+    args: [--markdown-linebreak-ext=md]
+  - id: end-of-file-fixer
+  - id: check-yaml
+  - id: check-toml
+  - id: check-ast
+  - id: check-added-large-files
+  - id: check-merge-conflict
+  - id: detect-private-key
+  - id: debug-statements
+- repo: https://github.com/pycqa/isort
+  rev: 5.12.0
+  hooks:
+  - id: isort
+- repo: https://github.com/PyCQA/flake8
+  rev: 7.0.0
+  hooks:
+  - id: flake8
+    args: [--max-line-length=127]
+    additional_dependencies: [
+        'flake8-docstrings==1.7.0',
+        'flake8-quotes==3.4.0',
+    ]

README.md

@@ -0,0 +1,106 @@
+# scripted-renderer-dev
+
+This project is a **3D rendering tool** that takes any 2 Blender objects and renders them on a plane with customizable orientations, positions, distances, and camera angles.
+
+## Setup
+
+### Step 1: Clone the Repository
+
+Clone this repository to your local machine:
+
+```bash
+git clone https://github.com/compling-wat/scripted-renderer-dev.git
+cd scripted-renderer-dev
+```
+
+### Step 2: Install Blender 4.3
+
+Download and install **[Blender 4.3](https://www.blender.org/download/)**.
+
+### Step 3: Set Up the Environment
+
+1. Locate where Blender 4.3 is installed:
+   ```bash
+   which/where blender
+   ```
+2. Open a terminal and navigate into the Blender installation directory (path varies by operating system):
+    ```bash
+   cd /path/to/blender/site-packages/
+   ```
+3. Create a `.pth` file named `scripted-renderer-dev.pth` and add the absolute path to the `src` directory of the cloned repository:
+   ```bash
+   echo "/path/to/scripted-renderer-dev/src" > /path/to/blender/site-packages/scripted-renderer-dev.pth
+   ```
+    - _Note: if you encounter errors on Windows, ensure the file encoding is **UTF-8 with BOM**._
+
+## Usage
+
+The repository contains a `scripts` folder with example shell scripts for using this tool. First **cd** into this directory. 
+
+### **Camera Settings**
+
+To set the camera configurations for the rendered images, you can add the following parameters to your script: 
+  ```bash
+  --camera-tilt X                             # Set camera tilt in degrees
+  --camera-pan X                              # Set camera pan in degrees
+  --camera-height X                           # Set camera height in meters
+  --camera-focal-length X                     # Set focal length in millimeters
+  ```
+
+### **Rendering Multiple Images** 
+
+To render all possible combinations of 2 objects under the `data` directory, use the `--render-random` parameter as shown in the `render_multiple.sh` script.
+- The generates images into a **main directory** for each combination of 2 objects within into the **specified image output folder**, along with **4 subdirectories** within the **main directory**:
+
+  - `[object1]_[object2]_left` (object2 to the left of object1)
+  - `[object1]_[object2]_right` (object2 to the right of object1)
+  - `[object1]_[object2]_front` (object2 to the front of object1)
+  - `[object1]_[object2]_behind` (object2 to the back of object1)
+ 
+- For each image, it also generates a corresponding `json` file with detailed information on the camera settings, and positions, rotations, orientations, and relative perspectives of the objects in the **specified scene output folder**.
+
+- You can specify the following constraints:
+  ```bash
+  --objects [list of objects]    # Select specific objects to render
+  --distance-between-objects X   # Set object distance in meters (default: 3)
+  --max-images N                 # Set max images (orientations combinations) per subdirectory (default: 1)
+  --max-camera-configs N         # Set max number of camera configurations per image (default: 1)
+  ```
+
+- If you do not specify `--objects`, the list of objects will be set to all objects in the `data` folder.
+- If you do not specify `--max-camera-configs`, you must fix a specific camera configuration for all images in the script.
+
+_This script can be used for generating an extensive **spatial reasoning dataset** for **vision-language models**._
+
+### **Rendering a Single Image**
+
+For controlled rendering of 2 selected objects, navigate to the `render_single.sh` script for an example usage. 
+
+- Unlike rendering multiple
+
+- Now, since you are only generating 1 image, you have the following additional customizations:
+  ```bash
+  --direction [left, right, behind, front]    # Set object 2’s position relative to object1
+  --object1-rotation X                        # Set object 1's rotation to X degrees clockwise (default: 0)
+  --object2-rotation X                        # Set object 2's rotation to X degrees clockwise (default: 0)
+  ```
+
+- In this case, you must specify a camera setting as well as the `--direction` parameter.
+  
+_This script is useful for **testing and fine-tuning** object placements before batch rendering._
+
+### **Adding AI-generated Backgrounds (EXTRA)**
+
+All the images rendered are just 2 objects on a white surface with a light grey "sky". If you would like to add a custom (more realistic) background to each image in your image output folder, you can navigate to the `generate_backgrounds.sh` script. Note: this feature is still under experimentation.
+
+- Here, you can customize the `PROMPT` argument to guide the background generation process.
+
+- The process utilizes the [**Stable Diffusion XL inpainting model**](https://huggingface.co/diffusers/stable-diffusion-xl-1.0-inpainting-0.1) to modify specific regions of images with custom backgrounds.
+
+_The goal is to enable comparisons between a fine-tuned spatial reasoning model’s performance on the original dataset versus a version with more realistic backgrounds._
+
+## Configuration
+
+The tool's settings, such as **output directories, image resolution, and other scene configurations**, can be customized in `config.json` under the `src` directory.
+
+You can also add your own objects by placing `.blend` files inside the `data` folder and specifying their properties in `properties.json`.

data/.DS_Store

@@ -0,0 +1,4 @@
+git clone https://github.com/compling-wat/FORG3D-object-data.git
+mv FORG3D-object-data/* .
+rm -rf FORG3D-object-data
+rm LICENSE