Needle Engine Dokumentation
Downloads
  • What is Needle Engine?
  • Erfahrungsberichte
  • Get an overview

    • Samples and Showcase
    • Unsere Vision 🔮
    • Funktionsübersicht
    • Technischer Überblick
  • Resources

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

    • Needle Engine für Unity
    • Needle Engine für Blender
    • Needle Engine als Web Component
    • Needle Engine auf Ihrer Website
    • Needle Cloud
  • Topics

    • Web-Projektstruktur
    • Everywhere Actions
    • Assets nach glTF exportieren
    • Frameworks, Bundler, HTML
    • Testen auf lokalen Geräten
    • Bereitstellung und Optimierung
  • Advanced

    • Netzwerkfunktionen
    • VR & AR (WebXR)
    • Needle Engine direkt aus HTML verwenden
    • Editor Synchronisierung
  • Troubleshooting

    • Debugging
    • Fragen und Antworten (FAQ) 💡
    • Get Help
  • Videos

    • Tutorials on Youtube
    • Interviews on Youtube
  • Scripting Overview

    • Scripting in Needle Engine
    • Einführung in das Scripting für Unity-Entwickler
    • Needle-Kernkomponenten
    • Everywhere Actions
  • Components and Lifecycle

    • Erstellen und Verwenden von Komponenten
    • @serializable und andere Decorators
    • Automatische Komponenten-Generierung
    • Scripting Beispiele
    • Community Contributions
    • Zusätzliche Module
  • Settings and APIs

    • <needle-engine> Konfiguration
    • 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?
  • Erfahrungsberichte
  • Get an overview

    • Samples and Showcase
    • Unsere Vision 🔮
    • Funktionsübersicht
    • Technischer Überblick
  • Resources

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

    • Needle Engine für Unity
    • Needle Engine für Blender
    • Needle Engine als Web Component
    • Needle Engine auf Ihrer Website
    • Needle Cloud
  • Topics

    • Web-Projektstruktur
    • Everywhere Actions
    • Assets nach glTF exportieren
    • Frameworks, Bundler, HTML
    • Testen auf lokalen Geräten
    • Bereitstellung und Optimierung
  • Advanced

    • Netzwerkfunktionen
    • VR & AR (WebXR)
    • Needle Engine direkt aus HTML verwenden
    • Editor Synchronisierung
  • Troubleshooting

    • Debugging
    • Fragen und Antworten (FAQ) 💡
    • Get Help
  • Videos

    • Tutorials on Youtube
    • Interviews on Youtube
  • Scripting Overview

    • Scripting in Needle Engine
    • Einführung in das Scripting für Unity-Entwickler
    • Needle-Kernkomponenten
    • Everywhere Actions
  • Components and Lifecycle

    • Erstellen und Verwenden von Komponenten
    • @serializable und andere Decorators
    • Automatische Komponenten-Generierung
    • Scripting Beispiele
    • Community Contributions
    • Zusätzliche Module
  • Settings and APIs

    • <needle-engine> Konfiguration
    • 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

    • Web-Projektstruktur
    • Everywhere Actions
    • Assets nach glTF exportieren
    • Frameworks, Bundler, HTML
    • Testen auf lokalen Geräten
    • Bereitstellung und Optimierung
    • Debugging
    • Fragen und Antworten (FAQ) 💡
  • Scripting

    • Scripting in Needle Engine
    • Einführung in das Scripting für Unity-Entwickler
    • Erstellen und Verwenden von Komponenten
    • Automatische Komponenten-Generierung
    • Scripting Beispiele
    • Community Contributions
  • Advanced

    • VR & AR (WebXR)
    • Netzwerkfunktionen
    • Editor Synchronisierung
  • Reference

    • Funktionsübersicht
    • Technischer Überblick
    • Needle-Kernkomponenten
    • needle.config.json
    • <needle-engine> Konfiguration
    • @serializable und andere Decorators

Needle-Kernkomponenten

Hier ist eine Übersicht über einige der von uns bereitgestellten Komponenten. Viele davon bilden Komponenten und Funktionen in Unity, Blender oder anderen Integrationen ab.

Eine vollständige Liste finden Sie in unserer API-Dokumentation.

Sie können jederzeit eigene Komponenten hinzufügen oder Wrapper für Unity-Komponenten erstellen, die wir noch nicht bereitgestellt haben.

Mehr dazu erfahren Sie im Abschnitt Skripting unserer Dokumentation.

Audio

NameBeschreibung
AudioListener
AudioSourceZum Abspielen von Audio

Animation

NameBeschreibung
Animator mit AnimatorControllerExport mit Animations-Zustandsmaschine, Bedingungen, Übergängen
AnimationGrundlegendste Animationskomponente. Nur der erste Clip wird exportiert
PlayableDirector mit TimelineAssetExportieren Sie leistungsstarke Sequenzen zur Steuerung von Animation, Audio, Zustand und mehr

