forked from kovacsv/Online3DViewer
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
49 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,59 @@ | ||
| # Online 3D Viewer | ||
| Here's the modified README.md with attribution to the original repo and a non-commercial license: | ||
|
|
||
| [](https://github.com/kovacsv/Online3DViewer/actions/workflows/build.yml) | ||
| [](https://badge.fury.io/js/online-3d-viewer) | ||
| [](https://deepscan.io/dashboard#view=project&tid=16586&pid=19893&bid=524595) | ||
| # TellMeWhereItHurtsNow.com | ||
|
|
||
| Online 3D Viewer (https://3dviewer.net) is a free and open source web solution to visualize and explore 3D models in your browser. This repository contains the source code of the website and the library behind it. | ||
| ## Interactive 3D Pain Mapping Tool | ||
|
|
||
| [Live website](https://3dviewer.net) - [Website documentation](https://3dviewer.net/info) - [Developer documentation](https://kovacsv.github.io/Online3DViewer) - [Discord server](https://discord.gg/C7x9u833yN) | ||
| TellMeWhereItHurtsNow.com is an innovative web application that allows users to visually communicate their pain experiences using a 3D human model. This tool is designed to help individuals accurately pinpoint and describe areas of discomfort, facilitating better communication with healthcare providers and tracking of pain over time. | ||
|
|
||
| ## Example | ||
| **Note**: This project is a repurposed version of [Online3DViewer](https://github.com/kovacsv/Online3DViewer) by kovacsv. We have adapted and modified the original codebase to create this pain mapping tool. | ||
|
|
||
|  | ||
| ## Features | ||
|
|
||
| [Check the live version!](https://3dviewer.net/#model=https://raw.githubusercontent.com/kovacsv/Online3DViewer/dev/test/testfiles/gltf/DamagedHelmet/glTF-Binary/DamagedHelmet.glb) | ||
| - **Interactive 3D Human Model**: Users can manipulate a detailed 3D representation of the human body to accurately indicate pain locations. | ||
| - **Highlight Tool**: An intuitive highlighting feature enables users to mark specific areas of pain on the 3D model. | ||
| - **Pain Intensity Scale**: Users can indicate the severity of their pain using a color-coded intensity scale. | ||
| - **Multiple View Angles**: The 3D model can be rotated and viewed from various angles to ensure precise pain location mapping. | ||
| - **Save and Share**: Users can save their pain maps and easily share them with healthcare professionals. | ||
| - **Responsive Design**: The application is optimized for use on desktop and mobile devices. | ||
|
|
||
| ## Supported file formats | ||
| ## How It Works | ||
|
|
||
| * **Import**: 3dm, 3ds, 3mf, amf, bim, brep, dae, fbx, fcstd, gltf, ifc, iges, step, stl, obj, off, ply, wrl. | ||
| * **Export**: 3dm, bim, gltf, obj, off, stl, ply. | ||
| 1. Access TellMeWhereItHurtsNow.com through your web browser. | ||
| 2. Use the controls to rotate and position the 3D human model. | ||
| 3. Select the highlight tool and mark the areas where you're experiencing pain. | ||
| 4. Adjust the color intensity to indicate the severity of pain in each area. | ||
| 5. Save your pain map and generate a shareable link or report. | ||
|
|
||
| ## External Libraries | ||
| ## Technology Stack | ||
|
|
||
| Online 3D Viewer uses these wonderful libraries: [three.js](https://github.com/mrdoob/three.js), [pickr](https://github.com/Simonwep/pickr), [fflate](https://github.com/101arrowz/fflate), [draco](https://github.com/google/draco), [rhino3dm](https://github.com/mcneel/rhino3dm), [web-ifc](https://github.com/tomvandig/web-ifc), [occt-import-js](https://github.com/kovacsv/occt-import-js). | ||
| - Frontend: HTML5, CSS3, JavaScript | ||
| - 3D Rendering: WebGL | ||
| - Backend: [Your chosen backend technology] | ||
| - Database: [Your chosen database technology] | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome contributions to improve TellMeWhereItHurtsNow.com! Please read our contributing guidelines before submitting pull requests. | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0). This means you are free to: | ||
|
|
||
| - Share — copy and redistribute the material in any medium or format | ||
| - Adapt — remix, transform, and build upon the material | ||
|
|
||
| Under the following terms: | ||
|
|
||
| - Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. | ||
| - NonCommercial — You may not use the material for commercial purposes. | ||
|
|
||
| For more details, please see the [full license text](https://creativecommons.org/licenses/by-nc/4.0/legalcode). | ||
|
|
||
| ## Acknowledgments | ||
|
|
||
| We would like to express our gratitude to kovacsv for creating the original Online3DViewer project, which served as the foundation for TellMeWhereItHurtsNow.com. The original project can be found at https://github.com/kovacsv/Online3DViewer. | ||
|
|
||
| ## Contact | ||
|
|
||
| For support or inquiries, please contact Tomas Lastrilla. |