Class OCCTAssemblyManager

بناء مستندات التجميع وتغييرها: صف الأجزاء وعقد التجميع وعقد النسخ الفورية كائنا واحدا في المرة، وادمجها في بنية، وابن مستندا منها؛ أو حمّل ملف STEP في مستند. ثم أعد تلوين التسميات وإعادة تسميتها، وحدّث الأجزاء أو أزلها، وصدّر إلى STEP أو glTF. المستند مقبض في الذاكرة يبقى حيا حتى يُحذف، فابن مرة واحدة واستعلم أو صدّر كلما احتجت.

Index

Constructors

constructor

new OCCTAssemblyManager(): OCCTAssemblyManager
Returns OCCTAssemblyManager

Methods

createImportedPart

createImportedPart(
inputs: CreateImportedPartDto,
): Promise<AssemblyLoadedPartDef>
يصف جزءا مأخوذا من مستند آخر، عادة مستند محمّل من STEP، بحيث تُنسخ شجرة تسمياته كلها مع التجميعات الفرعية والأسماء والألوان إلى التجميع الجديد.

sourceDocumentIndex يشير إلى قائمة sourceDocuments المعطاة لـ buildAssemblyDocument، و sourceLabel يختار شجرة فرعية بدلا من المستند كله. تضعه عقد النسخ بـ partId مثل أي جزء.
Parameters
- inputs: CreateImportedPartDto
  معرّف الجزء وفهرس المستند المصدر وتسمية مصدر واسم ولون اختيارية
Returns Promise<AssemblyLoadedPartDef>
تعريف الجزء المستورد، جاهز لـ combineStructure
Example
```
const chairDoc = await bitbybit.occt.assembly.manager.loadStepToDoc({ stepData });
const chair = await bitbybit.occt.assembly.manager.createImportedPart({ id: "chair", sourceDocumentIndex: 0, name: "Chair" });
const c1 = await bitbybit.occt.assembly.manager.createInstanceNode({ id: "c1", partId: "chair", name: "Chair 1", translation: [0, 0, 0] });
const c2 = await bitbybit.occt.assembly.manager.createInstanceNode({ id: "c2", partId: "chair", name: "Chair 2", translation: [500, 0, 0] });
const structure = await bitbybit.occt.assembly.manager.combineStructure({ parts: [], nodes: [c1, c2], loadedParts: [chair], clearDocument: false });
const doc = await bitbybit.occt.assembly.manager.buildAssemblyDocument({ structure, sourceDocuments: [chairDoc] });
```
- Defined in bitbybit-docs.d.ts:39580

assembly

createPart

createPart(
inputs: CreateAssemblyPartDto<TopoDSShapePointer>,
): Promise<AssemblyPartDef<TopoDSShapePointer>>
يصف جزءا لبنية تجميع: معرّف للإشارة إليه، وشكله، واسم ولون اختياري.

لا يُبنى شيء بعد؛ لا يصبح الجزء حقيقيا إلا عندما تمر بنية تحمله عبر buildAssemblyDocument. تضع عقد النسخ الجزء بمعرّفه، بقدر ما يلزم من المرات.
Parameters
- inputs: CreateAssemblyPartDto<TopoDSShapePointer>
  معرّف الجزء وشكله واسمه ولون اختياري
Returns Promise<AssemblyPartDef<TopoDSShapePointer>>
تعريف الجزء، جاهز لـ combineStructure
Example
```
const box = await bitbybit.occt.shapes.solid.createBox({ width: 10, length: 10, height: 10, center: [0, 0, 0] });
const part = await bitbybit.occt.assembly.manager.createPart({ id: "box", shape: box, name: "Box", colorRgba: { r: 1, g: 0, b: 0, a: 1 } });
```
- Defined in bitbybit-docs.d.ts:39542

createAssemblyNode

