Class JSCADShapes

构建 JSCAD 实体：立方体、长方体、球体、椭球体、圆柱体、圆环体以及由原始多边形点构成的实体，每种都有一个在列表的每个点上放置一个副本的变体。内核以 Z 作为自身的轴，因此圆柱体沿 Z 竖立，圆环体平躺在 XY 平面内；每个实体都是闭合的多边形网格，segments 指定用多少个平面小面来近似圆形表面。

Constructors

constructor

new JSCADShapes(): JSCADShapes
Returns JSCADShapes

primitives

cube

cube(inputs: Bit.Inputs.JSCAD.CubeDto): Promise<JSCADEntity>
构建以 center 为中心、边长为 size 的立方体，其面与坐标轴平行。
Parameters
- inputs: Bit.Inputs.JSCAD.CubeDto
  中心和边长
Returns Promise<JSCADEntity>
立方体实体
Example
```
const cube = await bitbybit.jscad.shapes.cube({ center: [0, 0, 0], size: 10 });
```
- Defined in bitbybit-docs.d.ts:37111

cuboid

cuboid(inputs: CuboidDto): Promise<JSCADEntity>
构建以 center 为中心的长方体，width 沿 X，height 沿 Y，length 沿 Z，其面与坐标轴平行。
Parameters
- inputs: CuboidDto
  中心和三个边长
Returns Promise<JSCADEntity>
长方体实体
Example
```
const box = await bitbybit.jscad.shapes.cuboid({ center: [0, 0, 0], width: 10, height: 5, length: 20 });
```
- Defined in bitbybit-docs.d.ts:37138

cylinderElliptic

cylinderElliptic(inputs: CylidnerEllipticDto): Promise<JSCADEntity>
构建横截面为椭圆、两端半径可以不同的圆柱体，沿 Z 竖立并以 center 为中心。

startRadius 是底端的 X 和 Y 半径，endRadius 是顶端的，因此不相等的两对生成锥形或类圆锥的实体；height 在 center 上下均分。
Parameters
- inputs: CylidnerEllipticDto
  中心、高度、两对半径和分段数
Returns Promise<JSCADEntity>
椭圆柱实体
Example
```
const cone = await bitbybit.jscad.shapes.cylinderElliptic({ center: [0, 0, 0], height: 10, startRadius: [4, 2], endRadius: [1, 0.5], segments: 32 });
```
- Defined in bitbybit-docs.d.ts:37169

cylinder

cylinder(inputs: CylidnerDto): Promise<JSCADEntity>
构建沿 Z 竖立、给定 radius 的圆柱体，height 在 center 上下均分。

segments 是其周围的平面侧边数量；越多越圆。
Parameters
- inputs: CylidnerDto
  中心、高度、半径和分段数
Returns Promise<JSCADEntity>
圆柱体实体
Example
```
const cylinder = await bitbybit.jscad.shapes.cylinder({ center: [0, 0, 0], height: 10, radius: 3, segments: 32 });
```
- Defined in bitbybit-docs.d.ts:37199

ellipsoid

ellipsoid(inputs: EllipsoidDto): Promise<JSCADEntity>
构建椭球体，即沿 X、Y 和 Z 分别拉伸的球体，以 center 为中心。

radius 按 [x, y, z] 的顺序包含三个半尺寸；相等的值生成球体。
Parameters
- inputs: EllipsoidDto
  中心、三个半径和分段数
Returns Promise<JSCADEntity>
椭球体实体
Example
```
const egg = await bitbybit.jscad.shapes.ellipsoid({ center: [0, 0, 0], radius: [5, 3, 8], segments: 32 });
```
- Defined in bitbybit-docs.d.ts:37228

geodesicSphere

geodesicSphere(inputs: GeodesicSphereDto): Promise<JSCADEntity>
用大小均匀的三角形构建球体，就像测地穹顶的构建方式，以 center 为中心。

frequency 是二十个起始面的细分精细程度；它按 6 的整数倍使用，必须至少为 6，值越高球体越圆。
Parameters
- inputs: GeodesicSphereDto
  中心、半径和细分频率
