Ets_Layout_Subnet()
**注意:**需要 OPNET Development Kit
摘要
对指定子网中的节点执行自动布局,以尝试生成美观的拓扑布局。
语法
Ets_Layout_Subnet (mdl_hndl, subnet_hndl, layout_options)
| 参数 | 类型 | 说明 |
|---|---|---|
mdl_hndl |
EtsT_Model_Handle |
指定其子网内容正在被布局的模型。 |
subnet_hndl |
EtsT_Obj_Handle |
标识指定模型中内容将被重新排布的特定子网。 |
layout_options |
EtsT_Subnet_Layout_Options * |
指定用于控制布局过程的各类布局相关信息。 |
返回类型
void
无返回值。
头文件
ets_api_layout.h
详情
该函数对指定子网中的节点执行自动布局,以尝试生成美观的拓扑布局,并尽量减少边的交叉。作为参数传入的 layout_options 结构控制布局过程的若干细节,包括聚类、节点固定(pinning)、是否考虑图标尺寸,以及布局区域的边界。(该结构定义于 <install_dir>/sys/include/ets_api_layout.h。)
该函数根据子网中节点的数量使用两种布局算法之一。这些算法对应 View 菜单中可用的 “Lay Out Nodes (Balanced)“ 和 “Lay Out Nodes (Simple)“ 操作。
- 对于小型网络(节点数低于指定阈值),使用 balanced(均衡)算法。
- 对于大型网络,使用 simple(简单)算法。该算法产生的布局较为简单,但速度更快。
该阈值由 “network_layout.use_simple_threshold“ 偏好设置决定。
从高层看,布局有两种独立的模式:
- 对当前子网中的所有节点进行布局
- 对节点簇进行布局。聚类是一种将相关节点分组并将整组放置在子网内特定区域的方式。簇内的节点先相对彼此布局,然后各簇再相对其他簇进行布局。
要执行类型 1 的布局,调用者将布局选项的 cluster_lptr 字段设为 NULL。要执行类型 2 的布局,调用者创建 EtsT_Subnet_Layout_Cluster 数据结构的列表,并将布局选项的 cluster_lptr 字段设为该列表。
要指定所有子网内容应布局到的区域,设置 layout_in_specified_region 标志并定义未固定节点的布局区域(layout_area_ul_x 等)。
ETSC_API_SUBNET_LAYOUT_OPTIONS_DEFAULT 宏创建一个默认的布局选项结构,允许对模型当前子网内的所有节点进行非常简单的布局。