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 composant web
    • Needle Engine sur votre site Web
    • Needle Cloud
  • Topics

    • Structure de projet Web
    • Everywhere Actions
    • Exporter des Assets vers glTF
    • Frameworks, Bundlers, HTML
    • Tester sur les appareils locaux
    • Déploiement et Optimisation
  • Advanced

    • Réseau
    • VR & AR (WebXR)
    • Utiliser Needle Engine directement depuis HTML
    • Synchronisation de l'Editor (Editor Sync)
  • Troubleshooting

    • Comment déboguer
    • Questions et Réponses (FAQ) 💡
    • Get Help
  • Videos

    • Tutorials on Youtube
    • Interviews on Youtube
  • Scripting Overview

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

    • Créer et utiliser des Components
    • @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 composant web
    • Needle Engine sur votre site Web
    • Needle Cloud
  • Topics

    • Structure de projet Web
    • Everywhere Actions
    • Exporter des Assets vers glTF
    • Frameworks, Bundlers, HTML
    • Tester sur les appareils locaux
    • Déploiement et Optimisation
  • Advanced

    • Réseau
    • VR & AR (WebXR)
    • Utiliser Needle Engine directement depuis HTML
    • Synchronisation de l'Editor (Editor Sync)
  • Troubleshooting

    • Comment déboguer
    • Questions et Réponses (FAQ) 💡
    • Get Help
  • Videos

    • Tutorials on Youtube
    • Interviews on Youtube
  • Scripting Overview

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

    • Créer et utiliser des Components
    • @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 de projet Web
    • Everywhere Actions
    • Exporter des Assets vers glTF
    • Frameworks, Bundlers, HTML
    • Tester sur les appareils locaux
    • Déploiement et Optimisation
    • Comment déboguer
    • Questions et Réponses (FAQ) 💡
  • Scripting

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

    • VR & AR (WebXR)
    • Réseau
    • Synchronisation de l'Editor (Editor Sync)
  • 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

Composants principaux de Needle

Voici un aperçu de certains des composants que nous fournissons. Beaucoup d'entre eux correspondent à des composants et des fonctionnalités dans Unity, Blender ou d'autres intégrations.

Pour une liste complète, veuillez consulter notre API docs.

Vous pouvez toujours ajouter vos propres composants ou ajouter des wrappers pour les composants Unity que nous n'avons pas encore fournis.

Apprenez-en plus dans la section Scripting de notre documentation.

Audio

NomDescription
AudioListener
AudioSourceUtiliser pour jouer de l'audio

Animation

NomDescription
Animator avec AnimatorControllerExporter avec animation state machine, conditions, transitions
AnimationComposant d'animation le plus basique. Seul le premier clip est exporté
PlayableDirector avec TimelineAssetExporter des séquences puissantes pour contrôler l'animation, l'audio, l'état et plus encore

Rendu

