完整3UG二次开发实用教程 第三章.docx
《完整3UG二次开发实用教程 第三章.docx》由会员分享，可在线阅读，更多相关《完整3UG二次开发实用教程 第三章.docx（16页珍藏版）》请在冰豆网上搜索。
完整3UG二次开发实用教程第三章
第3章编程基础
3.1UG/OpenAPI函数
3.1.1函数名称的约定
UG/OpenAPI共有两类名称约定。
一个是标准的UG/OpenAPI的函数名称约定；另一个是以前版本原有的名称约定。
1、标准名称约定
格式：
UF__
说明：
●UF_，userfunciton的简写，表示该函数为UG/OpenAPI函数；
●，应用或模块的名称缩写。
例如modl和disp分别是Modeling模块和Display功能的名称缩写；
●，表示其实现功能的语言描述，一般由下划线分开的动词和名词（或词组）组成。
常用的动词有：
ask（查询）、create（创建）、edit（编辑）、set（设置）、delete（删除）等。
例如：
UF_MODL_create_block1（）为创建立方体的函数；
UF_DISP_set_highlight（）是高亮显示对象的函数；
（2）非标准名称约定
格式：
uc和uf
说明：
代表UG/OpenAPIC程序，通常是四位数或三位数接一个字母。
例如：
uc1601是一个提示信息函数。
3.1.2函数参数的约定
UG/OpenAPI提供的函数遵守ANSI/ISOC的标准，并以下列格式在头文件中提供函数原型：
<返回数据类型><函数名>（变量列表）；
返回数据类型通常是C数据类型或UG/OpenAPI自定义数据类型。
参数的输入输出方式有3种：
I（Input）、O（Output）或OF（OutputFree），说明见表3-1。
表3-1 参数输入方式说明
元素
描述
I
表示参数为输入方式，参数在使用前必须赋值
O
表示参数为输出方式，使用前无须赋值
OF
表示参数为输出方式，且使用后需要释放内存。
UG/OpenAPI提供的常用释放内存函数有UF_free（）、UF_free_string（）和UF_STYLER_free_value（）等，至于选择哪种释放函数需视具体情况而定。
例如：
函数UF_PART_open（）
名称：
UF_PART_open
使用环境:
internal&external
语法格式:
intUF_PART_open（
char*part_name,
tag_t*part,
UF_PART_load_status_t*error_status
）;
描述：
加载一个UG部件文件到UG的界面环境中，并把它设为工作和当前显示部件，该函数的描述见表3-2。
表3-2函数UF_PART_open（）参数描述
参数
输入\输出
类型
描述
part_name
输入
char*
要打开的部件文件名
part
输出
tag_t*
打开部件的标识，当打开部件文件失败时为NULL_TAG
error_status
输出
UF_PART_load_status_t*
当加载部件失败时该结构中将包含错误代码和部件文件名称，使用结束后应使用函数UF_free_string_arry（）和UF_free（）释放内存
return
输出
int
返回代号：
为0时表示正常；
非0时表示错误代号
3.2UG/OpenAPI的数据类型
除了C语言标准的数据类型外，UG/OpenAPI还提供了一些自定义的数据类型，如tag_t类型、结构类型（structuretype）、枚举类型（enumtype）、联合类型（uniontype）与指针类型（pointertype）等，它们统一用后缀“_t”表示，且这些数据类型的指针用反缀“_p_t”命名表示。
数据类型约定如表3-3所示：
表3-3数据类型约定
后缀
描述
_t
数据类型（datatype）
_p_t
数据类型的指针（pointertodatatype）
_s
结构标识（structuretag）
_u_t
联合类型（uniontype）
_u_p_t
联合类型的指针（pointertoauniontype）
_f_t
函数指针（pointertoafunction）
3.2.1tag_t类型
UG/OpenAPI使用最多的数据类型是tag_t，在UG/OpenAPI的uf_defs.h中定义如下：
typedefunsignedint tag_t,*tag_p_t;
在UG环境中，tag_t是UG对象的句柄，即UG对象模型的唯一标识。
它是一种不重复的无符号整型数值，主要用于标识应用程序中的对象，如部件、草图、曲线、属性和表达式等。
UG应用程序只能访问句柄，而不能直接访问句柄所指示的实际对象。
程序一般通过调用API函数获取句柄，并且在其他API函数中使用这个句柄，以引用它指示的对象。
在此过程中，句柄的实际值对程序来说是无关紧要的。
此外，tag_p_t是指向tag_t数据类型的指针。
以部件对象为例，下面的代码首先获取工作部件的tag_t值，然后获取该句柄所引用部件对象的文件名。
tag_ttWorkPart;
tWorkPart=UF_ASSEM_ask_work_part（）;
3.2.2结构类型
UG/OpenAPI采用C语言的语法定义了一些常用的结构类型，将相应联系的不同类型数据封装在一起使用，这些结构类型用后缀“_s”表示，例如：
structUF_STYLER_item_value_type_s{
intreason;
constchar*item_id;
intsubitem_index;
intcount;
intitem_attr;
intindicator;
UF_STYLER_value_tvalue;
}
typedefstructUF_STYLER_item_value_type_sUF_STYLER_item_value_type_t,*UF_STYLER_item_value_type_p_t;
结构体UF_STYLER_item_value_type_s封装了对话框控件的基本属性，如reason、item_id和value等。
UG/OpenAPI使用关键词typedef将该结构类型定义为新类型UF_STYLER_item_value_type_t，用户可以使用它定义结构变量，然后引用结构体内的数据成员，例如：
UF_STYLER_item_value_type_tdata;
UF_STYLER_ask_value（dialog_id,&data）;
…
UF_STYLER_free_value（&data）;
3.2.3枚举类型
枚举类型将变量的值一一列举出来，变量的值只限于列举出来的值的范围。
UG/OpenAPI采用C语言的语法定义了一些常用的枚举类型，使用后缀“_e”表示。
以枚举类型UF_ASSEM_load_status_e为例，下面给出其详细定义：
enumUF_ASSEM_load_status_e{
UF_ASSEM_ok,
UF_ASSEM_suppressed,
UF_ASSEM_not_loaded,
UF_ASSEM_instance_suppressed
};
typedefenumUF_ASSEM_load_status_eUF_ASSEM_load_status_t;
枚举类型UF_ASSEM_load_status_e表示部件在装配体中的状态。
UG/OpenAPI使用typedef关键词将该枚举类型定义为新类型UF_ASSEM_load_status_t，例如：
charsPartPath[]=“E:
\\Example\\part.prt”;
tag_ttPart=NULL_TAG;
UF_PART_load_status_terror_status;
UF_PART_open（sPartPath,&tPart,&error_status）;
3.2.4联合类型
有时需要将不同数据类型的变量放在同一段内存单元中，这种使不同变量占用同一段内存的结构类型称为联合类型。
联合类型与结构类型的定义形式相似，但含义不同。
联合类型变量所占的内存长度等于其内部最长数据成员的长度，而结构类型变量所占的内存长度则是其各数据成员所占内存长度之和。
UG/OpenAPI采用C语言的语法定义了一些常用的联合类型，使用后缀“_u”表示。
以联合类型UF_STYLER_value_u为例，下面给出其详细定义：
unionUF_STYLER_value_u{
char*string;
char**strings;
intinteger;
int*integers;
doublereal;
double*reals;
UF_UI_selection_p_tselection;
UF_STYLER_notification_p_tnotify;
UF_UI_attachment_tattach;
UF_UI_option_toggle_toption_toggle;
};
typedefunionUF_STYLER_value_uUF_STYLER_value_t;
联合体UF_STYLER_value_u封装了对话框对话框控件的属性值，如string、integer和real等。
UG/OpenAPI使用typedef关键词将该联合类型定义为新类型UF_STYLER_value_t，它是UF_STYLER_item_value_type_t中的数据成员value的类型，例如：
UF_STYLER_item_value_type_tdata;
doublerValue;
sel_data.item_id=REAL_BUTTOM_DIAMETER;
UF_STYLER_ask_value（dialog_id,&sel_data）;
rValue=data.value.real;
3.3UG对象类型及基本操作
UG中的所有对象都是通过唯一的tag_t值进行标识，这些对象大致可以分为部件对象、UF对象、表达式、链表和属性。
3.3.1部件对象
部件对象是UG最基本的操作对象之一，不仅包含了零件的几何信息，而且更包含了大量的非几何信息，非几何信息包括：
创建部件的计算机类型；保存部件的UG版本；部件的历史信息（例如部件文件的保存记录等）；状态、描述和用户区的可永久保存在部件文件中的信息。
UG/OpenAPI提供的访问和操作部件文件的函数包括部件文件的创建、打开、关闭、保存和信息的查询等。
表3-4对部件对话操作的函数
函数
描述
UF_OBJ_cycle_objs_in_part（）
在部件中查询对象
UF_ATTR_ask_part_attrs（）
访问部件的属性
UF_PART_close（）
UF_PART_reopen（）
关闭和再打开部件
UF_PART_ask_part_name（）
获取部件的文件名
UF_PART_ask_customer_area（）
UF_PART_ask_description（）
UF_PART_ask_status（）
查询其他信息，包括：
查询用户定义的数据、部件文件的描述信息，部件文件的状态信息
UF_PART_ask_part_history（）
查询部件文件的历史
UF_PART_ask_compression_flags（）
UF_PART_set_com
升级会员 