Bitbybit Docs
    Preparing search index...
    Справочник TypeScript API

    Документация Bitbybit

    Версия 1.3.0

    Полный справочник по 3D CAD API Bitbybit - каждый класс, метод, тип входных данных и enum, сгенерированный из поставляемых деклараций TypeScript, поэтому он никогда не расходится с кодом.
    Изучите 1400+ функций в OCCT, JSCAD, Manifold и не только.

    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: сцена, камеры, свет, материалы, текстуры, выбор объектов, гизмо, 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

    Операции над массивами: создание, срез, уплощение, разворот, сортировка, группировка, zip, повтор и выбор - то, что стоит между двумя вызовами геометрии.

    color

    Цвета в hex, RGB и HSL, со смешиванием, инверсией и цветовыми диапазонами для параметров отрисовки и материалов.

    text

    Утилиты для строк: объединение, разбиение, замена, обрезка, смена регистра, дополнение и форматирование.

    dates

    Значения даты и времени: создавайте, разбирайте, форматируйте, сравнивайте и выполняйте над ними арифметику.

    json

    Разбирайте, сериализуйте, запрашивайте и редактируйте JSON - обычный способ принять конфигурацию и отдать результаты.

    csv

    Читайте и пишите CSV: управляйте моделью из таблицы параметров или экспортируйте обратно карту раскроя.

    verb

    Кривые и поверхности NURBS: интерполированные кривые, лофтовые и протянутые поверхности, пересечения и запросы ближайшей точки.

    tag

    Текстовые метки в 3D-пространстве, которые остаются читаемыми при движении камеры - размеры, номера деталей, аннотации.

    time

    Покадровые колбэки и значения времени, которые превращают статичную модель в анимированную.

    asset

    Загружайте 3D-модели, текстуры, шрифты и файлы данных из хранилища ассетов проекта или по URL, готовые для ядер или рендерера.

    Как организован API

    Все живет в корневом пространстве имен Bit, разделенном на три вида записей.

    Классы операций

    OCCT, JSCAD, Manifold, Vector, Draw, Babylon и их подклассы содержат методы, которые вы вызываете. Класс вроде OCCTShapes группирует конструкторы семейства форм; OCCTBooleans группирует объединение, разность и пересечение.

    Входные DTO

    Почти каждый метод принимает один аргумент DTO вместо позиционного списка, поэтому значения по умолчанию и единицы живут на странице DTO. Они лежат в Bit.Inputs.*, по пространству имен на ядро. Ядра намеренно повторяют имена - CircleDto есть в каждом - поэтому смотрите пространство имен в заголовке страницы.

    Модели и enum

    В Bit.Models.*: формы, которые вам возвращаются, плюс перечисления, которые используют DTO. Иерархия типов показывает, как типы связаны, а полный индекс символов перечисляет их все в одном месте.

    Остальная платформа

    Работаете с AI-ассистентом? Укажите ему на llms.txt - компактный индекс этого сайта, или смотрите использование AI с Bitbybit о файлах контекста и сервере Context7 MCP.