@vyr/three 0.0.33 → 0.0.36

package/src/descriptor/material/PointsMaterial.ts

@@ -0,0 +1,74 @@
+import {  DeserializationObject, Descriptor } from "@vyr/engine"
+import { Material, MaterialSide, MaterialDepthFunc, MaterialDlending } from "./Material"
+
+/**
+ * PointsMaterial类
+ * 点材质类
+ * 
+ * 作用：创建和管理点材质实例，用于渲染点云
+ */
+export class PointsMaterial extends Descriptor implements Material {
+    /**类类型标识 */
+    static type = 'PointsMaterial'
+    /**材质标识 */
+    readonly isMaterial = true
+    /**透明度测试阈值 @default 0 */
+    alphaTest: number
+    /**材质是否透明 @default false */
+    transparent: boolean
+    /**材质渲染面 @default MaterialSide.FrontSide */
+    side: MaterialSide
+    /**是否渲染材质的颜色 @default true */
+    colorWrite: boolean
+    /**是否启用深度测试 @default true */
+    depthTest: boolean
+    /**是否写入深度 @default true */
+    depthWrite: boolean
+    /**深度函数 @default MaterialDepthFunc.LessEqualDepth */
+    depthFunc: MaterialDepthFunc
+    /**混合模式，混合效果见 https://threejs.org/examples/#webgl_materials_blending @default MaterialDlending.NormalBlending */
+    blending: MaterialDlending
+    /**是否使用顶点着色 @default false */
+    vertexColors: boolean
+    /**
+     * 漫反射颜色
+     * @default '#ffffff'
+     */
+    color: string
+    /**
+     * 透明度
+     * @default 1
+     */
+    opacity: number
+    /**颜色贴图 @default "" */
+    map: string
+    /**透明度贴图 @default "" */
+    alphaMap: string
+    /**点大小 @default 1 */
+    size: number
+    /**点大小是否会被相机深度衰减 @default true */
+    sizeAttenuation: boolean
+    /**材质是否受雾影响 @default true */
+    fog: boolean
+
+    constructor(descriptor: Partial<DeserializationObject<PointsMaterial>> = {}) {
+        super(descriptor)
+        this.alphaTest = descriptor.alphaTest ?? 0
+        this.transparent = descriptor.transparent ?? false
+        this.side = descriptor.side ?? MaterialSide.FrontSide
+        this.colorWrite = descriptor.colorWrite ?? true
+        this.depthTest = descriptor.depthTest ?? true
+        this.depthWrite = descriptor.depthWrite ?? true
+        this.depthFunc = descriptor.depthFunc ?? MaterialDepthFunc.LessEqualDepth
+        this.blending = descriptor.blending ?? MaterialDlending.NormalBlending
+        this.vertexColors = descriptor.vertexColors ?? false
+        this.color = descriptor.color ? descriptor.color : '#ffffff'
+        this.opacity = descriptor.opacity ?? 1
+        this.map = descriptor.map ?? ''
+        this.alphaMap = descriptor.alphaMap ?? ''
+        this.size = descriptor.size ?? 1
+        this.sizeAttenuation = descriptor.sizeAttenuation ?? true
+        this.fog = descriptor.fog ?? true
+    }
+}
+Descriptor.register(PointsMaterial)

package/src/descriptor/material/ShaderMaterial.ts

