Ets_Nt_Subnet_Image_Capture_Core()
摘要
捕获子网的图形图像,并提供生成 HTML 的选项。
语法
Ets_Nt_Subnet_Image_Capture_Core (subnet_handle, ul_x, ul_y, lr_x, lr_y, image_pixel_width, image_type, dest_ptr, directory, image_name, options, html_options, map_ptr, status_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
subnet_hndl |
EtsT_Obj_Handle |
目标子网。 |
ul_x |
double |
左上角的 x 坐标,采用子网的单位。 |
ul_y |
double |
左上角的 y 坐标,采用子网的单位。 |
lr_x |
double |
右下角的 x 坐标,采用子网的单位。 |
lr_y |
double |
右下角的 y 坐标,采用子网的单位。 |
image_pixel_width |
int |
捕获图像的宽度(像素),高度按比例缩放。 |
image_type |
EtsT_Image_Export_Type |
捕获图像的格式(见 image_type)。 |
dest_ptr |
void * |
捕获图像的文件路径(若设置了 ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_IMAGE_BUFFER 选项,则为指向图像缓冲区的指针)。 |
directory |
const char * |
生成的 HTML 应存放的目录。仅当设置了 ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_HTML_OUTPUT 选项时使用。 |
image_name |
char * |
用于将生成的 HTML 链接到先前已捕获图像的名称。仅当同时设置了 ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_HTML_OUTPUT 与 ETSC_HTML_NT_IMAGEMAP_OPT_USE_EXTERNAL_IMAGE 选项时使用。 |
options |
int |
捕获图像的选项(见 options)。 |
html_options |
int |
生成 HTML 的选项(见 html_options)。仅当设置了 ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_HTML_OUTPUT 选项时使用。 |
map_ptr |
EtsT_Obj_Map * |
用于跟踪存在于多个子网中的对象哪些已导出到 HTML 的对象映射(见 map_ptr)。仅当设置了 ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_HTML_OUTPUT 选项时使用。 |
返回类型
char *
HTML 页面(若通过 ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_HTML_OUTPUT 选项请求)或 PRGC_NIL(若未请求 HTML 或操作失败)。
头文件
ets_api_nt.h
详情
该函数按子网在工作区中的显示样子捕获其图形图像,并保存到文件(若设置了 ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_IMAGE_BUFFER,则保存到图像缓冲区)。通过给出图像中所需子网部分的左上角与右下角坐标(ul_x、ul_y、lr_x 和 lr_y)来指定要捕获的区域。捕获的图像将缩放为 image_pixel_width 指定的宽度。可使用 Ets_Nt_Model_Visible_Bounds_Get() 获取当前子网视图的宽度。可通过 ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_OVERRIDE_BOUNDS 和 ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_DO_NOT_FIT_TO_PAGE 选项覆盖捕获的区域或宽度。
若设置了 ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_HTML_OUTPUT 选项,该函数还将返回捕获图像的 HTML 版本。可通过设置各种 HTML 选项(后文说明)来控制 HTML 的生成方式。
image_type
image_type 必须是以下常量之一:
EtsC_Image_Export_Type_GIFEtsC_Image_Export_Type_TIFFEtsC_Image_Export_Type_PNG
options
options 必须是 ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_NONE,或以下一个或多个常量按位 OR 的组合:
ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_HTML_OUTPUT——返回捕获图像的 HTML 版本ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_OVERRIDE_BOUNDS——在图像中捕获整个子网内容,而不只是指定的边界(ul_x、ul_y、lr_x、lr_y)ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_DO_NOT_FIT_TO_PAGE——按图像实际尺寸捕获,而不缩放以适应指定的image_pixel_widthETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_IMAGE_BUFFER——将捕获的图像存入缓冲区而不是保存为文件(dest_ptr指向图像缓冲区)
html_options
除非正在生成 HTML(设置了 ETSC_NT_SUBNET_IMAGE_CAPTURE_OPT_HTML_OUTPUT 选项),否则 html_options 参数被忽略。html_options 必须是 ETSC_HTML_NT_IMAGEMAP_OPT_NONE,或以下一个或多个常量按位 OR 的组合:
ETSC_HTML_NT_IMAGEMAP_OPT_EXCLUDE_ATTRIBUTES——不为每个对象创建包含属性数据的页面ETSC_HTML_NT_IMAGEMAP_OPT_SKIP_SIMPLE_SUBNETS——从第一个包含内容不止单个子网的子网(subnet_hndl或其子级)开始生成图像映射ETSC_HTML_NT_IMAGEMAP_OPT_GRAPHICS_PNG——以 PNG 格式创建图形(默认是 GIF)ETSC_HTML_NT_IMAGEMAP_OPT_GENERATE_BUFFER——以文本缓冲区而不是文件返回 HTMLETSC_HTML_NT_IMAGEMAP_OPT_NO_RECURSE——不包含子级子网ETSC_HTML_NT_IMAGEMAP_OPT_GENERATE_OBJECT_LINKS——生成的 HTML 带有指向各对象页面的超链接ETSC_HTML_NT_IMAGEMAP_OPT_NO_RESOLUTION_ADJUST——保持子网分辨率不变(通常该函数会临时改变子网分辨率以捕获全部内容)ETSC_HTML_NT_IMAGEMAP_OPT_USE_EXTERNAL_IMAGE——不捕获图形图像;而是将 HTML 图像映射链接到由image_name参数指定的先前已捕获的图像ETSC_HTML_NT_IMAGEMAP_OPT_ONLY_IMAGE_TEXT——只生成图像映射的文本而不是完整页面(这允许将该文本包含在另一个页面中)ETSC_HTML_NT_IMAGEMAP_OPT_NEW_BROWSER——生成将在新浏览器窗口中打开的超链接ETSC_HTML_NT_IMAGEMAP_OPT_IS_TOP——使用以目标子网(subnet_hndl)开头的对象名创建超链接,而不是完整的层次化名称
map_ptr
map_ptr 指定一个对象映射,用于记录哪些对象已经导出到 HTML、哪些还没有。当你对多个子网调用 Ets_Nt_Subnet_Image_Capture_Core() 且有些对象存在于多个子网中时,这会很有用。如果是这种情况,你应在第一次调用 Ets_Nt_Subnet_Image_Capture_Core() 之前用 Ets_Obj_Map_Create() 创建新的 map_ptr,并在最后一次调用之后销毁它。