Documentação do Needle Engine
Downloads
  • What is Needle Engine?
  • Depoimentos
  • Get an overview

    • Samples and Showcase
    • A Nossa Visão 🔮
    • Visão Geral de Recursos
    • Visão Geral Técnica
  • 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 no seu Website
    • Needle Cloud
  • Core Concepts

    • Estrutura de um Projeto Needle Engine
    • Everywhere Actions
    • Exportar Recursos para glTF
    • Frameworks, Bundlers, HTML
    • Testar em dispositivos locais
    • Implementação e Otimização
  • Advanced

    • VR & AR (WebXR)
    • Image Tracking (WebXR)
    • Rede
    • MaterialX
    • Sincronização do Editor
  • Troubleshooting

    • Como Depurar
    • Perguntas e Respostas (FAQ) 💡
    • Support and Community
  • Videos

    • Tutorials on Youtube
    • Interviews on Youtube
  • Scripting Overview

    • Scripting no Needle Engine
    • Introdução à Scripting para Developers Unity
    • Componentes Principais do Needle
    • Everywhere Actions
  • Components and Lifecycle

    • Criar e usar Componentes
    • @serializable e outros decorators
    • Geração Automática de Componentes
    • Exemplos de Scripting
    • Community Contributions
    • Módulos Adicionais
  • Settings and APIs

    • <needle-engine> Configuração
    • 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?
  • Depoimentos
  • Get an overview

    • Samples and Showcase
    • A Nossa Visão 🔮
    • Visão Geral de Recursos
    • Visão Geral Técnica
  • 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 no seu Website
    • Needle Cloud
  • Core Concepts

    • Estrutura de um Projeto Needle Engine
    • Everywhere Actions
    • Exportar Recursos para glTF
    • Frameworks, Bundlers, HTML
    • Testar em dispositivos locais
    • Implementação e Otimização
  • Advanced

    • VR & AR (WebXR)
    • Image Tracking (WebXR)
    • Rede
    • MaterialX
    • Sincronização do Editor
  • Troubleshooting

    • Como Depurar
    • Perguntas e Respostas (FAQ) 💡
    • Support and Community
  • Videos

    • Tutorials on Youtube
    • Interviews on Youtube
  • Scripting Overview

    • Scripting no Needle Engine
    • Introdução à Scripting para Developers Unity
    • Componentes Principais do Needle
    • Everywhere Actions
  • Components and Lifecycle

    • Criar e usar Componentes
    • @serializable e outros decorators
    • Geração Automática de Componentes
    • Exemplos de Scripting
    • Community Contributions
    • Módulos Adicionais
  • Settings and APIs

    • <needle-engine> Configuração
    • 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

    • Estrutura de um Projeto Needle Engine
    • Everywhere Actions
    • Exportar Recursos para glTF
    • Frameworks, Bundlers, HTML
    • Testar em dispositivos locais
    • Implementação e Otimização
  • Scripting

    • Scripting no Needle Engine
    • Introdução à Scripting para Developers Unity
    • Criar e usar Componentes
    • Geração Automática de Componentes
    • Exemplos de Scripting
    • Community Contributions
  • Advanced

    • VR & AR (WebXR)
    • Image Tracking (WebXR)
    • Rede
    • MaterialX
    • Sincronização do Editor
  • Troubleshooting

    • Como Depurar
    • Perguntas e Respostas (FAQ) 💡
    • Support and Community
  • Reference

    • Visão Geral de Recursos
    • Visão Geral Técnica
    • Componentes Principais do Needle
    • needle.config.json
    • <needle-engine> Configuração
    • @serializable e outros decorators

Componentes Principais do Needle

Aqui está uma visão geral de alguns dos componentes que fornecemos. Muitos deles mapeiam para componentes e funcionalidades em Unity, Blender ou outras integrações.

Para uma lista completa, consulte a nossa documentação da API.

Pode sempre adicionar os seus próprios componentes ou adicionar wrappers para componentes Unity que ainda não fornecemos.

Saiba mais na secção Scripting da nossa documentação.

Audio