@@ -0,0 +1,77 @@
+import { DeserializationObject, Descriptor } from "@vyr/engine"
+import { Material, MaterialSide, MaterialDepthFunc, MaterialDlending } from "./Material"
+
+/**
+ * ShaderMaterialAttribute接口
+ * 着色器材质属性接口
+ * 
+ * 作用：定义着色器材质的必要属性
+ */
+export interface ShaderMaterialAttribute {
+    /**着色器 uniforms */
+    uniforms: { [k: string]: any },
+    /**片元着色器代码 */
+    fragmentShader: string
+    /**顶点着色器代码 */
+    vertexShader: string
+}
+
+/**
+ * ShaderMaterial类
+ * 着色器材质类
+ * 
+ * 作用：创建和管理着色器材质实例，用于自定义着色器渲染
+ */
+export class ShaderMaterial extends Descriptor implements Material {
+    /**类类型标识 */
+    static type = 'ShaderMaterial'
+    /**材质标识 */
+    readonly isMaterial = true
+    /**透明度测试阈值 @default 0 */
+    alphaTest: number
+    /**材质是否透明 @default false */
+    transparent: boolean
+    /**材质渲染面 @default MaterialSide.FrontSide */
+    side: MaterialSide
+    /**是否渲染材质的颜色 @default true */
+    colorWrite: boolean
+    /**是否启用深度测试 @default true */
+    depthTest: boolean
+    /**是否写入深度 @default true */
+    depthWrite: boolean
+    /**深度函数 @default MaterialDepthFunc.LessEqualDepth */
+    depthFunc: MaterialDepthFunc
+    /**混合模式，混合效果见 https://threejs.org/examples/#webgl_materials_blending @default MaterialDlending.NormalBlending */
+    blending: MaterialDlending
+    /**是否使用顶点着色 @default false */
+    vertexColors: boolean
+    /**材质是否受到光照的影响 @default false */
+    lights: boolean
+    /**是否使用平面着色 @default false */
+    flatShading: boolean
+    /**材质是否受雾影响 @default true */
+    fog: boolean
+    /**将几何体渲染为线框 @default false */
+    wireframe: boolean
+    /**着色器资源引用，指向着色器资产的唯一标识 @default "" */
+    shader: string
+
+    constructor(descriptor: Partial<DeserializationObject<ShaderMaterial>> = {}) {
+        super(descriptor)
+        this.alphaTest = descriptor.alphaTest ?? 0
+        this.transparent = descriptor.transparent ?? false
+        this.side = descriptor.side ?? MaterialSide.FrontSide
+        this.colorWrite = descriptor.colorWrite ?? true
+        this.depthTest = descriptor.depthTest ?? true
+        this.depthWrite = descriptor.depthWrite ?? true
+        this.depthFunc = descriptor.depthFunc ?? MaterialDepthFunc.LessEqualDepth
+        this.blending = descriptor.blending ?? MaterialDlending.NormalBlending
+        this.vertexColors = descriptor.vertexColors ?? false
+        this.lights = descriptor.lights ?? false
+        this.flatShading = descriptor.flatShading ?? false
+        this.fog = descriptor.fog ?? true
+        this.wireframe = descriptor.wireframe ?? false
+        this.shader = descriptor.shader ?? ''
+    }
+}
+Descriptor.register(ShaderMaterial)

package/src/descriptor/material/ShadowMaterial.ts

@@ -0,0 +1,62 @@
+import { DeserializationObject, Descriptor } from "@vyr/engine"
+import { Material, MaterialSide, MaterialDepthFunc, MaterialDlending } from "./Material"
+
+/**
+ * ShadowMaterial类
+ * 阴影材质类
+ * 
+ * 作用：创建和管理阴影材质实例，用于专门接收阴影的平面
+ */
+export class ShadowMaterial extends Descriptor implements Material {
+    /**类类型标识 */
+    static type = 'ShadowMaterial'
+    /**材质标识 */
+    readonly isMaterial = true
+    /**透明度测试阈值 @default 0 */
+    alphaTest: number
+    /**材质是否透明 @default false */
+    transparent: boolean
+    /**材质渲染面 @default MaterialSide.FrontSide */
+    side: MaterialSide
+    /**是否渲染材质的颜色 @default true */
+    colorWrite: boolean
+    /**是否启用深度测试 @default true */
+    depthTest: boolean
+    /**是否写入深度 @default true */
+    depthWrite: boolean
+    /**深度函数 @default MaterialDepthFunc.LessEqualDepth */
+    depthFunc: MaterialDepthFunc
+    /**混合模式，混合效果见 https://threejs.org/examples/#webgl_materials_blending @default MaterialDlending.NormalBlending */
+    blending: MaterialDlending
+    /**是否使用顶点着色 @default false */
+    vertexColors: boolean
+    /**
+     * 漫反射颜色
+     * @default '#ffffff'
+     */
+    color: string
+    /**
+     * 透明度
+     * @default 1
+     */
+    opacity: number
+    /**材质是否受雾影响 @default true */
+    fog: boolean
+
+    constructor(descriptor: Partial<DeserializationObject<ShadowMaterial>> = {}) {
+        super(descriptor)
+        this.alphaTest = descriptor.alphaTest ?? 0
+        this.transparent = descriptor.transparent ?? false
+        this.side = descriptor.side ?? MaterialSide.FrontSide
+        this.colorWrite = descriptor.colorWrite ?? true
+        this.depthTest = descriptor.depthTest ?? true
+        this.depthWrite = descriptor.depthWrite ?? true
+        this.depthFunc = descriptor.depthFunc ?? MaterialDepthFunc.LessEqualDepth
+        this.blending = descriptor.blending ?? MaterialDlending.NormalBlending
+        this.vertexColors = descriptor.vertexColors ?? false
+        this.color = descriptor.color ? descriptor.color : '#ffffff'
+        this.opacity = descriptor.opacity ?? 1
+        this.fog = descriptor.fog ?? true
+    }
+}
+Descriptor.register(ShadowMaterial)

