Tactile.js 项目教程

Tactile.js 项目教程

tactile-js A Javascript library for representing, manipulating, and drawing periodic tilings of the plane. 项目地址: https://gitcode.com/gh_mirrors/ta/tactile-js

1. 项目目录结构及介绍

Tactile.js 是一个用于表示、操作和绘制平面周期性镶嵌的 JavaScript 库。以下是项目的目录结构及其介绍：

tactile-js/
├── demo/
│   ├── demo.html
│   ├── images/
│   ├── p5.js
│   └── quicksettings.js
├── lib/
│   └── tactile.js
├── spirals/
│   └── spiral.html
├── src/
│   ├── EdgeShape.js
│   ├── IsohedralTiling.js
│   ├── numTypes.js
│   └── tilingTypes.js
├── LICENSE
└── README.md

目录介绍

• demo/: 包含演示项目的文件，包括 demo.html 和一些依赖库如 p5.js 和 quicksettings.js。
• lib/: 包含核心库文件 tactile.js，这是项目的主要功能实现。
• spirals/: 包含一个额外的演示文件 spiral.html，展示如何使用库绘制螺旋图案。
• src/: 包含项目的源代码文件，包括 EdgeShape.js, IsohedralTiling.js, numTypes.js, 和 tilingTypes.js。
• LICENSE: 项目的许可证文件，采用 BSD-3-Clause 许可证。
• README.md: 项目的说明文件，包含项目的基本介绍和使用说明。

2. 项目的启动文件介绍

项目的启动文件主要是 demo/demo.html 和 spirals/spiral.html。这两个文件分别展示了如何使用 Tactile.js 库进行基本的镶嵌绘制和螺旋图案绘制。

demo/demo.html

这个文件是一个简单的 HTML 页面，包含了 p5.js 和 quicksettings.js 库，以及 Tactile.js 库。它通过 JavaScript 代码调用 Tactile.js 的功能，生成并展示不同的镶嵌图案。

spirals/spiral.html

这个文件也是一个 HTML 页面，专门用于展示如何使用 Tactile.js 绘制螺旋图案。它同样包含了 p5.js 库，并通过 JavaScript 代码调用 Tactile.js 的功能。

3. 项目的配置文件介绍

Tactile.js 项目本身没有传统的配置文件，因为它的功能主要通过 JavaScript 代码直接实现。不过，如果你需要在项目中进行一些自定义配置，可以通过修改 src/ 目录下的源代码文件来实现。

自定义配置示例

假设你想修改镶嵌图案的默认参数，可以通过修改 src/IsohedralTiling.js 文件中的相关参数来实现。例如：

// src/IsohedralTiling.js
class IsohedralTiling {
    constructor(type) {
        this.type = type;
        this.parameters = [0, 0, 0, 0, 0, 0]; // 默认参数
    }

    // 其他代码...
}

你可以根据需要调整 this.parameters 数组中的值，以改变镶嵌图案的外观。

通过以上步骤，你可以更好地理解和使用 Tactile.js 项目。

tactile-js A Javascript library for representing, manipulating, and drawing periodic tilings of the plane. 项目地址: https://gitcode.com/gh_mirrors/ta/tactile-js