3D Tiler

Welcome to the 3D Tiler project! This wiki provides comprehensive documentation to help you understand, use, and contribute to the 3D Tiler project.

---

Table of Contents

1. Introduction
2. Getting Started
3. Project Structure
4. Usage
5. Contributing
6. License

---

Introduction

3D Tiler is a web-based application designed to create and manipulate 3D tiling patterns. It supports various shapes and provides tools to export the designs in different formats.

Getting Started

To get started with 3D Tiler, follow these steps:

1. Clone the Repository:

   git clone https://github.com/gShahr/modular-robotics.git
   cd 3d-tiler

2. Open the Project: Open the index.html file in your web browser to start using the application.

Project Structure

The project is organized as follows:

3d-tiler/
├── index.html
├── src/
│   ├── 2dScreen.js
│   ├── 3dScreen.js
│   ├── Cube.js
│   ├── hexagon.js
│   ├── rhomDod.js
│   └── sketch.js
└── p5.js

• index.html: The main HTML file that includes all necessary scripts and styles.
• src/: Contains all JavaScript files for different functionalities.

Usage

Controls

• Layer Controls:

  • +1 Layer: Move up one layer.
  • -1 Layer: Move down one layer.
  • Highlight Layer: Highlight the current layer.

• Color Controls:

  • Red: Change the color to red.
  • Green: Change the color to green.
  • Blue: Change the color to blue.

• Export Options:

  • Export to JSON: Export the current design to a JSON file.
  • Export to .OBJ: Export the current design to an Object file.

• Import Options:

  • Import from JSON: Import a design from a JSON file.

Supported Shapes

• Cube: Standard 3D cube shape.
• Hexagon: Hexagonal tiling shape.
• Rhombic Dodecahedron: A polyhedron with 12 rhombic faces, also known as a rhombdod.

Static Modules

The application supports static modules, allowing you to create designs with fixed, non-movable elements.