安装说明
项目结构
一个典型的基于Cumulia ORE开发的3D应用,它的开发项目中包含有:
- index.html 在一个网络应用程序中,这个文件扮演着入口或默认首页的角色,定义了初始结构,但它通常会引用和加载其他资源来构建完整的用户界面。
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CAD Viewer</title>
</head>
<body>
<script type="module" src="./src/main.ts"></script>
</body>
</html>
-
src/ 体现软件包功能的真正代码被存储于此,它内部的结构取决于您的软件包的组织方式和复杂度。不过,它往往包含了:
- main.ts:这是整个软件包程序的主入口,导入其他文件中包含的函数或类,或者导出供其他应用程序使用的函数或类。
- 其他Type Script文件:为了更好的组织,软件包的核心逻辑可能会分散到多个文件中,并被导入到main.ts或其他包中使用。
-
public/ 这里面包含了需要推送到网页中的资源,包括3D模型、纹理、图片等。
-
package.json 该文件中指定了自定义脚本(通过使用
npm run <script_name>来自动执行),以及需要安装的依赖项及其版本,从而帮助开发者自动执行构建、测试,并确保兼容性。
ORE提供的SDK库
我们提供了ORE core和其他一系列插件供您使用:
- ore.core
- ore.material
- ore.geometry
- ore.color
- ore.annotator
- ore.gadget
- ore.postprocessing
- ore.snapshot
- ore.selector
- ore.locator
- gti.animation
- ore.camera
- ore.manipulator
- ore.debugger
安装方法
对于一个现代网络应用程序,npm可以帮助开发人员高效地、可维护地构建程序,简化依赖管理流程,提高开发效率。
设置开发环境
Node.js 安装: npm 与 Node.js 捆绑在一起,Node.js 是一个 JavaScript 运行时环境,使您能够在网络浏览器之外执行 JavaScript 代码。从官方网站下载并安装最新稳定版本的 Node.js。此安装过程会自动包含 npm。
代码编辑器或 IDE: 选择适合您偏好的代码编辑器或集成开发环境 (IDE)。流行选项包括 Visual Studio Code、Atom 或 WebStorm。这些工具提供语法突出显示、代码完成和调试功能。
软件包安装
设置好环境后,您就可以着手构建您的应用程序了。package.json中指定了你需要集成的软件包的名称,使用 npm install 命令,npm 将从 npm 注册表中检索这些软件包及其依赖项,并在项目目录 中自动新增 node_modules/ 文件夹,然后将依赖的软件包存储于此。
拷贝SDK库
将Cumulia ORE的一系列SDK库文件拷贝到node_modules/ 文件夹
运行
使用 npm run dev 命令,那么您将在终端中看到一个类似 http://localhost:3001/ 的URL,打开就可以看到您的应用程序。