CCGA.js
登录控制台 ↗
DOCUMENTATION / QUICKSTART

从 CGA 到模型，
只需一次调用。

解析语法用 /parse；生成 GLB 模型用 /compile。两者都需要 API key。

1. 创建 API key

注册并登录，进入控制台创建 key。key 完整值仅返回一次，请放入服务端环境变量。

解析 CGA 语法

curl https://www.cgajs.com/api/v1/parse   -H "Content-Type: application/json"   -H "x-api-key: $CGAJS_API_KEY"   -d '{"source":"@StartRule\nLot --> extrude(10)"}'

2. 生成真实 GLB

明确给出 polygon 顶点。parse 成功不等于生成了模型。

POST /api/v1/compile
{
  "source": "@StartRule\nLot --> extrude(10)",
  "initialShape": {"geometry": {
    "type": "polygon",
    "vertices": [[0,0,0],[10,0,0],[10,0,8],[0,0,8]]
  }}
}

响应包含 Base64 GLB 与几何统计。用 Three.js GLTFLoader 加载模型；先检查非空 mesh / vertexCount。

在 IDE 中验证 →

3. 常用函数

extrude(height)

将初始面拉伸为体块。

comp(f) { top: Roof | side: Wall }

将体块按面分组，再分派规则。

color("#087f72")

为形状设置颜色。

split(y) { 3: Floor }*

沿轴分割形状。可在 IDE 补全菜单查看参数提示。

原完整函数文档保留在当前文档目录中；不将历史运维页面作为产品导航。

完整函数参考 →

4. 鉴权与用量

使用 x-api-key 请求头。不要把 key 放在 URL、公开仓库或浏览器静态代码中。匿名或无效 key 返回 401。

控制台读取 /api/v1/quota 展示实际额度。免费试用不是付费激活；订阅只有在服务端确认付款后生效。