Rendering

NameBeschreibung
Camera
LightDirectionalLight, PointLight, Spotlight. Beachten Sie, dass Sie damit auch Licht backen können (z. B. rechteckige Lichtformen)
XRFlagSteuert, wann Objekte sichtbar sind. Z.B. Objekt nur in AR aktivieren
DeviceFlagSteuert, auf welchem Gerät Objekte sichtbar sind
LODGroup
ParticleSystemExperimentell und derzeit nicht vollständig unterstützt
VideoPlayerWiedergabe von Videos von URL oder referenzierter Videodatei (wird beim Export in den Output kopiert). Der VideoPlayer unterstützt auch Streaming von MediaStream-Objekten oder M3U8 Livestream-URLs
MeshRendererWird zur Handhabung des Renderings von Objekten verwendet, einschließlich Lightmapping und Instancing
SkinnedMeshRendererSiehe MeshRenderer
SpriteRendererWird zum Rendern von Sprites und Spriteanimationen verwendet
Volume mit PostProcessing AssetSiehe Tabelle unten

Nachbearbeitung

Nachbearbeitungseffekte verwenden im Hintergrund die pmndrs postprocessing library. Das bedeutet, Sie können auch einfach eigene Effekte hinzufügen und erhalten einen automatisch optimierten Nachbearbeitungsdurchgang.

  • Nur Unity: Beachten Sie, dass Postprocessing-Effekte, die ein Volume in Unity verwenden, nur mit URP unterstützt werden.
Effektname
Antialiasingzusätzliche Unity Komponente
Bloomvia Volume asset
Chromatic Aberrationvia Volume asset
Color Adjustments / Color Correctionvia Volume asset
Depth Of Fieldvia Volume asset
Vignettevia Volume asset
ToneMappingEffectvia Volume asset oder separate Komponente
Pixelation
Screenspace Ambient Occlusion N8
Screenspace Ambient Occlusion
Tilt Shift Effect
SharpeningEffect
Ihr eigener EffektSiehe Beispiel auf stackblitz

Networking

NameBeschreibung
SyncedRoomHaupt-Networking-Komponente. Platzieren Sie sie in Ihrer Szene, um Networking zu aktivieren
NetworkingWird zur Einrichtung des Backend-Servers für Networking verwendet.
SyncedTransformAutomatische Synchronisierung der Objekttransformation
SyncedCameraAutomatische Synchronisierung der Kameraposition und -ansicht für andere Benutzer im Raum. Sie können definieren, wie die Kamera gerendert wird, indem Sie ein Objekt referenzieren
WebXRSyncSynchronisiert WebXR-Avatare (AR und VR)
VoipErmöglicht Voice-Chat
ScreensharingErmöglicht Screen-Sharing-Funktionen

Interaktion

NameBeschreibung
EventSystemBehandelt das Auslösen von Pointer- und UI-Events auf Objekten in der Szene
ObjectRaycaterErforderlich für DragControls und Duplicatable
GraphicsRaycasterGleiches wie ObjectRaycater, aber für UI-Elemente
DragControlsErmöglicht das Ziehen von Objekten in der Szene. Erfordert Raycaster in der Elternhierarchie, z.B. ObjectRaycater
DuplicatableKann zugewiesene Objekte durch Ziehen duplizieren. Erfordert DragControls
InteractableGrundlegende Komponente zur Kennzeichnung eines Objekts als interaktionsfähig.
OrbitControlsZur Kamera hinzufügen, um die Orbit-Steuerungsfunktionalität der Kamera hinzuzufügen
SmoothFollowErmöglicht die sanfte Interpolation zur Transformation eines anderen Objekts
DeleteBoxZerstört Objekte mit der Komponente Deletable, wenn sie in die Box eintreten
DeletableDas GameObject, an das diese Komponente angehängt ist, wird gelöscht, wenn es in eine DeleteBox eintritt oder sich mit ihr überschneidet
DropListenerHinzufügen, um Datei-Drop-Events für den Upload zu empfangen
SpatialTriggerWird verwendet, um ein Event auszulösen, wenn ein Objekt einen bestimmten Raum oder Bereich betritt. Sie können auch Physik-Events verwenden
SpatialTriggerReceiverWird verwendet, um Events von SpatialTrigger zu empfangen

Physik

Die Physik wird mit Rapier implementiert.

NameBeschreibung
RigidbodyHinzufügen, um ein Objekt auf die Schwerkraft reagieren zu lassen (oder kinematisch und statisch zu sein)
BoxColliderEine Box-Collider-Form, mit der Objekte kollidieren oder Trigger-Events auslösen können, wenn sie auf trigger gesetzt ist
SphereColliderSiehe BoxCollider
CapsuleColliderSiehe BoxCollider
MeshColliderSiehe BoxCollider
Physik-MaterialienPhysik-Materialien können verwendet werden, um z. B. die Sprungkraft eines Colliders zu definieren

