Documentation de Needle Engine
Downloads
  • What is Needle Engine?
  • Témoignages
  • Get an overview

    • Samples and Showcase
    • Notre Vision 🔮
    • Aperçu des fonctionnalités
    • Vue d'ensemble technique
  • Resources

    • Pricing and Plans
    • Changelog
    • API Documentation
    • Support & Community
  • Integrations

    • Needle Engine pour Unity
    • Needle Engine pour Blender
    • Needle Engine en tant que Web Component
    • Needle Engine sur votre site Web
    • Needle Cloud
  • Core Concepts

    • Structure d'un projet Needle Engine
    • Everywhere Actions
    • Exporter des Assets vers glTF
    • Frameworks, Bundlers, HTML
    • Tester sur les appareils locaux
    • Déploiement et Optimisation
  • Advanced

    • VR & AR (WebXR)
    • Image Tracking (WebXR)
    • Réseau
    • MaterialX
    • Synchronisation de l'Editor (Editor Sync)
  • Troubleshooting

    • Comment déboguer
    • Questions et Réponses (FAQ) 💡
    • Support and Community
  • Videos

    • Tutorials on Youtube
    • Interviews on Youtube
  • Scripting Overview

    • Scripting dans Needle Engine
    • Introduction au Scripting pour les Développeurs Unity
    • Composants principaux de Needle
    • Everywhere Actions
  • Components and Lifecycle

    • Créer et utiliser des Composants
    • @serializable et autres décorateurs
    • Génération automatique de composants
    • Exemples de Scripting
    • Community Contributions
    • Modules supplémentaires
  • Settings and APIs

    • <needle-engine> Configuration
    • needle.config.json
    • Needle Engine API
    • three.js API
Help
Samples
Pricing
  • Needle Website
  • Needle Cloud
  • Support Community
  • Discord Server
  • X/Twitter
  • YouTube
  • Newsletter
  • Email
  • Feedback
  • Github
  • English
  • 简体中文
  • Español
  • Português
  • Français
  • हिन्दी
  • 日本語
  • Deutsch
  • Tiếng Việt
Downloads
  • What is Needle Engine?
  • Témoignages
  • Get an overview

    • Samples and Showcase
    • Notre Vision 🔮
    • Aperçu des fonctionnalités
    • Vue d'ensemble technique
  • Resources

    • Pricing and Plans
    • Changelog
    • API Documentation
    • Support & Community
  • Integrations

    • Needle Engine pour Unity
    • Needle Engine pour Blender
    • Needle Engine en tant que Web Component
    • Needle Engine sur votre site Web
    • Needle Cloud
  • Core Concepts

    • Structure d'un projet Needle Engine
    • Everywhere Actions
    • Exporter des Assets vers glTF
    • Frameworks, Bundlers, HTML
    • Tester sur les appareils locaux
    • Déploiement et Optimisation
  • Advanced

    • VR & AR (WebXR)
    • Image Tracking (WebXR)
    • Réseau
    • MaterialX
    • Synchronisation de l'Editor (Editor Sync)
  • Troubleshooting

    • Comment déboguer
    • Questions et Réponses (FAQ) 💡
    • Support and Community
  • Videos

    • Tutorials on Youtube
    • Interviews on Youtube
  • Scripting Overview

    • Scripting dans Needle Engine
    • Introduction au Scripting pour les Développeurs Unity
    • Composants principaux de Needle
    • Everywhere Actions
  • Components and Lifecycle

    • Créer et utiliser des Composants
    • @serializable et autres décorateurs
    • Génération automatique de composants
    • Exemples de Scripting
    • Community Contributions
    • Modules supplémentaires
  • Settings and APIs

    • <needle-engine> Configuration
    • needle.config.json
    • Needle Engine API
    • three.js API
Help
Samples
Pricing
  • Needle Website
  • Needle Cloud
  • Support Community
  • Discord Server
  • X/Twitter
  • YouTube
  • Newsletter
  • Email
  • Feedback
  • Github
  • English
  • 简体中文
  • Español
  • Português
  • Français
  • हिन्दी
  • 日本語
  • Deutsch
  • Tiếng Việt
  • Getting Started

    • Downloads
    • Needle Engine for Unity
    • Needle Engine for Blender
    • Needle Engine as Web Component
    • Needle Engine on your Website
    • Needle Cloud
    • Custom integrations
    • Support and Community
  • Core Concepts

    • Structure d'un projet Needle Engine
    • Everywhere Actions
    • Exporter des Assets vers glTF
    • Frameworks, Bundlers, HTML
    • Tester sur les appareils locaux
    • Déploiement et Optimisation
  • Scripting

    • Scripting dans Needle Engine
    • Introduction au Scripting pour les Développeurs Unity
    • Créer et utiliser des Composants
    • Génération automatique de composants
    • Exemples de Scripting
    • Community Contributions
  • Advanced

    • VR & AR (WebXR)
    • Image Tracking (WebXR)
    • Réseau
    • MaterialX
    • Synchronisation de l'Editor (Editor Sync)
  • Troubleshooting

    • Comment déboguer
    • Questions et Réponses (FAQ) 💡
    • Support and Community
  • Reference

    • Aperçu des fonctionnalités
    • Vue d'ensemble technique
    • Composants principaux de Needle
    • needle.config.json
    • <needle-engine> Configuration
    • @serializable et autres décorateurs

Attributs du composant web Needle Engine

