@deepinnet/threejs-fusion
v0.0.3
Published
threejs 融合 deeptwins
Downloads
425
Readme
@deepinnet/threejs-fusion
three.js 与 deeptwins 场景融合能力库,提供:
ThreeFusion默认入口,用于把融合渲染挂接到地图运行时sceneFusion底层场景融合能力QuarksParticle粒子系统封装- 多种内置粒子布局策略
- 一组材质特效辅助函数
安装
pnpm add @deepinnet/threejs-fusion three当前 peerDependencies:
react >= 16.9.0react-dom >= 16.9.0
快速使用
import ThreeFusion, {
QuarksParticle,
CurveFlowStrategy,
applyPlasmaTubeEffect,
} from '@deepinnet/threejs-fusion';默认导出 ThreeFusion,同时导出粒子系统、内置策略和材质特效函数。
开发命令
# 安装依赖
pnpm install
# 启动 dumi 开发环境
pnpm start
# 构建库产物
pnpm run build
# 构建文档站点
pnpm run docs:build
# 本地预览文档站点
pnpm run docs:preview
# 构建诊断
pnpm run doctor构建产物
pnpm run build 会执行以下流程:
- 使用
father build生成库产物 - 输出
dist/esm与dist/umd - 对所有
dist/**/*.js执行压缩最小化
当前构建特性:
- TypeScript 编译目标为
ES2020 dist/esm/*.js会被压缩,便于直接发布 npm 包dist/umd/threejs-fusion.min.js会输出浏览器分发版本.d.ts类型声明文件不会被改写
主要入口文件:
- ESM:
dist/esm/index.js - Types:
dist/esm/index.d.ts - UMD:
dist/umd/threejs-fusion.min.js
文档
仓库内文档基于 dumi 维护,主要入口:
公开能力概览
当前包主要暴露以下运行时能力:
ThreeFusionQuarksParticleCurveFlowStrategyPointBurstStrategySphereSurfaceFlowStrategyBoxVolumeFlowStrategySpiralFlowStrategyapplyPlasmaTubeEffectgetMaterialEffectConfigclearMaterialEffect
对应类型导出请参考 API 概览。
