-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add readme to a-frame components dir
- Loading branch information
Showing
1 changed file
with
14 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Docs for custom A-Frame components used with 3DStreet | ||
|
||
## Street-geo component | ||
|
||
The components accept longitude, latitude, elevation and an array of map types to indicate which child maps to spawn. Possible values for maps array: 'mapbox2d', 'google3d'. | ||
|
||
The component assigns the class 'autocreated' to its child elements. All attribute values can be changed at runtime and the component will update the child elements (map entities) and their corresponding parameters. The 'elevation' attribute is only used for the 'google3d' tiles element for now. | ||
|
||
To add support for a new map type, you need to take the following steps: | ||
* add map name to this.mapTypes variable | ||
* add creating function with name: `<mapName>Create` | ||
* add update function with name: `<mapName>Update` | ||
|
||
It is assumed that the appropriate libraries for all map types are loaded in advance. |