NomDescription
Camera
LightDirectionalLight, PointLight, Spotlight. Notez que vous pouvez l'utiliser pour le bake light (par exemple, les formes Rectangular Light) également
XRFlagContrôler la visibilité des objets. Par exemple, activer un objet uniquement en mode AR
DeviceFlagContrôler sur quel appareil les objets seront visibles
LODGroup
ParticleSystemExpérimental et actuellement pas entièrement supporté
VideoPlayerLecture de vidéos depuis une url ou un fichier vidéo référencé (sera copié dans la sortie lors de l'exportation). Le VideoPlayer prend également en charge le streaming depuis des objets MediaStream ou des url de livestream M3U8
MeshRendererUtilisé pour gérer le rendu des objets, y compris le lightmapping et l'instancing
SkinnedMeshRendererVoir MeshRenderer
SpriteRendererUtilisé pour rendre des Sprites et Spriteanimations
Volume avec asset PostProcessingVoir le tableau ci-dessous

Postprocessing

Les effets de post-traitement utilisent la bibliothèque postprocessing de pmndrs en arrière-plan. Cela signifie que vous pouvez également ajouter facilement vos propres effets personnalisés et obtenir un postprocessing pass automatiquement optimisé.

  • Unity only: Notez que les effets de Postprocessing utilisant un Volume dans Unity ne sont supportés qu'avec URP
Nom de l'effet
AntialiasingUnity Component supplémentaire
Bloomvia Volume asset
Chromatic Aberrationvia Volume asset
Color Adjustments / Color Correctionvia Volume asset
Depth Of Fieldvia Volume asset
Vignettevia Volume asset
ToneMappingEffectvia Volume asset ou component séparé
Pixelation
Screenspace Ambient Occlusion N8
Screenspace Ambient Occlusion
Tilt Shift Effect
SharpeningEffect
Votre effet personnaliséVoir l'exemple sur stackblitz

Networking

NomDescription
SyncedRoomComposant de mise en réseau principal. Placez-le dans votre scène pour activer la mise en réseau
NetworkingUtilisé pour configurer le backend server pour la mise en réseau.
SyncedTransformMet automatiquement en réseau la transformation de l'objet
SyncedCameraMet automatiquement en réseau la position et la vue de la caméra pour les autres utilisateurs de la salle. Vous pouvez définir la manière dont la caméra est rendue en référençant un objet
WebXRSyncMet en réseau les avatars WebXR (AR et VR)
VoipActive le voice-chat
ScreensharingActive les capacités de screen-sharing

Interaction

NomDescription
EventSystemGère le déclenchement des pointer events et des UI events sur les objets de la scène
ObjectRaycaterRequis pour DragControls et Duplicatable
GraphicsRaycasterIdentique à ObjectRaycaster mais pour les UI elements
DragControlsPermet de glisser des objets dans la scène. Nécessite un raycaster dans la hierarchy parent, par exemple ObjectRaycaster
DuplicatablePermet de dupliquer les objets assignés par glisser-déposer. Nécessite DragControls
InteractableComposant basique pour marquer un objet comme interactable.
OrbitControlsAjouter à la caméra pour ajouter une fonctionnalité de contrôle d'orbite de caméra
SmoothFollowPermet d'interpoler en douceur vers le transform d'un autre objet
DeleteBoxDétruira les objets avec le component Deletable lorsqu'ils entreront dans la boîte
DeletableLe GameObject auquel ce component est attaché sera supprimé lorsqu'il entrera ou intersectera avec un DeleteBox
DropListenerAjouter pour recevoir les file drop events pour le téléchargement
SpatialTriggerUtiliser pour déclencher un événement si un objet entre dans un espace ou une zone spécifique. Vous pouvez également utiliser les Physics events
SpatialTriggerReceiverUtiliser pour recevoir des événements de SpatialTrigger

Physique

La physique est implémentée en utilisant Rapier.

NomDescription
RigidbodyAjouter pour qu'un objet réagisse à la gravité (ou soit kinematic et static)
BoxColliderUne shape de Box collider avec laquelle les objets peuvent entrer en collision ou déclencher des trigger events lorsqu'elle est définie sur trigger
SphereColliderVoir BoxCollider
CapsuleColliderVoir BoxCollider
MeshColliderVoir BoxCollider
Physics MaterialsLes Physics materials peuvent être utilisés pour définir par exemple la bouncyness d'un collider

XR / WebXR

Lire la documentation XR

NomDescription
WebXRAjouter à la scène pour le support VR, AR et Passthrough ainsi que le rendu des Avatar models
USDZExporterAjouter pour activer le support USD et Quicklook
XRFlagContrôler la visibilité des objets, par exemple uniquement en VR ou AR ou uniquement en ThirdPerson
WebARSessionRootGère le placement et l'échelle de votre scène en mode AR
WebARCameraBackgroundAjouter pour accéder à l'image de la AR camera et appliquer des effets ou l'utiliser pour le rendu
WebXRImageTrackingAttribuer des images à suivre et éventuellement instancier un objet à la position de l'image
WebXRPlaneTrackingCréer des meshes de plan ou des colliders pour les plans suivis
XRControllerModelPeut être ajouté pour rendre les device controllers ou les hand models (sera créé par défaut si activé dans le WebXR component)
XRControllerMovementPeut être ajouté pour fournir les contrôles de mouvement par défaut et de teleport
XRControllerFollowPeut être ajouté à n'importe quel objet de la scène et configuré pour suivre les mains ou les controllers gauches ou droits

Débogage

NomDescription
GridHelperDessine une grille
BoxGizmoDessine une boîte
AxesHelperDessine les axes XYZ
Note : Lorsque vous écrivez du code personnalisé, vous pouvez utiliser les static Gizmos methods pour dessiner des lignes et des shapes de débogage

Entrée/Sortie de fichiers à l'exécution

NomDescription
GltfExportExpérimental ! Utiliser pour exporter des gltf depuis le web runtime.
DropListenerRecevoir les file drop events pour le téléchargement et la mise en réseau

UI

Les composants d'UI spatiale sont mappés du système UI de Unity (Canvas, pas UI Toolkit) à three-mesh-ui. L'UI peut être animée.

NomDescription
CanvasLe système d'UI de Unity. Doit être en mode World Space actuellement.
Text (Legacy)Rendre le Text en utilisant le component UI Text de Unity. Les polices personnalisées sont supportées, un font atlas sera automatiquement généré à l'exportation. Utilisez les paramètres de police ou le component FontAdditionalCharacters pour contrôler quels caractères sont inclus dans l'atlas.
Note : Dans Unity, assurez-vous d'utiliser le component Legacy/Text (TextMeshPro n'est pas supporté pour le moment)
ButtonReçoit les click events - utilisez l'onClick event pour y réagir. Il peut également être ajouté aux objets de scène 3D.
Note : Assurez-vous d'utiliser le component Legacy/Text dans le Button (ou créez le Button via le menu contextuel UI/Legacy/Button de Unity car TextMeshPro n'est pas supporté pour le moment)
ImageRend une sprite image
RawImageRend une texture
InputFieldPermet la text input

Note : Selon votre projet, un mélange d'UI spatiales et 2D a souvent du sens pour les projets multiplateformes où la VR, l'AR et les écrans sont pris en charge. Généralement, vous construisez les parties 2D avec HTML pour une meilleure accessibilité, et les parties 3D avec des UIs géométriques qui supportent également les depth offsets (par exemple, les button hover states et similaires).

Autre

NomDescription
SceneSwitcherGère le chargement et le déchargement d'autres scènes ou de prefabs / glTF files. Dispose de fonctionnalités pour le preload, le changement de scènes via le swiping, les keyboard events ou la URL navigation

Éditeur Uniquement

NomDescription
ExportInfoComposant principal pour gérer le(s) web project(s), par exemple pour installer ou démarrer l'application web
EditorSyncAjouter pour activer la mise en réseau des material ou des component value changes vers l'application three.js en cours d'exécution directement depuis le Unity Editor sans avoir à recharger

Page automatiquement traduite à l'aide de l'IA

Suggest changes
Dernière mise à jour:: 22/04/2025 11:01
Prev
Vue d'ensemble technique
Next
needle.config.json