Thermion开源项目教程

1. 项目目录结构及介绍

Thermion项目是一个为Dart和Flutter提供的跨平台3D渲染工具包。以下是其主要的目录结构及其介绍：

thermion/
├── assets/                # 存放项目资源，如纹理、模型等
├── docs/                  # 文档目录，包含项目的文档和示例
├── examples/              # 示例项目，展示如何使用Thermion
├── materials/             # 材料文件，用于定义渲染效果
├── thermion_dart/         # Dart部分的源代码
├── thermion_flutter/      # Flutter部分的源代码
├── .gitignore             # Git忽略文件列表
├── CHANGELOG.md           # 更新日志
├── LICENSE                # 项目许可证信息
├── Makefile               # 构建脚本
├── README.md              # 项目说明文件
├── docs.json              # 文档配置文件
└── melos.yaml             # Melos工具的配置文件

• assets/：包含项目所需的各种资源，例如模型文件、纹理等。
• docs/：存放项目的文档，包括API文档和用户指南。
• examples/：包含了一些示例项目，以展示如何在实际应用中使用Thermion。
• materials/：包含了用于定义物体材质的文件。
• thermion_dart/：这里是Dart语言的源代码，包含了Thermion的核心逻辑。
• thermion_flutter/：包含了用于Flutter的Thermion封装和示例代码。
• .gitignore：定义了Git应该忽略的文件和目录。
• CHANGELOG.md：记录了项目的所有更新和改动历史。
• LICENSE：项目所使用的许可证，本项目采用Apache-2.0。
• Makefile：用于构建项目或执行特定任务的脚本。
• README.md：项目的主说明文件，包含了项目的基本信息和如何开始使用。
• docs.json：文档配置文件，用于定义文档的元数据和生成选项。
• melos.yaml：Melos工具的配置文件，用于自动化项目维护任务。

2. 项目的启动文件介绍

在examples/目录下，你可以找到使用Thermion的Flutter示例应用。以下是启动一个简单的Flutter应用的基本步骤：

@override
Widget build(BuildContext context) {
  return Scaffold(
    body: Stack(
      children: [
        Positioned.fill(
          child: ViewerWidget(
            assetPath: "assets/cube.glb",
            skyboxPath: "assets/default_env_skybox.ktx",
            iblPath: "assets/default_env_ibl.ktx",
            transformToUnitCube: true,
            initialCameraPosition: Vector3(0, 0, 6),
            background: Colors.blue,
            manipulatorType: ManipulatorType.ORBIT,
            onViewerAvailable: (viewer) async {
              await Future.delayed(const Duration(seconds: 5));
              await viewer.removeSkybox();
            },
            initial: Container(
              color: Colors.red,
            ),
          ),
        ),
      ],
    ),
  );
}

这段代码创建了一个包含ViewerWidget的Scaffold，这个ViewerWidget负责加载和显示3D模型。

3. 项目的配置文件介绍

melos.yaml 是 Thermion 项目中用于配置 Melos 工具的文件。Melos 是一个用于管理多包 Dart 项目的工具。以下是melos.yaml文件的一个基本示例：

packages:
  thermion_dart:
    path: thermion_dart
  thermion_flutter:
    path: thermion_flutter
tasks:
  build:
    commands:
      - pub run build_runner build --delete-conflicting-outputs
    description: Build the packages.
  test:
    commands:
      - dart test
    description: Run tests for the packages.

在这个配置文件中，定义了项目的包结构以及可执行的任务。packages部分列出了项目中的所有包及其路径，而tasks部分定义了可执行的任务，例如构建(build)和测试(test)。

使用Melos，你可以运行以下命令来执行任务：

melos run build
melos run test

这些命令将执行在melos.yaml中定义的相应任务。