类 TMaterial

constructor

• new TMaterial(): TMaterial

  返回 TMaterial

textureLoader

initBasicTexture

• initBasicTexture(url: string): Texture

  创建基础纹理贴图

  参数

  • url: string

    图片路径

  返回 Texture

initCanvasTexture

• initCanvasTexture(canvasDom: HTMLCanvasElement): CanvasTexture

  从Canvas元素中创建纹理贴图

  参数

  • canvasDom: HTMLCanvasElement

    画布元素

  返回 CanvasTexture

initCubeTexture

• initCubeTexture(pathPrefix: string, picNameList: string[]): CubeTexture

  创建一个由6张图片组成的立方纹理

  参数

  • pathPrefix: string

    图片路径前缀
  • picNameList: string[]

    图片名称集合

  返回 CubeTexture

initDataTexture

• initDataTexture(
      data: TypedArray,
      width: number,
      height: number,
      format?: PixelFormat,
      type?: TextureDataType,
  ): DataTexture

  从原始数据创建一个纹理贴图

  参数

  • data: TypedArray

    包含纹理数据的数组或类型化数组
  • width: number

    纹理的宽度
  • height: number

    纹理的高度
  • 可选format: PixelFormat

    纹理的格式
  • 可选type: TextureDataType

    纹理的数据类型

  返回 DataTexture

initImageMaterial

• initImageMaterial(url: string): MeshBasicMaterial

  图片材质

  参数

  • url: string

  返回 MeshBasicMaterial

initImageTexture

• initImageTexture(
      url: string,
      repeat?: { active: boolean; x: number; y: number },
  ): Texture

  创建图片材质

  参数

  • url: string
  • 可选repeat: { active: boolean; x: number; y: number }

  返回 Texture

initLineBasicMaterial

• initLineBasicMaterial(
      color: string | number | Color,
      linecap?: string,
      linejoin?: string,
      map?: Texture,
  ): LineBasicMaterial

  创建基础线条材质

  参数

  • color: string | number | Color

    线条材质颜色
  • 可选linecap: string

    线条两端样式，可选值为 'butt', 'round' 和 'square'。默认值为 'round'
  • 可选linejoin: string

    线连接节点样式，可选值为 'round', 'bevel' 和 'miter'。默认值为 'round'
  • 可选map: Texture

    纹理贴图

  返回 LineBasicMaterial

initLineDashedMaterial

• initLineDashedMaterial(
      color: string | number | Color,
      scale?: number,
      dashSize?: number,
      gapSize?: number,
  ): LineDashedMaterial

  创建虚线材质

  参数

  • color: string | number | Color

    虚线材质颜色
  • 可选scale: number

    虚线材质线条中虚线部分的占比，默认值为1
  • 可选dashSize: number

    虚线材质虚线的大小，默认值为3
  • 可选gapSize: number

    虚线材质间隙大小，默认值为1

  返回 LineDashedMaterial

initMeshBasicMaterial

• initMeshBasicMaterial(color: string | number | Color): MeshBasicMaterial

  创建基础网格材质

  参数

  • color: string | number | Color

    基础网格材质颜色

  返回 MeshBasicMaterial

initMeshDepthMaterial

• initMeshDepthMaterial(
      alphaMap?: Texture,
      map?: Texture,
      wireframe?: boolean,
  ): MeshDepthMaterial

  创建深度网格材质

  参数

  • 可选alphaMap: Texture

    灰度纹理贴图
  • 可选map: Texture

    颜色贴图
  • 可选wireframe: boolean

    将几何体渲染为线框。默认为false（即渲染为平滑着色）

  返回 MeshDepthMaterial

initMeshDistanceMaterial

• initMeshDistanceMaterial(
      alphaMap?: Texture,
      map?: Texture,
  ): MeshDistanceMaterial

  创建MeshDistanceMaterial

  参数

  • 可选alphaMap: Texture

    灰度纹理贴图,默认为null
  • 可选map: Texture

    颜色贴图

  返回 MeshDistanceMaterial

initPhysicalMaterial

