Documentación de Needle Engine
Downloads
  • What is Needle Engine?
  • Testimonios
  • Get an overview

    • Samples and Showcase
    • Nuestra Visión 🔮
    • Resumen de Características
    • Resumen técnico
  • Resources

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

    • Needle Engine para Unity
    • Needle Engine para Blender
    • Needle Engine como Web Component
    • Needle Engine en tu sitio web
    • Needle Cloud
  • Topics

    • Estructura de Proyecto Web
    • Acciones Everywhere
    • Exportar Assets a glTF
    • Frameworks, Bundlers, HTML
    • Testing on local devices
    • Despliegue y optimización
  • Advanced

    • Redes
    • VR & AR (WebXR)
    • Usando Needle Engine directamente desde HTML
    • Editor Sync
  • Troubleshooting

    • Cómo Depurar
    • Preguntas Frecuentes (FAQ) 💡
    • Get Help
  • Videos

    • Tutorials on Youtube
    • Interviews on Youtube
  • Scripting Overview

    • Scripting in Needle Engine
    • Introducción al Scripting para Desarrolladores de Unity
    • Componentes principales de Needle
    • Acciones Everywhere
  • Components and Lifecycle

    • Crear y usar Components
    • @serializable y otros decoradores
    • Generación Automática de Componentes
    • Ejemplos de scripting
    • Community Contributions
    • Módulos Adicionales
  • Settings and APIs

    • Configuración de <needle-engine>
    • 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?
  • Testimonios
  • Get an overview

    • Samples and Showcase
    • Nuestra Visión 🔮
    • Resumen de Características
    • Resumen técnico
  • Resources

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

    • Needle Engine para Unity
    • Needle Engine para Blender
    • Needle Engine como Web Component
    • Needle Engine en tu sitio web
    • Needle Cloud
  • Topics

    • Estructura de Proyecto Web
    • Acciones Everywhere
    • Exportar Assets a glTF
    • Frameworks, Bundlers, HTML
    • Testing on local devices
    • Despliegue y optimización
  • Advanced

    • Redes
    • VR & AR (WebXR)
    • Usando Needle Engine directamente desde HTML
    • Editor Sync
  • Troubleshooting

    • Cómo Depurar
    • Preguntas Frecuentes (FAQ) 💡
    • Get Help
  • Videos

    • Tutorials on Youtube
    • Interviews on Youtube
  • Scripting Overview

    • Scripting in Needle Engine
    • Introducción al Scripting para Desarrolladores de Unity
    • Componentes principales de Needle
    • Acciones Everywhere
  • Components and Lifecycle

    • Crear y usar Components
    • @serializable y otros decoradores
    • Generación Automática de Componentes
    • Ejemplos de scripting
    • Community Contributions
    • Módulos Adicionales
  • Settings and APIs

    • Configuración de <needle-engine>
    • 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

    • Estructura de Proyecto Web
    • Acciones Everywhere
    • Exportar Assets a glTF
    • Frameworks, Bundlers, HTML
    • Testing on local devices
    • Despliegue y optimización
    • Cómo Depurar
    • Preguntas Frecuentes (FAQ) 💡
  • Scripting

    • Scripting in Needle Engine
    • Introducción al Scripting para Desarrolladores de Unity
    • Crear y usar Components
    • Generación Automática de Componentes
    • Ejemplos de scripting
    • Community Contributions
  • Advanced

    • VR & AR (WebXR)
    • Redes
    • Editor Sync
  • Reference

    • Resumen de Características
    • Resumen técnico
    • Componentes principales de Needle
    • needle.config.json
    • Configuración de <needle-engine>
    • @serializable y otros decoradores

Componentes principales de Needle

Aquí tienes una descripción general de algunos de los componentes que proporcionamos. Muchos de ellos se corresponden con componentes y funcionalidades de Unity, Blender u otras integraciones.

Para ver la lista completa, consulta nuestra documentación API.

Siempre puedes añadir tus propios componentes o añadir wrappers para componentes de Unity que aún no hemos proporcionado.

Obtén más información en la sección de Scripting de nuestra documentación.

Audio

NombreDescripción
AudioListener
AudioSourceÚsalo para reproducir audio

Animación

