<linkrel="alternate icon"type="image/png"href="../favicon-32x32.png"><styletype="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><bodyclass="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><ahref='../map_model/index.html'><divclass='logo-container rust-logo'><imgsrc='../rust-logo.png'alt='logo'></div></a><pclass="location">Crate map_model</p><divclass="block version"><p>Version 0.1.0</p></div><divclass="sidebar-elems"><aid="all-types"href="all.html"><p>See all map_model's items</p></a><divclass="block items"><ul><li><ahref="#modules">Modules</a></li><li><ahref="#structs">Structs</a></li><li><ahref="#enums">Enums</a></li><li><ahref="#constants">Constants</a></li></ul></div><pclass="location"></p><script>window.sidebarCurrent={name:"map_model",ty:"mod",relpath:"../"};</script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"><imgsrc="../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-choices"role="menu"></div></div><scriptsrc="../theme.js"></script><navclass="sub"><formclass="search-form"><divclass="search-container"><div><selectid="crate-search"><optionvalue="All crates">All crates</option></select><inputclass="search-input"name="search"disabledautocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"></div><spanclass="help-button">?</span>
<aid="settings-menu"href="../settings.html"><imgsrc="../wheel.svg"width="18"alt="Change settings"></a></div></form></nav><sectionid="main"class="content"><h1class="fqn"><spanclass="out-of-band"><spanid="render-detail"><aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass="inner">−</span>]</a></span><aclass="srclink"href="../src/map_model/lib.rs.html#1-118"title="goto source code">[src]</a></span><spanclass="in-band">Crate <aclass="mod"href="">map_model</a></span></h1><divclass="docblock"><p><code>map_model</code> describes the world where simulations occur. Importing a map from OSM partly happens
<li>ch = contraction hierarchy, for speeding up pathfinding</li>
<li>degenerate intersection = only has 2 roads connected, so why is it an intersection at all?</li>
<li>lc = lane-change (which is modelled very strangely: <ahref="https://dabreegster.github.io/abstreet/trafficsim/discrete_event.html#lane-changing">https://dabreegster.github.io/abstreet/trafficsim/discrete_event.html#lane-changing</a>)</li>
<li>ltr = left-to-right, the order of lanes for a road</li>
<li>osm = OpenStreetMap</li>
</ul>
<p>Map objects are usually abbreviated in method names:</p>
<table><trclass="module-item"><td><aclass="mod"href="city/index.html"title="map_model::city mod">city</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="mod"href="connectivity/index.html"title="map_model::connectivity mod">connectivity</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="mod"href="edits/index.html"title="map_model::edits mod">edits</a></td><tdclass="docblock-short"><p>Once a Map exists, the player can edit it in the UI (producing <code>MapEdits</code> in-memory), then save
</td></tr><trclass="module-item"><td><aclass="mod"href="make/index.html"title="map_model::make mod">make</a></td><tdclass="docblock-short"><p>See <ahref="https://dabreegster.github.io/abstreet/map/importing/index.html">https://dabreegster.github.io/abstreet/map/importing/index.html</a> for an overview. This module
</td></tr><trclass="module-item"><td><aclass="mod"href="map/index.html"title="map_model::map mod">map</a></td><tdclass="docblock-short"><p>A bunch of (mostly read-only) queries on a Map.</p>
</td></tr><trclass="module-item"><td><aclass="mod"href="objects/index.html"title="map_model::objects mod">objects</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="mod"href="osm/index.html"title="map_model::osm mod">osm</a></td><tdclass="docblock-short"><p>Useful utilities for working with OpenStreetMap.</p>
</td></tr><trclass="module-item"><td><aclass="mod"href="pathfind/index.html"title="map_model::pathfind mod">pathfind</a></td><tdclass="docblock-short"><p>Everything related to pathfinding through a map for different types of agents.</p>
</td></tr><trclass="module-item"><td><aclass="mod"href="raw/index.html"title="map_model::raw mod">raw</a></td><tdclass="docblock-short"><p>The convert_osm crate produces a RawMap from OSM and other data. Storing this intermediate
<table><trclass="module-item"><td><aclass="struct"href="struct.AccessRestrictions.html"title="map_model::AccessRestrictions struct">AccessRestrictions</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.Amenity.html"title="map_model::Amenity struct">Amenity</a></td><tdclass="docblock-short"><p>A business located inside a building.</p>
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.Area.html"title="map_model::Area struct">Area</a></td><tdclass="docblock-short"><p>Areas are just used for drawing.</p>
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.AreaID.html"title="map_model::AreaID struct">AreaID</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.Building.html"title="map_model::Building struct">Building</a></td><tdclass="docblock-short"><p>A building has connections to the road and sidewalk, may contain commercial amenities, and have
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.BuildingID.html"title="map_model::BuildingID struct">BuildingID</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.BusRoute.html"title="map_model::BusRoute struct">BusRoute</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.BusRouteID.html"title="map_model::BusRouteID struct">BusRouteID</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.BusStop.html"title="map_model::BusStop struct">BusStop</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.BusStopID.html"title="map_model::BusStopID struct">BusStopID</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.City.html"title="map_model::City struct">City</a></td><tdclass="docblock-short"><p>A single city (like Seattle) can be broken down into multiple boundary polygons (udistrict,
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.CompressedMovementID.html"title="map_model::CompressedMovementID struct">CompressedMovementID</a></td><tdclass="docblock-short"><p>This is cheaper to store than a MovementID. It simply indexes into the list of movements.</p>
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.ControlStopSign.html"title="map_model::ControlStopSign struct">ControlStopSign</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.ControlTrafficSignal.html"title="map_model::ControlTrafficSignal struct">ControlTrafficSignal</a></td><tdclass="docblock-short"><p>A traffic signal consists of a sequence of Stages that repeat in a cycle. Most Stages last for a
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.DirectedRoadID.html"title="map_model::DirectedRoadID struct">DirectedRoadID</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.EditEffects.html"title="map_model::EditEffects struct">EditEffects</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.EditRoad.html"title="map_model::EditRoad struct">EditRoad</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.Intersection.html"title="map_model::Intersection struct">Intersection</a></td><tdclass="docblock-short"><p>An intersection connects roads. Most have >2 roads and are controlled by stop signs or traffic
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.IntersectionCluster.html"title="map_model::IntersectionCluster struct">IntersectionCluster</a></td><tdclass="docblock-short"><p>This only applies to VehiclePathfinder; walking through these intersections is nothing special.</p>
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.IntersectionID.html"title="map_model::IntersectionID struct">IntersectionID</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.Lane.html"title="map_model::Lane struct">Lane</a></td><tdclass="docblock-short"><p>A road segment is broken down into individual lanes, which have a LaneType.</p>
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.LaneID.html"title="map_model::LaneID struct">LaneID</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.Map.html"title="map_model::Map struct">Map</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.MapConfig.html"title="map_model::MapConfig struct">MapConfig</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.MapEdits.html"title="map_model::MapEdits struct">MapEdits</a></td><tdclass="docblock-short"><p>Represents changes to a map. Note this isn't serializable -- that's what <code>PermanentMapEdits</code>
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.Movement.html"title="map_model::Movement struct">Movement</a></td><tdclass="docblock-short"><p>A Movement groups all turns from one road to another, letting traffic signals operate at a
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.MovementID.html"title="map_model::MovementID struct">MovementID</a></td><tdclass="docblock-short"><p>One road usually has 4 crosswalks, each a singleton Movement. We need all of the information
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.NamePerLanguage.html"title="map_model::NamePerLanguage struct">NamePerLanguage</a></td><tdclass="docblock-short"><p>None corresponds to the native name</p>
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.ParkingLot.html"title="map_model::ParkingLot struct">ParkingLot</a></td><tdclass="docblock-short"><p>Parking lots have some fixed capacity for cars, and are connected to a sidewalk and road.</p>
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.ParkingLotID.html"title="map_model::ParkingLotID struct">ParkingLotID</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.Path.html"title="map_model::Path struct">Path</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.PathRequest.html"title="map_model::PathRequest struct">PathRequest</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.PermanentMapEdits.html"title="map_model::PermanentMapEdits struct">PermanentMapEdits</a></td><tdclass="docblock-short"><p>MapEdits are converted to this before serializing. Referencing things like LaneID in a Map won't
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.Position.html"title="map_model::Position struct">Position</a></td><tdclass="docblock-short"><p>Represents a specific point some distance along a lane.</p>
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.Road.html"title="map_model::Road struct">Road</a></td><tdclass="docblock-short"><p>A Road represents a segment between exactly two Intersections. It contains Lanes as children.</p>
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.RoadID.html"title="map_model::RoadID struct">RoadID</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.RoadWithStopSign.html"title="map_model::RoadWithStopSign struct">RoadWithStopSign</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.Stage.html"title="map_model::Stage struct">Stage</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.Turn.html"title="map_model::Turn struct">Turn</a></td><tdclass="docblock-short"><p>A Turn leads from the end of one Lane to the start of another. (Except for pedestrians;
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.TurnID.html"title="map_model::TurnID struct">TurnID</a></td><tdclass="docblock-short"><p>Turns are uniquely identified by their (src, dst) lanes and their parent intersection.
</td></tr><trclass="module-item"><td><aclass="struct"href="struct.UberTurn.html"title="map_model::UberTurn struct">UberTurn</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.UberTurnGroup.html"title="map_model::UberTurnGroup struct">UberTurnGroup</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="struct"href="struct.Zone.html"title="map_model::Zone struct">Zone</a></td><tdclass="docblock-short"><p>A contiguous set of roads with access restrictions. This is derived from all the map's roads and
<table><trclass="module-item"><td><aclass="enum"href="enum.AmenityType.html"title="map_model::AmenityType enum">AmenityType</a></td><tdclass="docblock-short"><p>Businesses are categorized into one of these types.</p>
</td></tr><trclass="module-item"><td><aclass="enum"href="enum.AreaType.html"title="map_model::AreaType enum">AreaType</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="enum"href="enum.BuildingType.html"title="map_model::BuildingType enum">BuildingType</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="enum"href="enum.Direction.html"title="map_model::Direction enum">Direction</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="enum"href="enum.DrivingSide.html"title="map_model::DrivingSide enum">DrivingSide</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="enum"href="enum.EditCmd.html"title="map_model::EditCmd enum">EditCmd</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="enum"href="enum.EditIntersection.html"title="map_model::EditIntersection enum">EditIntersection</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="enum"href="enum.IntersectionType.html"title="map_model::IntersectionType enum">IntersectionType</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="enum"href="enum.LaneType.html"title="map_model::LaneType enum">LaneType</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="enum"href="enum.OffstreetParking.html"title="map_model::OffstreetParking enum">OffstreetParking</a></td><tdclass="docblock-short"><p>Represent no parking as Private(0, false).</p>
</td></tr><trclass="module-item"><td><aclass="enum"href="enum.PathConstraints.html"title="map_model::PathConstraints enum">PathConstraints</a></td><tdclass="docblock-short"><p>Who's asking for a path?</p>
</td></tr><trclass="module-item"><td><aclass="enum"href="enum.PathStep.html"title="map_model::PathStep enum">PathStep</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="enum"href="enum.StageType.html"title="map_model::StageType enum">StageType</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="enum"href="enum.Traversable.html"title="map_model::Traversable enum">Traversable</a></td><tdclass="docblock-short"><p>Either a lane or a turn, where most movement happens.</p>
<table><trclass="module-item"><td><aclass="constant"href="constant.NORMAL_LANE_THICKNESS.html"title="map_model::NORMAL_LANE_THICKNESS constant">NORMAL_LANE_THICKNESS</a></td><tdclass="docblock-short"></td></tr><trclass="module-item"><td><aclass="constant"href="constant.PARKING_LOT_SPOT_LENGTH.html"title="map_model::PARKING_LOT_SPOT_LENGTH constant">PARKING_LOT_SPOT_LENGTH</a></td><tdclass="docblock-short"><p>From some manually audited cases in Seattle, the length of parallel street parking spots is a
bit different than the length in parking lots, so set a different value here.</p>
