jupedsim.routing
#
Module Contents#
- class RoutingEngine(geometry: str | shapely.GeometryCollection | shapely.Polygon | shapely.MultiPolygon | shapely.MultiPoint | list[tuple[float, float]], **kwargs: Any)[source]#
RoutingEngine to compute the shortest paths with navigation meshes.
- Parameters:
geometry (str | shapely.GeometryCollection | shapely.Polygon | shapely.MultiPolygon | shapely.MultiPoint | list[tuple[float, float]]) –
kwargs (Any) –
- compute_waypoints(frm: tuple[float, float], to: tuple[float, float]) list[tuple[float, float]] [source]#
Computes shortest path between specified points.
- Parameters:
geometry –
Data to create the geometry out of. Data may be supplied as:
list of 2d points describing the outer boundary, holes may be added with use of excluded_areas kw-argument
GeometryCollection
consisting only out ofPolygons
,MultiPolygons
andMultiPoints
MultiPoint
forming a “simple” polygon when points are interpreted as linear ring without repetition of the start/end point.str with a valid Well Known Text. In this format the same WKT types as mentioned for the shapely types are supported: GEOMETRYCOLLETION, MULTIPOLYGON, POLYGON, MULTIPOINT. The same restrictions as mentioned for the shapely types apply.
frm (tuple[float, float]) – point from which to find the shortest path
to (tuple[float, float]) – point to which to find the shortest path
- Keyword Arguments:
excluded_areas – describes exclusions from the walkable area. Only use this argument if geometry was provided as list[tuple[float, float]].
- Returns:
List of points (path) from ‘frm’ to ‘to’ including from and to.
- Return type:
- is_routable(p: tuple[float, float]) bool [source]#
Tests if the supplied point is inside the underlying geometry.
- mesh() tuple[list[tuple[float, float]], list[list[int]]] [source]#
Access the navigation mesh geometry.
The navigation mesh is store as a collection of convex polygons in CCW order.
The returned data is to be interpreted as:
tuple[ list[tuple[float, float]], # All vertices in this mesh. list[ # List of polygons list[int] # List of indices into the vertices that compose this polygon in CCW order ] ]