Welcome to Augmented Reality for beams project documentation!

Introduction

Education project combining the use of Augmented Reality (AR) for the study of beams theory.

Showcase

Tip

Access the the repository here.

Project Structure

Warning

This repository is still under active development and was primarily written live during hands-on teaching sessions. As such, parts of the code may be rough, inconsistent, or temporarily out of place. Some files originate from a more complex parent project, and the structure still needs to be cleaned and streamlined. Use it as a learning resource, but expect changes and improvements over time!

Repository can be cloned from the following link:

git clone https://github.com/multi2mech/AR-simply-supported-beam-edu.git

Note

The project is based on Unity for the AR development and a custom educational tool for beam theory on C#.

Requirements

Main components

The project structure is as follows:

  • Geometries - 3D geometries of loads and contraints (limited for now)

  • Scripts with automatic generation of beam given its section, initial point and final points. It also incluse a ear clipping-based trinagulation algorithm.

  • Scripts to solve the beam elasticity eqautions given the desired loading scenario.

  • Automatic relations between beam, loads and constraints.

  • Interactions between controller ray casting and 3D object (you can move loads or constraints)

  • Object textures

root/
│
├── Assets/       # Contains general documentation and common scripts
│    │
│    ├── my3Dgeometries/        # Contains 3D geometries of loads and constraints
│    │
│    ├── myScriptBeam/          # Contains scripts with automatic generation of beam given its section, initial point and final points. It also incluse a ear clipping-based trinagulation algorithm.
│    │
│    ├── myScriptInteractions/  # Contains script to move object following the Meta XRay interaction
│    │
│    ├── myScriptsMaterialsAndGeometries/   # Containts script and assets to work with materials and shaders
│    │
│    └── Scenes/                # Contains the Unity scenes (main one and the initial one with the logo)
│
└──  docs/                       # Documentation and resources
      ├── documentation/        # Sphinx based documentation
      │
      └── index.html            # Landing page

Table of contents