Klasse OCCTWIO

Lesen und Schreiben von CAD-Dateien mit OCCT: alles, was io auf dem Kernel bietet, plus Lader, die eine STEP- oder IGES-Datei als File-Objekt oder als ihren Text nehmen und eine Form zurückgeben. Dateien sind per Konvention Z-oben, daher dreht adjustZtoY die geladene Form in das Y-oben dieser Bibliothek, sofern es nicht auf false gesetzt ist.

Hierarchie (Zusammenfassung anzeigen)

OCCTIO
- OCCTWIO

Index

Konstruktoren

constructor

new OCCTWIO(): OCCTWIO
Rückgabewert OCCTWIO
Geerbt von OCCTIO.constructor

Eigenschaften

`Schreibgeschützt`occWorkerManager

occWorkerManager: OCCTWorkerManager

assembly

convertStepToGltf

convertStepToGltf(
inputs: ConvertStepToGltfDto,
): Promise<Uint8Array<ArrayBufferLike>>
Converts a STEP file into a binary glTF (GLB), keeping the assembly tree as glTF nodes along with part names, colors, materials and placements.

stepData is the file as text, ArrayBuffer or Uint8Array. The mesh settings say how finely curved surfaces are triangulated: meshPrecision is the deflection, meshAngle the angular deflection. Z-up becomes glTF's Y-up. Failure throws.
Parameter
- inputs: ConvertStepToGltfDto
  The STEP file content and the meshing settings
Rückgabewert Promise<Uint8Array<ArrayBufferLike>>
The GLB file as bytes
Example
```
const glb = await bitbybit.occt.io.convertStepToGltf({ stepData: stepText, meshPrecision: 0.005, meshAngle: 0.5, meshRelative: true, internalVerticesMode: false, controlSurfaceDeflection: false });
```
Geerbt von OCCTIO.convertStepToGltf
- Definiert in bitbybit-docs.d.ts:41213

convertStepToGltfAdvanced

convertStepToGltfAdvanced(
inputs: ConvertStepToGltfAdvancedDto,
): Promise<Uint8Array<ArrayBufferLike>>
Converts a STEP file into a binary glTF (GLB) like convertStepToGltf, with every option exposed.

The read flags choose what to take from the file (colors, names, materials, layers, properties), the mesh settings how finely to triangulate, the export settings how the glTF is written (merged faces, 16-bit indexes, naming, scale). Switch off what you do not need.
Parameter
- inputs: ConvertStepToGltfAdvancedDto
  The STEP file content and the reading, meshing and export settings
Rückgabewert Promise<Uint8Array<ArrayBufferLike>>
The GLB file as bytes
Example
```
const options = new Bit.Inputs.OCCT.ConvertStepToGltfAdvancedDto();
options.stepData = stepText;
options.readColors = true;
options.readNames = true;
options.meshDeflection = 0.005;
options.mergeFaces = true;
options.adjustZtoY = true;
const glb = await bitbybit.occt.io.convertStepToGltfAdvanced(options);
```
Geerbt von OCCTIO.convertStepToGltfAdvanced
- Definiert in bitbybit-docs.d.ts:41238

convertStepToGltfWithDraco

convertStepToGltfWithDraco(
inputs: ConvertStepToGltfWithDracoDto,
): Promise<Uint8Array<ArrayBufferLike>>
Converts a STEP file into a binary glTF (GLB) like convertStepToGltf and compresses the geometry with Draco, which makes the file much smaller at the cost of a Draco-capable loader.

The Draco settings set the compression level and how many bits positions, normals, texture coordinates and colors keep; fewer bits mean a smaller file and less precision.
Parameter
- inputs: ConvertStepToGltfWithDracoDto
  The STEP file content, the meshing settings and the Draco settings
Rückgabewert Promise<Uint8Array<ArrayBufferLike>>
The GLB file as bytes
Example
```
const options = new Bit.Inputs.OCCT.ConvertStepToGltfWithDracoDto();
options.stepData = stepText;
options.meshPrecision = 0.005;
options.dracoCompressionLevel = 7;
options.dracoQuantizePositionBits = 14;
const glb = await bitbybit.occt.io.convertStepToGltfWithDraco(options);
```
Geerbt von OCCTIO.convertStepToGltfWithDraco
- Definiert in bitbybit-docs.d.ts:41260