createAssemblyNode(inputs: CreateAssemblyNodeDto): Promise<AssemblyNodeDef>
يصف عقدة تجميع، حاوية تجمع النسخ والتجميعات الأخرى في التسلسل الهرمي.

parentId يسمي التجميع الذي تقع فيه؛ اتركه للجذر. مصفوفة اختيارية تضع المجموعة كلها.
Parameters
- inputs: CreateAssemblyNodeDto
  معرّف العقدة واسمها ومعرّف أصل اختياري ولون اختياري ومصفوفة وضع اختيارية
Returns Promise<AssemblyNodeDef>
تعريف العقدة، جاهز لـ combineStructure
Example
```
const root = await bitbybit.occt.assembly.manager.createAssemblyNode({ id: "root", name: "Root Assembly" });
const sub = await bitbybit.occt.assembly.manager.createAssemblyNode({ id: "sub", name: "Sub Assembly", parentId: "root" });
```
- Defined in bitbybit-docs.d.ts:39560

createInstanceNode

createInstanceNode(inputs: CreateInstanceNodeDto): Promise<AssemblyNodeDef>
يصف عقدة نسخة، وضعا واحدا لجزء: أي جزء بـ partId، وأين يذهب وتحت أي تجميع.

translation ينقله، و rotation يديره بزوايا أويلر بالدرجات حول X و Y و Z، و scale يحجّمه بانتظام؛ ويمكن لـ matrix أن تحل محل الثلاثة. يمكن أن يوضع الجزء نفسه بنسخ كثيرة.
Parameters
- inputs: CreateInstanceNodeDto
  معرّف العقدة ومعرّف الجزء والاسم ومعرّف أصل اختياري والوضع
Returns Promise<AssemblyNodeDef>
تعريف العقدة، جاهز لـ combineStructure
Example
```
const first = await bitbybit.occt.assembly.manager.createInstanceNode({ id: "box1", partId: "box", name: "Box 1" });
const second = await bitbybit.occt.assembly.manager.createInstanceNode({ id: "box2", partId: "box", name: "Box 2", translation: [20, 0, 0], rotation: [0, 0, 45] });
```
- Defined in bitbybit-docs.d.ts:39599

createPartUpdate

createPartUpdate(
inputs: CreatePartUpdateDto<TopoDSShapePointer>,
): Promise<AssemblyPartUpdateDef<TopoDSShapePointer>>
يصف تغييرا لجزء موجود أصلا في مستند: شكل جديد أو اسم جديد أو لون جديد، أو أي مزيج منها، معنونا بتسمية الجزء.

اجمع التحديثات في combineStructure تحت partUpdates ومرر البنية إلى buildAssemblyDocument مع المستند الموجود.
Parameters
- inputs: CreatePartUpdateDto<TopoDSShapePointer>
  تسمية الجزء والشكل والاسم واللون الجديدة الاختيارية
Returns Promise<AssemblyPartUpdateDef<TopoDSShapePointer>>
تعريف التحديث، جاهز لـ combineStructure
Example
```
const parts = await bitbybit.occt.assembly.query.getDocumentParts({ document: doc });
const bigger = await bitbybit.occt.shapes.solid.createBox({ width: 20, length: 20, height: 20, center: [0, 0, 0] });
const update = await bitbybit.occt.assembly.manager.createPartUpdate({ label: parts[0].label, shape: bigger, name: "Bigger Box" });
const structure = await bitbybit.occt.assembly.manager.combineStructure({ parts: [], nodes: [], partUpdates: [update], clearDocument: false });
await bitbybit.occt.assembly.manager.buildAssemblyDocument({ structure, existingDocument: doc });
```
- Defined in bitbybit-docs.d.ts:39620

combineStructure

combineStructure(
inputs: CombineAssemblyStructureDto<TopoDSShapePointer>,
): Promise<AssemblyStructureDef<TopoDSShapePointer>>
يجمع الأجزاء والعقد، وللتحديثات الإزالات وتحديثات الأجزاء والأجزاء المستوردة، في تعريف بنية واحد، الخطوة الأخيرة قبل buildAssemblyDocument.

