Klasse OCCTAssemblyQuery

Lesen eines Baugruppendokuments: die Teile und Unterbaugruppen, die es enthält, die Form hinter einem Label, Farbe, Platzierung und Details eines Labels und die ganze Hierarchie als Baum. Labels sind die Ids, die das Dokument jedem Teil, jeder Instanz und jeder Baugruppe gibt, etwa 0:1:1:1; getDocumentParts und getAssemblyHierarchy listen sie auf, die anderen Methoden nehmen eines entgegen. Das Dokument selbst wird durch keine Abfrage geändert.

Index

Konstruktoren

constructor

query

getDocumentParts getShapeFromLabel getLabelColor getLabelTransform getLabelInfo getAssemblyHierarchy

Konstruktoren

constructor

new OCCTAssemblyQuery(): OCCTAssemblyQuery
Rückgabewert OCCTAssemblyQuery

query

getDocumentParts

getDocumentParts(
inputs: DocumentQueryDto<TDocStdDocumentPointer>,
): Promise<DocumentPartInfo[]>
Listet jedes Teil und jede Unterbaugruppe in einem Dokument mit Label, Name, Typ, Farbe und der Anzahl seiner Platzierungen auf.

Die Labels sind das, was die anderen Abfragemethoden und die Label-Setter nehmen.
Parameter
- inputs: DocumentQueryDto<TDocStdDocumentPointer>
  Das Dokument
Rückgabewert Promise<DocumentPartInfo[]>
Ein Eintrag pro Teil oder Baugruppe
Example
```
const parts = await bitbybit.occt.assembly.query.getDocumentParts({ document: doc });
parts.forEach(part => console.log(part.name, part.type, part.label));
```
- Definiert in bitbybit-docs.d.ts:39810

getShapeFromLabel

getShapeFromLabel(
inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>,
): Promise<TopoDSShapePointer>
Liest die unter einem Label eines Dokuments gespeicherte Form, zum Beispiel um ein Teil zu zeichnen oder eine Operation darauf auszuführen.
Parameter
- inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>
  Das Dokument und das Label
Rückgabewert Promise<TopoDSShapePointer>
Die Form an diesem Label
Example
```
const shape = await bitbybit.occt.assembly.query.getShapeFromLabel({ document: doc, label: "0:1:1:1" });
```
- Definiert in bitbybit-docs.d.ts:39824

getLabelColor

getLabelColor(
inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>,
): Promise<LabelColorInfo>
Liest die einem Label eines Dokuments zugewiesene Farbe, als Rot, Grün, Blau und Alpha von 0 bis 1, zusammen mit einem Flag, das sagt, ob das Label überhaupt eine Farbe hat.
Parameter
- inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>
  Das Dokument und das Label
Rückgabewert Promise<LabelColorInfo>
Die Farbe mit ihrem hasColor-Flag
Example
```
const color = await bitbybit.occt.assembly.query.getLabelColor({ document: doc, label: "0:1:1:1" });
if (color.hasColor) console.log(color.r, color.g, color.b);
```
- Definiert in bitbybit-docs.d.ts:39839

getLabelTransform

getLabelTransform(
inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>,
): Promise<LabelTransformInfo>
Liest die Platzierung eines Instanz-Labels in einem Dokument als spaltenweise gespeicherte Matrix plus seine Verschiebung, sein Rotationsquaternion und seine gleichmäßige Skalierung.

Ein Teil-Label, im Gegensatz zu einer Instanz, trägt keine eigene Platzierung.
Parameter
- inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>
  Das Dokument und das Label
Rückgabewert Promise<LabelTransformInfo>
Die Matrix, die Verschiebung, das Quaternion und die Skalierung
Example
```
const placement = await bitbybit.occt.assembly.query.getLabelTransform({ document: doc, label: "0:1:1:1" });
console.log(placement.translation);
```
- Definiert in bitbybit-docs.d.ts:39856

getLabelInfo

getLabelInfo(
inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>,
): Promise<LabelInfo>
Beschreibt ein Label eines Dokuments: seinen Namen, seinen Typ und ob es eine einfache Form, eine Baugruppe, eine Referenz auf ein anderes Label oder eine Komponente von einem ist.
Parameter
- inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>
  Das Dokument und das Label
Rückgabewert Promise<LabelInfo>
Name, Typ und Flags des Labels
Example
```
const info = await bitbybit.occt.assembly.query.getLabelInfo({ document: doc, label: "0:1:1:1" });
console.log(info.name, info.isAssembly);
```
- Definiert in bitbybit-docs.d.ts:39871

getAssemblyHierarchy

getAssemblyHierarchy(
inputs: DocumentQueryDto<TDocStdDocumentPointer>,
): Promise<AssemblyHierarchyResult>
Liest den ganzen Baugruppenbaum eines Dokuments als flache Liste von Knoten mit ihren Eltern, sodass er durchlaufen oder als Baum angezeigt werden kann.

Jeder Knoten trägt sein Label, seinen Namen, seinen Typ und seine Platzierung; die Liste ist in Tiefensuchreihenfolge, sodass Kinder ihrem Elternteil folgen. Eine unbenannte Instanz wird nach dem benannt, was sie platziert, nummeriert bei Wiederholung; definitionName hält diesen Namen.
Parameter
- inputs: DocumentQueryDto<TDocStdDocumentPointer>
  Das Dokument
Rückgabewert Promise<AssemblyHierarchyResult>
Die Knoten des Baums mit ihrer Anzahl und der Formatversion
Example
```
const tree = await bitbybit.occt.assembly.query.getAssemblyHierarchy({ document: doc });
console.log(tree.totalNodes, tree.nodes.map(n => n.name));
```
- Definiert in bitbybit-docs.d.ts:39890

Klasse OCCTAssemblyQuery

Index

Konstruktoren

query

Konstruktoren

constructor

Rückgabewert OCCTAssemblyQuery

query

getDocumentParts

Parameter

Rückgabewert Promise<DocumentPartInfo[]>

Example

getShapeFromLabel

Parameter

Rückgabewert Promise<TopoDSShapePointer>

Example

getLabelColor

Parameter

Rückgabewert Promise<LabelColorInfo>

Example

getLabelTransform

Parameter

Rückgabewert Promise<LabelTransformInfo>

Example

getLabelInfo

Parameter

Rückgabewert Promise<LabelInfo>

Example

getAssemblyHierarchy

Parameter

Rückgabewert Promise<AssemblyHierarchyResult>

Example

Einstellungen

Auf dieser Seite