拓扑路径

样例：

createTopology

创建 topology 对象。

定义：

interface TopologyEffectInfo {
  //
  renderLink?: boolean;
  linkWidth?: number;
  linkColor?: IColor | IColor[];
  //
  renderNode?: boolean;
  nodeColor?: IColor;
  nodeRadius?: number;
  //
  imgUrl?: LinkInfo['imgUrl'];
  animation?: LinkInfo['animation'];
}

type TopologyType = 'line' | 'network';

interface TopologyNodeInfo {
  id: BaseObject3DInfo['id'];
  name?: BaseObject3DInfo['name'];
  position: Position;
  graphs?: TopologyNodeGraph[];
}

interface TopologyNodeGraph {
  targetNodeId: string;
  linkInfo: {
    id: string;
    name?: string;
  };
  passable: number;
}

interface TopologyInfo extends BaseObject3DInfo, TopologyEffectInfo {
  type: TopologyType;
  nodes: TopologyNodeInfo[];
}

function createTopology(topologyInfo: TopologyInfo): Topology;

用法：

const topology = ssp.createTopology({
  id: 'topology_1',
  name: 'topology_1_name',
  type: 'line',
  nodes: [
    {
      id: 'node1',
      position: { x: 0, y: 1, z: 0 },
    },
    {
      id: 'node2',
      position: { x: 0, y: 1, z: 100 },
    },
    {
      id: 'node3',
      position: { x: 100, y: 1, z: 100 },
    },
    {
      id: 'node4',
      position: { x: 100, y: 1, z: -100 },
    },
  ],
  renderNode: true,
});

参数：

topologyInfo

描述: 实例路径对象所需信息
类型: TopologyInfo
必填:

TopologyInfo

属性	描述	类型	默认值
id	唯一ID	string \| number
name	名称	string
nodes	节点坐标集合	TopologyNodeInfo[]
type	路径类型	line \| network
renderLink	是否渲染连接线	boolean	true
linkWidth	线宽	number	20
linkColor	连接线颜色	IColor ｜ IColor[]	0x00ff00
renderNode	是否渲染节点	boolean	true
nodeColor	节点颜色	IColor	0x0000ff
nodeRadius	节点半径	numbers	10
imgUrl	非纯色线时使用的图片资源路径	string	null
animation	非纯色线时的流动动画	boolean \| AnimationOptions	false
level	显示层级范围	Level	{ max: null, min: null }
visible	是否可见	boolean	true
position	位置坐标	Position	{ x: 0, y: 0, z: 0 }
rotation	旋转弧度	Rotation	{ x: 0, y: 0, z: 0 }
scale	缩放比例	Scale	{ x: 1, y: 1, z: 1 }
userData	用户数据	any	{}

linkColor 为数组时，有效长度是 4 个，分别对应 passable 的四个状态时路径颜色；为单个颜色时，表示所有路径颜色。

TopologyNodeInfo

属性	描述	类型
id	节点唯一ID	string \| number
name	节点名称	string
position	节点坐标	Position
graphs	网结构信息	TopologyNodeGraph[]

TopologyNodeGraph

属性	描述	类型
targetNodeId	目标 node ID	string \| number
linkInfo	路径信息	{ id: string, name?: string }
passable	路径通行许可	0 \| 1 \| 2 \| 3

passable 的枚举含义分别为：双向通行（0）｜单向正向通行（1）｜单向反向通行（2）｜禁止通行（3）

注意

此处的 passable 数据是配合 linkColor 使用，直接设置无法影响 getShortestPath 等方法的结果

需要动态设置链路的通行属性请使用 setTopologyPassable 方法

setTopologyPassable

样例

定义：

interface TopologyPassableInfo {
  sourceNodeId: BaseObject3DInfo['id'];
  targetNodeId: BaseObject3DInfo['id'];
  passable: number;
}

function setTopologyPassable(topology: Topology, info: TopologyPassableInfo[]): void;

用法：