Returns Promise<JSCADEntity>
测地球体实体
Example
```
const dome = await bitbybit.jscad.shapes.geodesicSphere({ center: [0, 0, 0], radius: 5, frequency: 12 });
```
- Defined in bitbybit-docs.d.ts:37259

roundedCuboid

roundedCuboid(inputs: RoundedCuboidDto): Promise<JSCADEntity>
构建所有边和角都以 roundRadius 倒圆的长方体，以 center 为中心，width 沿 X，height 沿 Y，length 沿 Z。

roundRadius 必须小于最短边的一半，否则抛出错误；segments 设置倒圆分面的平滑程度。
Parameters
- inputs: RoundedCuboidDto
  中心、三个边长、圆角半径和分段数
Returns Promise<JSCADEntity>
圆角长方体实体
Example
```
const soft = await bitbybit.jscad.shapes.roundedCuboid({ center: [0, 0, 0], width: 10, height: 5, length: 20, roundRadius: 1, segments: 16 });
```
- Defined in bitbybit-docs.d.ts:37290

roundedCylinder

roundedCylinder(inputs: RoundedCylidnerDto): Promise<JSCADEntity>
构建沿 Z 竖立、两个边缘以 roundRadius 倒圆的圆柱体，height 在 center 上下均分。

height 必须大于 roundRadius 的两倍，否则抛出错误。
Parameters
- inputs: RoundedCylidnerDto
  中心、圆角半径、高度、半径和分段数
Returns Promise<JSCADEntity>
圆角圆柱体实体
Example
```
const pill = await bitbybit.jscad.shapes.roundedCylinder({ center: [0, 0, 0], roundRadius: 1, height: 10, radius: 3, segments: 32 });
```
- Defined in bitbybit-docs.d.ts:37320

sphere

sphere(inputs: Bit.Inputs.JSCAD.SphereDto): Promise<JSCADEntity>
构建以 center 为中心、给定 radius 的球体；segments 是其周围的分面数量，因此越多越圆。
Parameters
- inputs: Bit.Inputs.JSCAD.SphereDto
  中心、半径和分段数
Returns Promise<JSCADEntity>
球体实体
Example
```
const ball = await bitbybit.jscad.shapes.sphere({ center: [0, 0, 0], radius: 5, segments: 32 });
```
- Defined in bitbybit-docs.d.ts:37348

torus

torus(inputs: Bit.Inputs.JSCAD.TorusDto): Promise<JSCADEntity>
构建一个圆环体，即横截面为圆形的圆环，平放在 XY 平面内、绕 center 分布， Z 轴穿过其孔洞。

outerRadius 是从中心到管中线的距离，innerRadius 是管本身的半径，它必须更小。旋转角和 startAngle 以度为单位； outerRotation 小于 360 时圆环保持开放。
Parameters
- inputs: Bit.Inputs.JSCAD.TorusDto
  中心、两个半径、两个分段数量、两个旋转角和起始角
Returns Promise<JSCADEntity>
圆环体实体
Example
```
const ring = await bitbybit.jscad.shapes.torus({ center: [0, 0, 0], innerRadius: 1, outerRadius: 5, innerSegments: 16, outerSegments: 48, innerRotation: 0, outerRotation: 360, startAngle: 0 });
```
- Defined in bitbybit-docs.d.ts:37380

primitives on centers

cubesOnCenterPoints

cubesOnCenterPoints(inputs: CubeCentersDto): Promise<JSCADEntity[]>
在 centers 的每个点上构建一个边长为 size 的立方体，顺序相同。
Parameters
- inputs: CubeCentersDto
  中心点和边长
Returns Promise<JSCADEntity[]>
每个中心点一个立方体
Example
```
const cubes = await bitbybit.jscad.shapes.cubesOnCenterPoints({ centers: [[0, 0, 0], [20, 0, 0], [40, 0, 0]], size: 10 });
```
- Defined in bitbybit-docs.d.ts:37124

cuboidsOnCenterPoints

cuboidsOnCenterPoints(inputs: CuboidCentersDto): Promise<JSCADEntity[]>
在 centers 的每个点上构建一个具有给定 width、height 和 length 的长方体，顺序相同。
Parameters
- inputs: CuboidCentersDto
  中心点和三个边长
