GLMW 开源项目使用文档

GLMW 开源项目使用文档

glmwWebAssembly based Matrix and Vector library项目地址:https://gitcode.com/gh_mirrors/gl/glmw

1. 项目的目录结构及介绍

GLMW 项目的目录结构如下：

glmw/
├── dist/
│   ├── glmw.js
│   └── glmw.min.js
├── src/
│   ├── core/
│   │   ├── mat2.js
│   │   ├── mat3.js
│   │   ├── mat4.js
│   │   ├── quat.js
│   │   ├── vec2.js
│   │   ├── vec3.js
│   │   └── vec4.js
│   ├── glmw.js
│   └── index.js
├── test/
│   ├── core/
│   │   ├── mat2.spec.js
│   │   ├── mat3.spec.js
│   │   ├── mat4.spec.js
│   │   ├── quat.spec.js
│   │   ├── vec2.spec.js
│   │   ├── vec3.spec.js
│   │   └── vec4.spec.js
│   └── index.spec.js
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
└── webpack.config.js

目录结构介绍

• dist/: 包含编译后的 JavaScript 文件，包括 glmw.js 和压缩版的 glmw.min.js。
• src/: 源代码目录，包含核心数学库和入口文件。
  • core/: 包含各种数学运算的实现，如矩阵和向量。
  • glmw.js: 主入口文件。
  • index.js: 项目的入口文件。
• test/: 测试目录，包含单元测试文件。
  • core/: 包含各个核心模块的测试文件。
  • index.spec.js: 主入口文件的测试。
• .gitignore: Git 忽略文件列表。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• webpack.config.js: Webpack 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js，它负责引入和初始化 GLMW 库。以下是 index.js 的简要内容：

import glmw from './glmw';

export default glmw;

该文件导入了 glmw.js 并将其作为默认导出，使得用户可以通过 import glmw from 'glmw' 的方式使用 GLMW 库。

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的元数据和依赖信息。以下是部分关键内容：

{
  "name": "glmw",
  "version": "1.0.0",
  "description": "WebGL Maths library",
  "main": "dist/glmw.js",
  "scripts": {
    "build": "webpack",
    "test": "jest"
  },
  "dependencies": {
    "webpack": "^5.0.0"
  },
  "devDependencies": {
    "jest": "^27.0.0",
    "webpack-cli": "^4.0.0"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 主入口文件路径。
• scripts: 包含构建和测试脚本。
  • build: 使用 Webpack 构建项目。
  • test: 使用 Jest 运行测试。
• dependencies: 生产环境依赖。
• devDependencies: 开发环境依赖。

webpack.config.js

webpack.config.js 文件是 Webpack 的配置文件，用于打包 JavaScript 文件。以下是简要内容：

const path = require('path');

module.exports = {
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'glmw.js',
    library: '

glmwWebAssembly based Matrix and Vector library项目地址:https://gitcode.com/gh_mirrors/gl/glmw