Skip to content

Update README.md #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Beakerboy merged 1 commit into from
Apr 29, 2025
+10 −6
Merged

Update README.md #85

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@ OSM Building Viewer

### Visualize an OSM Building in 3D

Visualize an OSM Building from the live OSM data.
To visualize a building tagged with a way, use the URL:
https://beakerboy.github.io/OSMBuilding/index.html?id=[id]
https://beakerboy.github.io/OSMBuilding?id=[id]

If the building is a multipolygon, or a relation, use:
https://beakerboy.github.io/OSMBuilding/index.html?type=relation&id=[id]
https://beakerboy.github.io/OSMBuilding?type=relation&id=[id]

...replacing [id] with the actual id of the way or relation.

Additional details will be displayed if "&info" is appended to the URL.
Additional details will be displayed if `&info` is appended to the URL.

Console debug messages can be printed to the screen if "&errorBox" is appended to the url. Helpful since mobile browsers often lack any inspection capability.
Console debug messages can be printed to the screen if `&errorBox` is appended to the url. Helpful since mobile browsers often lack any inspection capability.

Use the left mouse button to rotate the camera. To move, use the right one.

Supports:
* Ways with a building tag
* Ways with building parts inside.
* Building relations with way and/or multipolygon parts
* Mulipolygon buildings
* Multipolygon buildings
* Multipolygon building with multiple open ways which combine to a closed way.

Roof Types:
Expand All @@ -43,3 +43,7 @@ Examples:
* Building Relation [Burj Khalifa](https://beakerboy.github.io/OSMBuilding/index.html?type=relation&id=7584462)
* Multipolygon with no parts - [Freer Art Gallery](https://beakerboy.github.io/OSMBuilding/index.html?type=relation&id=1029355)
* Relation with multipolygon parts - [Leaning Tower of Pisa](https://beakerboy.github.io/OSMBuilding/index.html?type=relation&id=12982338)

Specify the `osmApiUrl` parameter to use other OSM APIs. Examples:
* [OpenHistoricalMap](https://beakerboy.github.io/OSMBuilding/?id=2826540&osmApiUrl=https://api.openhistoricalmap.org/api/0.6&type=relation)
* [OpenGeofiction](https://beakerboy.github.io/OSMBuilding/?id=461819&osmApiUrl=https://opengeofiction.net/api/0.6&type=relation)
⚡