package/src/descriptor/material/SpriteMaterial.ts

@@ -0,0 +1,74 @@
+import { DeserializationObject, Descriptor } from "@vyr/engine"
+import { Material, MaterialSide, MaterialDepthFunc, MaterialDlending } from "./Material"
+
+/**
+ * SpriteMaterial类
+ * 精灵材质类
+ * 
+ * 作用：创建和管理精灵材质实例，用于2D精灵渲染
+ */
+export class SpriteMaterial extends Descriptor implements Material {
+    /**类类型标识 */
+    static type = 'SpriteMaterial'
+    /**材质标识 */
+    readonly isMaterial = true
+    /**透明度测试阈值 @default 0 */
+    alphaTest: number
+    /**材质是否透明 @default false */
+    transparent: boolean
+    /**材质渲染面 @default MaterialSide.FrontSide */
+    side: MaterialSide
+    /**是否渲染材质的颜色 @default true */
+    colorWrite: boolean
+    /**是否启用深度测试 @default true */
+    depthTest: boolean
+    /**是否写入深度 @default true */
+    depthWrite: boolean
+    /**深度函数 @default MaterialDepthFunc.LessEqualDepth */
+    depthFunc: MaterialDepthFunc
+    /**混合模式，混合效果见 https://threejs.org/examples/#webgl_materials_blending @default MaterialDlending.NormalBlending */
+    blending: MaterialDlending
+    /**是否使用顶点着色 @default false */
+    vertexColors: boolean
+    /**
+     * 漫反射颜色
+     * @default '#ffffff'
+     */
+    color: string
+    /**
+     * 透明度
+     * @default 1
+     */
+    opacity: number
+    /**颜色贴图 @default "" */
+    map: string
+    /**透明度贴图 @default "" */
+    alphaMap: string
+    /**精灵旋转角度 @default 0 */
+    rotation: number
+    /**精灵大小是否会被相机深度衰减 @default true */
+    sizeAttenuation: boolean
+    /**材质是否受雾影响 @default true */
+    fog: boolean
+
+    constructor(descriptor: Partial<DeserializationObject<SpriteMaterial>> = {}) {
+        super(descriptor)
+        this.alphaTest = descriptor.alphaTest ?? 0
+        this.transparent = descriptor.transparent ?? false
+        this.side = descriptor.side ?? MaterialSide.FrontSide
+        this.colorWrite = descriptor.colorWrite ?? true
+        this.depthTest = descriptor.depthTest ?? true
+        this.depthWrite = descriptor.depthWrite ?? true
+        this.depthFunc = descriptor.depthFunc ?? MaterialDepthFunc.LessEqualDepth
+        this.blending = descriptor.blending ?? MaterialDlending.NormalBlending
+        this.vertexColors = descriptor.vertexColors ?? false
+        this.color = descriptor.color ? descriptor.color : '#ffffff'
+        this.opacity = descriptor.opacity ?? 1
+        this.map = descriptor.map ?? ''
+        this.alphaMap = descriptor.alphaMap ?? ''
+        this.rotation = descriptor.rotation ?? 0
+        this.sizeAttenuation = descriptor.sizeAttenuation ?? true
+        this.fog = descriptor.fog ?? true
+    }
+}
+Descriptor.register(SpriteMaterial)

