4.2 KiB
4.2 KiB
| outline | ||
|---|---|---|
|
API 总览
本文档基于 packages/sdk/src 的实际源码结构整理，并参考 packages/demo/src 中的调用方式补充了常见入口。每个页面都包含函数入参、出参以及属性作用说明。
SDK 执行 pnpm sdk:build 后，会同时输出运行时代码到 packages/sdk/dist，并输出类型声明到 packages/sdk/types。外部项目通过 @deep/engine 导入时，可直接获得对应的 TypeScript 类型信息。
快速使用流程
import { Tool, Viewer, ViewerEvents } from "@deep/engine";
const viewer = new Viewer("viewer", {
initCameraState: {
position: { x: 5, y: 5, z: 5 },
target: { x: 0, y: 0, z: 0 },
},
});
viewer.emitter.once(ViewerEvents.INIT).then(() => {
viewer.resources.loadGLTF("/model/demo.glb").then((model) => {
viewer.scene.add(model);
Tool.setRenderOrder(viewer.scene, 1, [{ name: "岩样", renderOrder: 2 }]);
});
});
模块导航
核心
管理器
- ClippingManager
- ClippingPlane
- CSS2DRendererManager
- CSS3DRendererManager
- EventManager
- IconManager
- PanelManager
- ParametricManager
- PipelineManager
- RangeCullingManager
- ResourceManager
- RuptureEventManager
- SelectionManager
网格与面板
工具
材质
- MaterialFactory
- Rock1Material
- Rock2Material
- Rock3Material
- Rock4Material
- Rock5Material
- Rock6Material
- Rock7Material
- Rock8Material
- RockMaterial
特效
体积与点云
参数化
- ParametricArch
- ParametricBox
- ParametricCylinder
- ParametricGeometryBase
- ParametricPipe
- ParametricRing
- ParametricSphere
- ParametricTorus
- ParametricWireframe
- types