Needle Engine est disponible en tant que composant web : <needle-engine>. Ce composant peut être utilisé pour charger et afficher des scènes 3D, des modèles, et plus encore dans un navigateur web. Il est livré avec un ensemble d'attributs qui vous permettent de configurer son comportement et son apparence. Tous ces paramètres peuvent être écrasés par le code, mais les attributs sont un moyen pratique de les configurer en HTML.

Le composant web se trouve dans index.html

Que vous créiez un projet via Unity ou Blender, ou directement dans le code, vous pouvez utiliser et ajuster le composant web <needle-engine>. Généralement, vous le trouverez dans le fichier index.html de votre projet web.

Le tableau ci-dessous présente la liste des attributs disponibles et leurs descriptions.

AttributDescription
Chargement
srcChemin vers un ou plusieurs fichiers glTF ou glb.
Les types pris en charge sont string, string[] ou un tableau sous forme de chaîne de caractères (séparés par ,)
dracoDecoderPathURL vers le décodeur draco, par ex. ./include/draco/ pour utiliser le décodeur Draco local
dracoDecoderTypeType de décodeur draco. Les options sont wasm ou js. Voir documentation three.js
ktx2DecoderPathURL vers le décodeur KTX2, par ex. ./include/ktx2/ pour utiliser le décodeur KTX2 local
Rendu
background-coloroptionnel, couleur hexadécimale à utiliser comme couleur de fond. Exemples : rgb(255, 200, 100), #dddd00
background-imageoptionnel, URL vers une image de skybox (image de fond) ou une chaîne de préréglage : studio, blurred-skybox, quicklook, quicklook-ar
background-blurrinessoptionnel, valeur de flou entre 0 (pas de flou) et 1 (flou max) pour l'background-image. Exemple : background-blurriness="0.5"
environment-imageoptionnel, URL vers une image d'environnement (lumière d'environnement) ou une chaîne de préréglage : studio, blurred-skybox, quicklook, quicklook-ar
contactshadowsoptionnel, rend les ombres de contact
tone-mappingoptionnel, les valeurs prises en charge sont none, linear, neutral, agx
tone-mapping-exposurenombre optionnel, par ex. augmente l'exposition avec tone-mapping-exposure="1.5", nécessite que tone-mapping soit défini
Interaction
autoplayajouter ou définir sur true pour lire automatiquement les animations, par ex. <needle-engine autoplay
camera-controlsajouter ou définir sur true pour ajouter automatiquement des OrbitControls si aucun contrôle de caméra n'est trouvé dans la scène
auto-rotateajouter pour activer la rotation automatique (uniquement utilisé avec camera-controls)
Événements
loadstartNom de la fonction à appeler lorsque le chargement commence. Notez que les arguments sont (ctx:Context, evt:Event). Vous pouvez appeler evt.preventDefault() pour masquer l'overlay de chargement par défaut
progressNom de la fonction à appeler lors des mises à jour de chargement. onProgress(ctx:Context, evt: {detail: {context:Context, name:string, index:number, count:number, totalProgress01:number}) { ... }
loadfinishedNom de la fonction à appeler lorsque le chargement est terminé
Affichage de ChargementOptions disponibles pour modifier l'apparence de l'affichage de chargement de Needle Engine. Utilisez ?debugloadingrendering pour faciliter l'édition
loading-backgroundPRO — Défaut : transparent. Change la couleur de fond du chargement (par ex. #dd5500)
loading-logo-srcPRO — Change l'image du logo de chargement (par ex. https://yourdomain.com/logo.png ou /logo.png)
hide-loading-overlayPRO — Ne pas afficher l'overlay de chargement
Interne
hashUtilisé en interne, est ajouté aux fichiers chargés pour forcer une mise à jour (par ex. lorsque le navigateur a mis en cache un fichier glb). Ne devrait pas être modifié manuellement.

Avis de mise à niveau:

  • Attributs supprimés dans Needle Engine 4.5.0 : loading-style, loading-background-color, loading-text-color, primary-color, secondary-color

Exemples

<!-- Réglage du chemin vers un fichier glb personnalisé à charger -->
<needle-engine src="path/to/your.glb"></needle-engine>
<!-- Remplacement de l'emplacement du décodeur draco -->
<needle-engine src="path/to/your.glb" dracoDecoderPath="./include/draco/"></needle-engine>

Définition des images d'environnement, lecture d'animation et contrôles automatiques de la caméra. Voir en direct sur stackblitz

<needle-engine
      camera-controls
      auto-rotate
      autoplay
      skybox-image="https://dl.polyhaven.org/file/ph-assets/HDRIs/hdr/1k/industrial_sunset_puresky_1k.hdr"
      environment-image="https://dl.polyhaven.org/file/ph-assets/HDRIs/hdr/1k/industrial_sunset_puresky_1k.hdr"
      src="https://raw.githubusercontent.com/KhronosGroup/glTF-Sample-Models/master/2.0/DamagedHelmet/glTF-Embedded/DamagedHelmet.gltf"
      >
      </needle-engine>

Réception d'un événement lorsque le contexte needle-engine a terminé le chargement :

<needle-engine loadfinished="onLoadFinished"> </needle-engine>
<script>
    function onLoadFinished() {
        console.log("Needle Engine a terminé le chargement");
    }
</script>

Style de chargement personnalisé (PRO)

Vous pouvez facilement modifier l'apparence de Needle Engine en définissant les attributs appropriés sur le composant web <needle-engine>. Veuillez consulter le tableau ci-dessus pour plus de détails.

chargement personnaliséVoir le code sur github

Page traduite automatiquement par l'IA

Suggest changes
Dernière mise à jour: 15/08/2025 08:05
Prev
needle.config.json
Next
@serializable et autres décorateurs