# 装配模块
# 模块名称： Assembly
# 特征信息： {'instanceId':'', 'entityId':0, 'id':0, 'name':''}
# 插入零件或装配
- 插入绘制的零件或装配实例
接口名称： insertComponent
输入参数：
| 参数名称 | 参数含义 | 类型 | 必须 | 参数值说明 |
|---|---|---|---|---|
| insertInstanceName | 特征的标识名 | 字符串 | 是 | 编辑状态时调用 |
| docName | 插入的文档名 | 字符串 | 是 | |
| position | 插入的位置 | 点Point | 是 | |
| matrix4 | 插入的矩阵位置 | 矩阵Matrix4 | 否 | 使用matrix4时，position值将被忽略 |
| boxCenter | 是否按照模型中心确定位置 | 整型 | 否 | 0 表示否 默认 1 表示是 |
| projectId | 文档所在项目id | 字符串 | 否 | 默认当前项目 |
返回值： 插入实例特征信息（KVObject）
- 插入二次开发新生成的实例
接口名称： insertComponentFromExecProgram
输入参数：
| 参数名称 | 参数含义 | 类型 | 必须 | 参数值说明 |
|---|---|---|---|---|
| insertInstanceName | 特征的标识名 | 字符串 | 是 | 编辑状态时调用 |
| programName | 插入的程序名 | 字符串 | 是 | |
| position | 插入的位置 | 点Point | 是 | |
| matrix4 | 插入的矩阵位置 | 矩阵Matrix4 | 否 | 使用matrix4时，position值将被忽略 |
| boxCenter | 是否按照模型中心确定位置 | 整型 | 否 | 0 表示否 默认 1 表示是 |
| arguments | 参数列表 | KVObject | 否 | 修改UI输入的值 |
返回值： 插入二次开发实例特征信息（KVObject）
- 插入参数化新生成的实例
接口名称： insertParametricPart
输入参数：
| 参数名称 | 参数含义 | 类型 | 必须 | 参数值说明 |
|---|---|---|---|---|
| insertInstanceName | 特征的标识名 | 字符串 | 是 | 编辑状态时调用 |
| templateName | 字符串 | |||
| position | 插入的位置 | 点Point | 是 | |
| matrix4 | 插入的矩阵位置 | 矩阵Matrix4 | 否 | 使用matrix4时，position值将被忽略 |
| boxCenter | 是否按照模型中心确定位置 | 整型 | 否 | 0 表示否 默认 1 表示是 |
| parameters | KVObj |
返回值： 插入参数化实例特征信息（KVObject）
# 替换实例
- 使用绘制的零件或装配替换实例
接口名称： replaceComponent
输入参数：
| 参数名称 | 参数含义 | 类型 | 必须 | 参数值说明 |
|---|---|---|---|---|
| instanceId | 被替换实例instanceId | 字符串 | 是 | |
| docName | 插入的文档名 | 字符串 | 是 | |
| position | 替换的文档名 | 字符串 | 是 | |
| projectId | 文档所在项目id | 字符串 | 否 | 默认当前项目 |
返回值： NULL
- 使用二次开发新生成的实例替换实例
接口名称： replaceComponentFromExecProgram
输入参数：
| 参数名称 | 参数含义 | 类型 | 必须 | 参数值说明 |
|---|---|---|---|---|
| instanceId | 被替换实例instanceId | 字符串 | 是 | |
| programName | 替换的程序名 | 字符串 | 是 | |
| arguments | 参数列表 | KVObject | 否 | 修改UI界面输入的值 |
返回值： NULL
# 配合
接口名称： createMating
输入参数：
| 参数名称 | 参数含义 | 类型 | 必须 | 参数值说明 |
|---|---|---|---|---|
| insertInstanceName | 特征的标识名 | 字符串 | 是 | 编辑状态时调用 |
| moveInstanceId | 移动实例instanceId | 字符串 | 是 | |
| moveElementId | 移动元素id | 整型 | 是 | |
| refInstanceId | 参考实例instanceId | 字符串 | 是 | |
| refElementId | 参考元素id | 整型 | 是 | |
| matingType | 配合类型 | 整型 | 是 | 0 表示重合 1 表示平行 2 表示相切 3 表示同轴心 7 表示垂直 11 表示距离 12 表示角度 |
| alignType | 对齐类型 | 整型 | 否 | |
| offsetValue | 偏移值 | 浮点型 | 否 |
返回值： 配合特征信息（KVObject）
# 阵列
- 线性阵列
接口名称： linearPattern
输入参数：
| 参数名称 | 参数含义 | 类型 | 必须 | 参数值说明 |
|---|---|---|---|---|
| linearPatternName | 特征的标识名 | 字符串 | 是 | 编辑状态时调用 |
| component | 实例instanceId | 字符串 | 是 | 只能拾取1个 |
| direction1 | 方向1 | 方向Direction | 是 | |
| spacing1 | 距离1 | 浮点型 | 是 | |
| instanceNum1 | 实例数1 | 整型 | 是 | |
| reverse1 | 反向1 | 整型 | 否 | 0 表示不反向 默认 1 表示反向 |
| hasDirection2 | 是否有方向2 | 整型 | 否 | 0 不勾选 1 勾选 |
| direction2 | 方向2 | 方向Direction | 否 | |
| spacing2 | 距离2 | 浮点型 | 否 | |
| instanceNum2 | 实例数2 | 整型 | 否 | |
| reverse2 | 反向2 | 整型 | 否 | 0 不勾选 1 勾选 |
| patternSeed | 只阵列源 | 整型 | 否 | 仅在第二方向存在时需要 |
| skipInstance | 跳过实例 | 整型 | 否 | 0 不勾选 1 勾选 |
| instancesToSkip | 跳过的实例 | 字符串 list | 否 | 仅在skipInstance为1时需要, 示例 ['(2,1)'] |
返回值： 线性阵列特征信息（KVObject）
- 圆周阵列
接口名称： circularPattern
输入参数：
| 参数名称 | 参数含义 | 类型 | 必须 | 参数值说明 |
|---|---|---|---|---|
| circularPatternName | 特征的标识名 | 字符串 | 是 | 编辑状态时调用 |
| component | 实例instanceId | 字符串 | 是 | 只能拾取1个 |
| axis | 阵列中心轴 | 轴 Axis | 是 | |
| reverse | 反向 | 整型 | 否 | 0 表示不反向 默认 1 表示反向 |
| angle1 | 角度1 | 浮点型 | 是 | |
| instanceNum1 | 实例数1 | 整型 | 是 | |
| equalSpacing1 | 相等间距1 | 整型 | 否 | 0 不勾选 1 勾选 默认 |
| symmetric | 两侧对称 | 整型 | 否 | 对称时没有第二方向 |
| hasDirection2 | 方向2 | 整型 | 否 | 0 不勾选 默认 1 勾选 |
| angle2 | 角度2 | 浮点型 | 否 | |
| instanceNum2 | 实例数2 | 整型 | 否 | |
| equalSpacing2 | 相等间距2 | 整型 | 否 | 0 不勾选 默认 1 勾选 |
| skipInstance | 跳过实例 | 整型 | 否 | 0 不勾选 默认 1 勾选 |
| instancesToSkip | 跳过的实例 | 字符串 list | 否 | 仅在skipInstance为1时需要, 示例 ['(2,1)'] |
返回值： 圆周阵列特征信息（KVObject）
- 曲线阵列
接口名称： curvePattern
输入参数：
| 参数名称 | 参数含义 | 类型 | 必须 | 参数值说明 |
|---|---|---|---|---|
| curvePatternName | 特征的标识名 | 字符串 | 是 | 编辑状态时调用 |
| component | 实例instanceId | 字符串 | 是 | 只能拾取1个 |
| curves | 曲线Id | 整型list | 是 | 可以选取多个连续的曲线 |
| curveInstances | 曲线所在的实例id | 整型list | 是 | 需要与曲线id一一对应 |
| spacing | 距离1 | 浮点型 | 是 | |
| instanceNum | 实例数1 | 整型 | 是 | |
| reverse | 反向1 | 整型 | 否 | 0 表示不反向 默认 1 表示反向 |
| curveMethod | 曲线方法 | 整型 | 否 | 0 转换曲线 默认 1 等距曲线 |
| alignmentMethod | 对齐方式 | 整型 | 否 | 0 与曲线相切 默认 1 对齐到源 |
| skipInstance | 跳过实例 | 整型 | 否 | 0 不勾选 1 勾选 |
| instancesToSkip | 跳过的实例 | 字符串 list | 否 | 仅在skipInstance为1时需要, 示例 ['(2,1)'] |
返回值： 曲线阵列特征信息（KVObject）
# 阵列驱动阵列
接口名称： patternDrivePattern
输入参数：
| 参数名称 | 参数含义 | 类型 | 必须 | 参数值说明 |
|---|---|---|---|---|
| drivePatternName | 特征的标识名 | 字符串 | 是 | 编辑状态时调用 |
| instanceId | 实例instanceId | 字符串 List | 是 | |
| driveFeatureId | 驱动阵列的特征featureId | 整型 | 否 | |
| driveInstance | 驱动阵列的实例instanceId | 字符串 | 否 | |
| skipInstance | 是否跳过实例 | 整型 | 是 | 0 不跳过 默认 1 跳过 |
| instanceToSkip | 跳过实例的数组 | 整型 List | 否 | |
| modOriPosition | 是否修改源位置 | 整型 | 是 | 0 不修改 默认 1 修改 |
| orgPositionInsId | 源实例位置Id | 字符串 | 否 |
返回值： 阵列驱动阵列特征信息（KVObject）
# 固定/活动实例
接口名称： fixInstance
输入参数：
| 参数名称 | 参数含义 | 类型 | 必须 | 参数值说明 |
|---|---|---|---|---|
| instanceId | 实例instanceId | 字符串 | 是 | 编辑状态时调用 |
| status | 固定/活动标识 | 整型 | 是 | 0 表示活动 1 表示固定 |
返回值： NULL
# 移动零部件
接口名称： moveInstance
输入参数：
| 参数名称 | 参数含义 | 类型 | 必须 | 参数值说明 |
|---|---|---|---|---|
| instanceId | 实例instanceId | 字符串 | 是 | |
| startPos | 移动的起点 | 点 Point | 否 | |
| endPos | 移动的终点 | 点 Point | 否 | |
| moveType | 移动零部件的方式 | 整型 | 是 | 0 自由拖动 1 沿装配体XYZ 2 沿实体 3 到XYZ位置 4 XYZ变量 |
| checkType | 是否动态干涉检查 | 整型 | 是 | 0：否 默认 1：是 |
| moveDir | 移动方向 | 方向 Direction | 否 | |
| varX | 移动距离的X变量 | 浮点型 | 否 | |
| varY | 移动距离的Y变量 | 浮点型 | 否 | |
| varZ | 移动距离的Z变量 | 浮点型 | 否 | |
| checkRange | 检查范围的零件数组 | 整型 List | 否 | 默认全部零部件 |
返回值： NULL
# 旋转零部件
接口名称： rotateInstance
输入参数：
| 参数名称 | 参数含义 | 类型 | 必须 | 参数值说明 |
|---|---|---|---|---|
| instanceId | 实例instanceId数组 | 字符串 List | 是 | |
| rotateType | 旋转方式 | 整型 | 是 | 0 自由拖动 1 沿实体 2 XYZ变量 |
| checkType | 是否动态干涉检查 | 整型 | 是 | 0 否 1 是 |
| axialDir | 拖拽方向向量 | 点 Point | 否 | |
| rotateAxis | 旋转轴 | 轴 Axis | 否 | |
| angleVal | 拖拽角度 | 浮点型 | 否 | |
| angleValX | X旋转角度 | 浮点型 | 否 | |
| angleValY | Y 旋转角度 | 浮点型 | 否 | |
| angleValZ | Z 旋转角度 | 浮点型 | 否 | |
| checkRange | 检查范围的零件数组 | 整型 List | 否 | 默认全部零部件 |
返回值： NULL
# 镜像
接口名称： mirrorInstance
输入参数：
| 参数名称 | 参数含义 | 类型 | 必须 | 参数值说明 |
|---|---|---|---|---|
| instanceId | 实例instanceId数组 | 字符串 List | 是 | 编辑状态时调用 |
| mirrorPlaneInstanceId | 镜像面所在的实体entityId | 整型 | 是 | 仅镜像面在实体上时填写 |
| mirrorPlaneId | 镜像面id | 整型 | 是 |
返回值： NULL