- Documentation
- Construire avec le SDK
Utiliser avec A-Frame (HTML simple)
Trois balises script et une scène. Pas de bundler, rien à installer. Avec npm, npm install @tempusxr/sdk-aframe @tempusxr/sdk-tracker-image aframe.
<script src="https://aframe.io/releases/1.8.0/aframe.min.js"></script>
<script src="https://tempusxr.vercel.app/v1/tempusxr-aframe.min.js"></script>
<script src="https://tempusxr.vercel.app/v1/tempusxr-image.min.js"></script>
<a-scene tempusxr="tracker: image; targets: targets.txr; maxTrack: 2" renderer="alpha: true" vr-mode-ui="enabled: false">
<a-camera look-controls="enabled: false" wasd-controls="enabled: false"></a-camera>
<a-entity tempusxr-image-target="index: 0">
<a-plane width="1" height="0.75" color="#40c4ff" opacity="0.3"></a-plane>
<a-box position="0 0 0.15" width="0.3" height="0.3" depth="0.3" color="red"></a-box>
</a-entity>
</a-scene>
L'ordre de chargement compte : A-Frame, puis Tempusxr, puis le traqueur. Le fichier Tempusxr contient aussi le chargeur de fichiers de scène (tempusxr-scene) et la capture photo et vidéo (tempusxr-capture).
tempusxr sur la scène
| Attribut | Défaut | Rôle |
|---|---|---|
tracker | image | Quel tracker utiliser. |
targets | aucun | Un ou plusieurs fichiers .txr, séparés par des virgules. |
maxTrack | 1 | Nombre d'images suivies en même temps. |
warmupTolerance, missTolerance | 5, 5 | Images vidéo avant « trouvée », et avant « perdue ». |
smoothing | true | Lisser la pose. filterMinCutOff (1,5) et filterBeta (8) la règlent. |
facing | environment | Caméra arrière. Utilisez la caméra arrière pour le suivi. |
cameraWidth, cameraHeight | 640, 480 | Taille de l'image caméra. Plus petit va plus vite (voir section 7). |
autoStart | true | Avec false, démarrez à la main : scene.components.tempusxr.start(). |
overlay | default | default, none, ou le sélecteur de votre propre interface. |
language | navigateur | fr ou en. |
debug | false | Affiche le panneau de débogage (voir section 8). Actif aussi avec ?debug dans l'adresse. |
tempusxr-image-target="index: N" place une entité sur la N-ième image des fichiers .txr. L'entité n'est visible que tant que cette image est vue. Le contenu voit l'image comme un plan de 1 unité de large (ou la largeur imprimée en mètres si le fichier en contient une), centré, +X vers la droite, +Y vers le haut, +Z vers l'observateur.
tempusxr-image-plane sur un <a-plane> (ou <a-video>) dans une cible lui donne la vraie taille et les vraies proportions de l'image, quelles qu'elles soient : <a-plane tempusxr-image-plane color="red"></a-plane>.
Événements. Sur l'entité : targetFound, targetLost. Sur la scène : tempusxr-ready (détail : tracker, overlay), tempusxr-error (détail : error).
document.querySelector('[tempusxr-image-target]').addEventListener('targetFound', () => {
console.log('vue !');
});