Returns Promise<JSCADEntity[]>
每个中心点一个长方体
Example
```
const boxes = await bitbybit.jscad.shapes.cuboidsOnCenterPoints({ centers: [[0, 0, 0], [20, 0, 0]], width: 10, height: 5, length: 20 });
```
- Defined in bitbybit-docs.d.ts:37152

cylinderEllipticOnCenterPoints

cylinderEllipticOnCenterPoints(
inputs: CylidnerCentersEllipticDto,
): Promise<JSCADEntity[]>
在 centers 的每个点上构建一个具有给定半径和高度的椭圆柱体，顺序相同，与 cylinderElliptic 对一个所做的相同。
Parameters
- inputs: CylidnerCentersEllipticDto
  中心点、高度、两对半径和分段数
Returns Promise<JSCADEntity[]>
每个中心点一个椭圆柱
Example
```
const cones = await bitbybit.jscad.shapes.cylinderEllipticOnCenterPoints({ centers: [[0, 0, 0], [20, 0, 0]], height: 10, startRadius: [4, 2], endRadius: [1, 0.5], segments: 32 });
```
- Defined in bitbybit-docs.d.ts:37183

cylindersOnCenterPoints

cylindersOnCenterPoints(inputs: CylidnerCentersDto): Promise<JSCADEntity[]>
在 centers 的每个点上构建一个具有给定 radius 和 height 的圆柱体，顺序相同，与 cylinder 对一个所做的相同。
Parameters
- inputs: CylidnerCentersDto
  中心点、高度、半径和分段数
Returns Promise<JSCADEntity[]>
每个中心点一个圆柱体
Example
```
const posts = await bitbybit.jscad.shapes.cylindersOnCenterPoints({ centers: [[0, 0, 0], [20, 0, 0], [40, 0, 0]], height: 10, radius: 1, segments: 16 });
```
- Defined in bitbybit-docs.d.ts:37213

ellipsoidsOnCenterPoints

ellipsoidsOnCenterPoints(inputs: EllipsoidCentersDto): Promise<JSCADEntity[]>
在 centers 的每个点上构建一个具有给定半径的椭球体，顺序相同，与 ellipsoid 对一个所做的相同。
Parameters
- inputs: EllipsoidCentersDto
  中心点、三个半径和分段数
Returns Promise<JSCADEntity[]>
每个中心点一个椭球体
Example
```
const eggs = await bitbybit.jscad.shapes.ellipsoidsOnCenterPoints({ centers: [[0, 0, 0], [20, 0, 0]], radius: [5, 3, 8], segments: 32 });
```
- Defined in bitbybit-docs.d.ts:37242

geodesicSpheresOnCenterPoints

geodesicSpheresOnCenterPoints(
inputs: GeodesicSphereCentersDto,
): Promise<JSCADEntity[]>
在 centers 的每个点上构建一个给定 radius 的测地球体，顺序相同，与 geodesicSphere 对一个所做的相同。
Parameters
- inputs: GeodesicSphereCentersDto
  中心点、半径和细分频率
Returns Promise<JSCADEntity[]>
每个中心点一个测地球体
Example
```
const domes = await bitbybit.jscad.shapes.geodesicSpheresOnCenterPoints({ centers: [[0, 0, 0], [20, 0, 0]], radius: 5, frequency: 12 });
```
- Defined in bitbybit-docs.d.ts:37273

roundedCuboidsOnCenterPoints

roundedCuboidsOnCenterPoints(
inputs: RoundedCuboidCentersDto,
): Promise<JSCADEntity[]>
在 centers 的每个点上构建一个具有给定边长和倒圆的圆角长方体，顺序相同，与 roundedCuboid 对一个所做的相同。
Parameters
- inputs: RoundedCuboidCentersDto
  中心点、三个边长、圆角半径和分段数
Returns Promise<JSCADEntity[]>
每个中心点一个圆角长方体
Example
```
const softBoxes = await bitbybit.jscad.shapes.roundedCuboidsOnCenterPoints({ centers: [[0, 0, 0], [20, 0, 0]], width: 10, height: 5, length: 20, roundRadius: 1, segments: 16 });
```
- Defined in bitbybit-docs.d.ts:37304

