Class OCCTAssemblyQuery

读取装配文档：它容纳的零件和子装配、标签背后的形状、标签的颜色、位置和详情，以及以树表示的完整层级。标签是文档赋予每个零件、实例和装配的 id，例如 0:1:1:1；getDocumentParts 和 getAssemblyHierarchy 列出它们，其他方法接受一个标签。任何查询都不会更改文档本身。

Index

Constructors

constructor

query

getDocumentParts getShapeFromLabel getLabelColor getLabelTransform getLabelInfo getAssemblyHierarchy

Constructors

constructor

new OCCTAssemblyQuery(): OCCTAssemblyQuery
Returns OCCTAssemblyQuery

query

getDocumentParts

getDocumentParts(
inputs: DocumentQueryDto<TDocStdDocumentPointer>,
): Promise<DocumentPartInfo[]>
列出文档中的每个零件和子装配体及其标签、名称、类型、颜色和被放置的次数。

这些标签正是其他查询方法和标签设置方法所接受的。
Parameters
- inputs: DocumentQueryDto<TDocStdDocumentPointer>
  文档
Returns Promise<DocumentPartInfo[]>
每个零件或装配一个条目
Example
```
const parts = await bitbybit.occt.assembly.query.getDocumentParts({ document: doc });
parts.forEach(part => console.log(part.name, part.type, part.label));
```
- Defined in bitbybit-docs.d.ts:39810

getShapeFromLabel

getShapeFromLabel(
inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>,
): Promise<TopoDSShapePointer>
读取存储在文档某个标签下的形状，例如用于绘制一个零件或对其运行操作。
Parameters
- inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>
  文档和标签
Returns Promise<TopoDSShapePointer>
该标签处的形状
Example
```
const shape = await bitbybit.occt.assembly.query.getShapeFromLabel({ document: doc, label: "0:1:1:1" });
```
- Defined in bitbybit-docs.d.ts:39824

getLabelColor

getLabelColor(
inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>,
): Promise<LabelColorInfo>
读取分配给文档某个标签的颜色，以 0 到 1 的红、绿、蓝和透明度表示，并附带一个表示该标签是否有颜色的标志。
Parameters
- inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>
  文档和标签
Returns Promise<LabelColorInfo>
颜色及其 hasColor 标志
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);
```
- Defined in bitbybit-docs.d.ts:39839

getLabelTransform

getLabelTransform(
inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>,
): Promise<LabelTransformInfo>
读取文档中实例标签的放置信息，以列主序矩阵加上其平移、旋转四元数和均匀缩放的形式给出。

零件标签（与实例相对）本身不携带放置信息。
Parameters
- inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>
  文档和标签
Returns Promise<LabelTransformInfo>
矩阵、平移、四元数和缩放
Example
```
const placement = await bitbybit.occt.assembly.query.getLabelTransform({ document: doc, label: "0:1:1:1" });
console.log(placement.translation);
```
- Defined in bitbybit-docs.d.ts:39856

getLabelInfo

getLabelInfo(
inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>,
): Promise<LabelInfo>
描述文档的一个标签：其名称、类型，以及它是简单形状、装配体、对另一个标签的引用还是其组件。
Parameters
- inputs: DocumentLabelQueryDto<TDocStdDocumentPointer>
  文档和标签
Returns Promise<LabelInfo>
标签的名称、类型和标志
Example
```
const info = await bitbybit.occt.assembly.query.getLabelInfo({ document: doc, label: "0:1:1:1" });
console.log(info.name, info.isAssembly);
```
- Defined in bitbybit-docs.d.ts:39871

getAssemblyHierarchy

getAssemblyHierarchy(
inputs: DocumentQueryDto<TDocStdDocumentPointer>,
): Promise<AssemblyHierarchyResult>
以带父节点的节点平坦列表读取文档的整棵装配体树，以便遍历或以树形显示。

每个节点携带其标签、名称、类型和放置信息；列表按深度优先顺序排列，因此子节点紧随其父节点。未命名的实例以其放置的对象命名，重复时加上编号；definitionName 保存该名称。
Parameters
- inputs: DocumentQueryDto<TDocStdDocumentPointer>
  文档
Returns Promise<AssemblyHierarchyResult>
树的节点及其数量和格式版本
Example
```
const tree = await bitbybit.occt.assembly.query.getAssemblyHierarchy({ document: doc });
console.log(tree.totalNodes, tree.nodes.map(n => n.name));
```
- Defined in bitbybit-docs.d.ts:39890

Class OCCTAssemblyQuery

Index

Constructors

query

Constructors

constructor

Returns OCCTAssemblyQuery

query

getDocumentParts

Parameters

Returns Promise<DocumentPartInfo[]>

Example

getShapeFromLabel

Parameters

Returns Promise<TopoDSShapePointer>

Example

getLabelColor

Parameters

Returns Promise<LabelColorInfo>

Example

getLabelTransform

Parameters

Returns Promise<LabelTransformInfo>

Example

getLabelInfo

Parameters

Returns Promise<LabelInfo>

Example

getAssemblyHierarchy

Parameters

Returns Promise<AssemblyHierarchyResult>

Example

Settings

On This Page