- Documentation
- Construire avec le SDK
Utiliser avec Three.js
npm install @tempusxr/sdk-three @tempusxr/sdk-tracker-image three
Sans npm, utilisez la page à trois fichiers dans Installer le SDK.
import * as THREE from 'three';
import { create } from '@tempusxr/sdk-three';
import '@tempusxr/sdk-tracker-image'; // le charger enregistre le tracker 'image'
const ar = create({ container: '#ar' });
const tracker = await ar.use('image', { targets: ['/plan.txr'], maxTrack: 2 });
tracker.anchors.forEach((anchor) => {
const cube = new THREE.Mesh(new THREE.BoxGeometry(0.3, 0.3, 0.3), new THREE.MeshNormalMaterial());
ar.attach(anchor, cube);
});
ar.on('found', (anchor) => console.log('trouvée', anchor.id));
ar.on('lost', (anchor) => console.log('perdue', anchor.id));
await ar.start();
create(options)
| Option | Défaut | Rôle |
|---|---|---|
container | obligatoire | Élément ou sélecteur. Il passe en plein écran (fullscreen: false pour garder votre mise en page). |
overlay | default | 'default', 'none' ou votre propre élément. |
language, labels | navigateur | 'fr' ou 'en', et les textes à remplacer. |
cameraOptions | 1280x720 | { facing, idealWidth, idealHeight, idealFrameRate }. Utilisez 640x480 pour le suivi d'image. |
stage | { near, far, maxPixelRatio, createRenderer }. |
Ce que vous récupérez : ar.scene (une scène Three.js), ar.stage.camera, ar.ui (l'interface), ar.adjust (taille et rotation choisies avec les boutons), attach(anchor, object), detach(object), use(kind, options), on(event, handler), start(), stop(), dispose().
Caméra avant. cameraOptions: { facing: 'user' } fonctionne : la vidéo et le canevas 3D sont inversés ensemble, comme dans un miroir (le contenu, texte compris, est inversé aussi). L'interface n'est pas inversée.
Options du tracker d'image (ar.use('image', options)) : targets (une URL ou des octets, ou une liste), maxTrack, warmupTolerance, missTolerance, smoothing ({ minCutOff, beta } ou false).
Une ancre est la pose d'une image : id, kind, targetIndex, visible, matrix (4x4, colonnes en premier, espace caméra, un seul tableau réutilisé pendant toute la vie de l'ancre), size ({ width, height } en unités d'ancre : largeur 1, hauteur selon les proportions de l'image), et les événements found, lost, update.