工具文档
共 183 个 CATIA V5 工具(PLM 工具另计)
目前AI可以落地的,帮助工程师完成一些自动化和批量化的任务,例如实例化超级副本等模板,导出工程数据,数据的输入输出
在生成设计图纸这一项中,自动创建工程图框,插入2D部件,一些固定化的标注和注释生成,可以做一些批量的标注属性修改,
因为接口限制,虽然有很多不完善的地方,是经过日积月累,会为我们的工作带来很大的便利性
capture_cat_view
用 CATIA 原生 API 截取当前活动视图(仅 CATIA 窗口内容)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
output_path | string | — | 默认 catia_view.jpg |
image_format | string | — | 默认 jpeg |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
capture_screen
截取当前屏幕并保存为图片。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
output_path | string | — | 默认 screenshot.png |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
catia_connect
连接 CATIA V5 应用程序。如果 CATIA 已在运行,连接到当前实例;否则启动新的 CATIA 实例。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
catia_status
检查当前 CATIA 连接状态。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
new_part
新建一个 CATPart 文档。 Args: part_name: Part 的名称(默认: "Part")
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
part_name | string | — | 默认 Part |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
new_part_timestamp
以当前时间作为名称新建一个 CATPart 文档。 零件名称格式: YYYYMMDD_HHMMSS(无空格)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
print_selected_object_type
打印 CATIA 当前选中对象的类型 (TypeName)、名称、选择类型及 LeafProduct。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
save_current_document
保存当前活动文档。 Args: file_path: 完整保存路径(如 "D:/models/my_part.CATPart")
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
file_path | string | 必填 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
screen_capture
截取屏幕并保存到指定路径。依赖第三方库 PIL.ImageGrab。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
output_path | string | — | 默认 screen_capture.png |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
screen_capture_send_once
截取电脑屏幕并将截图作为邮件附件发送到指定邮箱。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sender | string | — | 默认 |
auth_code | string | — | 默认 |
receivers | string | — | |
subject | string | — | 默认 屏幕监控截图 |
body | string | — | 默认 这是自动截取的电脑屏幕截图,请注意查收。 |
output | string | — | 默认 screen_capture.png |
smtp_host | string | — | 默认 smtp.126.com |
smtp_port | number | — | 默认 465 |
loop | boolean | — | 默认 False |
interval | number | — | 默认 5 |
capture_only | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
screen_send_email_with_screenshot
发送包含截图附件的邮件。依赖第三方库 PIL 与标准库 smtplib/email。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sender | string | 必填 | |
auth_code | string | 必填 | |
receivers | array | 必填 | |
screenshot_path | string | 必填 | |
subject | string | — | 默认 屏幕监控截图 |
body | string | — | 默认 这是自动截取的电脑屏幕截图,请注意查收。 |
sender_name | string | — | 默认 屏幕监控脚本 |
smtp_host | string | — | 默认 smtp.126.com |
smtp_port | number | — | 默认 465 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_circle
在活动 Part 中创建圆形曲线 (GSD 线框)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
center_x | number | — | 默认 0.0 |
center_y | number | — | 默认 0.0 |
center_z | number | — | 默认 0.0 |
radius | number | — | 默认 50.0 |
support_plane | string | — | 默认 XY |
geometrical_set | string | — | 默认 Circles |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_cylinder_surface
在活动 Part 中创建圆柱曲面 (GSD 模块)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
center_x | number | — | 默认 0.0 |
center_y | number | — | 默认 0.0 |
center_z | number | — | 默认 0.0 |
direction | string | — | 默认 Z |
radius | number | — | 默认 30.0 |
height | number | — | 默认 100.0 |
geometrical_set | string | — | 默认 Cylinder Surface |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_extract_surface
创建提取 (提取子几何元素)。请先在 CATIA 中选择要提取的元素,再调用此工具。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
geometrical_set | string | — | 默认 Extracts |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_fill
创建填充曲面。请先在 CATIA 中选择构成边界的曲线,再调用此工具。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
geometrical_set | string | — | 默认 Fill Surface |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_geometrical_sets
批量创建几何图形集 (Geometrical Sets)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
count | number | — | 默认 20 |
name_prefix | string | — | 默认 几何图形集 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_gsd_line
在活动 Part 中创建两点直线 (GSD 线框)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
start_x | number | — | 默认 0.0 |
start_y | number | — | 默认 0.0 |
start_z | number | — | 默认 0.0 |
end_x | number | — | 默认 100.0 |
end_y | number | — | 默认 0.0 |
end_z | number | — | 默认 0.0 |
geometrical_set | string | — | 默认 Lines |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_intersection_curve
创建相交曲线。请先在 CATIA 中选择两个相交元素,再调用此工具。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
geometrical_set | string | — | 默认 Intersections |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_join_elements
接合多个曲面或曲线。请先在 CATIA 中选择要接合的元素,再调用此工具。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
geometrical_set | string | — | 默认 Joined |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_loft
创建放样曲面。请先在 CATIA 中选择至少 2 条截面曲线,再调用此工具。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
geometrical_set | string | — | 默认 Loft Surface |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_offset_plane
创建偏移平面。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
reference | string | — | 默认 XY |
offset | number | — | 默认 10.0 |
geometrical_set | string | — | 默认 Planes |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_point
在活动 Part 中按坐标创建一个点。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
x | number | — | 默认 0.0 |
y | number | — | 默认 0.0 |
z | number | — | 默认 0.0 |
geometrical_set | string | — | 默认 Points |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_projection_curve
创建投影曲线。请先在 CATIA 中依次选择: 1) 要投影的元素, 2) 支撑面。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
projection_type | number | — | 默认 0 |
geometrical_set | string | — | 默认 Projections |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_sphere_surface
在活动 Part 中创建球体曲面 (GSD 模块)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
center_x | number | — | 默认 0.0 |
center_y | number | — | 默认 0.0 |
center_z | number | — | 默认 0.0 |
radius | number | — | 默认 50.0 |
geometrical_set | string | — | 默认 Sphere Surface |
v_start_angle | number | — | 默认 -90.0 |
v_end_angle | number | — | 默认 90.0 |
h_start_angle | number | — | 默认 0.0 |
h_end_angle | number | — | 默认 360.0 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_spotweld_normals
遍历几何图形集中的所有点,对能法向投影到曲面的点创建曲面法线并基于法线创建轴系(Z 轴沿法线)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
surface_name | string | — | 默认 Final Surface - LH Part |
geometrical_set | string | — | 默认 Spotwelds |
normal_length | number | — | 默认 100.0 |
normal_orientation | boolean | — | 默认 True |
output_set | string | — | 默认 Spotweld Axis Systems |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_surface_offset_tool
创建偏移曲面。请先在 CATIA 中选择要偏移的曲面,再调用此工具。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
offset | number | — | 默认 10.0 |
geometrical_set | string | — | 默认 Offsets |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_sweep
创建显式扫掠曲面。请先在 CATIA 中依次选择: 1) 轮廓, 2) 引导线。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
geometrical_set | string | — | 默认 Swept Surface |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_trim_surface
创建修剪曲面。请先在 CATIA 中选择 2 个要相互修剪的元素,再调用此工具。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
geometrical_set | string | — | 默认 Trims |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
extract_faces_with_color
遍历当前活动 Part 的所有 Body,提取每个 Body 中的面并换色、计算面积。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
geometrical_set | string | — | 默认 Extracted Faces |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_boundary
创建曲面边界 (AddNewBoundaryOfSurface)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
surface | string | 必填 | |
body_name | string | — | 默认 GSM_SURFACES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_extrude
创建拉伸曲面 (AddNewExtrude)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
profile | string | 必填 | |
length | number | — | 默认 50.0 |
dx | number | — | 默认 0.0 |
dy | number | — | 默认 0.0 |
dz | number | — | 默认 1.0 |
body_name | string | — | 默认 GSM_SURFACES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_inverse
创建反向元素 (AddNewInverse)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
element | string | 必填 | |
body_name | string | — | 默认 GSM_SURFACES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_line_angle
在曲面上按角度创建直线 (AddNewLineAngle)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
curve | string | 必填 | |
surface | string | 必填 | |
point | string | 必填 | |
angle | number | 必填 | |
length | number | — | 默认 50.0 |
reverse | boolean | — | 默认 False |
body_name | string | — | 默认 GSM_LINES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_line_bisecting
创建两条直线的角平分线 (AddNewLineBisecting)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
line1 | string | 必填 | |
line2 | string | 必填 | |
length | number | — | 默认 50.0 |
solution | number | — | 默认 1 |
reverse | boolean | — | 默认 False |
body_name | string | — | 默认 GSM_LINES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_line_bisecting_with_point
创建与两条线角平分且通过指定点的直线 (AddNewLineBisectingWithPoint)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
line1 | string | 必填 | |
line2 | string | 必填 | |
point | string | 必填 | |
length | number | — | 默认 50.0 |
solution | number | — | 默认 1 |
reverse | boolean | — | 默认 False |
body_name | string | — | 默认 GSM_LINES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_line_datum
将源线元素转换为 Datum 直线 (AddNewLineDatum)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
source_name | string | 必填 | |
body_name | string | — | 默认 GSM_LINES |
datum_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_line_normal
创建曲面法线 (AddNewLineNormal)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
surface | string | 必填 | |
point | string | 必填 | |
length | number | — | 默认 50.0 |
reverse | boolean | — | 默认 False |
body_name | string | — | 默认 GSM_LINES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_line_pt_dir
从点按方向创建直线 (AddNewLinePtDir)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
point | string | 必填 | |
length | number | 必填 | |
dir_x | number | — | 默认 1.0 |
dir_y | number | — | 默认 0.0 |
dir_z | number | — | 默认 0.0 |
reverse | boolean | — | 默认 False |
body_name | string | — | 默认 GSM_LINES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_line_pt_pt_extended
由两点创建可延伸直线 (AddNewLinePtPtExtended)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
pt1 | string | 必填 | |
pt2 | string | 必填 | |
begin_offset | number | — | 默认 0.0 |
end_offset | number | — | 默认 0.0 |
body_name | string | — | 默认 GSM_LINES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_line_pt_pt_on_support
在支撑曲面上由两点创建直线 (AddNewLinePtPtOnSupport)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
pt1 | string | 必填 | |
pt2 | string | 必填 | |
support | string | 必填 | |
body_name | string | — | 默认 GSM_LINES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_line_tangency
创建曲线切线 (AddNewLineTangency)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
curve | string | 必填 | |
point | string | 必填 | |
length | number | — | 默认 50.0 |
reverse | boolean | — | 默认 False |
body_name | string | — | 默认 GSM_LINES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_loft
创建多截面放样曲面 (AddNewLoft)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
section_names | string | 必填 | |
body_name | string | — | 默认 GSM_SURFACES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_offset
创建偏移曲面 (AddNewOffset)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
surface | string | 必填 | |
offset | number | — | 默认 10.0 |
body_name | string | — | 默认 GSM_SURFACES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_plane_1_curve
通过平面曲线创建平面 (AddNewPlane1Curve)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
curve | string | 必填 | |
body_name | string | — | 默认 GSM_PLANES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_plane_1_line_1_pt
通过一条直线和一个点创建平面 (AddNewPlane1Line1Pt)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
line | string | 必填 | |
point | string | 必填 | |
body_name | string | — | 默认 GSM_PLANES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_plane_2_lines
通过两条平行直线创建平面 (AddNewPlane2Lines)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
line1 | string | 必填 | |
line2 | string | 必填 | |
body_name | string | — | 默认 GSM_PLANES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_plane_angle
绕轴旋转参考平面创建平面 (AddNewPlaneAngle)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
plane | string | 必填 | |
axis | string | 必填 | |
angle | number | 必填 | |
reverse | boolean | — | 默认 False |
body_name | string | — | 默认 GSM_PLANES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_plane_between
创建两平面之间的中间平面 (AddNewPlaneBetween)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
plane1 | string | 必填 | |
plane2 | string | 必填 | |
ratio | number | — | 默认 0.5 |
body_name | string | — | 默认 GSM_PLANES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_plane_datum
将源面元素转换为 Datum 平面 (AddNewPlaneDatum)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
source_name | string | 必填 | |
body_name | string | — | 默认 GSM_PLANES |
datum_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_plane_equation
通过方程 Ax+By+Cz=D 创建平面 (AddNewPlaneEquation)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
a | number | 必填 | |
b | number | 必填 | |
c | number | 必填 | |
d | number | 必填 | |
body_name | string | — | 默认 GSM_PLANES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_plane_mean
通过多点平均创建拟合平面 (AddNewPlaneMean)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
point_names | string | 必填 | |
body_name | string | — | 默认 GSM_PLANES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_plane_offset
创建偏移平面 (AddNewPlaneOffset)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
plane | string | 必填 | |
offset | number | 必填 | |
reverse | boolean | — | 默认 False |
body_name | string | — | 默认 GSM_PLANES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_plane_offset_pt
通过经过点偏移创建平面 (AddNewPlaneOffsetPt)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
plane | string | 必填 | |
point | string | 必填 | |
body_name | string | — | 默认 GSM_PLANES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_plane_tangent
在曲面的指定点处创建切平面 (AddNewPlaneTangent)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
surface | string | 必填 | |
point | string | 必填 | |
body_name | string | — | 默认 GSM_PLANES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_point_between
创建两点之间的比例点 (AddNewPointBetween)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
pt1 | string | 必填 | |
pt2 | string | 必填 | |
ratio | number | — | 默认 0.5 |
body_name | string | — | 默认 GSM_POINTS |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_point_center
创建圆/圆弧的中心点 (AddNewPointCenter)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
curve | string | 必填 | |
body_name | string | — | 默认 GSM_POINTS |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_point_coord_with_reference
基于参考点创建带偏移坐标的点 (AddNewPointCoordWithReference)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
x | number | 必填 | |
y | number | 必填 | |
z | number | 必填 | |
ref | string | 必填 | |
body_name | string | — | 默认 GSM_POINTS |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_point_datum
将源点元素转换为 Datum 点 (AddNewPointDatum)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
source_name | string | 必填 | |
body_name | string | — | 默认 GSM_POINTS |
datum_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_point_on_curve_from_distance
在曲线上按距离创建点 (AddNewPointOnCurveFromDistance)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
curve | string | 必填 | |
distance | number | 必填 | |
reverse | boolean | — | 默认 False |
body_name | string | — | 默认 GSM_POINTS |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_point_on_curve_ref_distance
在曲线上基于参考点按距离创建点 (AddNewPointOnCurveWithReferenceFromDistance)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
curve | string | 必填 | |
ref | string | 必填 | |
distance | number | 必填 | |
reverse | boolean | — | 默认 False |
body_name | string | — | 默认 GSM_POINTS |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_point_on_curve_ref_percent
在曲线上基于参考点按百分比创建点 (AddNewPointOnCurveWithReferenceFromPercent)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
curve | string | 必填 | |
ref | string | 必填 | |
ratio | number | 必填 | |
reverse | boolean | — | 默认 False |
body_name | string | — | 默认 GSM_POINTS |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_point_on_plane
在平面上按坐标创建点 (AddNewPointOnPlane)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
plane | string | 必填 | |
x | number | 必填 | |
y | number | 必填 | |
body_name | string | — | 默认 GSM_POINTS |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_point_on_plane_with_reference
在平面上基于参考点按坐标创建点 (AddNewPointOnPlaneWithReference)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
plane | string | 必填 | |
ref | string | 必填 | |
x | number | 必填 | |
y | number | 必填 | |
body_name | string | — | 默认 GSM_POINTS |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_point_on_surface
在曲面上按距离创建点 (AddNewPointOnSurface)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
surface | string | 必填 | |
distance | number | 必填 | |
dir_x | number | — | 默认 1.0 |
dir_y | number | — | 默认 0.0 |
dir_z | number | — | 默认 0.0 |
body_name | string | — | 默认 GSM_POINTS |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_point_on_surface_with_reference
在曲面上基于参考点按距离创建点 (AddNewPointOnSurfaceWithReference)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
surface | string | 必填 | |
ref | string | 必填 | |
distance | number | 必填 | |
dir_x | number | — | 默认 1.0 |
dir_y | number | — | 默认 0.0 |
dir_z | number | — | 默认 0.0 |
body_name | string | — | 默认 GSM_POINTS |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_point_tangent
在曲线上按方向创建切点 (AddNewPointTangent)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
curve | string | 必填 | |
dir_x | number | — | 默认 0.0 |
dir_y | number | — | 默认 0.0 |
dir_z | number | — | 默认 1.0 |
body_name | string | — | 默认 GSM_POINTS |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_project
创建投影 (AddNewProject)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
element | string | 必填 | |
support | string | 必填 | |
body_name | string | — | 默认 GSM_SURFACES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_revol
创建旋转曲面 (AddNewRevol)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
profile | string | 必填 | |
axis | string | 必填 | |
angle | number | — | 默认 360.0 |
body_name | string | — | 默认 GSM_SURFACES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_sphere_v2
创建球体曲面 (AddNewSphere)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
center | string | 必填 | |
axis | string | 必填 | |
radius | number | — | 默认 50.0 |
body_name | string | — | 默认 GSM_SURFACES |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
gsm_create_surface_datum
将源曲面元素转换为 Datum 曲面 (AddNewSurfaceDatum)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
source_name | string | 必填 | |
body_name | string | — | 默认 GSM_SURFACES |
datum_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
isolate_selected_features
隔离 (Isolate) CATIA 当前选中的特征,将其转为 datum 基准并断开与父特征的关联。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
geometrical_set | string | — | 默认 Isolated Features |
delete_original | boolean | — | 默认 True |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
list_selected_set_colors
列出 CATIA 当前选中几何图形集内特征的颜色(RGB)。limit 为最多返回数(<=0 不限)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
recursive | boolean | — | 默认 True |
limit | number | — | 默认 100 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
new_part_with_sphere
一键创建包含球体曲面的新 Part 文档。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
part_name | string | — | 默认 SphereDemo |
center_x | number | — | 默认 0.0 |
center_y | number | — | 默认 0.0 |
center_z | number | — | 默认 0.0 |
radius | number | — | 默认 50.0 |
save_path | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
close_sketch
关闭当前草图编辑模式并更新 Part。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_coincidence
在两个组件的指定发布之间创建相合约束。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
comp1 | string | 必填 | |
pub1 | string | 必填 | |
comp2 | string | 必填 | |
pub2 | string | 必填 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_sketch
在当前活动 Part 的参考平面上创建一个新草图。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
plane_name | string | — | 默认 XY |
sketch_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_sketch_with_circle
一键创建草图并绘制圆形(闭合轮廓)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
plane_name | string | — | 默认 XY |
center_x | number | — | 默认 0.0 |
center_y | number | — | 默认 0.0 |
radius | number | — | 默认 50.0 |
sketch_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_sketch_with_rectangle
一键创建草图并绘制矩形(闭合轮廓)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
plane_name | string | — | 默认 XY |
left | number | — | 默认 0.0 |
top | number | — | 默认 100.0 |
right | number | — | 默认 200.0 |
bottom | number | — | 默认 0.0 |
sketch_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
sketch_add_arc
在当前打开的草图中添加一段圆弧。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
center_x | number | — | 默认 0.0 |
center_y | number | — | 默认 0.0 |
radius | number | — | 默认 50.0 |
start_angle | number | — | 默认 0.0 |
end_angle | number | — | 默认 180.0 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
sketch_add_circle
在当前打开的草图中添加一个圆形。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
center_x | number | — | 默认 0.0 |
center_y | number | — | 默认 0.0 |
radius | number | — | 默认 50.0 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
sketch_add_constraints
列出并修改草图中的尺寸约束。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sketch | string | 必填 | |
value | string | — | |
modify | string | — | |
dry_run | boolean | — | 默认 True |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
sketch_add_distance_constraints
为草图中按顺序传入的圆/点相邻元素添加间距 (Distance) 约束。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sketch | string | 必填 | |
circles | string | — | |
value | number | — | 默认 80.0 |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
sketch_add_line
在当前打开的草图中添加一条直线。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
start_x | number | — | 默认 0.0 |
start_y | number | — | 默认 0.0 |
end_x | number | — | 默认 100.0 |
end_y | number | — | 默认 0.0 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
sketch_add_point_distance
为草图中按顺序传入的点相邻元素添加间距 (Distance) 约束。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sketch | string | 必填 | |
points | string | — | |
value | number | — | 默认 80.0 |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
sketch_add_radius_constraints
为草图中选中的圆/圆弧添加半径 (Radius) 约束。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sketch | string | 必填 | |
circles | string | — | |
value | string | — | |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
sketch_add_rectangle
在当前打开的草图中添加一个矩形(四条线段闭合)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
left | number | — | 默认 0.0 |
top | number | — | 默认 100.0 |
right | number | — | 默认 200.0 |
bottom | number | — | 默认 0.0 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
sketch_coincide_points_line
将草图中的多个点与一根线做相合 (Coincidence) 约束。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sketch | string | 必填 | |
points | string | — | |
line | string | — | |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
sketch_distribute_circles
在草图选中的线上均匀分布创建圆。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sketch | string | 必填 | |
line | string | 必填 | |
count | number | — | 默认 15 |
radius | number | — | 默认 10.0 |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
sketch_open
打开当前 Part 中最近创建的草图进行编辑。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
sketch_translate_pattern
对草图元素沿指定方向做平移阵列 (复制圆)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sketch | string | 必填 | |
base_circle | string | 必填 | |
count | number | — | 默认 15 |
spacing | number | — | 默认 80.0 |
direction | string | — | 默认 v |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
add_chamfer
对当前选中的边添加倒角 (Chamfer)。请先在 CATIA 中选择要倒角的边。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
length | number | — | 默认 5.0 |
angle | number | — | 默认 45.0 |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
add_edge_fillet
对当前选中的边添加倒圆角 (Edge Fillet)。请先在 CATIA 中选择要倒圆角的边。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
radius | number | — | 默认 5.0 |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_block
一键创建矩形方块(新建 Part → 矩形草图 → 拉伸)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
length | number | — | 默认 100.0 |
width | number | — | 默认 50.0 |
height | number | — | 默认 25.0 |
plane_name | string | — | 默认 XY |
part_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_cylinder
一键创建圆柱体(新建 Part → 圆形草图 → 拉伸)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
radius | number | — | 默认 30.0 |
height | number | — | 默认 50.0 |
plane_name | string | — | 默认 XY |
part_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_hole
在当前选中的面上创建孔 (Hole)。请先在 CATIA 中选择放置孔的面。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
diameter | number | — | 默认 10.0 |
depth | number | — | 默认 20.0 |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
create_shell
对当前选中的面添加抽壳 (Shell)。请先在 CATIA 中选择要移除的面。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
thickness | number | — | 默认 2.0 |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
pad_from_sketch
从已有草图创建拉伸凸台 (Pad)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sketch_name | string | — | 默认 Sketch.1 |
length | number | — | 默认 10.0 |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
part_info
返回指定零件的 BOM 信息和参数列表。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
part_number | string | 必填 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
part_most_instances
返回当前 Product 中实例数量最多的零件(按零件号统计)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
pocket_from_sketch
从已有草图创建拉伸凹槽 (Pocket / 切割)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sketch_name | string | — | 默认 Sketch.1 |
depth | number | — | 默认 10.0 |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
shaft_from_sketch
从已有草图创建旋转体 (Shaft / 旋转特征)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sketch_name | string | — | 默认 Sketch.1 |
angle | number | — | 默认 360.0 |
feature_name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
close_all_documents
关闭所有可见窗口中的文档。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
save_first | boolean | — | 默认 True |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
close_document
关闭当前活动文档。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
save_first | boolean | — | 默认 True |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
export_to_igs
将当前活动文档导出为 IGES 格式 (.igs)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
output_path | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
export_to_step
将当前活动文档导出为 STEP 格式 (.stp)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
output_path | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
export_to_stl
将当前活动文档导出为 STL 格式 (.stl)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
output_path | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
list_open_documents
列出所有可见窗口中的文档。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
open_document
打开 CATIA 支持的任何文档类型 (.CATPart/.CATProduct/.stp/.igs/.stl 等)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
file_path | string | 必填 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
set_active_document
切换活动文档。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
doc_name | string | 必填 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
center_part
选中指定零件号的第一个实例,并在 CATIA 中居中显示。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
part_number | string | 必填 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
export_bom
导出活动 Product 文档的 BOM 表(ASCII 表格,含质量/体积/重心)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
export_product_json
遍历当前活动 Product 并导出为 JSON 文件。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
output_path | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
insert_components
把一个或多个零件文件插入到当前 Product。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
file_paths | string | 必填 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
list_publications
列出指定组件的发布元素。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
component_name | string | 必填 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
print_product_tree
打印活动 Product 的目录树(子产品/子零件名称、零件号及数量统计)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_add_connector
添加连接器(CATIProduct::AddConnector,Automation 可能不支持)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
obj | string | — | 默认 |
product | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_add_product
添加子产品:--name 新建 或 --reference 从已有引用实例化(CATIProduct::AddProduct)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | — | |
reference | string | — | |
product | string | — | |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_add_products
批量添加子产品(CATIProduct::AddProducts,循环 AddNewFrom 实现)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
references | string | — | 默认 |
product | string | — | |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_add_shape_rep
添加产品表示(CATIProduct::AddShapeRepresentation,Automation 可能不支持)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
from_object | boolean | — | 默认 False |
type | string | — | |
path | string | — | |
shape_name | string | — | |
mode | string | — | 默认 3D |
product | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_all_children
递归列出所有子产品树(CATIProduct::GetAllChildren)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
product | string | — | |
show_reference | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_children
列出直接子产品(CATIProduct::GetChildren)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
product | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_children_count
返回直接子产品数量(CATIProduct::GetChildrenCount)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
product | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_enum_tree
递归枚举子树,返回 [(depth, product), ...](先序)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
product | string | 必填 | |
depth | number | — | 默认 0 |
out | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_father
返回产品的父产品(CATIProduct::GetFatherProduct)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
product | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_find_instance
在上下文中查找产品的实例(CATIProduct::FindInstance)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
reference | string | — | 默认 |
context | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_find_product
按显示名查找产品;找不到返回 None。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
root | string | 必填 | |
name | string | 必填 | |
recursive | boolean | — | 默认 True |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_get_connector
返回引用指定对象的连接器(CATIProduct::GetConnector,Automation 可能不支持)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
obj | string | — | 默认 |
product | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_get_instance_name
返回产品实例名(CATIProduct::GetPrdInstanceName)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
product | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_get_part_number
返回引用产品的 PartNumber(CATIProduct::GetPartNumber)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
product | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_get_shape_rep
按名称检索产品表示(CATIProduct::GetShapeRep,Automation 可能不支持)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
shape_name | string | — | 默认 Default |
mode | string | — | 默认 3D |
product | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_is_associated_to_shape
判断产品是否有指定表示(CATIProduct::IsAssociatedToShape,Automation 可能不支持)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
shape_name | string | — | 默认 |
mode | string | — | 默认 3D |
product | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_is_reference
判断产品是否为引用产品(CATIProduct::IsReference)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
product | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_list_shape_rep
列出产品的表示(CATIProduct::ListShapeRep,Automation 可能不支持)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
mode | string | — | 默认 3D |
product | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_product_bom
获取激活产品所有子产品的 BOM 信息(名称、零件号、属性)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
find | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_product_name
返回产品的可读名称:优先实例名,其次 PartNumber,最后 Name。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
product | string | 必填 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_reference
返回产品的引用产品(CATIProduct::GetReferenceProduct)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
product | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_reference_of
返回产品的引用产品(晚绑定包装),失败/引用产品返回 None。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
product | string | 必填 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_remove_product
移除指定产品实例(CATIProduct::RemoveProduct)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | — | 默认 |
product | string | — | |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_remove_shape_rep
移除产品的指定表示(CATIProduct::RemoveShapeRep,Automation 可能不支持)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
shape_name | string | — | 默认 |
mode | string | — | 默认 3D |
product | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_set_instance_name
设置产品实例名(CATIProduct::SetPrdInstanceName)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | — | 默认 |
product | string | — | |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_set_part_number
设置引用产品的 PartNumber(CATIProduct::SetPartNumber)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | — | 默认 |
product | string | — | |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
product_target_product
解析 --product 参数:默认返回根产品,否则按名称查找。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
root | string | 必填 | |
name | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
sync_product_to_bom
遍历当前活动 Product 并将数据发送到 BOM 系统。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
server_url | string | — | 默认 http://192.168.100.35:5000 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
traverse_active_product
获取当前活动 Product 文档,遍历其完整的零件/子产品结构。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
traverse_product_tree
递归遍历活动 Product 文档的零件树结构,输出树形列表。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
knowledge_create_powercopy_template
在当前激活文档中创建 PowerCopy 模板。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | — | 默认 PowerCopy |
output_dir | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
knowledge_create_udf
在当前激活文档中创建 UDF (User Defined Feature) 目录条目。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | — | 默认 |
catalog_path | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
knowledge_export_parameters
导出当前激活文档中指定特征下的根级参数到 CSV 文件。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
output | string | — | |
geo_set | string | — | |
recursive | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
knowledge_generate_template
在当前 CATIA Part 中生成几何图形集模板结构。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
parent | string | — | 默认 TPL_UDF |
ref_set | string | — | 默认 References |
result_set | string | — | 默认 OutPuts |
params | string | — | |
no_sub_sets | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
knowledge_import_json_params
解析 JSON 文件,在选定几何图形集(支持 / 嵌套路径)下创建参数。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
json_path | string | — | 默认 |
parent | string | — | 默认 |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
knowledge_instantiate_powercopy
遍历指定几何图形集中的曲线,对每条线实例化 PowerCopy 并可修改发布参数。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
powercopy_name | string | — | 默认 TPL |
template_path | string | — | |
geo_set | string | — | 默认 LINES |
input_name | string | — | 默认 curve |
output_geo_set | string | — | 默认 TPL_UDF |
parameters | string | — | |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
knowledge_instantiate_template
将 PowerCopy 模板实例化到当前文档。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
template_path | string | — | 默认 |
name | string | — | 默认 PW |
instance_name | string | — | 默认 Instance |
parameters | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
knowledge_update_udf_parameters
链式更新 UDF 参数:将每个子几何图形集的 StartHeight 设为前一个的 EndHeight,
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
geo_set | string | — | 默认 TPL_UDF |
start_height | string | — | 默认 StartHeight |
end_height | string | — | 默认 EndHeight |
unit | string | — | 默认 mm |
angle | string | — | 默认 3.7deg |
angle_param | string | — | 默认 SlopeAngle |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
spiral_ramp_create_loft
螺旋坡道:相邻断面两两对应边分别 Loft(脊线 center_curve),结果放 LOFT_SURFACES。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sections_set_name | string | — | 默认 SECTIONS |
output_set_name | string | — | 默认 LOFT_SURFACES |
center_curve_name | string | — | 默认 center_curve |
edge_names | string | — | 默认 左侧外轮廓边线,右侧外轮廓边线,底边线 |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
spiral_ramp_instances
螺旋坡道:在选中集合的 center_curve 上创建比率点并实例化 PowerCopy(pt/crv/axis),结果放 SECTIONS。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
center_curve_name | string | — | 默认 center_curve |
point_count | number | — | 默认 20 |
template_path | string | — | 默认 D:\PROJECT\bridge_shanghai_longyaoroad\model\template\spiral_ramp_section_template.CATPart |
powercopy_name | string | — | 默认 斜坡道断面 |
input_pt | string | — | 默认 pt |
input_crv | string | — | 默认 crv |
input_axis | string | — | 默认 axis |
axis_name | string | — | 默认 绝对轴系 |
point_prefix | string | — | 默认 RampPoint |
instance_prefix | string | — | 默认 RampSec |
sections_set_name | string | — | 默认 SECTIONS |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
spiral_ramp_update_parameters
按实例序号线性插值更新螺旋坡道下沿右/左侧点长度参数。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sections_set_name | string | — | 默认 SECTIONS |
right_point_name | string | — | 默认 下沿右侧点 |
left_point_name | string | — | 默认 下沿左侧点 |
right_start | string | — | 默认 -1650mm |
right_end | string | — | 默认 -1050mm |
left_start | string | — | 默认 -1050mm |
left_end | string | — | 默认 -1050mm |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
stair_step_create_extrude_surfaces
把踏步实例的踏面线/踢面线沿方向拉伸成曲面(直到元素),放入 SURF。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
instances_set | string | — | 默认 STEP_SETS |
output_set | string | — | 默认 SURF |
tread_line_name | string | — | 默认 踏面线 |
riser_line_name | string | — | 默认 踢面线 |
plane1_name | string | — | 默认 楼梯边界面一 |
plane2_name | string | — | 默认 楼梯边界面二 |
dx | number | — | 默认 0.0 |
dy | number | — | 默认 1.0 |
dz | number | — | 默认 0.0 |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
stair_step_instances
楼梯踏步链式实例化:第 1 个绑定起始点,之后每个绑定上一实例内的踏面控制点。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
start_point_name | string | — | 默认 起始点 |
powercopy_name | string | — | 默认 STEP |
input_name | string | — | 默认 起始点 |
output_set | string | — | 默认 STEP_SETS |
count | number | — | 默认 30 |
instance_name_prefix | string | — | 默认 STEP |
chain_point_name | string | — | 默认 踏面控制点 |
template_path | string | — | 默认 D:\PROJECT\bridge_shanghai_longyaoroad\model\template\template_powercopy_stair.CATPart |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
stair_step_instances_continue
在现有楼梯踏步实例基础上继续链式实例化(接续最后一个实例的踏面控制点)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
instances_set | string | — | 默认 STEP_SETS |
powercopy_name | string | — | 默认 STEP |
input_name | string | — | 默认 起始点 |
count | number | — | 默认 20 |
instance_name_prefix | string | — | 默认 STEP |
chain_point_name | string | — | 默认 踏面控制点 |
template_path | string | — | 默认 D:\PROJECT\bridge_shanghai_longyaoroad\model\template\template_powercopy_stair.CATPart |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
stair_step_set_lengths
修改 STEP_SETS 下所有实例的控制点长度参数(踏面控制点→tread_length,踢面控制点→riser_length,带单位字符串)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
instances_set | string | — | 默认 STEP_SETS |
tread_point_name | string | — | 默认 踏面控制点 |
riser_point_name | string | — | 默认 踢面控制点 |
tread_length | string | — | 默认 0.32m |
riser_length | string | — | 默认 -0.14m |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
stair_step_set_lengths_selected
把当前选中几何图形集下所有子集的踏面/踢面控制点长度设为指定值(踏面300mm/踢面-150mm)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
tread_point_name | string | — | 默认 踏面控制点 |
riser_point_name | string | — | 默认 踢面控制点 |
tread_length | string | — | 默认 300mm |
riser_length | string | — | 默认 -150mm |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
stair_step_set_specific_lengths
把指定实例(逗号分隔)内某控制点的长度参数设为指定值(如 STEP_17/STEP_33 踏面控制点→1.5m)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
instances_set | string | — | 默认 STEP_SETS |
instance_names | string | — | 默认 STEP_17,STEP_33 |
point_name | string | — | 默认 踏面控制点 |
length | string | — | 默认 1.5m |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
facade_glass_pattern
在已选择的几何图形集内,沿参考线创建等距分格点(起点为参考点,点位于曲线上)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
point_name | string | — | 默认 Point.2 |
line_name | string | — | 默认 右侧结构边线 |
count | number | — | 默认 20 |
spacing | number | — | 默认 6000.0 |
start_distance | number | — | 默认 0.0 |
orientation | boolean | — | 默认 True |
output_set | string | — |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
facade_handrail_instances
按点集批量实例化 platform_handrail 超级副本(每点一个,绑定 point/axis/line)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
points_set | string | — | 默认 玻璃分格点 |
point_name_prefix | string | — | 默认 GlassPoint |
line_name | string | — | 默认 右侧结构边线 |
axis_name | string | — | 默认 Absolute Axis System |
template_path | string | — | 默认 D:\SYNC\PROJECT\SMEDI_Facade_Project\model\template\template_platform_handrail.CATPart |
powercopy_name | string | — | 默认 platform_handrail |
input_point | string | — | 默认 point |
input_axis | string | — | 默认 axis |
input_line | string | — | 默认 line |
output_set | string | — | |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
facade_handrail_offset_zero
将各超级副本 Reference 草图中的 Offset 约束值统一改为指定值(默认按当前值定位,不依赖约束名)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
instances_set | string | — | 默认 Platform_Handrail_Instances |
constraint_name | string | — | |
old_value | string | — | 默认 1000.0 |
value | number | — | 默认 0.0 |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
bridge_create_axis_base_points
遍历当前选中的几何图形集,在每个点位置创建轴系(AxisSystem)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
dry_run | boolean | — | 默认 False |
geo_set_name | string | — | 默认 AXIS_SYSTEMS |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
bridge_extract_axis_geometry
从当前选中的一个或多个轴系提取原点、方向轴与三个平面,创建几何元素。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
scale | number | — | 默认 100.0 |
geo_set_name | string | — | 默认 EXTRACTED_AXIS |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
bridge_extract_surface_center
选中面(或按名称查找),搜索其边线并用 GSM AddNewExtract 提取边界。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
face_name | string | — | |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
bridge_extract_wireframe_fill_boundary
将输入几何图形集的相交线按平面分组,两两 Join 成闭合环后创建 Fill 填充曲面。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
input_geo_set | string | — | 默认 NormalPlane_Result |
group_prefix | string | — | 默认 Section_P |
output_geo_set | string | — | 默认 Fill_Result |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
bridge_intersect_normal_plane_solid
沿参考曲线按法线方向创建多个平面,并分别与目标几何图形集内所有元素相交。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
curve_name | string | — | 默认 |
curve_geo_set | string | — | 默认 Check-Logic |
target_geo_set | string | — | 默认 |
num_planes | number | — | 默认 10 |
output_geo_set | string | — | 默认 NormalPlane_Result |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
bridge_panel_assembly
从 CATProduct 模板批量插入面板组件,并约束到参考组件的轴系发布。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
template_path | string | — | 默认 |
ref_index | number | — | 默认 1 |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
bridge_rename_selection
遍历 CATIA 当前选中的所有对象,按顺序依次重命名(Prefix_N 格式)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
prefix | string | — | 默认 Item |
start | number | — | 默认 1 |
digits | number | — | 默认 0 |
separator | string | — | 默认 _ |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
bridge_rename_to
将选中的对象(如草图约束)重命名为指定名称,批量时自动追加编号。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | — | 默认 |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
bridge_steel_truss_bridge
参数化生成钢桁架桥梁框架结构。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
n_points | number | — | 默认 11 |
spacing | number | — | 默认 7800.0 |
height | number | — | 默认 11000.0 |
offset_y | number | — | 默认 22000.0 |
geo_set_name | string | — | 默认 STEEL_TRUSS_BRIDGE |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
drawing_annotate_view_points
在指定名称的图纸视图中,为链接几何图形集里的每个点创建名称标注。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
view_name | string | — | 默认 1111 |
offset | number | — | 默认 20.0 |
text_size | number | — | 默认 5.0 |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
drawing_annotation_automatically
从 Part 文档 AnnoSets 几何图形集提取 UDF,在 Drawing 视图投影元素上创建标注。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
udf_filter | string | — | |
offset | number | — | 默认 30.0 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
drawing_batch_dimension_automatically
从 Part 文档 AnnoSets 几何图形集提取 UDF,在 Drawing 视图上批量创建标注/尺寸。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
udf_filter | string | — | |
offset | number | — | 默认 30.0 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
drawing_create_sectional_view
遍历零件所有几何图形集,若集合内包含平面,则基于该平面在图纸生成断面图。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
offset | number | — | 默认 5000.0 |
view_scale | number | — | 默认 1.0 |
section_type | string | — | 默认 SectionCut |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
drawing_create_three_views
基于当前零件新建图纸,投影零件并生成三视图(主视图/俯视图/左视图)。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
view_scale | number | — | 默认 1.0 |
spacing | number | — | 默认 500.0 |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
drawing_generate_cut_views
基于 Part 文档 LVL 几何图形集平面,在 Drawing 中批量生成偏移剖切断面图。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
front_geo_set | string | — | 默认 Geometrical Set.1 |
lvl_geo_set | string | — | 默认 LVL |
offset | number | — | 默认 5000.0 |
view_scale | number | — | 默认 1.0 |
dry_run | boolean | — | 默认 False |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
drawing_get_view_points
返回指定名称视图链接的几何图形集里所有点的名称列表。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
view_name | string | — | 默认 1111 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
drawing_rename_catpart_views
批量重命名文件夹下所有 CATPart 中 平面图→PLN、立面图→ELV、断面图→SEC。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
folder | string | — | 默认 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
drawing_test_create_dimension
在活动 Drawing 文档的首个视图中用 Factory2D 创建两点并标注其距离。
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
offset | number | — | 默认 30.0 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | [OK] 成功 / [ERR] 失败及原因 |
hello
基础调试工具,返回问候信息
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
message | string | 问候消息 |
echo
回显输入信息,用于测试通信
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
text | string | 必填 | 需要回显的文本 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
echo | string | 回显的文本 |
info
获取系统信息和配置详情
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
systemInfo | object | 系统信息对象 |
config | object | 配置信息 |
connect
连接到 PLM 建筑与基础设施模块
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
server | string | — | 服务器地址 |
port | number | — | 端口号 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
connected | boolean | 是否连接成功 |
test
执行基础功能测试
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
passed | boolean | 测试是否通过 |
results | array | 测试结果详情 |
active-part
获取当前活动零件信息
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
partName | string | 零件名称 |
partId | string | 零件ID |
settings
查看或修改系统设置
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
key | string | — | 设置项名称 |
value | any | — | 设置值(可选,为空则读取) |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
settings | object | 设置项信息 |
template
从模板创建零件
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
templateName | string | 必填 | 模板名称 |
params | object | — | 模板参数 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
partId | string | 新建零件ID |
rename
重命名零件
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
partId | string | 必填 | 零件ID |
newName | string | 必填 | 新名称 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
batch-rename
批量重命名零件
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
partIds | array[string] | 必填 | 零件ID列表 |
pattern | string | 必填 | 命名模式 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
renamedCount | number | 重命名数量 |
rename-vb
使用 VBA 脚本重命名零件
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
partId | string | 必填 | 零件ID |
newName | string | 必填 | 新名称 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
rename-object
重命名对象(几何体、特征等)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
objectId | string | 必填 | 对象ID |
newName | string | 必填 | 新名称 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
change-params-name
修改参数名称
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
paramId | string | 必填 | 参数ID |
newName | string | 必填 | 新名称 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
product
创建或操作产品结构
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
productName | string | 必填 | 产品名称 |
operation | string | — | 操作类型:create / add / remove |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
productId | string | 产品ID |
create-obj-to-part
创建对象到零件中
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
partId | string | 必填 | 目标零件ID |
objectType | string | 必填 | 对象类型 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
objectId | string | 创建的对象ID |
list-params
列出零件中的所有参数
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
partId | string | — | 零件ID,默认当前活动零件 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
params | array[object] | 参数列表 |
infra_bridge_wireframe_t1
生成桥梁线框模型
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
params | object | — | 桥梁参数 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
wireframeId | string | 线框模型ID |
bridge-nest-net-lines
生成桥梁嵌套网格线
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
density | number | — | 网格密度 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
linesCount | number | 生成的线条数量 |
demo-hybrid
演示混合建模功能
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | 演示结果 |
udf-instantiate
实例化 UDF(超级副本)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
udfName | string | 必填 | UDF名称 |
params | object | — | UDF参数 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
instanceId | string | 实例ID |
udf-replace
替换 UDF 实例
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
instanceId | string | 必填 | 实例ID |
newUdfName | string | 必填 | 新UDF名称 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
export-udf-params
导出 UDF 参数
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
udfName | string | 必填 | UDF名称 |
path | string | — | 导出路径 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
params | object | UDF参数 |
update-udf-params
更新 UDF 参数
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
udfName | string | 必填 | UDF名称 |
params | object | 必填 | 新参数值 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
update-params-db
更新参数到数据库
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
partId | string | 必填 | 零件ID |
params | object | 必填 | 参数数据 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
updated | boolean | 是否成功更新 |
kp-autorun
自动运行知识工程规则
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
executed | boolean | 是否执行成功 |
write_drawingtable_bridge_a1
写入 A1 图纸表格(桥梁专用)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
data | object | 必填 | 表格数据 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
written | boolean | 是否成功写入 |
write_drawingtable_bridge_a2a3
写入 A2/A3 图纸表格(桥梁专用)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
data | object | 必填 | 表格数据 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
written | boolean | 是否成功写入 |
write_drawingtable_bridge_a4a5
写入 A4/A5 图纸表格(桥梁专用)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
data | object | 必填 | 表格数据 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
written | boolean | 是否成功写入 |
write_drawingtable_bridge_a6
写入 A6 图纸表格(桥梁专用)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
data | object | 必填 | 表格数据 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
written | boolean | 是否成功写入 |
drawing-table
创建工程图表格
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
rows | number | 必填 | 行数 |
cols | number | 必填 | 列数 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
tableId | string | 表格ID |
drw-table-a1
创建 A1 图纸表格
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
data | object | — | 表格数据 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
tableId | string | 表格ID |
write-drawingtable-vb
使用 VBA 写入图纸表格
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
data | object | 必填 | 表格数据 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
written | boolean | 是否成功写入 |
excel-to-drawing
从 Excel 导入数据到图纸表格
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
excelPath | string | 必填 | Excel 文件路径 |
sheetName | string | — | 工作表名称 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
importedRows | number | 导入行数 |
set-cell-font
设置单元格字体样式
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
cellId | string | 必填 | 单元格ID |
fontName | string | — | 字体名称 |
fontSize | number | — | 字体大小 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
hello1
测量查询模块测试工具1
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
message | string | 测试消息 |
hello2
测量查询模块测试工具2
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
message | string | 测试消息 |
check
检查测量数据
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
objectId | string | 必填 | 对象ID |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
valid | boolean | 数据是否有效 |
get-distance
获取两点之间的距离
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
point1 | object | 必填 | 点1坐标 {x, y, z} |
point2 | object | 必填 | 点2坐标 {x, y, z} |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
distance | number | 距离 mm |
get-length
获取曲线或边的长度
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
curveId | string | 必填 | 曲线或边ID |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
length | number | 长度 mm |
get-point-coordinate
获取点的坐标
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
pointId | string | 必填 | 点ID |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
coordinate | object | 坐标 {x, y, z} |
del-dim
删除尺寸标注
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
dimId | string | 必填 | 尺寸标注ID |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
deleted | boolean | 是否成功删除 |