Skip to content

a js lib based on three.js to show 3D indoor map

License

Notifications You must be signed in to change notification settings

sxhxliang/indoor3D

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

indoor3D

This is a javascript lib based on three.js to show a 3D indoor map

#Usage a simplest example:

<!DOCTYPE html>
<html>
<body>
<script src="js/three.min.js"></script>
<script src="js/Detector.js"></script>
<script src="js/OrbitControls.js"></script>
<script src="js/Indoor3D.js"></script>
<link href="css/indoor3D.css" rel="stylesheet">
<script>
    var indoorMap = new Indoor3D();
    indoorMap.load('B000A9R4FE.json');
    indoorMap.showFloor(1);
</script>
</body>
</html>

a little more complex example:

<!DOCTYPE html>
<html>
<body>
<script src="js/three.min.js"></script>
<script src="js/Detector.js"></script>
<script src="js/OrbitControls.js"></script>
<script src="js/Indoor3D.js"></script>
<link href="css/indoor3D.css" rel="stylesheet">

<div id="indoor3d" style="width: 800px; height: 500px"></div>
<script>
    var params = {
        mapDiv:"indoor3d"
    }
    var indoorMap = Indoor3D(params);
    indoorMap.load('B000A9R4FE.json', function(){
        indoorMap.showAllFloors();
        indoorMap.showLabels(true);
        indoorMap.setSelectable(true);
        var ul = indoorMap.getUI(indoorMap);
        document.body.appendChild(ul);
    });
</script>

</body>
</html>
  1. include the required js files
<script src="js/three.min.js"></script>
<script src="js/Detector.js"></script>
<script src="js/OrbitControls.js"></script>
<script src="js/Indoor3D.js"></script>
<script src="js/IndoorMap2d.js"></script>
<script src="js/IndoorMap3d.js"></script>
<link href="css/indoor3D.css" rel="stylesheet">
  • three.min.js: 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
  1. set up the parent <div> node of the indoor map and pass the params
var params={mapDiv:"indoor3d"};
var indoorMap = Indoor3D(params);

So there must be a corresponding <div id="indoor3d"> tag in your html codes, or it will create a fullscreen map. If there is no params passed to Indoor3D, it will create a fullscreen one as well:

var indoorMap = new Indoor3D();
  1. load the map data, and set up its styles.
indoorMap.load('B000A9R4FE.json', function(){
        indoorMap.showAllsFloor();
        indoorMap.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 loaded. if you don't need the ui, you can also set the style outside the callback function:

indoorMap.load('B000A9R4FE.json');
indoorMap.showFloor(1);
indoorMap.setSelectable(true);
indoorMap.showLabels(true);

the style of the ui is defined in the css file. so you can specify it by yourself.

#User Reference There are two main classes: -IndoorMap -Mall

IndoorMap

###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 <ul> tag with all the floor id. The user can switch the floor by clicking the <li> You can insert the <ul> to anywhere in the html. Make sure to call this method only after the map is loaded.

.setSelectionListener(callback)

set the call back function when a shop is selected.

the shop id is passed as the parameter of callback. and -1 for nothing is selected.

.getSelectedId()

get the selected shop's id

.selectById(id)

select the shop by its id

.showFloor(id)

id-the floor id shows the floor by id. Notice this does not handle the labels.

.showAllFloors()

shows all the floors together. Notice this does not handle the labels.

Mall:

###Properties .floors

This is an array with all the floors of [THREE.Object3D](http://threejs.org/docs/#Reference/Core/Object3D) type.

###Methods: .getCurFloorId()

gets the id of the current floor. Notice: the id is a signed integers. -1 means Floor B1, and 1 means Floor F1. 0 is preserved for showing all the floors.

.getFloor(id)

id-the floor id gets the floor of [THREE.Object3D](http://threejs.org/docs/#Reference/Core/Object3D) type by its id.

.getCurFloor()

gets the current floor of [THREE.Object3D](http://threejs.org/docs/#Reference/Core/Object3D) type.

About

a js lib based on three.js to show 3D indoor map

http://wolfwind521.github.io

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 97.5%
  • HTML 1.8%
  • CSS 0.7%