NombreDescripción
Animator con AnimatorControllerExporta con máquina de estados de animación, condiciones, transiciones
AnimationEl componente de animación más básico. Solo se exporta el primer clip
PlayableDirector con TimelineAssetExporta secuencias potentes para controlar la animación, el audio, el estado y más

Renderizado

NombreDescripción
Camera
LightDirectionalLight, PointLight, Spotlight. Ten en cuenta que también puedes usarlo para hornear luz (por ejemplo, formas de luz rectangulares)
XRFlagControla cuándo serán visibles los objetos. Por ejemplo, solo habilita el objeto cuando está en AR
DeviceFlagControla en qué dispositivo serán visibles los objetos
LODGroup
ParticleSystemExperimental y actualmente no totalmente compatible
VideoPlayerReproducción de videos desde url o archivo de video referenciado (se copiará a la salida al exportar). El VideoPlayer también admite streaming desde objetos MediaStream o URLs de transmisión en vivo M3U8
MeshRendererSe usa para manejar el renderizado de objetos, incluyendo lightmapping e instanciación
SkinnedMeshRendererVer MeshRenderer
SpriteRendererSe usa para renderizar Sprites y Spriteanimations
Volume con asset PostProcessingVer tabla a continuación

Postprocesado

Los efectos de postprocesado utilizan la librería pmndrs postprocessing internamente. Esto significa que también puedes añadir fácilmente tus propios efectos personalizados y obtener un pase de postprocesado automáticamente optimizado.

  • Solo Unity: Ten en cuenta que los efectos de postprocesado que usan un Volume en Unity solo son compatibles con URP
Nombre del Efecto
AntialiasingComponente extra de Unity
Bloommediante asset Volume
Aberración Cromáticamediante asset Volume
Ajustes de Color / Corrección de Colormediante asset Volume
Profundidad de Campomediante asset Volume
Viñetamediante asset Volume
ToneMappingEffectmediante asset Volume o componente separado
Pixelación
Screenspace Ambient Occlusion N8
Screenspace Ambient Occlusion
Efecto Tilt Shift
Efecto de Enfoque
Tu efecto personalizadoVer ejemplo en stackblitz

Redes

NombreDescripción
SyncedRoomComponente principal de red. Ponlo en tu escena para habilitar las redes
NetworkingSe usa para configurar el servidor backend para redes.
SyncedTransformSincroniza automáticamente la transformación de objetos
SyncedCameraSincroniza automáticamente la posición y vista de la cámara a otros usuarios en la sala. Puedes definir cómo se renderiza la cámara referenciando un objeto
WebXRSyncSincroniza avatares WebXR (AR y VR)
VoipHabilita el chat de voz
ScreensharingHabilita las capacidades de compartir pantalla

Interacción

NombreDescripción
EventSystemManeja la activación de eventos de puntero y eventos de UI en objetos de la escena
ObjectRaycaterRequerido para DragControls y Duplicatable
GraphicsRaycasterIgual que ObjectRaycaster pero para elementos UI
DragControlsPermite que los objetos sean arrastrados en la escena. Requiere un raycaster en la jerarquía padre, por ejemplo, ObjectRaycater
DuplicatablePuede duplicar objetos asignados arrastrando. Requiere DragControls
InteractableComponente básico para marcar un objeto como interactuable.
OrbitControlsAñade a la cámara para añadir la funcionalidad de control de órbita de la cámara
SmoothFollowPermite interpolar suavemente a la transformación de otro objeto
DeleteBoxDestruirá objetos con el componente Deletable al entrar en la caja
DeletableEl GameObject al que se adjunta este componente será eliminado cuando entre o interseccione con un DeleteBox
DropListenerAñade para recibir eventos de arrastrar y soltar archivos para subir
SpatialTriggerÚsalo para activar un evento si un objeto entra en un espacio o área específica. También puedes usar eventos de Physics
SpatialTriggerReceiverÚsalo para recibir eventos de SpatialTrigger

Física

La física se implementa usando Rapier.

