This repository contains integrations of existing 3D viewers or reference implementations of 3D viewers for embedding in Kitodo.Presentation or DFG-Viewer.
- Clone repository or download source code.
- Run the
install.shbash script to download libraries and frameworks undermodulesfolder of each viewer implementation
After these steps, you will have a folder with the respective viewer integration, its dependencies and resources as well as the dlf-3d-viewer.yml configuration file required for the integration.
For more informations regarding embedding this folder into Kitodo.Presentation and DFG-Viewer, read the Embedded 3D Viewer documentation.
These are integrations of 3D viewers or custom 3D viewer implementations base on a JavaScript 3D library (e.g. three.js) which have been prepared for Kitodo.Presentation and thus for the DFG-Viewer.
Note
DLF prefix stands for “Digital Library Framework” and is the key of the TYPO3 extension “Kitodo.Presentation”. The name of the viewer integration can be chosen freely for your custom viewer.
Overview of the integrated viewers and their supported model formats
| Viewer | FBX | OBJ | DAE | PLY | 3DS | IFC | STL | GLB | glTF | JSON | XYZ | HTML |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| dlf-3dbigdataspace-viewer | ✅ | |||||||||||
| dlf-3dhop | ✅ | ✅ | ||||||||||
| dlf-4dbrowser | ✅ | |||||||||||
| dlf-aim-3d | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | |
| dlf-aton | ✅ | ✅ | ||||||||||
| dlf-jena-3dviewer-gaussiansplat | ✅ | |||||||||||
| dlf-jena-3dviewer-holopyramid | ✅ | ✅ | ||||||||||
| dlf-jena-3dviewer-ply-pointcloud | ✅ | |||||||||||
| dlf-jena-3dviewer-vrglasses | ✅ | ✅ | ||||||||||
| dlf-kompakkt | ✅ | ✅ | ✅ | ✅ | ||||||||
| dlf-model-viewer | ✅ | ✅ | ||||||||||
| dlf-pcss-viewer | ✅ | ✅ | ✅ | |||||||||
| dlf-threejs | ✅ |
Integration of the 3D Artifact Viewer from 3DBigDataSpace project.
Supported model formats: .glb
Integration of 3DHOP framework.
Supported model formats: .ply, .obj
Integration of UH4D Browser.
Supported model formats: .json (IIIF manifest)
Integration of 3D Viewer implementation thedworak/dfg_3dviewer of Daniel Dworak Hochschule Mainz.
Supported model formats: .obj, .dae, .fbx, .ply, .ifc, .stl, .xyz, .json, .3ds, .gltf, .glb
Integration of ATON framework.
Supported model formats: .glb, .gltf
Integration of the Gaussian Splat Viewer from https://3drepo.eu/.
Supported model formats: .html
Integration of the 3DView for Holopyramid from https://3drepo.eu/.
Supported model formats: .glb, .gltf
Integration of the PLY Point Cloud Viewer from https://3drepo.eu/.
Supported model formats: .ply
Integration of the 3DView for VR Glasses from https://3drepo.eu/.
Supported model formats: .glb, .gltf
Integration of Kompakkt using the Kompakkt Standalone Viewer.
Supported model formats: .glb, .babylon, .gltf, .obj, .stl
Integration of the model-viewer.
Kitodo.Presentation an thus DFG-Viewer includes this as a default viewer now
Supported model formats: .glb, .gltf
Default of viewer Kitodo.Presentation and with that DFG-Viewer https://3dtest.dfg-viewer.de/viewer?tx_dlf[id]=https://data.3drepo.eu/xml/metsmods/b5df7cd550f64e818943ad96fff7e902metsmods.xml
Use the model viewer from the Integration repository https://3dtest.dfg-viewer.de/viewer?tx_dlf[id]=https://data.3drepo.eu/xml/metsmods/b5df7cd550f64e818943ad96fff7e902metsmods.xml&tx_dlf[viewer]=dlf-model-viewer
Default of viewer Kitodo.Presentation and with that DFG-Viewer http://localhost/viewer?tx_dlf[id]=https://data.3drepo.eu/xml/metsmods/b5df7cd550f64e818943ad96fff7e902metsmods.xml
Use the model viewer from the Integration repository http://localhost/viewer?tx_dlf[id]=https://data.3drepo.eu/xml/metsmods/b5df7cd550f64e818943ad96fff7e902metsmods.xml&tx_dlf[viewer]=dlf-model-viewer
Supported model formats: .glb, .gltf, .obj
Integration of a minimal implementation of three.js with ply model loader.
Supported model formats: .ply
If you have write permissions for this repository, you can start a DFG Viewer test system that includes the latest versions of the available integrations. Please check beforehand if the test system https://bear-genuine-hookworm.ngrok-free.app/ is already running.
Under Actions tab above, you will find the workflow named Run DFG-Viewer test system over ngrok. By clicking on it, a Run workflow button will appear in the upper-right area above the list of recent workflow executions. When clicking on this button, a popup opens. Click the green button with the label Run workflow in the popup.
It takes a moment for the starting workflow to be displayed. Reloading the page can make it appear faster.
After a short time (1-2 minutes), the test system was generated and is accessible at the URL https://bear-genuine-hookworm.ngrok-free.app/ for one hour. After that, the test system will be automatically stopped.