os

该插件用于和 TacOS数字空间 进行连接，连接后可以使用其提供的各种功能

• 插件名称

  os-animation

• 初始参数

  • 无

• 示例

import { webglPlugin } from "@tslfe/dt-enging"
...省略获取meta实例的步骤...

const osPlugin = meta.plugin.use(webglPlugin.os());

属性

event

事件发射器

• 类型: EventEmitter

• 说明: 用于监听到 数字空间 的消息后，在 DT-Engine 中发布消息

方法

connect( )

与数字空间建立连接，建立连接后才能使用其提供的各种功能

function connect: (options: OSOptions) => Promise<Core>

• 参数

  • options: 连接配置参数

    • 参考: OSOptions

• 返回值

  • Promise<Core>

    • 参考: 数字空间.Core

• 示例

...省略挂载os插件的步骤...

osPlugin.connect({
    appCode: "xxx",
    socket: {
        url: "xxx"
    }
}).then((core) => {
    
});

loadModelUrl( ) v4.1.6

function loadModelUrl: (path: string) => Promise<string>

• 参数

  • path: 数字空间资源定位符

    • 参考: 数字空间.path

• 返回值

  • Promise<string>

• 示例

...省略挂载os插件的步骤...

osPlugin.loadModelUrl('/').then((url:string)=>{
    console.log(url);
})

enter( )

通过 数字空间.path 进入某一个空间

function enter: (path: string, hook?: (path: string) => string) => Promise<any>

• 参数

  • path: 数字空间中的空间路径

    • 参考: 数字空间.path

  • hook: v4.1.4 钩子函数，在进入空间前触发，可用于自定义处理数字空间对应的模型文件地址

• 返回值

  • Promise<Component<WebglModel>>

    • 参考: Component

• 示例

...省略挂载os插件的步骤...

osPlugin.enter("/",(url:string)=>{
    return url;
});

compile( ) v4.1.6

预编译

function compile: (path: string, hook?: (path: string) => string) => Promise<string>

• 参数

  • path: 数字空间资源定位符

    • 参考: 数字空间.path

  • hook:

• 返回值

  • Promise<Component<WebglModel>>

    • 参考: Component

• 示例

...省略挂载os插件的步骤...

osPlugin.compile("/",(url:string)=>{
    return url;
});

dispose( )

销毁连接

function dispose: () => void

• 参数

  • 无

• 返回值

  • 无

• 示例

...省略挂载os插件的步骤...

osPlugin.dispose();