XR / WebXR

Lesen Sie die XR-Dokumentation

NameBeschreibung
WebXRZur Szene hinzufügen für VR-, AR- und Passthrough-Unterstützung sowie zum Rendern von Avatar-Modellen
USDZExporterHinzufügen, um USD und Quicklook-Unterstützung zu aktivieren
XRFlagSteuert, wann Objekte sichtbar sind, z. B. nur in VR oder AR oder nur in der Third-Person-Ansicht
WebARSessionRootHandhabt die Platzierung und Skalierung Ihrer Szene im AR-Modus
WebARCameraBackgroundHinzufügen, um auf das AR-Kamerabild zuzugreifen und Effekte anzuwenden oder es für das Rendering zu verwenden
WebXRImageTrackingBilder zur Verfolgung zuweisen und optional ein Objekt an der Bildposition instanziieren
WebXRPlaneTrackingPlanare Meshes oder Collider für verfolgte Ebenen erstellen
XRControllerModelKann hinzugefügt werden, um Geräte-Controller oder Handmodelle zu rendern (werden standardmäßig erstellt, wenn in der WebXR-Komponente aktiviert)
XRControllerMovementKann hinzugefügt werden, um Standardbewegungs- und Teleportationssteuerungen bereitzustellen
XRControllerFollowKann zu jedem Objekt in der Szene hinzugefügt und so konfiguriert werden, dass es entweder der linken oder rechten Hand oder den Controllern folgt

Debugging

NameBeschreibung
GridHelperZeichnet ein Gitter
BoxGizmoZeichnet eine Box
AxesHelperZeichnet XYZ-Achsen
Hinweis: Wenn Sie benutzerdefinierten Code schreiben, können Sie die statischen Gizmos-Methoden zum Zeichnen von Debugging-Linien und -Formen verwenden

Laufzeit-Datei-Input/Output

NameBeschreibung
GltfExportExperimentell! Wird zum Exportieren von gltf aus der Web-Laufzeit verwendet.
DropListenerEmpfängt Datei-Drop-Events für den Upload und Networking

UI

Räumliche UI-Komponenten werden von Unity UI (Canvas, nicht UI Toolkit) auf three-mesh-ui abgebildet. UI kann animiert werden.

NameBeschreibung
CanvasUnitys UI-System. Muss derzeit im World Space Modus sein.
Text (Legacy)Rendert Text mit Unitys UI Text-Komponente. Benutzerdefinierte Schriftarten werden unterstützt, ein Schriftart-Atlas wird beim Export automatisch generiert. Verwenden Sie die Schriftart-Einstellungen oder die FontAdditionalCharacters-Komponente, um zu steuern, welche Zeichen in den Atlas aufgenommen werden.
Hinweis: Stellen Sie in Unity sicher, dass Sie die Komponente Legacy/Text verwenden (TextMeshPro wird derzeit nicht unterstützt)
ButtonEmpfängt Klick-Events - verwenden Sie das onClick-Event, um darauf zu reagieren. Es kann auch zu 3D-Szenenobjekten hinzugefügt werden.
Hinweis: Stellen Sie sicher, dass Sie die Komponente Legacy/Text im Button verwenden (oder erstellen Sie den Button über das Kontextmenü UI/Legacy/Button in Unity, da TextMeshPro derzeit nicht unterstützt wird)
ImageRendert ein Sprite-Bild
RawImageRendert eine Textur
InputFieldErmöglicht Texteingabe

Hinweis: Je nach Projekt ist oft eine Mischung aus räumlicher und 2D-UI sinnvoll für Cross-Platform-Projekte, bei denen VR, AR und Bildschirme unterstützt werden. Typischerweise würden Sie die 2D-Teile mit HTML für beste Zugänglichkeit erstellen und die 3D-Teile mit geometrischen UIs, die auch Tiefen-Offsets unterstützen (z. B. Button-Hover-States und ähnliches).

Sonstiges

NameBeschreibung
SceneSwitcherHandhabt das Laden und Entladen anderer Szenen oder Prefabs / glTF-Dateien. Verfügt über Funktionen zum Vorladen, Wechseln von Szenen durch Wischen, Tastatur-Events oder URL-Navigation

Nur Editor

NameBeschreibung
ExportInfoHauptkomponente zur Verwaltung des/der Webprojekts/e, z. B. zum Installieren oder Starten der Web-App
EditorSyncHinzufügen, um die Netzwerk-Synchronisierung von Material- oder Komponentenwertänderungen direkt vom Unity Editor zur laufenden three.js-App zu ermöglichen, ohne neu laden zu müssen
Seite automatisch mit AI übersetzt
Suggest changes
Zuletzt aktualisiert:: 22.04.25, 08:44
Prev
Technischer Überblick
Next
needle.config.json