convertStepToGltfAdvancedWithDraco

convertStepToGltfAdvancedWithDraco(
inputs: ConvertStepToGltfAdvancedWithDracoDto,
): Promise<Uint8Array<ArrayBufferLike>>
Converts a STEP file into a binary glTF (GLB) with every reading, meshing and writing option exposed, as convertStepToGltfAdvanced does, and compresses the geometry with Draco.

The Draco settings set the compression level and how many bits positions, normals, texture coordinates and colors keep; fewer bits mean a smaller file and less precision.
Parameter
- inputs: ConvertStepToGltfAdvancedWithDracoDto
  The STEP file content, the reading, meshing and export settings, and the Draco settings
Rückgabewert Promise<Uint8Array<ArrayBufferLike>>
The GLB file as bytes
Example
```
const options = new Bit.Inputs.OCCT.ConvertStepToGltfAdvancedWithDracoDto();
options.stepData = stepText;
options.readColors = true;
options.meshDeflection = 0.005;
options.dracoCompressionLevel = 7;
const glb = await bitbybit.occt.io.convertStepToGltfAdvancedWithDraco(options);
```
Geerbt von OCCTIO.convertStepToGltfAdvancedWithDraco
- Definiert in bitbybit-docs.d.ts:41282

parseStepToJson

parseStepToJson(inputs: ParseStepAssemblyToJsonDto): Promise<AssemblyJsonResult>
Reads the assembly structure of a STEP file without building geometry: every part and sub-assembly as a node with its id, name, whether it is an assembly, its visibility, its color and its placement matrix.

The nodes come in depth-first order, so children follow their parent. A file that cannot be parsed reports its error in the result.
Parameter
- inputs: ParseStepAssemblyToJsonDto
  The STEP file content
Rückgabewert Promise<AssemblyJsonResult>
The list of nodes, the format version and any error
Example
```
const tree = await bitbybit.occt.io.parseStepToJson({ stepData: stepText });
console.log(tree.nodes.map(n => n.name));
```
Geerbt von OCCTIO.parseStepToJson
- Definiert in bitbybit-docs.d.ts:41301

dxf

shapeToDxfPaths

shapeToDxfPaths(
inputs: ShapeToDxfPathsDto<TopoDSShapePointer>,
): Promise<DxfPathDto[]>
Turns the wires of a shape into DXF path records, the first step of a 2D DXF export.

The shape must lie flat on the XZ ground plane, since DXF drawings are two-dimensional. The deflection settings say how closely curved edges are followed. Give the paths a layer with dxfPathsWithLayer and write the file with dxfCreate.
Parameter
- inputs: ShapeToDxfPathsDto<TopoDSShapePointer>
  The shape and the deflection settings
Rückgabewert Promise<DxfPathDto[]>
The DXF paths
Example
```
const paths = await bitbybit.occt.io.shapeToDxfPaths({
    shape: flatOutline,
    angularDeflection: 0.1,
    curvatureDeflection: 0.1,
    minimumOfPoints: 2,
    uTolerance: 1e-9,
    minimumLength: 1e-7,
});
```
Geerbt von OCCTIO.shapeToDxfPaths
- Definiert in bitbybit-docs.d.ts:41156

dxfPathsWithLayer

dxfPathsWithLayer(inputs: DxfPathsWithLayerDto): Promise<DxfPathsPartDto>
Puts DXF paths on a named layer with a color, making one part of a DXF drawing.

A drawing may hold several parts, each with its own layer and color; dxfCreate writes them into one file.
Parameter
- inputs: DxfPathsWithLayerDto
  The paths, the layer name and the color
Rückgabewert Promise<DxfPathsPartDto>
The paths as one layered part
Example
```
const part = await bitbybit.occt.io.dxfPathsWithLayer({ paths, layer: "cut", color: "#ff0000" });
```
Geerbt von OCCTIO.dxfPathsWithLayer
- Definiert in bitbybit-docs.d.ts:41172

dxfCreate

dxfCreate(inputs: DxfPathsPartsListDto): Promise<string>
Writes DXF parts into one DXF file and returns its text.