ssp.setTopologyPassable(topology, [
  {
    sourceNodeId: '8NM2FFLB40ZD',
    targetNodeId: '8NM2Z1GHW1OK',
    /**
     * 禁止通行，当使用 getShortestPath 等方法时会避开此链路
     */
    passable: 3,
  },
]);

参数：

topology

描述: 拓扑路径对象
类型: Topology
必填:

info

描述: 最短路径信息
类型: TopologyPassableInfo[]
必填:

属性	描述	类型
sourceNodeId	原始节点id	string \| number
targetNodeId	目标节点id	string \| number
passable	路径通行许可	0 \| 1 \| 2 \| 3

passable 的枚举含义分别为：双向通行（0）｜单向正向通行（1）｜单向反向通行（2）｜禁止通行（3）

提示

如果需要获取拓扑路径中的 node 对象时，可临时绑定一个点击事件

ssp.signals.click.add((event) => {
  const [intersect] = ssp.viewport.getIntersects(event, topology.nodes);

  if (intersect) {
    console.log('node对象 id', intersect.object.sid);
  }
});

getShortestPath

获取最短路径

定义：

interface ShortestPathInfo extends BaseObject3DInfo, TopologyEffectInfo {
  start: Position;
  end: Position;
}

function getShortestPath(topology: Topology, info: ShortestPathInfo): Topology | null;

用法：

const shortestTopology = ssp.getShortestPath(topologyFromOther, {
  start: { x: 0, y: 0, z: 0 },
  end: { x: 100, y: 0, z: 300 },
  id: 'shortestPath',
  linkColor: 'red',
  nodeColor: 'orange',
  imgUrl: '../../asstes/img/topology/arrow.png',
  animation: true,
});

参数：

topology

描述: 拓扑路径对象
类型: Topology
必填:

info

描述: 最短路径信息
类型: ShortestPathInfo
必填:

属性	描述	类型	必填	默认值
start	路径的起始点（世界位置）	Position
end	路径的结束点（世界位置）	Position

部分配置参考 TopologyInfo

getShortestPathAsync

同 getShortestPath，但是内部计算使用 WebWorker，用于异步获取最短路径。

定义：

function getShortestPathAsync(topology: Topology, info: ShortestPathInfo): Promise<Topology | null>;

用法：

const shortestTopology = await ssp.getShortestPathAsync(topologyFromOther, {
  start: { x: 0, y: 0, z: 0 },
  end: { x: 100, y: 0, z: 300 },
  id: 'shortestPath',
  linkColor: 'red',
  nodeColor: 'orange',
  imgUrl: '../../asstes/img/topology/arrow.png',
  animation: true,
});

提示

支持 4 个 worker 线程同时计算。

getShortestPathByMultipleStartPoints

通过指定多个起点和一个终点，并计算每个起点与终点间的最短路径，然后再从这些最短路径中找出最短的那条作为最终的路径并返回。

定义：

interface ShortestPathByMultipleStartPoints extends BaseObject3DInfo, TopologyEffectInfo {
  start: Position[];
  end: Position;
}

function getShortestPathByMultipleStartPoints(
  topology: Topology,
  info: ShortestPathByMultipleStartPoints
): Topology | null;

用法：

const shortestTopology = ssp.getShortestPathByMultipleStartPoints(topologyFromOther, {
  start: [
    { x: 0, y: 0, z: 0 },
    { x: 20, y: 0, z: 0 },
  ],
  end: { x: 100, y: 0, z: 300 },
  id: 'shortestPath',
  linkColor: 'red',
  nodeColor: 'orange',
  imgUrl: '../../asstes/img/topology/arrow.png',
  animation: true,
});

参数：

topology

描述: 拓扑路径对象
类型: Topology
必填:

info

描述: 多起点最短路径信息
类型: ShortestPathByMultipleStartPoints
必填:

属性	描述	类型	必填	默认值
start	路径的起始点（世界位置）	Position[]
end	路径的结束点（世界位置）	Position

部分配置参考 TopologyInfo

getShortestPathByMultipleStartPointsAsync

