Skip to content

Commit

Permalink
remove productized features from alpha labs
Browse files Browse the repository at this point in the history
also remove beta description
  • Loading branch information
kfarr committed Dec 10, 2024
1 parent 84a677f commit f09d299
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 43 deletions.
8 changes: 4 additions & 4 deletions docs/3dstreet-editor/saving-and-loading-scenes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ sidebar_position: 5

You can save and load scenes with a 3DStreet Cloud account. So that you don't have to create a new password, and so that we don't have to store it, we use a third-party provider Google Sign-in for account access.

## Beta software

3DStreet is "[beta](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta) software" in active development and may not behave as expected. As we continue improving the product, we do our best ensure backward compatibility so that your 3DStreet data remains useable, but you may experience data loss. In using these features, you understand that you use this application at your own risk including your acceptance of the liability of potential data loss per the terms of the [License](https://github.com/3DStreet/3dstreet/blob/main/LICENSE) that we use to make 3DStreet available to you.

## File export options
In addition to saving and sharing files with 3DStreet Cloud, you can instantly export your 3DStreet scene as a downloadable file in your browser.

* Editable 3DStreet JSON Files - You can save and load scenes using 3DStreet JSON files ending in `.3dstreet.json` extension. These files contain layers, entities and components that make up your street scene in JavaScript notation. This is the same JSON format used in 3DStreet Cloud but made available as a file that you can save and store locally. Usually you can continue editing a 3DStreet JSON file after reloading it in a future session.
* Read-only glTF Scene Files - You can also export scenes in the glTF graphics transmission files ending in `.glb` extension. These files can be used by other 3D applications such as Blender, Unreal or Unity. This is a binary file and is not editable again by 3DStreet Editor in future sessions.

## Terms of use

In using 3DStreet Cloud features, you understand that you use this application at your own risk including your acceptance of the liability of potential data loss per the terms of the [License](https://github.com/3DStreet/3dstreet/blob/main/LICENSE) that we use to make 3DStreet available to you.

## Feedback on saving and loading scenes

We're open to suggestions on alternate account creation and access methods for 3DStreet scenes. [Join our Discord server](https://discord.com/invite/VN242sx9qu) or [suggest an issue](https://github.com/3dstreet/3dstreet/issues/new) on our GitHub repos accessed via the links in the footer below.
40 changes: 1 addition & 39 deletions docs/development/alpha-labs.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,44 +22,6 @@ Save a backup of your scene before trying these "Alpha Labs" experiments. 3DStre
![Screenshot of editor changing street length.](/img/docs/alpha/edit-street-length.jpg)


## Adding and editing an intersection

1) Add a new Intersection using the Pro add entity bottom panel. The Intersection will instantiate with default settings
2) In the Layers left panel select the new "Intersection 90º" layer you created
3) Open the right-hand panel and scroll down to "Intersection" and click the down arrow

![Screenshot of editor adding, selecting and editing intersection.](/img/docs/alpha/add-edit-intersections.jpg)

4) Modify these following properties to adjust the intersection to match your scene conditions.

| Property | Description | Default Value |
| --------- | --------- | --------- |
| dimensions | Specifies the width and depth of the intersection. First value represents width, second value represents depth. | '20 20' |
| sidewalk | Sets the width of the sidewalk at each side of the intersection. Values are set in the order of west, east, north, south. | '0 0 0 0' |
| northeastcurb | Sets the curb dimensions for the north east curb. Values are updated as width, then depth. | '4 4' |
| southwestcurb | Sets the curb dimensions for the south west curb. Values are updated as width, then depth. | '4 4' |
| southeastcurb | Sets the curb dimensions for the south east curb. Values are updated as width, then depth. | '4 4' |
| northwestcurb | Sets the curb dimensions for the north west curb. Values are updated as width, then depth. | '4 4' |
| stopsign | Sets if each side of the intersection has a stop sign. Values are set in the order of east, west, north, south. 0 is false, 1 is true. | '0 0 0 0' |
| trafficsignal | Sets if each side of the intersection has a traffic signal. Values are set in the order of east, west, north, south. 0 is false, 1 is true. | '1 1 1 1' |
| crosswalk | ​​Sets if each side of the intersection has a crosswalk. Values are set in the order of east, west, north, south. 0 is false, 1 is true. | '1 1 1 1' |

## SVG Extrusion Component

3DStreet SVG import is designed to accept 1 closed path or geometry at a time in a simple SVG format. This component accepts a `svgString` and creates a new entity with geometry extruded from the svg and applies the default mixin material grass. Extrusion can help to emulate the look of curbs and other surfaces. This method requires separates SVG imports for different parts of a scene.

## Add an image

This code snippet creates a plane geometry with a user specified image path.

Replace the https://... part to a publicly accessible HTTPS URL pointing to your image. We recommend [glitch.com](https://glitch.com/) as a great web host for assets like this but any host that provides a public URL path is fine.

```
newEl = document.createElement('a-entity')
newEl.setAttribute('geometry', 'primitive: plane; height: 10; width: 10;')
newEl.setAttribute('rotation', '-90 0 0')
newEl.setAttribute('data-layer-name', 'Image • User Specified Path')
newEl.setAttribute('material', 'src: url(https://cdn.glitch.global/a72f8f09-9d40-4560-8b00-a9481850c5e9/3D.St%20stacked%20icon.png?v=1717710211486);')
parentEl = document.querySelector('#street-container')
parentEl.appendChild(newEl)
```
3DStreet SVG import is designed to accept 1 closed path or geometry at a time in a simple SVG format. This component accepts a `svgString` and creates a new entity with geometry extruded from the svg and applies the default mixin material grass. Extrusion can help to emulate the look of curbs and other surfaces. This method requires separates SVG imports for different parts of a scene.

0 comments on commit f09d299

Please sign in to comment.