- Documentation
- Contribuer
Comment c'est construit
Pour les personnes qui travaillent sur le SDK lui-même. Le dépôt est privé ; cette page est celle qu'un nouveau membre de l'équipe lit en premier.
packages/
sdk-core session, boucle d'images, caméra, ancres, registre des traqueurs, overlay, format .txr (ni Three.js, ni A-Frame)
sdk-three scène Three.js, attach(anchor, object), loadScene
sdk-aframe composants A-Frame : tempusxr, tempusxr-image-target, tempusxr-scene, tempusxr-capture
sdk-capture capture photo et vidéo
sdk-tracker-image le fork de MindAR derrière le contrat de traqueur
sdk-tracker-world suivi du sol et des murs en WebXR
scene schéma des fichiers de scène, validation, migrations
target-compiler images vers .txr, dans un navigateur
apps/viewer le Viewer web
tools/ générateurs de doc et de site, scripts de publication
examples/ un dossier par exemple ; examples/library.json alimente la Bibliothèque
Les règles qui façonnent le code :
- Un paquet adaptateur par moteur.
sdk-coren'importe aucun moteur de suivi ni bibliothèque 3D. Three.js n'est importé que danssdk-three(et les applications) ; A-Frame que danssdk-aframe. Les deux sont des dépendances « peer », jamais embarquées. - Les contrats d'abord.
CameraProvider,TrackerAdapter,Anchor, l'API publique et le format de scène ne changent qu'après une courte proposition et une mise à jour de la section 1 deROADMAP.md. Le format de scène est versionné et chaque changement vient avec une migration. - Les matrices sont 4x4, colonne par colonne,
Float32Array, espace monde, en mètres (commeMatrix4.fromArrayde Three.js). - Aucune allocation dans la boucle d'images. Les traqueurs se chargent à la demande.
- Licences. Seulement des dépendances MIT, Apache 2.0, BSD, ISC, Zlib ou CC0, chacune listée dans
NOTICE.md. Jamais de code GPL, AGPL ou non commercial. - TypeScript strict, pas de
anydans les types publics.
Écrire un nouveau traqueur : implémentez TrackerAdapter (voir packages/sdk-core/src/contracts/tracker.ts : load, start, stop, dispose, anchors, événements), étendez TrackerBase, et enregistrez-le avec trackers.register('face', factory). Ensuite session.use('face', options) marche, dans A-Frame, Three.js et les fichiers de scène.