Class MeshModule

constructor

• new MeshModule(entity, options?): MeshModule

• Parameters

  • entity: Entity

  • Optional options: MeshModuleOption

  Returns MeshModule

Static moduleName

material

• get material(): any

• 获取可修改的材质对象

  Returns any

mesh

• get mesh(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

• mesh对象

  Returns Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

addEdges

• addEdges(option?, isHideMesh?): void

• 增加模型边框线

  Parameters

  • Optional option: LineBasicMaterialParameters

  • Optional isHideMesh: boolean

    是否隐藏mesh本身（默认false)

  Returns void

clearEdges

• clearEdges(): void

• 移除模型边框线

  Returns void

clearHighlight

• clearHighlight(): void

• 清除高亮

  Returns void

fromJSON

• fromJSON(data, objects): void

• Parameters

  • data: Record<string, any>

  • objects: Map<string, Object3D<Object3DEventMap>>

  Returns void

getEdges

• getEdges(): any

• 获取模型边框线

  Returns any

highlightMaterial

• highlightMaterial(): any

• 获取高亮材质

  Returns any

isHighlight

• isHighlight(): boolean

• 是否高亮

  Returns boolean

onDestroy

• onDestroy(): void

• Returns void

opacityMaterial

• opacityMaterial(): any

• 获取透明度材质

  Returns any

rawMaterial

• rawMaterial(): any

• 获取最开始的原生材质，为空表示没有修改过

  Returns any

replaceMaterial

• replaceMaterial(material): void

• 替换材质

  Parameters

  • material: Material | Material[]

  Returns void

resetMaterial

• resetMaterial(): void

• 恢复材质

  Returns void

setHeatmapDataMaterial

• setHeatmapDataMaterial(options): Promise<{
      lut: Lut;
      material: ShaderMaterial;
      reset: (() => void);
  }>

• 设置热力图数据分析材质

  Parameters

  • options: {
        MaterialParameters?: ShaderMaterialParameters;
        colorCount?: number;
        colorMap?: [number, number][];
        data: {
            value: number;
            x: number;
            y: number;
            z: number;
        }[];
        dataMax?: number;
        dataMin?: number;
        interpolation?: {
            alpha?: number;
            model?: "circle" | "linear" | "gaussian" | "exponential" | "spherical";
            power?: number;
            sigma2?: number;
            useInvDistWeight?: boolean;
        };
        segmentX?: number;
        segmentY?: number;
        segmentZ?: number;
    }

    • Optional MaterialParameters?: ShaderMaterialParameters

      材质参数

    • Optional colorCount?: number

      颜色表分的总数 默认100

    • Optional colorMap?: [number, number][]

      颜色表[值(0-1),颜色]，默认为 [[ 0.0, 0x0000FF ], [ 0.2, 0x00FFFF ], [ 0.5, 0x00FF00 ], [ 0.8, 0xFFFF00 ], [ 1.0, 0xFF0000 ]]

    • data: {
          value: number;
          x: number;
          y: number;
          z: number;
      }[]

      数据

    • Optional dataMax?: number

      数据最大值

    • Optional dataMin?: number

      数据最小值

    • Optional interpolation?: {
          alpha?: number;
          model?: "circle" | "linear" | "gaussian" | "exponential" | "spherical";
          power?: number;
          sigma2?: number;
          useInvDistWeight?: boolean;
      }

      插值选项

      • Optional alpha?: number

        Alpha α对应方差函数的先验值，此参数可能控制钻孔扩散范围,越小范围越大,少量点效果明显，但点多了且分布均匀以后改变该数字即基本无效果了，默认设置为100

      • Optional model?: "circle" | "linear" | "gaussian" | "exponential" | "spherical"

        模型 默认 exponential

      • Optional power?: number

        反距离幂指数，用于控制距离和权重之间的关系 缺省值2

      • Optional sigma2?: number

        sigma2是σ²，对应高斯过程的方差参数，也就是这组数据z的距离，方差参数σ²的似然性反映了高斯过程中的误差，并应手动设置。一般设置为 0 ，其他数值设了可能会出空白图

      • Optional useInvDistWeight?: boolean

        使用反距离权重插值法

    • Optional segmentX?: number

      x轴分段数 默认10

    • Optional segmentY?: number

      y轴分段数 默认10

    • Optional segmentZ?: number

      z轴分段数 默认10

  Returns Promise<{
      lut: Lut;
      material: ShaderMaterial;
      reset: (() => void);
  }>