clearDocument بقيمة false يحتفظ بما يحمله المستند الموجود أصلا عند تطبيق البنية عليه.
Parameters
- inputs: CombineAssemblyStructureDto<TopoDSShapePointer>
  الأجزاء والعقد والإزالات وتحديثات الأجزاء والأجزاء المستوردة وعلم المسح الاختيارية
Returns Promise<AssemblyStructureDef<TopoDSShapePointer>>
البنية، جاهزة للبناء
Example
```
const structure = await bitbybit.occt.assembly.manager.combineStructure({ parts: [part], nodes: [root, first, second], clearDocument: false });
const doc = await bitbybit.occt.assembly.manager.buildAssemblyDocument({ structure });
```
- Defined in bitbybit-docs.d.ts:39638

buildAssemblyDocument

buildAssemblyDocument(
    inputs: BuildAssemblyDocumentDto<
        TopoDSShapePointer,
        TDocStdDocumentPointer,
    >,
): Promise<TDocStdDocumentPointer>
يبني مستند تجميع من بنية، أو يطبق البنية على مستند موجود.

مع existingDocument تُحذف التسميات في removals أولا، وتُطبق partUpdates، ثم تُضاف الأجزاء والعقد الجديدة؛ والبنية التي لا تحوي أيا منهما تفرّغ المستند ما لم يكن clearDocument هو false. sourceDocuments يوفر المستندات التي تنسخ منها الأجزاء المستوردة. يبقى المستند في الذاكرة حتى يُحذف.
Parameters
- inputs: BuildAssemblyDocumentDto<TopoDSShapePointer, TDocStdDocumentPointer>
  البنية ومستند اختياري للتحديث والمستندات المصدر الاختيارية
Returns Promise<TDocStdDocumentPointer>
مقبض المستند، جديدا أو محدثا
Throws
Error if assembly building fails
Example
```
const structure = await bitbybit.occt.assembly.manager.combineStructure({ parts: [part], nodes: [root, first], clearDocument: false });
const doc = await bitbybit.occt.assembly.manager.buildAssemblyDocument({ structure });
const glb = await bitbybit.occt.assembly.manager.exportDocumentToGltf({ document: doc, meshDeflection: 0.1, meshAngle: 0.5, internalVerticesMode: false, controlSurfaceDeflection: false, mergeFaces: false, forceUVExport: false, fileName: "assembly.glb", tryDownload: false });
```
- Defined in bitbybit-docs.d.ts:39660

loadStepToDoc

loadStepToDoc(inputs: LoadStepToDocDto): Promise<TDocStdDocumentPointer>
يحمّل ملف STEP في مستند تجميع جديد، مع أجزائه وتجميعاته الفرعية وأسمائه وألوانه وأوضاعه.

stepData هو الملف كنص أو ثنائي؛ ويُقبل STEP-Z المضغوط بـ gzip أيضا. الملف الذي لا يمكن تحميله يرمي خطأ. النسخة التي يتركها الملف بلا اسم، كما يفعل SolidWorks، تُسمّى باسم الجزء الذي تضعه، مع ترقيمها عندما يتكرر ذلك الجزء بجانبها.
Parameters
- inputs: LoadStepToDocDto
  محتوى ملف STEP
Returns Promise<TDocStdDocumentPointer>
مقبض المستند
Throws
Error if STEP loading fails
Example
```
const doc = await bitbybit.occt.assembly.manager.loadStepToDoc({ stepData: stepText });
const parts = await bitbybit.occt.assembly.query.getDocumentParts({ document: doc });
```
- Defined in bitbybit-docs.d.ts:39680

export

exportDocumentToStep