NameDescription
AudioListener
AudioSourceUsar para reproduzir áudio

Animation

NameDescription
Animator com AnimatorControllerExporta com máquina de estado de animação, condições, transições
AnimationComponente de animação mais básico. Apenas o primeiro clip é exportado
PlayableDirector com TimelineAssetExporta sequências poderosas para controlar animação, áudio, estado e mais

Rendering

NameDescription
Camera
LightDirectionalLight, PointLight, Spotlight. Note que pode usá-lo para fazer bake de luz (e.g. formas Rectangular Light) também
XRFlagControla quando os objetos serão visíveis. E.g. habilitar objeto apenas em AR
DeviceFlagControla em que dispositivo os objetos serão visíveis
LODGroup
ParticleSystemExperimental e atualmente não totalmente suportado
VideoPlayerReproduz vídeos de url ou ficheiro de vídeo referenciado (será copiado para o output na exportação). O VideoPlayer também suporta streaming de objetos MediaStream ou URLs de livestream M3U8
MeshRendererUsado para lidar com o rendering de objetos incluindo lightmapping e instancing
SkinnedMeshRendererVer MeshRenderer
SpriteRendererUsado para renderizar Sprites e Spriteanimations
Volume com asset PostProcessingVer tabela abaixo

Postprocessing

Os efeitos de postprocessing usam a biblioteca pmndrs postprocessing por baixo. Isso significa que também pode adicionar facilmente os seus próprios efeitos personalizados e obter um passo de postprocessing otimizado automaticamente.

  • Unity only: Note que efeitos de Postprocessing usando um Volume em Unity só são suportados com URP
Effect Name
Antialiasingcomponente Unity extra
Bloomvia asset Volume
Chromatic Aberrationvia asset Volume
Color Adjustments / Color Correctionvia asset Volume
Depth Of Fieldvia asset Volume
Vignettevia asset Volume
ToneMappingEffectvia asset Volume ou componente separado
Pixelation
Screenspace Ambient Occlusion N8
Screenspace Ambient Occlusion
Tilt Shift Effect
SharpeningEffect
O seu efeito personalizadoVer exemplo no stackblitz

Networking

NameDescription
SyncedRoomComponente principal de networking. Coloque na sua cena para habilitar networking
NetworkingUsado para configurar o servidor backend para networking.
SyncedTransformRede automaticamente a transformação de objetos
SyncedCameraRede automaticamente a posição da câmara e a vista para outros utilizadores na sala. Pode definir como a câmara está a ser renderizada referenciando um objeto
WebXRSyncRede avatares WebXR (AR e VR)
VoipHabilita chat de voz
ScreensharingHabilita capacidades de partilha de ecrã

Interaction

NameDescription
EventSystemLida com a emissão de eventos de ponteiro e eventos de UI em objetos na cena
ObjectRaycaterNecessário para DragControls e Duplicatable
GraphicsRaycasterO mesmo que ObjectRaycaster mas para elementos de UI
DragControlsPermite que objetos sejam arrastados na cena. Requer raycaster na hierarquia pai, e.g. ObjectRaycater
DuplicatablePode duplicar objetos atribuídos por arrasto. Requer DragControls
InteractableComponente básico para marcar um objeto como interativo.
OrbitControlsAdicione à câmara para adicionar funcionalidade de controlo de órbita da câmara
SmoothFollowPermite interpolar suavemente para a transformação de outro objeto
DeleteBoxDestruirá objetos com o componente Deletable ao entrar na caixa
DeletableO GameObject ao qual este componente está anexado será eliminado quando entrar ou intersetar com um DeleteBox
DropListenerAdicione para receber eventos de arrasto de ficheiros para upload
SpatialTriggerUse para emitir um evento se um objeto entrar num espaço ou área específica. Pode também usar eventos de Physics
SpatialTriggerReceiverUse para receber eventos de SpatialTrigger

Physics

Physics é implementado usando Rapier.