NombreDescripción
RigidbodyAñade para hacer que un objeto reaccione a la gravedad (o sea cinemático y estático)
BoxColliderUna forma de colisionador de caja con la que los objetos pueden colisionar o activar eventos trigger cuando se establece a trigger
SphereColliderVer BoxCollider
CapsuleColliderVer BoxCollider
MeshColliderVer BoxCollider
Physics MaterialsLos Physics Materials se pueden usar para definir, por ejemplo, la elasticidad de un colisionador

XR / WebXR

Lee la documentación de XR

NombreDescripción
WebXRAñade a la escena para soporte de VR, AR y Passthrough, así como para renderizar modelos de Avatares
USDZExporterAñade para habilitar soporte USD y Quicklook
XRFlagControla cuándo son visibles los objetos, por ejemplo, solo en VR o AR o solo en ThirdPerson
WebARSessionRootManeja la colocación y escala de tu escena en modo AR
WebARCameraBackgroundAñade para acceder a la imagen de la cámara AR y aplicar efectos o usarla para renderizar
WebXRImageTrackingAsigna imágenes para ser rastreadas y opcionalmente instancia un objeto en la posición de la imagen
WebXRPlaneTrackingCrea mallas de plano o colliders para planos rastreados
XRControllerModelSe puede añadir para renderizar controladores de dispositivo o modelos de mano (se crearán por defecto cuando estén habilitados en el componente WebXR)
XRControllerMovementSe puede añadir para proporcionar movimiento predeterminado y controles de teletransporte
XRControllerFollowSe puede añadir a cualquier objeto de la escena y configurar para seguir la mano o el controlador izquierdo o derecho

Depuración

NombreDescripción
GridHelperDibuja una cuadrícula
BoxGizmoDibuja una caja
AxesHelperDibuja los ejes XYZ
Nota: Cuando escribas código personalizado, puedes usar los métodos estáticos Gizmos para dibujar líneas y formas de depuración

Entrada/Salida de Archivos en Tiempo de Ejecución

NombreDescripción
GltfExport¡Experimental! Úsalo para exportar gltf desde el runtime web.
DropListenerRecibe eventos de arrastrar y soltar archivos para subir y sincronizar en red

UI

Los componentes Spatial UI se mapean desde Unity UI (Canvas, no UI Toolkit) a three-mesh-ui. La UI se puede animar.

NombreDescripción
CanvasSistema UI de Unity. Necesita estar en modo World Space ahora mismo.
Text (Legacy)Renderiza Text usando el componente UI Text de Unity. Se admiten fuentes personalizadas, se generará automáticamente un atlas de fuentes al exportar. Utiliza la configuración de fuente o el componente FontAdditionalCharacters para controlar qué caracteres se incluyen en el atlas.
Nota: En Unity, asegúrate de usar el componente Legacy/Text (TextMeshPro no es compatible en este momento)
ButtonRecibe eventos de clic - usa el evento onClick para reaccionar a él. También se puede añadir a objetos de la escena 3D.
Nota: Asegúrate de usar el componente Legacy/Text en el Button (o crea el Button a través del menú contextual UI/Legacy/Button de Unity ya que TextMeshPro no es compatible en este momento)
ImageRenderiza una imagen sprite
RawImageRenderiza una textura
InputFieldPermite la entrada de texto

Nota: Dependiendo de tu proyecto, a menudo tiene sentido una mezcla de UI espacial y 2D para proyectos multiplataforma donde se admiten VR, AR y pantallas. Típicamente, construirías las partes 2D con HTML para una mejor accesibilidad, y las partes 3D con UIs geométricas que también admitan desfases de profundidad (por ejemplo, estados hover de botones y similares).

Otros

NombreDescripción
SceneSwitcherManeja la carga y descarga de otras escenas o archivos prefabs / glTF. Tiene características para precargar, cambiar de escena mediante deslizamientos, eventos de teclado o navegación por URL

Solo Editor

NombreDescripción
ExportInfoComponente principal para gestionar el(los) proyecto(s) web, por ejemplo, para instalar o iniciar la aplicación web
EditorSyncAñade para habilitar la sincronización de cambios de valor de materiales o componentes en la aplicación three.js en ejecución directamente desde el Editor de Unity sin tener que recargar

Página traducida automáticamente usando IA

Suggest changes
Actualizado el:: 22/4/25, 8:44
Prev
Resumen técnico
Next
needle.config.json