• initPhysicalMaterial(
      color: string | number | Color,
      map?: Texture,
      envMap?: Texture,
      metalness?: number,
      roughness?: number,
      clearcoat?: number,
      clearcoatRoughness?: number,
      envMapIntensity?: number,
      side?: number,
  ): MeshPhysicalMaterial

  创建物理网格材质

  参数

  • color: string | number | Color

    材质的颜色
  • 可选map: Texture

    颜色贴图
  • 可选envMap: Texture

    环境贴图
  • 可选metalness: number

    金属度 非金属材质0.0，金属使用1.0 范围从0.0-1.0
  • 可选roughness: number

    粗糙度 0.0表示平滑的镜面反射，1.0表示完全漫反射。默认值为1.0
  • 可选clearcoat: number

    表示clear coat层的强度 范围从0.0到1.0m,默认为0.0
  • 可选clearcoatRoughness: number

    clear coat层的粗糙度，由0.0到1.0。 默认为0.0
  • 可选envMapIntensity: number

    通过乘以环境贴图的颜色来缩放环境贴图的效果
  • 可选side: number

    定义将要渲染哪一面 正面0，背面1, 双面2 默认为正面

  返回 MeshPhysicalMaterial

initPointsMaterial

• initPointsMaterial(
      color: string | number | Color,
      vertexColors: boolean,
      size?: number,
      map?: Texture,
  ): PointsMaterial

  创建点材质

  参数

  • color: string | number | Color

    材质的颜色
  • vertexColors: boolean

    定义材料是否使用顶点颜色，默认false ---如果该选项设置为true，则color属性失效
  • 可选size: number

    设置点的大小 默认值为1.0
  • 可选map: Texture

    颜色贴图

  返回 PointsMaterial

initRawShaderMaterial

• initRawShaderMaterial(
      vertexShader: string,
      fragmentShader: string,
      uniforms?: { [p: string]: IUniform<any> },
      vertexColors?: boolean,
      side?: number,
  ): RawShaderMaterial

  创建原始着色器材质

  参数

  • vertexShader: string

    顶点着色器的GLSL代码
  • fragmentShader: string

    片元着色器的GLSL代码
  • 可选uniforms: { [p: string]: IUniform<any> }

    uniforms
  • 可选vertexColors: boolean

    定义是否使用顶点着色。默认为false
  • 可选side: number

    定义将要渲染哪一面 正面0，背面1, 双面2 默认为正面

  返回 RawShaderMaterial

initShaderMaterial

• initShaderMaterial(
      uniforms: { [p: string]: IUniform<any> },
      vertexShader: string,
      fragmentShader: string,
  ): ShaderMaterial

  创建着色器材质

  参数

  • uniforms: { [p: string]: IUniform<any> }

    uniforms
  • vertexShader: string

    顶点着色器的GLSL代码
  • fragmentShader: string

    片元着色器的GLSL代码

  返回 ShaderMaterial

initShadowMaterial

• initShadowMaterial(): ShadowMaterial

  阴影材质; 此材质可以接收阴影，但在其他方面完全透明。

  返回 ShadowMaterial

initSpriteMaterial

• initSpriteMaterial(url: string, color: string, fog: boolean): SpriteMaterial

  创建精灵材质

  参数

  • url: string
  • color: string
  • fog: boolean

  返回 SpriteMaterial

initToonMaterial

• initToonMaterial(
      color: string | number | Color,
      emissive?: string | number | Color,
      map?: Texture,
      gradientMap?: Texture,
  ): MeshToonMaterial

  创建卡通材质

  参数

  • color: string | number | Color

    材质的颜色
  • 可选emissive: string | number | Color

    发射（光）颜色
  • 可选map: Texture

    颜色贴图
  • 可选gradientMap: Texture

    卡通着色的渐变贴图

  返回 MeshToonMaterial

initVideoMaterial

• initVideoMaterial(videoDom: HTMLVideoElement): VideoTexture

  生成视频材质

  参数

  • videoDom: HTMLVideoElement

  返回 VideoTexture

setWaterSkin

• setWaterSkin(
      geometry: PlaneGeometry,
      width: number,
      height: number,
      url: string,
      waterColor?: string | number | Color,
      sunDirection?: Vector3,
      sunColor?: string | number | Color,
  ): Water

  给模型设置水波纹材质（需要将色调映射 设置为 NoToneMapping）

  参数

  • geometry: PlaneGeometry

    模型
  • width: number
  • height: number
  • url: string
  • 可选waterColor: string | number | Color

    水颜色
  • 可选sunDirection: Vector3

    太阳方向
  • 可选sunColor: string | number | Color

    太阳颜色

  返回 Water