roundedCylindersOnCenterPoints

roundedCylindersOnCenterPoints(
inputs: RoundedCylidnerCentersDto,
): Promise<JSCADEntity[]>
在 centers 的每个点上构建一个具有给定尺寸和倒圆的圆角圆柱体，顺序相同，与 roundedCylinder 对一个所做的相同。
Parameters
- inputs: RoundedCylidnerCentersDto
  中心点、圆角半径、高度、半径和分段数
Returns Promise<JSCADEntity[]>
每个中心点一个圆角圆柱体
Example
```
const pills = await bitbybit.jscad.shapes.roundedCylindersOnCenterPoints({ centers: [[0, 0, 0], [20, 0, 0]], roundRadius: 1, height: 10, radius: 3, segments: 32 });
```
- Defined in bitbybit-docs.d.ts:37334

spheresOnCenterPoints

spheresOnCenterPoints(inputs: SphereCentersDto): Promise<JSCADEntity[]>
在 centers 的每个点上构建一个给定 radius 的球体，顺序相同，与 sphere 对一个所做的相同。
Parameters
- inputs: SphereCentersDto
  中心点、半径和分段数
Returns Promise<JSCADEntity[]>
每个中心点一个球体
Example
```
const balls = await bitbybit.jscad.shapes.spheresOnCenterPoints({ centers: [[0, 0, 0], [20, 0, 0], [40, 0, 0]], radius: 5, segments: 32 });
```
- Defined in bitbybit-docs.d.ts:37362

shapes

fromPolygonPoints

fromPolygonPoints(inputs: FromPolygonPoints): Promise<JSCADEntity>
由各面构建实体，每个面给定为绕该面一周的点列表。

每个面的点从实体外部看按顺时针列出；这些面必须封闭实体，布尔运算才能对其生效。每个列表按逆序读取，输入不会被更改。
Parameters
- inputs: FromPolygonPoints
  以点列表表示的面
Returns Promise<JSCADEntity>
实体
Example
```
const tetrahedron = await bitbybit.jscad.shapes.fromPolygonPoints({ polygonPoints: [
    [[0, 0, 0], [10, 0, 0], [0, 10, 0]],
    [[0, 0, 0], [0, 10, 0], [0, 0, 10]],
    [[0, 0, 0], [0, 0, 10], [10, 0, 0]],
    [[10, 0, 0], [0, 0, 10], [0, 10, 0]],
] });
```
- Defined in bitbybit-docs.d.ts:37402

Class JSCADShapes

Index

Constructors

primitives

primitives on centers

shapes

Constructors

constructor

Returns JSCADShapes

primitives

cube

Parameters

Returns Promise<JSCADEntity>

Example

cuboid

Parameters

Returns Promise<JSCADEntity>

Example

cylinderElliptic

Parameters

Returns Promise<JSCADEntity>

Example

cylinder

Parameters

Returns Promise<JSCADEntity>

Example

ellipsoid

Parameters

Returns Promise<JSCADEntity>

Example

geodesicSphere

Parameters

Returns Promise<JSCADEntity>

Example

roundedCuboid

Parameters

Returns Promise<JSCADEntity>

Example

roundedCylinder

Parameters

Returns Promise<JSCADEntity>

Example

sphere

Parameters

Returns Promise<JSCADEntity>

Example

torus

Parameters

Returns Promise<JSCADEntity>

Example

primitives on centers

cubesOnCenterPoints

Parameters

Returns Promise<JSCADEntity[]>

Example

cuboidsOnCenterPoints

Parameters

Returns Promise<JSCADEntity[]>

Example

cylinderEllipticOnCenterPoints

Parameters

Returns Promise<JSCADEntity[]>

Example

cylindersOnCenterPoints

Parameters

Returns Promise<JSCADEntity[]>

Example

ellipsoidsOnCenterPoints

Parameters

Returns Promise<JSCADEntity[]>

Example

geodesicSpheresOnCenterPoints

Parameters

Returns Promise<JSCADEntity[]>

Example

roundedCuboidsOnCenterPoints

Parameters

Returns Promise<JSCADEntity[]>

Example

roundedCylindersOnCenterPoints