exportDocumentToStep(
inputs: ExportDocumentToStepDto<TDocStdDocumentPointer>,
): Promise<Uint8Array<ArrayBufferLike>>
يكتب مستند تجميع كملف STEP بتسلسله الهرمي وأسمائه وألوانه، ويعيد بايتات الملف.

author و organization يذهبان إلى ترويسة الملف؛ compress يكتب STEP-Z المضغوط بـ gzip بدلا من ذلك. الفشل يرمي خطأ.
Parameters
- inputs: ExportDocumentToStepDto<TDocStdDocumentPointer>
  المستند واسم الملف وتفاصيل الترويسة وعلم الضغط وخيار التنزيل
Returns Promise<Uint8Array<ArrayBufferLike>>
ملف STEP كبايتات
Example
```
const step = await bitbybit.occt.assembly.manager.exportDocumentToStep({ document: doc, fileName: "assembly.step", author: "Bitbybit user", organization: "Bitbybit", compress: false, tryDownload: false });
```
- Defined in bitbybit-docs.d.ts:39726

exportDocumentToGltf

exportDocumentToGltf(
inputs: ExportDocumentToGltfDto<TDocStdDocumentPointer>,
): Promise<Uint8Array<ArrayBufferLike>>
يثلّث مستند تجميع ويكتبه كـ glTF ثنائي (GLB) مع الاحتفاظ بالتسلسل الهرمي والأسماء والألوان كعقد ومواد glTF.

meshDeflection و meshAngle يضبطان مدى دقة تثليث الأسطح المنحنية؛ mergeFaces يوصل أوجه الجزء في شبكة واحدة. الفشل يرمي خطأ.
Parameters
- inputs: ExportDocumentToGltfDto<TDocStdDocumentPointer>
  المستند وإعدادات التشبيك وأعلام التصدير واسم الملف وخيار التنزيل
Returns Promise<Uint8Array<ArrayBufferLike>>
ملف GLB كبايتات
Example
```
const glb = await bitbybit.occt.assembly.manager.exportDocumentToGltf({ document: doc, meshDeflection: 0.1, meshAngle: 0.5, internalVerticesMode: false, controlSurfaceDeflection: false, mergeFaces: false, forceUVExport: false, fileName: "assembly.glb", tryDownload: false });
```
- Defined in bitbybit-docs.d.ts:39743

exportDocumentToGltfWithDraco

exportDocumentToGltfWithDraco(
inputs: ExportDocumentToGltfWithDracoDto<TDocStdDocumentPointer>,
): Promise<Uint8Array<ArrayBufferLike>>
يكتب مستند تجميع كـ glTF ثنائي (GLB) مثل exportDocumentToGltf ويضغط الهندسة بـ Draco، مما يجعل الملف أصغر بكثير على حساب الحاجة إلى محمّل يدعم Draco.

تضبط إعدادات Draco مستوى الضغط وعدد البتات التي تحتفظ بها المواضع والنواظم وإحداثيات النسيج والألوان.
Parameters
- inputs: ExportDocumentToGltfWithDracoDto<TDocStdDocumentPointer>
  المستند وإعدادات التشبيك وأعلام التصدير وإعدادات Draco
Returns Promise<Uint8Array<ArrayBufferLike>>
ملف GLB كبايتات
Example
```
const options = new Bit.Inputs.OCCT.ExportDocumentToGltfWithDracoDto<Bit.Inputs.OCCT.TDocStdDocumentPointer>();
options.document = doc;
options.meshDeflection = 0.1;
options.dracoCompressionLevel = 7;
const glb = await bitbybit.occt.assembly.manager.exportDocumentToGltfWithDraco(options);
```
- Defined in bitbybit-docs.d.ts:39765

lifecycle

deleteDocument

deleteDocument(inputs: DocumentQueryDto<TDocStdDocumentPointer>): Promise<void>
يحذف مستند تجميع ويحرر الذاكرة التي يحملها.

