# indoor3D **Repository Path**: zz618/indoor3D ## Basic Information - **Project Name**: indoor3D - **Description**: No description available - **Primary Language**: Unknown - **License**: GPL-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2024-06-12 - **Last Updated**: 2024-06-12 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README indoor3D ==== This is a javascript lib based on three.js to show an indoor map. **This was an experimental project when I was learning javascript and webgl, and I haven't updated it since then.** **Thanks for the followers and feedbacks, I decide to update it again.** **A GUI map eidtor written by QT is under development. And I'm working on supporting the popular GeoJson format** # Demo # 2D Map Demo Page: http://wolfwind521.github.io/2dmap 3D Map Demo Page: http://wolfwind521.github.io # Usage # a simplest example: ```html ``` a little more complex example: ```html
``` The explanation is as follows: 1) include the required js files ```html ``` - [three.min.js](http://threejs.org/): a 3D javascript library - Detector: detects whether the browser support the webgl. if it does not, threejs switches to a normal canvas renderer. - OrbitControls: handles the user interactions to zoom, pan and pivot. (Only used in 3D version) - Projector: user selection detection used by threejs. (Only used in 3D version) 2) set up the parameters of the indoor map and pass it to the creator ```js var params={mapDiv:"indoor3d",dim:"3d"}; var indoorMap = IndoorMap(params); ``` optional parameters:\ @mapDiv: if you have create your own ```
``` as a map container, you can specify its id here, otherwise it will create a full screen map.\ @dim: "2d" or "3d". "3d" as default value. But the final result depends on your device. If it doesn't support WebGL, it will show a 2d map even if u set "3d". So if there is no params passed to IndoorMap, it will create a fullscreen 3D map by default: ```js var indoorMap = IndoorMap(); ``` 3) load the map data, and set up its styles. ```js indoorMap.load('data/testMapData.json', function(){ map.setTheme(myTheme).showAllFloors().showAreaNames(true).setSelectable(true); var ul = IndoorMap.getUI(indoorMap); document.body.appendChild(ul); }); ``` the second parameter of the load() function is a callback function when the data is successfully loaded. You can customize the style and interaction of your indoor map in it. You may call the functions separately: ```js map.setTheme(myTheme); map.showAllFloors(); map.showAreaNames(true); map.setSelectable(true); ``` or in a chain for convenience: ```js map.setTheme(myTheme).showAllFloors().showAreaNames(true).setSelectable(true); ``` The UI is the buttons for switching floors. Its style is defined in the css file. so you can customize it by yourself. # User Reference # There are Three main classes:\ -IndoorMap\ -IndoorMap2d\ -IndoorMap3d ## IndoorMap2d ## ### methods: ### **.load(fileName, callback)** loads a file. When it finishes loading, the callback functon is called. Since the ui can only be constructed after the data is fully loaded, so the `getUI()` function must be called in the callback. if the file is already loaded by other modules, you should use the `.parse(jsonData)` method instead **.parse(jsonData)** parse the json Data. if the jsonData is loaded by other modules, you can just use this function to pass it to the indoor map **.setDefaultView()** reset the camera to default view (Default perspective view for a 3d map and default top view for a 2d map) **.setTopView()** set the camera to the top view. this function is only valid in the 3d map. **.zoomIn(zoomScale)** zoom in. zoom Scale is not necessary. so you can just call .zoomIn() **.zoomOut(zoomScale)** zoom out. Same as the zoomIn() function, zoom Scale is not necessary. **.adjustCamera** Resets the camera to its default settings. This function is called when switching floors **.setSelectable(selectable)** selectable- a boolean parameter to specify whether the rooms are selectable **.showLabels(showLabels)** showLabels- a boolean parameter to specify whether to show the labels. The labels are the icons and texts in the map. **.getUI()** returns a `