同 getShortestPathByMultipleStartPoints，但是内部计算使用 WebWorker，用于异步获取最短路径。

定义：

function getShortestPathByMultipleStartPointsAsync(
  topology: Topology,
  info: ShortestPathByMultipleStartPoints
): Promise<Topology | null>;

用法：

const shortestTopology = await ssp.getShortestPathByMultipleStartPointsAsync(topologyFromOther, {
  start: [
    { x: 0, y: 0, z: 0 },
    { x: 20, y: 0, z: 0 },
  ],
  end: { x: 100, y: 0, z: 300 },
  id: 'shortestPath',
  linkColor: 'red',
  nodeColor: 'orange',
  imgUrl: '../../asstes/img/topology/arrow.png',
  animation: true,
});

getShortestPathByMultipleEndPoints

通过指定一个起点和多个终点，并计算这个起点与每个终点间的最短路径，然后再从这些最短路径中找出最短的那条作为最终的路径并返回。

定义：

interface ShortestPathByMultipleEndPoints extends BaseObject3DInfo, TopologyEffectInfo {
  start: Position;
  end: Position[];
}

function getShortestPathByMultipleEndPoints(topology: Topology, info: ShortestPathByMultipleEndPoints): Topology | null;

用法：

const shortestTopology = ssp.getShortestPathByMultipleEndPoints(topologyFromOther, {
  start: { x: 0, y: 0, z: 0 },
  end: [
    { x: 100, y: 0, z: 300 },
    { x: 200, y: 0, z: 400 },
  ],
  id: 'shortestPath',
  linkColor: 'red',
  nodeColor: 'orange',
  imgUrl: '../../asstes/img/topology/arrow.png',
  animation: true,
});

参数：

topology

描述: 拓扑路径对象，一般是从 gml 文件加载的拓扑路径图
类型: Topology
必填:

info

描述: 多终点最短路径信息
类型: ShortestPathByMultipleEndPoints
必填:

属性	描述	类型	必填	默认值
start	路径的起始点（世界位置）	Position
end	路径的结束点（世界位置）	Position[]

部分配置参考 TopologyInfo

getShortestPathByMultipleEndPointsAsync

同 getShortestPathByMultipleEndPoints，但是内部计算使用 WebWorker，用于异步获取最短路径。

定义：

function getShortestPathByMultipleEndPointsAsync(
  topology: Topology,
  info: ShortestPathByMultipleEndPoints
): Promise<Topology | null>;

用法：

const shortestTopology = await ssp.getShortestPathByMultipleEndPointsAsync(topologyFromOther, {
  start: { x: 0, y: 0, z: 0 },
  end: [
    { x: 100, y: 0, z: 300 },
    { x: 200, y: 0, z: 400 },
  ],
  id: 'shortestPath',
  linkColor: 'red',
  nodeColor: 'orange',
  imgUrl: '../../asstes/img/topology/arrow.png',
  animation: true,
});

getTopologyById

通过 id 查找

定义：

function getTopologyById(id: TopologyInfo['id']): Topology | null;

用法：

const topology = ssp.getTopologyById('xxx');

弃用警告

请使用 getObjectById 替代

getTopologyByName

通过 name 查找

定义：

function getTopologyByName(name: string): Topology[];

用法：

const topologyList = ssp.getTopologyByName('xxx');

弃用警告

请使用 getObjectByName 替代

getAllTopology

获取所有 Topology 对象

定义：

function getAllTopology(): Topology[];

用法：

const allTopologyList = ssp.getAllTopology();

getTopologyByUserDataProperty

通过 userData 属性查找

定义：

function getTopologyByUserDataProperty(propNameOrFindFunc: string | UserDataPropertyFindFunc, value?: any): Topology[];

用法：

const topologyList = ssp.getTopologyByUserDataProperty('propKey'， 'propVal')
// or
const topologyList = ssp.getTopologyByUserDataProperty(item => item['itemPropKey'] === 'itemPropVal')

参数：

propNameOrFindFunc

描述: userData 内属性名或 find 函数
类型: string | function
必填:

