ClayGL 开源项目教程

2024-09-14 23:11:57作者：余洋婵Anita

1. 项目介绍

ClayGL 是一个用于构建可扩展 Web3D 应用程序的 WebGL 图形库。它易于使用，并且可以通过配置实现高质量的图形效果。ClayGL 的模块化设计使得它可以轻松地集成到各种项目中，并且可以通过树摇（tree shaking）技术将基本 3D 应用程序的体积缩小到仅 22k（gzip 压缩后）。

2. 项目快速启动

创建一个旋转的立方体

以下是一个简单的示例，展示如何使用 ClayGL 创建一个旋转的立方体。

<!DOCTYPE html>
<html lang="en">
<head>
    <script src="lib/claygl.js"></script>
</head>
<body>
    <canvas id="main"></canvas>
    <script>
        clay.application.create('#main', {
            width: window.innerWidth,
            height: window.innerHeight,
            init(app) {
                // 创建相机
                this._camera = app.createCamera([0, 2, 5], [0, 0, 0]);
                
                // 创建一个红色的立方体
                this._cube = app.createCube({ color: '#f00' });
                
                // 创建光源
                this._mainLight = app.createDirectionalLight([-1, -1, -1]);
            },
            loop(app) {
                this._cube.rotation.rotateY(app.frameTime / 1000);
            }
        });
    </script>
</body>
</html>

最小化打包示例

以下示例展示了如何使用 Webpack 4.0 打包一个仅 22k（gzip 压缩后）的 ClayGL 应用程序。

import { Renderer, GeometryBase, Shader, Material } from 'claygl';

const vsCode = `
    attribute vec3 position;
    void main() {
        gl_Position = vec4(position, 1.0);
    }
`;

const fsCode = `
    void main() {
        gl_FragColor = vec4(1.0, 0.0, 1.0, 1.0);
    }
`;

const renderer = new Renderer({
    canvas: document.getElementById('main')
});
renderer.resize(400, 400);

const geometry = new GeometryBase();
geometry.createAttribute('position', 'float', 3);
geometry.attributes.position.fromArray([
    [-0.5, -0.5, 0],
    [0.5, -0.5, 0],
    [0, 0.5, 0]
]);

const material = new Material({
    shader: new Shader(vsCode, fsCode)
});

renderer.renderPass([
    [geometry, material]
]);

3. 应用案例和最佳实践

应用案例

ECharts GL: 使用 ClayGL 构建的 3D 数据可视化工具。
Clay Viewer: 一个基于 ClayGL 的 3D 模型查看器。
DOTA2 Hero Viewer: 使用 ClayGL 实现的 DOTA2 英雄模型查看器。

最佳实践

模块化设计: 利用 ClayGL 的模块化特性，只导入项目所需的模块，以减小打包体积。
高质量图形配置: 通过配置 ClayGL 的高级渲染管线，实现高质量的图形效果。
性能优化: 使用 WebGL 的性能优化技术，如批量渲染和纹理压缩，提升应用性能。

4. 典型生态项目

ClayGL Advanced Renderer: 提供完整的高级渲染管线，包括泛光、屏幕空间环境光遮蔽、屏幕空间反射、景深等效果。
FBX to glTF2.0 Converter: 一个用于将 FBX 文件转换为 glTF2.0 格式的工具，便于在 WebGL 中使用。

通过以上模块的介绍，您可以快速上手并深入了解 ClayGL 的使用和生态系统。

claygl

A WebGL graphic library for building scalable Web3D applications

项目地址：https://gitcode.com/gh_mirrors/cl/claygl

登录后查看全文