يبقى المستند المبني بـ buildAssemblyDocument أو المحمّل بـ loadStepToDoc في الذاكرة حتى يُستدعى هذا، فاحذفه بعد قراءة أشكاله وتصديراته.
Parameters
- inputs: DocumentQueryDto<TDocStdDocumentPointer>
  المستند المراد حذفه
Returns Promise<void>
لا شيء؛ لا يعود مقبض المستند صالحا بعد ذلك
Example
```
const doc = await bitbybit.occt.assembly.manager.buildAssemblyDocument({ structure });
const glb = await bitbybit.occt.assembly.manager.exportDocumentToGltf({ document: doc, meshDeflection: 0.1, meshAngle: 0.5, internalVerticesMode: false, controlSurfaceDeflection: false, mergeFaces: false, forceUVExport: false, fileName: "assembly.glb", tryDownload: false });
await bitbybit.occt.assembly.manager.deleteDocument({ document: doc });
```
- Defined in bitbybit-docs.d.ts:39783

modify

setDocLabelColor

setDocLabelColor(
inputs: SetDocLabelColorDto<TDocStdDocumentPointer>,
): Promise<boolean>
يلوّن تسمية في مستند، جزءا أو نسخة أو تجميعا، بأحمر وأخضر وأزرق وألفا من 0 إلى 1.

يُحتفظ باللون عند تصدير المستند إلى STEP أو glTF.
Parameters
- inputs: SetDocLabelColorDto<TDocStdDocumentPointer>
  المستند والتسمية وقنوات اللون الأربع
Returns Promise<boolean>
true عندما يتم تعيين اللون
Example
```
const done = await bitbybit.occt.assembly.manager.setDocLabelColor({ document: doc, label: "0:1:1:1", r: 1, g: 0, b: 0, a: 1 });
```
- Defined in bitbybit-docs.d.ts:39696

setDocLabelName

setDocLabelName(
inputs: SetDocLabelNameDto<TDocStdDocumentPointer>,
): Promise<boolean>
يعيد تسمية تسمية في مستند، جزءا أو نسخة أو تجميعا.
Parameters
- inputs: SetDocLabelNameDto<TDocStdDocumentPointer>
  المستند والتسمية والاسم الجديد
Returns Promise<boolean>
true عندما يتم تعيين الاسم
Example
```
const done = await bitbybit.occt.assembly.manager.setDocLabelName({ document: doc, label: "0:1:1:1", name: "Left bracket" });
```
- Defined in bitbybit-docs.d.ts:39709

Class OCCTAssemblyManager

Index

Constructors

Methods

assembly

export

lifecycle

modify

Constructors

constructor

Returns OCCTAssemblyManager

Methods

createImportedPart

Parameters

Returns Promise<AssemblyLoadedPartDef>

Example

assembly

createPart

Parameters

Returns Promise<AssemblyPartDef<TopoDSShapePointer>>

Example

createAssemblyNode

Parameters

Returns Promise<AssemblyNodeDef>

Example

createInstanceNode

Parameters

Returns Promise<AssemblyNodeDef>

Example

createPartUpdate

Parameters

Returns Promise<AssemblyPartUpdateDef<TopoDSShapePointer>>

Example

combineStructure

Parameters

Returns Promise<AssemblyStructureDef<TopoDSShapePointer>>

Example

buildAssemblyDocument

Parameters

Returns Promise<TDocStdDocumentPointer>

Throws

Example

loadStepToDoc

Parameters

Returns Promise<TDocStdDocumentPointer>

Throws

Example

export

exportDocumentToStep

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

Example

exportDocumentToGltf

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

Example

exportDocumentToGltfWithDraco

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

Example

lifecycle

deleteDocument

Parameters

Returns Promise<void>

Example

modify

setDocLabelColor

Parameters

Returns Promise<boolean>

Example

setDocLabelName

Parameters

Returns Promise<boolean>

Example

Settings

On This Page