Class OCCTSolid

Тела в OpenCascade: замкнутые формы, охватывающие объем. Постройте тело из примитива (createBox, createSphere, createCylinder, createCone, createTorus), из плоского профиля, выдавленного вперед и назад (звезда, n-угольник, сердце, балка и другие профильные тела), или из замкнутой оболочки через fromClosedShell; затем измерьте его геттерами объема, площади поверхности и центра масс и отфильтруйте точки по тому, лежат ли они внутри него. У вершин, ребер, контуров, граней, оболочек и компаундов есть собственные классы рядом с этим под shapes.

Constructors

constructor

new OCCTSolid(): OCCTSolid
Returns OCCTSolid

beam

createIBeamProfileSolid

createIBeamProfileSolid(
inputs: IBeamProfileSolidDto,
): Promise<TopoDSSolidPointer>
Создает двутавр выдавливанием его плоского профиля вперед и назад вдоль его собственной нормали.

extrusionLengthFront и extrusionLengthBack говорят, на сколько он растет в каждую сторону, в единицах модели; хотя бы одна должна быть больше 0, иначе выбрасывается ошибка.
Parameters
- inputs: IBeamProfileSolidDto
  Профиль двутавра и две длины выдавливания
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const beam = await bitbybit.occt.shapes.solid.createIBeamProfileSolid({
    width: 10,
    height: 20,
    flangeThickness: 1,
    webThickness: 1,
    alignment: Bit.Inputs.Base.basicAlignmentEnum.midMid,
    rotation: 0,
    center: [0, 0, 0],
    direction: [0, 0, 1],
    extrusionLengthFront: 100,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44885

createHBeamProfileSolid

createHBeamProfileSolid(
inputs: HBeamProfileSolidDto,
): Promise<TopoDSSolidPointer>
Создает H-образную балку выдавливанием ее плоского профиля вперед и назад вдоль его собственной нормали.

extrusionLengthFront и extrusionLengthBack говорят, на сколько она растет в каждую сторону, в единицах модели; хотя бы одна должна быть больше 0, иначе выбрасывается ошибка.
Parameters
- inputs: HBeamProfileSolidDto
  Профиль H-балки и две длины выдавливания
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const beam = await bitbybit.occt.shapes.solid.createHBeamProfileSolid({
    width: 20,
    height: 20,
    flangeThickness: 1,
    webThickness: 1,
    alignment: Bit.Inputs.Base.basicAlignmentEnum.midMid,
    rotation: 0,
    center: [0, 0, 0],
    direction: [0, 0, 1],
    extrusionLengthFront: 100,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44912

createTBeamProfileSolid

createTBeamProfileSolid(
inputs: TBeamProfileSolidDto,
): Promise<TopoDSSolidPointer>
Создает тавр выдавливанием его плоского профиля вперед и назад вдоль его собственной нормали.

extrusionLengthFront и extrusionLengthBack говорят, на сколько он растет в каждую сторону, в единицах модели; хотя бы одна должна быть больше 0, иначе выбрасывается ошибка.
Parameters
- inputs: TBeamProfileSolidDto
  Профиль тавра и две длины выдавливания
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const beam = await bitbybit.occt.shapes.solid.createTBeamProfileSolid({
    width: 10,
    height: 20,
    flangeThickness: 1,
    webThickness: 1,
    alignment: Bit.Inputs.Base.basicAlignmentEnum.midMid,
    rotation: 0,
    center: [0, 0, 0],
    direction: [0, 0, 1],
    extrusionLengthFront: 100,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44939

createUBeamProfileSolid

createUBeamProfileSolid(
inputs: UBeamProfileSolidDto,
): Promise<TopoDSSolidPointer>
Создает швеллер выдавливанием его плоского профиля вперед и назад вдоль его собственной нормали.

extrusionLengthFront и extrusionLengthBack говорят, на сколько он растет в каждую сторону, в единицах модели; хотя бы одна должна быть больше 0, иначе выбрасывается ошибка.
Parameters
- inputs: UBeamProfileSolidDto
  Профиль швеллера и две длины выдавливания
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const beam = await bitbybit.occt.shapes.solid.createUBeamProfileSolid({
    width: 10,
    height: 20,
    flangeThickness: 1,
    webThickness: 1,
    flangeWidth: 3,
    alignment: Bit.Inputs.Base.basicAlignmentEnum.midMid,
    rotation: 0,
    center: [0, 0, 0],
    direction: [0, 0, 1],
    extrusionLengthFront: 100,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44967

debug

debugInfo

debugInfo(inputs: ShapeDto<TopoDSSolidPointer>): Promise<SolidDebugInfo>
Собирает диагностические сведения о теле: действительно ли оно, сколько у него граней и ребер, его площадь поверхности и объем, и для каждой грани тип поверхности, степени, числа контрольных точек, границы и площадь.

Пустая или null форма дает отчет, помеченный недействительным, с нулевыми счетчиками.
Parameters
- inputs: ShapeDto<TopoDSSolidPointer>
  Тело для проверки
Returns Promise<SolidDebugInfo>
Отчет с количествами, площадью, объемом и по одной записи на грань
Example
```
const info = await bitbybit.occt.shapes.solid.debugInfo({ shape: box });
console.log(info.nbFaces, info.volume);
```
- Defined in bitbybit-docs.d.ts:44551

filter

filterSolidPoints

filterSolidPoints(
inputs: FilterSolidPointsDto<TopoDSSolidPointer>,
): Promise<Point3[]>
Оставляет точки, лежащие внутри тела, на его поверхности или снаружи, как выбрано флагами keepIn, keepOn и keepOut.

Точка считается лежащей на поверхности, когда она в пределах tolerance от нее. Точки, которые ядро не может классифицировать, сохраняются только при keepUnknown.
Parameters
- inputs: FilterSolidPointsDto<TopoDSSolidPointer>
  Тело, точки, допуск и какие классы точек оставить
Returns Promise<Point3[]>
Прошедшие фильтр точки, в исходном порядке
Example
```
const inside = await bitbybit.occt.shapes.solid.filterSolidPoints({
    shape: box,
    points: [[0, 0, 0], [100, 0, 0]],
    tolerance: 1e-7,
    keepIn: true,
    keepOn: false,
    keepOut: false,
    keepUnknown: false,
});
```
- Defined in bitbybit-docs.d.ts:45074

from

fromClosedShell

fromClosedShell(
inputs: ShapeDto<TopoDSShellPointer>,
): Promise<TopoDSSolidPointer>
Превращает замкнутую оболочку в тело, так что объем, который она охватывает, становится телом, которое можно измерять, подвергать булевым операциям и строить меш.

Оболочка должна быть герметичной; оболочка с зазорами дает тело, которое ядро не может использовать.
Parameters
- inputs: ShapeDto<TopoDSShellPointer>
  Замкнутая оболочка
Returns Promise<TopoDSSolidPointer>
Тело, ограниченное оболочкой
Example
```
const solid = await bitbybit.occt.shapes.solid.fromClosedShell({ shape: closedShell });
```
- Defined in bitbybit-docs.d.ts:44567

get

getSolidSurfaceArea

getSolidSurfaceArea(inputs: ShapeDto<TopoDSSolidPointer>): Promise<number>
Измеряет полную площадь всех граней тела.
Parameters
- inputs: ShapeDto<TopoDSSolidPointer>
  Тело
Returns Promise<number>
Площадь поверхности в квадратных единицах модели
Example
```
const area = await bitbybit.occt.shapes.solid.getSolidSurfaceArea({ shape: box });
```
- Defined in bitbybit-docs.d.ts:44980

getSolidVolume

getSolidVolume(inputs: ShapeDto<TopoDSSolidPointer>): Promise<number>
Измеряет объем, который охватывает тело, в кубических единицах модели.
Parameters
- inputs: ShapeDto<TopoDSSolidPointer>
  Тело
Returns Promise<number>
Объем в кубических единицах модели
Example
```
const volume = await bitbybit.occt.shapes.solid.getSolidVolume({ shape: box });
```
- Defined in bitbybit-docs.d.ts:44993

getSolidsVolumes

getSolidsVolumes(inputs: ShapesDto<TopoDSSolidPointer>): Promise<number[]>
Измеряет объем каждого тела в списке.
Parameters
- inputs: ShapesDto<TopoDSSolidPointer>
  Тела
Returns Promise<number[]>
По одному объему на тело, в том же порядке
Example
```
const volumes = await bitbybit.occt.shapes.solid.getSolidsVolumes({ shapes: [box, sphere] });
```
- Defined in bitbybit-docs.d.ts:45006

getSolidCenterOfMass

getSolidCenterOfMass(inputs: ShapeDto<TopoDSSolidPointer>): Promise<Point3>
Находит центр масс тела, считая его заполненным материалом равномерной плотности.
Parameters
- inputs: ShapeDto<TopoDSSolidPointer>
  Тело
Returns Promise<Point3>
Точка центра масс
Example
```
const center = await bitbybit.occt.shapes.solid.getSolidCenterOfMass({ shape: box });
```
- Defined in bitbybit-docs.d.ts:45019

getSolidsCentersOfMass

getSolidsCentersOfMass(inputs: ShapesDto<TopoDSSolidPointer>): Promise<Point3[]>
Находит центр масс каждого тела в списке, считая каждое заполненным материалом равномерной плотности.
Parameters
- inputs: ShapesDto<TopoDSSolidPointer>
  Тела
Returns Promise<Point3[]>
По одной точке на тело, в том же порядке
Example
```
const centers = await bitbybit.occt.shapes.solid.getSolidsCentersOfMass({ shapes: [box, sphere] });
```
- Defined in bitbybit-docs.d.ts:45033

getSolids

getSolids(inputs: ShapeDto<TopoDSShapePointer>): Promise<TopoDSSolidPointer[]>
Перечисляет тела внутри любой формы, такие как тела компаунда или результат булевой операции.

Форма, которая сама является телом, дает список с этим одним телом.
Parameters
- inputs: ShapeDto<TopoDSShapePointer>
  Форма, из которой взять тела
Returns Promise<TopoDSSolidPointer[]>
Тела, найденные в форме
Example
```
const solids = await bitbybit.occt.shapes.solid.getSolids({ shape: compound });
```
- Defined in bitbybit-docs.d.ts:45049

primitives

createBox

createBox(inputs: BoxDto): Promise<TopoDSSolidPointer>
Создает тело бокса со сторонами, параллельными осям.

width идет вдоль X, height вдоль Y (вверх) и length вдоль Z, все в единицах модели. По умолчанию бокс центрируется на center; при originOnCenter, установленном в false, он вместо этого стоит на этой точке, так что center становится серединой нижней грани.
Parameters
- inputs: BoxDto
  Размер параллелепипеда, точка, в которой он размещается, и центрируется ли он на ней или стоит на ней
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const box = await bitbybit.occt.shapes.solid.createBox({ width: 10, length: 20, height: 5, center: [0, 0, 0], originOnCenter: true });
```
- Defined in bitbybit-docs.d.ts:44584

createCube

createCube(inputs: Bit.Inputs.OCCT.CubeDto): Promise<TopoDSSolidPointer>
Создает тело куба, бокс со всеми тремя сторонами одного размера, параллельными осям.

По умолчанию куб центрируется на center; при originOnCenter, установленном в false, он вместо этого стоит на этой точке, так что center становится серединой нижней грани.
Parameters
- inputs: Bit.Inputs.OCCT.CubeDto
  Размер куба, точка, в которой он размещается, и центрируется ли он на ней или стоит на ней
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const cube = await bitbybit.occt.shapes.solid.createCube({ size: 10, center: [0, 0, 0], originOnCenter: true });
```
- Defined in bitbybit-docs.d.ts:44600

createBoxFromCorner

createBoxFromCorner(inputs: BoxFromCornerDto): Promise<TopoDSSolidPointer>
Создает тело бокса, которое начинается в угловой точке и продолжается вдоль положительных осей.

Угол с наименьшими x, y и z находится в corner; бокс простирается оттуда на width вдоль X, height вдоль Y и length вдоль Z, все в единицах модели.
Parameters
- inputs: BoxFromCornerDto
  Размер параллелепипеда и угол, от которого он растет
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const box = await bitbybit.occt.shapes.solid.createBoxFromCorner({ width: 10, length: 20, height: 5, corner: [0, 0, 0] });
```
- Defined in bitbybit-docs.d.ts:44616

createCylinder

createCylinder(inputs: Bit.Inputs.OCCT.CylinderDto): Promise<TopoDSSolidPointer>
Создает тело цилиндра с круглым основанием в center, растущее на height вдоль direction.

При включенном originOnCenter цилиндр сдвигается назад на половину своей высоты, так что center оказывается в его середине. angle, в градусах, вырезает клин из полного круга в 360 градусов, как кусок торта.
Parameters
- inputs: Bit.Inputs.OCCT.CylinderDto
  Радиус, высота, центр основания, направление, необязательный неполный угол и центрировать ли на точке
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const cylinder = await bitbybit.occt.shapes.solid.createCylinder({ radius: 5, height: 20, center: [0, 0, 0], direction: [0, 1, 0], angle: 360, originOnCenter: false });
```
- Defined in bitbybit-docs.d.ts:44633

createCylindersOnLines

createCylindersOnLines(
inputs: CylindersOnLinesDto,
): Promise<TopoDSSolidPointer[]>
Создает по одному телу цилиндра вдоль каждой линии, от ее начала до конца, все с одним радиусом.

Высота каждого цилиндра - длина его линии.
Parameters
- inputs: CylindersOnLinesDto
  Линии и радиус
Returns Promise<TopoDSSolidPointer[]>
По одному телу на линию, в том же порядке
Example
```
const rods = await bitbybit.occt.shapes.solid.createCylindersOnLines({
    lines: [{ start: [0, 0, 0], end: [0, 10, 0] }, { start: [5, 0, 0], end: [5, 10, 0] }],
    radius: 0.5,
});
```
- Defined in bitbybit-docs.d.ts:44652

createSphere

createSphere(inputs: Bit.Inputs.OCCT.SphereDto): Promise<TopoDSSolidPointer>
Создает тело сферы заданного радиуса вокруг центральной точки.
Parameters
- inputs: Bit.Inputs.OCCT.SphereDto
  Радиус и центр
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const sphere = await bitbybit.occt.shapes.solid.createSphere({ radius: 5, center: [0, 0, 0] });
```
- Defined in bitbybit-docs.d.ts:44665

createCone

createCone(inputs: Bit.Inputs.OCCT.ConeDto): Promise<TopoDSSolidPointer>
Создает тело конуса, или усеченного конуса, когда оба радиуса больше 0, стоящее на круглом основании в center и растущее на height вдоль direction.

radius1 - основание, а radius2 - вершина; верхний радиус 0 дает острый конус. angle, в градусах, вырезает клин из полного круга в 360 градусов.
Parameters
- inputs: Bit.Inputs.OCCT.ConeDto
  Радиусы основания и вершины, высота, центр основания, направление и необязательный неполный угол
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const cone = await bitbybit.occt.shapes.solid.createCone({ radius1: 5, radius2: 0, height: 10, center: [0, 0, 0], direction: [0, 1, 0], angle: 360 });
```
- Defined in bitbybit-docs.d.ts:44682

createTorus

createTorus(inputs: Bit.Inputs.OCCT.TorusDto): Promise<TopoDSSolidPointer>
Создает тело тора, кольцо с круглым сечением, центрированное на center с осью вдоль direction.

majorRadius - расстояние от центра до середины трубки, а minorRadius - собственный радиус трубки. angle, в градусах, дает частичное кольцо вместо полных 360 градусов.
Parameters
- inputs: Bit.Inputs.OCCT.TorusDto
  Большой и малый радиусы, центр, направление и необязательный неполный угол
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const ring = await bitbybit.occt.shapes.solid.createTorus({ majorRadius: 10, minorRadius: 2, center: [0, 0, 0], direction: [0, 1, 0], angle: 360 });
```
- Defined in bitbybit-docs.d.ts:44699

createStarSolid

createStarSolid(inputs: StarSolidDto): Promise<TopoDSSolidPointer>
Создает звездообразное тело выдавливанием плоского профиля звезды вперед и назад вдоль его собственной нормали.

extrusionLengthFront и extrusionLengthBack говорят, на сколько оно растет в каждую сторону, в единицах модели; хотя бы одна должна быть больше 0, иначе выбрасывается ошибка. Сама звезда строится так, как ее строит shapes.wire.createStarWire.
Parameters
- inputs: StarSolidDto
  Профиль звезды и две длины выдавливания
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const star = await bitbybit.occt.shapes.solid.createStarSolid({
    numRays: 5,
    outerRadius: 10,
    innerRadius: 5,
    half: false,
    center: [0, 0, 0],
    direction: [0, 1, 0],
    extrusionLengthFront: 2,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44726

createNGonSolid

createNGonSolid(inputs: NGonSolidDto): Promise<TopoDSSolidPointer>
Создает тело с сечением правильного многоугольника выдавливанием плоского профиля n-угольника вперед и назад вдоль его собственной нормали.

extrusionLengthFront и extrusionLengthBack говорят, на сколько оно растет в каждую сторону, в единицах модели; хотя бы одна должна быть больше 0, иначе выбрасывается ошибка.
Parameters
- inputs: NGonSolidDto
  Профиль многоугольника и две длины выдавливания
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const hexPrism = await bitbybit.occt.shapes.solid.createNGonSolid({
    nrCorners: 6,
    radius: 5,
    center: [0, 0, 0],
    direction: [0, 1, 0],
    extrusionLengthFront: 10,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44750

createParallelogramSolid

createParallelogramSolid(
inputs: ParallelogramSolidDto,
): Promise<TopoDSSolidPointer>
Создает тело с сечением параллелограмма выдавливанием плоского профиля параллелограмма вперед и назад вдоль его собственной нормали.

extrusionLengthFront и extrusionLengthBack говорят, на сколько оно растет в каждую сторону, в единицах модели; хотя бы одна должна быть больше 0, иначе выбрасывается ошибка.
Parameters
- inputs: ParallelogramSolidDto
  Профиль параллелограмма и две длины выдавливания
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const slab = await bitbybit.occt.shapes.solid.createParallelogramSolid({
    width: 10,
    height: 5,
    angle: 15,
    center: [0, 0, 0],
    direction: [0, 1, 0],
    aroundCenter: true,
    extrusionLengthFront: 2,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44776

createHeartSolid

createHeartSolid(inputs: HeartSolidDto): Promise<TopoDSSolidPointer>
Создает тело в форме сердца выдавливанием плоского профиля сердца вперед и назад вдоль его собственной нормали.

extrusionLengthFront и extrusionLengthBack говорят, на сколько оно растет в каждую сторону, в единицах модели; хотя бы одна должна быть больше 0, иначе выбрасывается ошибка.
Parameters
- inputs: HeartSolidDto
  Профиль сердца и две длины выдавливания
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const heart = await bitbybit.occt.shapes.solid.createHeartSolid({
    sizeApprox: 10,
    rotation: 0,
    center: [0, 0, 0],
    direction: [0, 1, 0],
    extrusionLengthFront: 2,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44800

createChristmasTreeSolid

createChristmasTreeSolid(
inputs: ChristmasTreeSolidDto,
): Promise<TopoDSSolidPointer>
Создает тело в форме елки выдавливанием плоского профиля елки вперед и назад вдоль его собственной нормали.

extrusionLengthFront и extrusionLengthBack говорят, на сколько оно растет в каждую сторону, в единицах модели; хотя бы одна должна быть больше 0, иначе выбрасывается ошибка.
Parameters
- inputs: ChristmasTreeSolidDto
  Профиль елки и две длины выдавливания
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const tree = await bitbybit.occt.shapes.solid.createChristmasTreeSolid({
    height: 10,
    innerDist: 1.5,
    outerDist: 3,
    nrSkirts: 5,
    trunkHeight: 1,
    trunkWidth: 1,
    half: false,
    rotation: 0,
    origin: [0, 0, 0],
    direction: [0, 1, 0],
    extrusionLengthFront: 2,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44830

createLPolygonSolid

createLPolygonSolid(inputs: LPolygonSolidDto): Promise<TopoDSSolidPointer>
Создает L-образное тело выдавливанием плоского профиля L вперед и назад вдоль его собственной нормали.

extrusionLengthFront и extrusionLengthBack говорят, на сколько оно растет в каждую сторону, в единицах модели; хотя бы одна должна быть больше 0, иначе выбрасывается ошибка.
Parameters
- inputs: LPolygonSolidDto
  L-образный профиль и две длины выдавливания
Returns Promise<TopoDSSolidPointer>
Новое тело
Example
```
const bracket = await bitbybit.occt.shapes.solid.createLPolygonSolid({
    widthFirst: 10,
    lengthFirst: 20,
    widthSecond: 10,
    lengthSecond: 15,
    align: Bit.Inputs.OCCT.directionEnum.outside,
    rotation: 0,
    center: [0, 0, 0],
    direction: [0, 1, 0],
    extrusionLengthFront: 2,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44858

Class OCCTSolid

Index

Constructors

beam

debug

filter

from

get

primitives

Constructors

constructor

Returns OCCTSolid

beam

createIBeamProfileSolid

Parameters

Returns Promise<TopoDSSolidPointer>

Example

createHBeamProfileSolid

Parameters

Returns Promise<TopoDSSolidPointer>

Example

createTBeamProfileSolid

Parameters

Returns Promise<TopoDSSolidPointer>

Example

createUBeamProfileSolid

Parameters

Returns Promise<TopoDSSolidPointer>

Example

debug

debugInfo

Parameters

Returns Promise<SolidDebugInfo>

Example

filter

filterSolidPoints

Parameters

Returns Promise<Point3[]>

Example

from

fromClosedShell

Parameters

Returns Promise<TopoDSSolidPointer>

Example

get

getSolidSurfaceArea

Parameters

Returns Promise<number>

Example

getSolidVolume

Parameters

Returns Promise<number>

Example

getSolidsVolumes

Parameters

Returns Promise<number[]>

Example

getSolidCenterOfMass

Parameters

Returns Promise<Point3>

Example

getSolidsCentersOfMass

Parameters

Returns Promise<Point3[]>

Example

getSolids

Parameters

Returns Promise<TopoDSSolidPointer[]>

Example

primitives

createBox

Parameters

Returns Promise<TopoDSSolidPointer>

Example

createCube

Parameters

Returns Promise<TopoDSSolidPointer>

Example

createBoxFromCorner

Parameters