3DStreet

3DStreet creates 3D visualizations of your 2D Streetmix.net streets using A-Frame and WebXR. Developers can use the same core street A-Frame component of 3DStreet for their own projects.

Online Tool

(or visit https://3dstreet.app)

Quick Start - How to make your own 3DStreet scene from Streetmix. See documentation here.

The rest of this README is for developers. User-facing docs are here.

This repo is the 3DStreet Core Viewer. It provides parsing of JSON in Streetmix format into a 3DStreet scene. It also provides all of the core components needed for viewers. It is also a core dependency of the 3DStreet Editor hosted in a separate repository.

Project Hosting Path

This repo's main branch is hosted via github pages at github.3dstreet.org. The 3DStreet Editor uses this path to fetch 3DStreet dependencies. A-Frame developers leveraging 3DStreet Core will also use this path.

A-Frame component

3DStreet is built upon a custom A-Frame street component which is also available for you to customize for your own custom A-Frame street scenes. The street component takes a string of JSON and renders one or more "segments" (also known as lanes or slices) of a street and optionally buildings and ground to the left and right.

Usage Example

  
    <title>Street Component!</title>
    
    
    
  
    
      
    
  

A-Frame street Component API

The street component creates a street made up of one or more segments as children of the entity it's attached to. It may also create buildings, ground, and place models in the scene using mixins. Creating the JSON array of segments by hand is cumbersome and typically the streetmix-loader component (below) is also used on the same entity to populate the street JSON from a Streetmix.net street.

A-Frame intersection Component API

The intersection component creates an intersection surface with options for adding curbs, sidewalks, crosswalks, stop signs, and traffic signals.

A-Frame streetmix-loader Component API

The streetmix-loader component requests a Streetmix API response when given a unique street URL and then passes the segments array JSON as a string to the street component (which is a dependency -- you must have the street component on the same entity as that of the streetmix-loader component).

Either 1 of the 2 properties are required. If both are provided the component will use streetmixAPIURL value and ignore streetmixStreetURL.

Orientation and Scale

A default Streetmix.net cross-section view is oriented to show vehicles heading away from you as "outbound". The street component follows this convention and when placed in a new A-Frame scene the default camera is looking toward the outbound direction of the generated street. The default rendering is 1:1 scale.

Automatic Asset Loading

When aframe-street-component.js is included on a page it automatically loads 3D models and other assets using the A-Frame asset loader by adding them to the scene's a-assets block and defining mixins pointing to these assets. The street component itself simply places entities with appropriate mixin names. For more information on the asset loader see this docs link.

Additional variant strings

• The word animated can be added to the variantString of the type sidewalk to make the pedestrians animated. Here is an example of how this can be implemented:

{
  "width": 9,
  "variantString": "normal|animated",
  "type": "sidewalk"
}

Please see animated.html for a demo.

List of Supported Segment Types

3DStreet does not yet support all of the street segments found in Streetmix. You may find some segments don't display at all or are missing 3D elements. Here is a complete list:

List of Building Variants

"Buildings" are lots and/or objects rendered on either side of the street to add to the setting.

License

The 3DStreet codebase is offered under the GNU Affero General Public License v3, as specified in the LICENSE file.

Assets such as 3D models, textures, and audio are offered under the Creative Commons By Attribution Non-Commercial License, unless a more specific license is specified for each asset in the documentation on this page.

Contact kieran@3dstreet.org for commercial licensing.

Developer Docs

See this link for more information about the custom components developed and modified for the project.

Model Credits

• Creative Commons Google Poly
• Some city / car models https://sketchfab.com/3d-models/polygon-city-pack-preview-5a16f543d1054fbc9ce1cb17a2ba412e
• Some road textures https://www.textures.com/download/roads0086/44877 https://www.textures.com/download/roads0122/55065
• Sidewalk textures https://www.textures.com/download/floorsregular0299/87153 https://www.textures.com/download/floorsregular0301/87158
• Fence model https://sketchfab.com/3d-models/chainlink-fence-low-poly-50901b0cc91b4e04a18ecd13bc379a90
• Bus stop, creative commons https://poly.google.com/view/7iBPwMlmfge
• Do something with this adorable train: https://sketchfab.com/3d-models/tram-and-rails-modular-4168da5a8b884171b4540dd33eb05ef2
• Trolley: https://sketchfab.com/3d-models/neighborhood-trolley-3bc683cca6b84d8985cc0befe710b8fa

Audio Credits

• wide, narrow urban building variants: Ambient SF https://www.soundsnap.com/ssl_16_11_amb_ext_afternoon_alamo_square_painted_houses_park_with_birds_some_people_around_calm_city_san_francisco_st_wav
• fence, grass variants - AMB_Suburbs_Afternoon_Woods_Spring_Small Field_Bird Chirps_Low Car Rumbles_Grass_Leaves Rustle_ST_MKH8050-30.mp3
• parking-lot variant - "Parking lot ambience - long - looping.mp3" https://www.soundsnap.com/parking_lot_ambience_long_looping_wav
• waterfront variant - UKdock4.mp3 - https://www.soundsnap.com/ukdock4
• waterfront variant - Water pier underneath small waves distant traffic ambience_BLASTWAVEFX_31752.mp3 - https://www.soundsnap.com/node/96455
• residential (suburban) variant - lawn mower, etc. - AMB_Suburbs_Spring_Day_Distant Lawnmowers_Birds_Distant Traffic_Distant Plastic Windmill Spin_Truck Pass By_Plane Overhead_MS_ST_MKH8050-30.mp3 https://www.soundsnap.com/amb_suburbs_spring_day_distant_lawnmowers_birds_distant_traffic_distant_plastic_windmill_spin_truck_pass_by_plane_overhead_ms_st
• Diesel idling bus https://www.soundsnap.com/turbodiesel_bus_riding_and_idling
• Tram pass https://www.soundsnap.com/tram_pass_by_fast_wav
• Historic streetcar pass https://www.soundsnap.com/streetcar_passing_by_smoothly

Skybox credits

• Most skybox images (c) Polyhaven CC0 license polyhaven.com individual credits