setHighlight

• setHighlight(color?, opacity?): void

• 设置高亮

  Parameters

  • Optional color: ColorRepresentation

  • Optional opacity: number

  Returns void

setOpacity

• setOpacity(opacity, isAccOpacity?): void

• 设置透明度

  Parameters

  • opacity: number

    透明度0(完全透明)-1(不透明)

  • Optional isAccOpacity: boolean

    是否累加透明度(ture和之前透明度相乘，false直接设置透明度)

  Returns void

setupUiConfig

• setupUiConfig(): {
      app: App;
      children: ({
          bounds?: undefined;
          getValue: (() => boolean);
          label: string;
          onChange?: undefined;
          setValue: ((v) => void);
          stepSize?: undefined;
          type: string;
          value?: undefined;
      } | {
          bounds: number[];
          getValue?: undefined;
          label: string;
          onChange: ((v) => void);
          setValue?: undefined;
          stepSize: number;
          type: string;
          value: number;
      } | {
          bounds?: undefined;
          getValue?: undefined;
          label: string;
          onChange: ((v) => void);
          setValue?: undefined;
          stepSize?: undefined;
          type: string;
          value: boolean;
      } | {
          bounds?: undefined;
          getValue: (() => number);
          label: string;
          onChange?: undefined;
          setValue: ((v) => void);
          stepSize?: undefined;
          type: string;
          value?: undefined;
      })[];
      expanded: boolean;
      label: string;
      type: string;
  }

• Returns {
      app: App;
      children: ({
          bounds?: undefined;
          getValue: (() => boolean);
          label: string;
          onChange?: undefined;
          setValue: ((v) => void);
          stepSize?: undefined;
          type: string;
          value?: undefined;
      } | {
          bounds: number[];
          getValue?: undefined;
          label: string;
          onChange: ((v) => void);
          setValue?: undefined;
          stepSize: number;
          type: string;
          value: number;
      } | {
          bounds?: undefined;
          getValue?: undefined;
          label: string;
          onChange: ((v) => void);
          setValue?: undefined;
          stepSize?: undefined;
          type: string;
          value: boolean;
      } | {
          bounds?: undefined;
          getValue: (() => number);
          label: string;
          onChange?: undefined;
          setValue: ((v) => void);
          stepSize?: undefined;
          type: string;
          value?: undefined;
      })[];
      expanded: boolean;
      label: string;
      type: string;
  }

  • app: App

  • children: ({
        bounds?: undefined;
        getValue: (() => boolean);
        label: string;
        onChange?: undefined;
        setValue: ((v) => void);
        stepSize?: undefined;
        type: string;
        value?: undefined;
    } | {
        bounds: number[];
        getValue?: undefined;
        label: string;
        onChange: ((v) => void);
        setValue?: undefined;
        stepSize: number;
        type: string;
        value: number;
    } | {
        bounds?: undefined;
        getValue?: undefined;
        label: string;
        onChange: ((v) => void);
        setValue?: undefined;
        stepSize?: undefined;
        type: string;
        value: boolean;
    } | {
        bounds?: undefined;
        getValue: (() => number);
        label: string;
        onChange?: undefined;
        setValue: ((v) => void);
        stepSize?: undefined;
        type: string;
        value?: undefined;
    })[]

  • expanded: boolean

  • label: string

  • type: string

toJSON

• toJSON(): {
      mesh: {
          uuid: string;
      };
  }

• Returns {
      mesh: {
          uuid: string;
      };
  }

  • mesh: {
        uuid: string;
    }

    • uuid: string

useMaterial

• useMaterial(): any

• 获取替换后的正使用的材质，为空表示没有修改过

  Returns any