GooTechnologies/goojs 项目教程

1. 项目目录结构及介绍

GooTechnologies/goojs 是一个基于 WebGL 的 3D 引擎，其目录结构如下：

goojs/
├── examples/
├── lib/
├── out/
├── spec/
├── src/
│   └── goo/
├── test/
├── tools/
├── visual-test/
├── .eslintignore
├── .eslintrc
├── .gitignore
├── .jshintrc
├── CHANGES
├── CI
├── COPYING
├── CT
├── E2E
├── Gruntfile.js
├── LICENSE
├── README.md
├── index.js
├── package.json
└── webpack.records.json

目录介绍

• examples/: 包含项目的示例代码，展示了如何使用 GooJS 引擎创建 3D 场景。
• lib/: 存放编译后的 JavaScript 文件，可以直接在浏览器中使用。
• out/: 存放编译后的输出文件，包括文档和测试结果。
• spec/: 包含项目的规格说明文件。
• src/goo/: 项目的源代码，包含了引擎的核心逻辑。
• test/: 包含项目的单元测试代码。
• tools/: 包含项目使用的工具脚本，如文档生成器等。
• visual-test/: 包含视觉测试的代码和资源。
• .eslintignore: ESLint 忽略文件配置。
• .eslintrc: ESLint 配置文件。
• .gitignore: Git 忽略文件配置。
• .jshintrc: JSHint 配置文件。
• CHANGES: 项目变更记录。
• CI: 持续集成相关文件。
• COPYING: 项目许可证副本。
• CT: 项目相关文档。
• E2E: 端到端测试相关文件。
• Gruntfile.js: Grunt 任务配置文件。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• index.js: 项目的入口文件。
• package.json: Node.js 项目的配置文件，包含依赖项和脚本。
• webpack.records.json: Webpack 构建记录文件。

2. 项目启动文件介绍

项目的启动文件是 index.js，该文件是 GooJS 引擎的入口点。它负责初始化引擎并加载必要的资源。以下是 index.js 的基本结构：

// index.js

// 引入必要的模块
const GooRunner = require('goojs');

// 创建一个运行器实例
const gooRunner = new GooRunner();

// 获取世界对象
const world = gooRunner.world;

// 将渲染器的 DOM 元素添加到页面中
document.body.appendChild(gooRunner.renderer.domElement);

// 添加光源实体
world.createEntity(new goo.PointLight(), [100, 100, 100]).addToWorld();

// 添加相机实体
world.createEntity(new goo.Camera(), new goo.OrbitCamControlScript([spherical: [5, 0, 0]])).addToWorld();

// 添加一个带有旋转脚本的盒子实体
world.createEntity(new goo.Box(), goo.Material.createMaterial(goo.ShaderLib.simpleLit), function update(entity) {
    entity.setRotation(world.time, world.time, 0);
}).addToWorld();

启动文件功能

• 初始化引擎: 通过 new GooRunner() 创建引擎实例。
• 加载资源: 将渲染器的 DOM 元素添加到页面中。
• 创建实体: 添加光源、相机和带有旋转脚本的盒子实体。

3. 项目的配置文件介绍

package.json

package.json 是 Node.js 项目的配置文件，包含了项目的元数据和依赖项。以下是 package.json 的基本结构：

{
  "name": "goojs",
  "version": "1.0.0",
  "description": "3D WebGL engine",
  "main": "index.js",
  "scripts": {
    "test": "grunt unittest",
    "start": "node index.js"
  },
  "dependencies": {
    "goojs": "^1.0.0"
  },
  "devDependencies": {
    "grunt": "^1.0.0",
    "grunt-cli": "^1.0.0"
  },
  "license": "MIT"
}

配置文件功能

• 项目信息: 包含项目的名称、版本、描述等信息。
• 入口文件: 指定项目的入口文件为 index.js。
• 脚本命令: 定义了 test 和 start 命令，分别用于运行单元测试和启动项目。
• 依赖项: 列出了项目所需的依赖项，包括开发依赖项。

通过以上配置，开发者可以轻松地管理项目的依赖和运行脚本。