propValue

描述: userData 内属性值。
类型: any
必填:

find 函数使用场景

topology.userData = {
  people: {
    name: 'xiaoming',
    age: 18,
  },
};
const topologyList = ssp.getTopologyByUserDataProperty((userData) => userData?.people?.name === 'xiaoming');

弃用警告

请使用 getObjectByUserDataProperty 替代

removeTopologyById

通过 id 移除

定义：

function removeTopologyById(id: TopologyInfo['id']): boolean;

用法：

ssp.removeTopologyById('xxx');

弃用警告

请使用 removeObjectById 替代

createTopologyToGroup

创建 topology 到一个组内。

定义：

function createTopologyToGroup(groupInfo: GroupInfo, topologyInfoList: TopologyInfo[]): Group;

用法：

ssp.createTopologyToGroup(
  // groupInfo
  {
    id: 'firstTopologyGroup',
    name: 'name_firstTopologyGroup',
    // ...
  },
  // topologyInfoList
  [topologyInfo1, topologyInfo2, topologyInfo3]
);

参数

groupInfo

描述: 实例组对象所需信息
类型: GroupInfo
必填:

topologyInfoList

描述: topologyInfo 集合
类型: TopologyInfo[]
必填:

createTopologyFromGml

创建 Topology 组，从 gml 文件资源。

定义：

interface TopologyInfoForGml extends BaseObject3DInfo {
  url: string;
  id: BaseObject3DInfo['id'];
  name?: BaseObject3DInfo['name'];
  linkWidth?: number;
  linkColor?: IColor;
  renderNode?: boolean;
  nodeColor?: IColor;
}

function createTopologyFromGml(topologyInfo: TopologyInfoForGml): Promise<Topology>;

用法：

ssp
  .createTopologyFromGml({
    url: './tuobutujinzui.gml',
    id: 'gml_for_topology',
    name: 'gml_for_topology_name',
    linkWidth: 100,
    linkColor: 'blue',
    renderNode: true,
    nodeColor: 'green',
  })
  .then((topology) => {
    console.log(topology);
  });

参数

topologyInfo

描述: topologyInfo 对象
类型: TopologyInfoForGml
必填:

TopologyInfoForGml

属性	描述	类型	默认值
url	gml 资源路径	string
id	路径对象唯一ID	string
name	路径对象名称	string
linkWidth	路径线宽	number	20
linkColor	路径线颜色	IColor	0x00ff00
renderNode	是否渲染路径节点	boolean	true
nodeColor	节点颜色	IColor	0x0000ff

createGroupForTopology

为 topology 提前创建一个空组。

使用场景

与 createTopologyToGroup 不同，有些时候可能你还没有具体的 topologyInfo 数据，但你想提前创建一个批量管理的空组，当有数据时再使用 addTopologyForGroup 插入。

定义：

function createGroupForTopology(groupInfo: GroupInfo): Group;

用法：

ssp.createGroupForTopology({
  id: 'firstTopologyGroup',
  name: 'name_firstTopologyGroup',
  // ...
});

参数

groupInfo

描述: 实例组对象所需信息
类型: GroupInfo
必填:

弃用警告

请使用 createGroup 替代

addTopologyForGroup

向一个已经存在的组内添加 topology 对象。

定义：

function addTopologyForGroup(groupId: GroupInfo['id'], topologyInfoList: TopologyInfo[]): Group | null;

用法：

ssp.addTopologyForGroup(
  // groupId
  'firstTopologyGroup',
  // topologyInfoList
  [topologyInfo4, topologyInfo5]
);

参数

groupId

描述: 组 id
类型: groupId[‘id’]
必填:

topologyInfoList

描述: topologyInfo 集合
类型: topologyinfo[]
必填:

getTopologyGroupById

通过 id 查找 topology 组

定义：

function getTopologyGroupById(id: GroupInfo['id']): Group | null;

用法：

const group = ssp.getTopologyGroupById('firstTopologyGroup');

弃用警告

请使用 getObjectById 替代

getTopologyGroupByName