NameDescription
RigidbodyAdicione para fazer um objeto reagir à gravidade (ou ser cinemático e estático)
BoxColliderUma forma de colisor Box com a qual os objetos podem colidir ou emitir eventos de gatilho quando definido como trigger
SphereColliderVer BoxCollider
CapsuleColliderVer BoxCollider
MeshColliderVer BoxCollider
Physics MaterialsPhysics materials podem ser usados para definir e.g. a elasticidade de um colisor

XR / WebXR

Leia a documentação XR

NameDescription
WebXRAdicione à cena para suporte VR, AR e Passthrough, bem como para renderizar modelos de Avatar
USDZExporterAdicione para habilitar suporte USD e Quicklook
XRFlagControla quando os objetos são visíveis, e.g. apenas em VR ou AR ou apenas em ThirdPerson
WebARSessionRootLida com a colocação e escala da sua cena no modo AR
WebARCameraBackgroundAdicione para aceder à imagem da câmara AR e aplicar efeitos ou usá-la para rendering
WebXRImageTrackingAtribua imagens a serem rastreadas e opcionalmente instancie um objeto na posição da imagem
WebXRPlaneTrackingCrie meshes de plano ou colisores para planos rastreados
XRControllerModelPode ser adicionado para renderizar controladores de dispositivo ou modelos de mão (serão criados por padrão quando habilitado no componente WebXR)
XRControllerMovementPode ser adicionado para fornecer controlos padrão de movimento e teletransporte
XRControllerFollowPode ser adicionado a qualquer objeto na cena e configurado para seguir a mão ou controlador esquerdo ou direito

Debugging

NameDescription
GridHelperDesenha uma grelha
BoxGizmoDesenha uma caixa
AxesHelperDesenha eixos XYZ
Nota: Quando estiver a escrever código personalizado, pode usar os métodos estáticos Gizmos para desenhar linhas e formas de depuração

Runtime File Input/Output

NameDescription
GltfExportExperimental! Use para exportar gltf do runtime web.
DropListenerReceber eventos de arrasto de ficheiros para upload e networking

UI

Os componentes Spatial UI são mapeados de Unity UI (Canvas, não UI Toolkit) para three-mesh-ui. A UI pode ser animada.

NameDescription
CanvasSistema de UI do Unity. Necessita de estar no modo World Space neste momento.
Text (Legacy)Renderiza Texto usando o componente UI Text do Unity. Fontes personalizadas são suportadas, um atlas de fontes será gerado automaticamente na exportação. Use as configurações de fonte ou o componente FontAdditionalCharacters para controlar quais caracteres estão incluídos no atlas.
Nota: No Unity, certifique-se de usar o componente Legacy/Text (TextMeshPro não é suportado no momento)
ButtonRecebe eventos de clique - use o evento onClick para reagir a ele. Pode ser adicionado a objetos de cena 3D também.
Nota: Certifique-se de usar o componente Legacy/Text no Botão (ou crie o Botão através do menu de contexto UI/Legacy/Button do Unity, uma vez que TextMeshPro não é suportado no momento)
ImageRenderiza uma imagem sprite
RawImageRenderiza uma textura
InputFieldPermite input de texto

Nota: Dependendo do seu projeto, muitas vezes faz sentido uma mistura de UI espacial e 2D para projetos cross-platform onde VR, AR, e ecrãs são suportados. Tipicamente, construiria as partes 2D com HTML para melhor acessibilidade, e as partes 3D com UIs geométricas que também suportam offsets de profundidade (e.g. estados de hover de botão e similares).

Other

NameDescription
SceneSwitcherLida com o carregamento e descarregamento de outras cenas ou prefabs / ficheiros glTF. Tem funcionalidades para precarregar, mudar de cena via swipe, eventos de teclado ou navegação por URL

Editor Only

NameDescription
ExportInfoComponente principal para gerir o(s) projeto(s) web, e.g. para instalar ou iniciar a aplicação web
EditorSyncAdicione para habilitar a rede de alterações de valor de material ou componente para a aplicação three.js em execução diretamente do Unity Editor sem ter que recarregar

Página traduzida automaticamente usando IA

Suggest changes
Last Updated: 11/06/2025, 12:25
Prev
Visão Geral Técnica
Next
needle.config.json