Bitbybit Docs
    Preparing search index...
    TypeScript API 参考

    Bitbybit 文档

    版本 1.3.0

    Bitbybit 3D CAD API 的完整参考 - 每个类、方法、输入类型和枚举, 都由随包发布的 TypeScript 声明生成,因此永远不会与代码脱节。
    探索 OCCT、JSCAD、Manifold 等内核的 1400+ 个函数。

    3 个 CAD 内核
    1400+ 个 API 函数
    3 个游戏引擎

    使用 npm 包快速开始

    几秒钟内搭建一个配置完整的 3D CAD 项目。该 CLI 会配置好 Vite、TypeScript 和全部三个几何内核 - OCCT、JSCAD 和 Manifold - 并附带你所选引擎的起始代码。 同样的包也能在 Node.js 中运行,-worker 变体 则让 WASM 内核不占用浏览器的主线程。

    npx @bitbybit-dev/create-app my-project
    支持:
    Three.js Babylon.js PlayCanvas

    快速访问 - 主要 API 类别

    每个类别都是你代码中 bitbybit 对象的一个属性,因此 bitbybit.occt.shapes 就是 occt 卡片下的 shapes 类。 当你需要某个调用的确切签名、参数 DTO 或返回类型时,请使用本站; 要看教程和完整示例,请前往 learn.bitbybit.dev

    draw

    将任何几何 - 点、线、网格、内核形状、标签 - 渲染到场景中,然后更新或释放返回的结果。

    babylon

    BabylonJS 引擎功能:场景、相机、光源、材质、纹理、拾取、Gizmo、glTF 和 XR。

    vector

    2D 和 3D 向量运算:加、减、缩放、点积和叉积、归一化、夹角和插值。

    point

    2D 和 3D 中的点,单个或按网格、螺线和六边形集合排列;测量、排序和变换它们。

    line

    由起点和终点确定的直线段:批量创建、测量、反向、变换并转换为内核的边。

    polyline

    相连的线段序列,开放或闭合 - 在变成面或实体之前最简单的轮廓。

    mesh

    多边形网格几何 - 三角形、顶点、法线 - 以及各内核所用表示形式之间的转换。

    occt

    OpenCascade 实体建模内核:精确的 BREP 布尔运算、圆角、放样、扫掠、偏移、抽壳、STEP 和 IGES。

    advanced

    建立在内核之上的高层工具:尺寸标注、相机导航、曲面阵列和 3D 文字。可在 bitbybit.dev 编辑器中使用。

    things

    成品参数化模型 - 家具、花瓶、盒子、鸟屋 - 每个都暴露出决定其形状的参数。可在 bitbybit.dev 编辑器中使用。

    jscad

    JSCAD 构造实体几何内核:基本体通过布尔运算、扩展、凸包和拉伸进行组合。

    manifold

    Manifold 内核:快速且可靠水密的网格布尔运算,以及 2D 横截面及其拉伸。

    logic

    比较、与/或/非、条件选择和值门控,让模型能够响应其参数。

    math

    三角函数、舍入、钳制、范围之间的重新映射、插值和带种子的随机数。

    lists

    数组操作:创建、切片、展平、反转、排序、分组、配对、重复和挑选 - 两个几何调用之间的那部分工作。

    color

    十六进制、RGB 和 HSL 之间的颜色,带混合、反转和颜色范围,用于绘制选项和材质。

    text

    字符串工具:连接、拆分、替换、去除空白、大小写转换、填充和格式化。

    dates

    日期和时间值:创建、解析、格式化、比较并对其进行运算。

    json

    解析、序列化、查询和编辑 JSON - 读入配置和输出结果的常用方式。

    csv

    读写 CSV:用一张参数表格驱动模型,或者把下料清单导出回去。

    verb

    NURBS 曲线和曲面:插值曲线、放样和扫掠曲面、求交和最近点查询。

    tag

    定位在 3D 空间中、随相机移动仍保持可读的文字标签 - 尺寸、零件编号、注释。

    time

    逐帧回调和计时值,让静态模型变成动画模型。

    asset

    从项目的资源库或 URL 加载 3D 模型、纹理、字体和数据文件,供内核或渲染器使用。

    API 的组织方式

    一切都位于根命名空间 Bit 之下,分为三类条目。

    操作类

    OCCTJSCADManifoldVectorDrawBabylon 及其子类承载你调用的方法。像 OCCTShapes 这样的类把一个 形状族的构造方法归为一组;OCCTBooleans 则归并了并集、 差集和交集。

    输入 DTO

    几乎每个方法都接受单个 DTO 参数而不是位置参数列表,所以默认值和单位 都写在 DTO 页面上。它们位于 Bit.Inputs.* 之下,每个内核一个命名空间。 各内核有意重复使用名称 - 每个内核都有一个 CircleDto - 所以请留意 页面标题中的命名空间。

    模型和枚举

    位于 Bit.Models.* 之下:返回给你的形状, 以及 DTO 使用的枚举。类型层次展示了各 类型之间的关系,完整符号索引则把每一个都列在一处。

    平台的其他部分

    在使用 AI 助手?把它指向 llms.txt,那是本站的精简索引; 或者参阅将 AI 与 Bitbybit 结合使用, 了解上下文文件和 Context7 MCP 服务器。