colorFormat chooses AutoCAD's indexed colors or true color, acadVersion the DXF version: AC1009 is R12, the most widely readable, AC1015 is 2000. fileName and tryDownload matter only where a browser download can be started.
Parameter
- inputs: DxfPathsPartsListDto
  The layered parts, the color format, the DXF version and the download options
Rückgabewert Promise<string>
The DXF file as text
Example
```
const dxf = await bitbybit.occt.io.dxfCreate({
    pathsParts: [part],
    colorFormat: Bit.Inputs.OCCT.dxfColorFormatEnum.aci,
    acadVersion: Bit.Inputs.OCCT.dxfAcadVersionEnum.AC1009,
    fileName: "drawing.dxf",
    tryDownload: false,
});
```
Geerbt von OCCTIO.dxfCreate
- Definiert in bitbybit-docs.d.ts:41195

io

saveShapeSTEP

saveShapeSTEP(inputs: SaveStepDto<TopoDSShapePointer>): Promise<void>
Writes a shape as STEP, the standard exchange format for exact CAD geometry, and starts a browser download of the file.

With adjustYtoZ true the shape is turned so this library's Y-up becomes STEP's Z-up; fromRightHanded skips the mirror that swap otherwise includes. fileName names the download and tryDownload false skips it. saveShapeSTEPAndReturn gives the file's text instead.
Parameter
- inputs: SaveStepDto<TopoDSShapePointer>
  The shape, the file name, the axis adjustment and the download options
Rückgabewert Promise<void>
Nothing; the download starts when the file is ready
Example
```
await bitbybit.occt.io.saveShapeSTEP({ shape: box, fileName: "box.step", adjustYtoZ: true, tryDownload: true });
```
Geerbt von OCCTIO.saveShapeSTEP
- Definiert in bitbybit-docs.d.ts:41076

saveShapeSTEPAndReturn

saveShapeSTEPAndReturn(inputs: SaveStepDto<TopoDSShapePointer>): Promise<string>
Writes a shape as STEP, the standard exchange format for exact CAD geometry, and returns the file's text.

With adjustYtoZ true the shape is turned so this library's Y-up becomes STEP's Z-up; fromRightHanded skips the mirror that swap otherwise includes. fileName and tryDownload matter only where a browser download can be started.
Parameter
- inputs: SaveStepDto<TopoDSShapePointer>
  The shape, the file name, the axis adjustment and the download options
Rückgabewert Promise<string>
The STEP file as text
Example
```
const step = await bitbybit.occt.io.saveShapeSTEPAndReturn({ shape: box, fileName: "box.step", adjustYtoZ: true, tryDownload: false });
```
Geerbt von OCCTIO.saveShapeSTEPAndReturn
- Definiert in bitbybit-docs.d.ts:41094

saveShapeStl

saveShapeStl(inputs: SaveStlDto<TopoDSShapePointer>): Promise<void>
Triangulates a shape, writes it as STL, the mesh format 3D printers read, and starts a browser download of the file.

precision is the meshing tolerance in model units; smaller values follow curved surfaces more closely and make a bigger file. adjustYtoZ turns Y-up into Z-up. fileName names the download, tryDownload false skips it. saveShapeStlAndReturn gives the text instead.
Parameter
- inputs: SaveStlDto<TopoDSShapePointer>
  The shape, the file name, the meshing precision, the axis adjustment and the download options
Rückgabewert Promise<void>
Nothing; the download starts when the file is ready
Example
```
await bitbybit.occt.io.saveShapeStl({ shape: box, fileName: "box.stl", precision: 0.01, adjustYtoZ: true, tryDownload: true });
```
Geerbt von OCCTIO.saveShapeStl
- Definiert in bitbybit-docs.d.ts:41112

saveShapeStlAndReturn

saveShapeStlAndReturn(inputs: SaveStlDto<TopoDSShapePointer>): Promise<string>
Triangulates a shape and writes it as STL, the mesh format 3D printers and slicers read, returning the file's text.

precision is the meshing tolerance in model units; smaller values follow curved surfaces more closely and make a bigger file. adjustYtoZ turns the shape so Y-up becomes Z-up. fileName and tryDownload only matter where a download can start.
Parameter
- inputs: SaveStlDto<TopoDSShapePointer>
  The shape, the file name, the meshing precision, the axis adjustment and the download options