package/src/descriptor/texture/Texture.ts

@@ -0,0 +1,172 @@
+import { Descriptor, DeserializationObject, Vector2 } from '@vyr/engine'
+
+/**
+ * TextureMapping枚举
+ * 纹理映射枚举
+ * 
+ * 作用：定义纹理如何应用到物体上
+ */
+export enum TextureMapping {
+    /**UV映射 */
+    UVMapping = 300,
+    /**立方体反射映射 */
+    CubeReflectionMapping = 301,
+    /**立方体折射映射 */
+    CubeRefractionMapping = 302,
+    /**等矩形反射映射 */
+    EquirectangularReflectionMapping = 303,
+    /**等矩形折射映射 */
+    EquirectangularRefractionMapping = 304,
+    /**立方体UV反射映射 */
+    CubeUVReflectionMapping = 306,
+}
+
+/**
+ * TextureWrap枚举
+ * 纹理包裹枚举
+ * 
+ * 作用：定义纹理在边缘如何包裹
+ */
+export enum TextureWrap {
+    /**重复包裹 */
+    RepeatWrapping = 1000,
+    /**边缘夹紧包裹 */
+    ClampToEdgeWrapping = 1001,
+    /**镜像重复包裹 */
+    MirroredRepeatWrapping = 1002,
+}
+
+/**
+ * TextureFType枚举
+ * 纹理类型枚举
+ * 
+ * 作用：定义纹理数据的类型
+ */
+export enum TextureFType {
+    /**无符号字节类型 */
+    UnsignedByteType = 1009,
+    /**半浮点数类型 */
+    HalfFloatType = 1016,
+    /**浮点数类型 */
+    FloatType = 1015,
+    /**字节类型 */
+    ByteType = 1010,
+    /**短整数类型 */
+    ShortType = 1011,
+    /**无符号短整数类型 */
+    UnsignedShortType = 1012,
+    /**整数类型 */
+    IntType = 1013,
+    /**无符号整数类型 */
+    UnsignedIntType = 1014,
+    /**无符号短整数4444类型 */
+    UnsignedShort4444Type = 1017,
+    /**无符号短整数5551类型 */
+    UnsignedShort5551Type = 1018,
+    /**无符号整数248类型 */
+    UnsignedInt248Type = 1020,
+    /**无符号整数5999类型 */
+    UnsignedInt5999Type = 35902,
+}
+
+/**
+ * TextureFormat枚举
+ * 纹理格式枚举
+ * 
+ * 作用：定义纹理的像素格式
+ */
+export enum TextureFormat {
+    /**Alpha格式 */
+    AlphaFormat = 1021,
+    /**红色通道格式 */
+    RedFormat = 1028,
+    /**红色通道整数格式 */
+    RedIntegerFormat = 1029,
+    /**红绿通道格式 */
+    RGFormat = 1030,
+    /**红绿通道整数格式 */
+    RGIntegerFormat = 1031,
+    /**RGB格式 */
+    RGBFormat = 1022,
+    /**RGBA格式 */
+    RGBAFormat = 1023,
+    /**RGBA整数格式 */
+    RGBAIntegerFormat = 1033,
+    /**深度格式 */
+    DepthFormat = 1026,
+    /**深度模板格式 */
+    DepthStencilFormat = 1027,
+}
+
+/**
+ * TextureColorSpace常量
+ * 纹理颜色空间常量
+ * 
+ * 作用：定义纹理的颜色空间
+ */
+export const TextureColorSpace = {
+    /**无颜色空间 */
+    NoColorSpace: "",
+    /**SRGB颜色空间 */
+    SRGBColorSpace: "srgb",
+    /**线性SRGB颜色空间 */
+    LinearSRGBColorSpace: "srgb-linear",
+} as const
+
+/**
+ * Texture类
+ * 纹理类
+ * 
+ * 作用：创建和管理纹理实例，用于为材质提供纹理贴图
+ */
+export class Texture extends Descriptor {
+    /**类类型标识 */
+    static type = 'Texture'
+    /**纹理文件URL @default "" */
+    url: string
+    /**纹理映射方式 @default TextureMapping.UVMapping */
+    mapping: number
+    /**纹理水平方向包裹方式 @default TextureWrap.ClampToEdgeWrapping */
+    wrapS: number
+    /**纹理垂直方向包裹方式 @default TextureWrap.ClampToEdgeWrapping */
+    wrapT: number
+    /**纹理格式 @default TextureFormat.RGBAFormat */
+    format: number
+    /**纹理数据类型 @default TextureFType.UnsignedByteType */
+    ftype: number
+    /**纹理偏移 @default {x:0,y:0} */
+    offset: Vector2
+    /**纹理重复 @default {x:1,y:1} */
+    repeat: Vector2
+    /**纹理中心点 @default {x:0,y:0} */
+    center: Vector2
+    /**纹理旋转角度 @default 0 */
+    rotation: number
+    /**是否生成mipmap @default true */
+    generateMipmaps: boolean
+    /**是否预乘alpha通道 @default false */
+    premultiplyAlpha: boolean
+    /**是否沿Y轴翻转 @default true */
+    flipY: boolean
+    /**纹理颜色空间 @default TextureColorSpace.SRGBColorSpace */
+    colorSpace: string
+
+    constructor(descriptor: Partial<DeserializationObject<Texture>> = {}) {
+        super(descriptor)
+        this.url = descriptor.url ?? ''
+        this.mapping = descriptor.mapping ?? TextureMapping.UVMapping
+        this.wrapS = descriptor.wrapS ?? TextureWrap.ClampToEdgeWrapping
+        this.wrapT = descriptor.wrapT ?? TextureWrap.ClampToEdgeWrapping
+        this.format = descriptor.format ?? TextureFormat.RGBAFormat
+        this.ftype = descriptor.ftype ?? TextureFType.UnsignedByteType
+        this.offset = Vector2.create(descriptor.offset)
+        this.repeat = descriptor.repeat ? Vector2.create(descriptor.repeat) : Vector2.create(1, 1)
+        this.center = Vector2.create(descriptor.center)
+        this.rotation = descriptor.rotation ?? 0
+        this.generateMipmaps = descriptor.generateMipmaps ?? true
+        this.premultiplyAlpha = descriptor.premultiplyAlpha ?? false
+        this.flipY = descriptor.flipY ?? true
+        this.colorSpace = descriptor.colorSpace ?? TextureColorSpace.SRGBColorSpace
+    }
+}
+Descriptor.register(Texture)

package/src/index.ts

@@ -5,5 +5,4 @@ export * from './asset'
 export * from './descriptor'
 export * from './actor'
 export * from './interpreter'
-export * from './preset'
 export * from './controls'

package/src/interpreter/ComposerServiceInterpreter.ts

@@ -1,9 +1,9 @@
 // import { UpdateArgs } from '@vyr/engine'
 // import { ComposerServiceDescriptor } from '../descriptor/ComposerServiceDescriptor'
-// import { SceneServiceInterpreter } from './SceneServiceInterpreter'
+// import { Scene3DServiceInterpreter } from './Scene3DServiceInterpreter'
 // import { ComposerServiceActor } from '../actor'
 
-// class ComposerServiceInterpreter extends SceneServiceInterpreter {
+// class ComposerServiceInterpreter extends Scene3DServiceInterpreter {
 //     static type = ComposerServiceDescriptor.type
 
 //     protected createActor(descriptor: ComposerServiceDescriptor) {
@@ -20,6 +20,6 @@
 //     }
 // }
 
-// SceneServiceInterpreter.register(ComposerServiceInterpreter)
+// Scene3DServiceInterpreter.register(ComposerServiceInterpreter)
 
 // export { ComposerServiceInterpreter }