通过 name 查找 topology 组

定义：

function getTopologyGroupByName(name: string): Group[];

用法：

const groupList = ssp.getTopologyGroupByName('name_firstTopologyGroup');

弃用警告

请使用 getObjectByName 替代

getAllTopologyGroup

获取所有 Topology 对象组

定义：

function getAllTopologyGroup(): Group[];

用法：

const allTopologyGroupList = ssp.getAllTopologyGroup();

弃用警告

请使用 getAllGroup 替代

removeTopologyGroupById

通过 id 移除 topology 组

定义：

function removeTopologyGroupById(id: GroupInfo['id']): boolean;

用法：

const isRemoveSuccess = ssp.removeTopologyGroupById('firstTopologyGroup');

弃用警告

请使用 removeObjectById 替代

clearTopology

清除当前场景内所有 topology 对象。

定义：

function clearTopology(): void;

用法：

ssp.clearTopology();

showAllTopology

显示当前场景内所有 topology 对象。

定义：

function showAllTopology(): void;

用法：

ssp.showAllTopology();

hideAllTopology

隐藏当前场景内所有 topology 对象。

定义：

function hideAllTopology(): void;

用法：

ssp.hideAllTopology();

拓扑路径 ​

样例： ​

createTopology ​

定义： ​

用法： ​

参数： ​

topologyInfo ​

TopologyInfo ​

TopologyNodeInfo ​

TopologyNodeGraph ​

setTopologyPassable ​

样例 ​

定义： ​

用法： ​

参数： ​

topology ​

info ​

getShortestPath ​

定义： ​

用法： ​

参数： ​

topology ​

info ​

getShortestPathAsync ​

定义： ​

用法： ​

getShortestPathByMultipleStartPoints ​

定义： ​

用法： ​

参数： ​

topology ​

info ​

getShortestPathByMultipleStartPointsAsync ​

定义： ​

用法： ​

getShortestPathByMultipleEndPoints ​

定义： ​

用法： ​

参数： ​

topology ​

info ​

getShortestPathByMultipleEndPointsAsync ​

定义： ​

用法： ​

getTopologyById ​

定义： ​

用法： ​

getTopologyByName ​

定义： ​

用法： ​

getAllTopology ​

定义： ​

用法： ​

getTopologyByUserDataProperty ​

定义： ​

用法： ​

参数： ​

propNameOrFindFunc ​

propValue ​

removeTopologyById ​

定义： ​

用法： ​

createTopologyToGroup ​

定义： ​

用法： ​

参数 ​

groupInfo ​

topologyInfoList ​

createTopologyFromGml ​

定义： ​

用法： ​

参数 ​

topologyInfo ​

TopologyInfoForGml ​

createGroupForTopology ​

定义： ​

用法： ​

参数 ​

groupInfo ​

addTopologyForGroup ​

拓扑路径

样例：

createTopology

定义：

用法：

参数：

topologyInfo

TopologyInfo

TopologyNodeInfo

TopologyNodeGraph

setTopologyPassable

样例

定义：

用法：

参数：

topology

info

getShortestPath

定义：

用法：

参数：

topology

info

getShortestPathAsync

定义：

用法：

getShortestPathByMultipleStartPoints

定义：

用法：

参数：

topology

info

getShortestPathByMultipleStartPointsAsync

定义：

用法：

getShortestPathByMultipleEndPoints

定义：

用法：

参数：

topology

info

getShortestPathByMultipleEndPointsAsync

定义：

用法：

getTopologyById

定义：

用法：

getTopologyByName

定义：

用法：

getAllTopology

定义：

用法：

getTopologyByUserDataProperty

定义：

用法：

参数：

propNameOrFindFunc

propValue

removeTopologyById

定义：

用法：

createTopologyToGroup

定义：

用法：

参数

groupInfo

topologyInfoList

createTopologyFromGml

定义：

用法：

参数

topologyInfo

TopologyInfoForGml

createGroupForTopology

定义：

用法：

参数

groupInfo

addTopologyForGroup