Rückgabewert Promise<string>
The STL file as text
Example
```
const stl = await bitbybit.occt.io.saveShapeStlAndReturn({ shape: box, fileName: "box.stl", precision: 0.01, adjustYtoZ: true, tryDownload: false });
```
Geerbt von OCCTIO.saveShapeStlAndReturn
- Definiert in bitbybit-docs.d.ts:41130

loadSTEPorIGES

loadSTEPorIGES(inputs: ImportStepIgesDto): Promise<TopoDSShapePointer>
Liest eine STEP- oder IGES-Datei, gegeben als File, in eine Form ein.

Die Erweiterung der Datei entscheidet über die Art: .step, .stp sind STEP, .iges, .igs sind IGES. adjustZtoY verwandelt das Z-oben der Datei in Y-oben. Eine Datei, die nicht gelesen werden kann, ergibt undefined.
Parameter
- inputs: ImportStepIgesDto
  Die Datei und die Achsenanpassung
Rückgabewert Promise<TopoDSShapePointer>
Die geladene Form
Example
```
const file = await bitbybit.asset.getFile({ fileName: "part.step" });
const shape = await bitbybit.occt.io.loadSTEPorIGES({ assetFile: file, adjustZtoY: true });
await bitbybit.draw.drawAnyAsync({ entity: shape });
```
- Definiert in bitbybit-docs.d.ts:58659

loadSTEPorIGESFromText

loadSTEPorIGESFromText(
inputs: ImportStepIgesFromTextDto,
): Promise<TopoDSShapePointer>
Liest eine STEP- oder IGES-Datei, gegeben als ihr Text, in eine Form ein; fileType sagt, in welchem der beiden Formate der Text vorliegt.

adjustZtoY verwandelt das Z-oben der Datei in Y-oben. Text, der nicht gelesen werden kann, ergibt undefined.
Parameter
- inputs: ImportStepIgesFromTextDto
  Der Dateitext, sein Format und die Achsenanpassung
Rückgabewert Promise<TopoDSShapePointer>
Die geladene Form
Example
```
const text = await bitbybit.asset.fetchText({ url: "https://example.com/models/part.step" });
const shape = await bitbybit.occt.io.loadSTEPorIGESFromText({ text, fileType: Bit.Inputs.OCCT.fileTypeEnum.step, adjustZtoY: true });
```
- Definiert in bitbybit-docs.d.ts:58675

Klasse OCCTWIO

Hierarchie (Zusammenfassung anzeigen)

Index

Konstruktoren

Eigenschaften

assembly

dxf

io

Konstruktoren

constructor

Rückgabewert OCCTWIO

Eigenschaften

SchreibgeschütztoccWorkerManager

assembly

convertStepToGltf

Parameter

Rückgabewert Promise<Uint8Array<ArrayBufferLike>>

Example

convertStepToGltfAdvanced

Parameter

Rückgabewert Promise<Uint8Array<ArrayBufferLike>>

Example

convertStepToGltfWithDraco

Parameter

Rückgabewert Promise<Uint8Array<ArrayBufferLike>>

Example

convertStepToGltfAdvancedWithDraco

Parameter

Rückgabewert Promise<Uint8Array<ArrayBufferLike>>

Example

parseStepToJson

Parameter

Rückgabewert Promise<AssemblyJsonResult>

Example

dxf

shapeToDxfPaths

Parameter

Rückgabewert Promise<DxfPathDto[]>

Example

dxfPathsWithLayer

Parameter

Rückgabewert Promise<DxfPathsPartDto>

Example

dxfCreate

Parameter

Rückgabewert Promise<string>

Example

io

saveShapeSTEP

Parameter

Rückgabewert Promise<void>

Example

saveShapeSTEPAndReturn

Parameter

Rückgabewert Promise<string>

Example

saveShapeStl

Parameter

Rückgabewert Promise<void>

Example

saveShapeStlAndReturn

Parameter

Rückgabewert Promise<string>

Example

loadSTEPorIGES

Parameter

Rückgabewert Promise<TopoDSShapePointer>

Example

loadSTEPorIGESFromText

Parameter

Rückgabewert Promise<TopoDSShapePointer>

Example

Einstellungen

Auf dieser Seite

`Schreibgeschützt`occWorkerManager