@rbxts/rbxcad v1.0.0

rbxcad

jscad/modeling@3.0.1-alpha.0 ported to roblox-ts

Overview

This library contains boolean operations based on Constructive Solid Geometry (CSG). CSG is a modeling technique that uses boolean operations like union and intersection to combine 3D solids. This library implements CSG operations on meshes elegantly and concisely using BSP trees, and is meant to serve as an easily understandable implementation of the algorithm.

Installation

npm install @rbxts/rbxcad

Usage

import {colors, curves, geometries, maths, measurements, primitives, text} from "@rbxts/rbxcad";
import {booleans, extrusions, hulls, modifiers, offsets, transforms} from "@rbxts/rbxcad";

Examples are included in src/examples

Documentation

• API Reference
• JSCAD User Guide

Running Tests

!NOTE(https://github.com/jsdotlua/jest-lua) depends on debug.loadmodule (FFlagEnableLoadModule) to run tests.

npm install
npm run buildrbxl

Open the rbxl in Roblox Studio, then start a playtest session in Run Mode (F8).

Copyrights

Some copyrights apply from integration of original libraries.

CSG Library : Copyright (c) 2012 Joost Nieuwenhuijse, under the MIT license. Copyright (c) 2011 Evan Wallace, under MIT license.

Portions of glMatrix Library: Copyright (c) 2015-2020, Brandon Jones, Colin MacKenzie IV, under MIT license.

Quickhull Library: Copyright (c) 2015 Mauricio Poppe, under the MIT license.

License

The MIT License (MIT) (unless specified otherwise)