Skip to content

Commit e770b2f

Browse files
committed
update node module usage
1 parent ea1a8a6 commit e770b2f

2 files changed

Lines changed: 43 additions & 28 deletions

File tree

NODEUSAGE.md

Lines changed: 36 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
# Using as module in node.
22

3+
Install package from npm.
4+
```
5+
npm install obj23dtiles
6+
```
7+
38
## Convert to `.gltf`
49

510
```javascript
6-
var obj23dtiles = require('./lib/obj23dtiles');
11+
var obj23dtiles = require('obj23dtiles');
712

813
var objPath = './bin/barrel/barrel.obj';
914
var gltfPath = './bin/barrel/barrel.gltf';
@@ -13,7 +18,7 @@
1318
## Convert to `.glb`
1419

1520
```javascript
16-
var obj23dtiles = require('./lib/obj23dtiles');
21+
var obj23dtiles = require('obj23dtiles');
1722

1823
var objPath = './bin/barrel/barrel.obj';
1924
var glbPath = './bin/barrel/barrel.glb';
@@ -23,7 +28,7 @@
2328
## Convert to `.b3dm`
2429

2530
```javascript
26-
var obj23dtiles = require('./lib/obj23dtiles');
31+
var obj23dtiles = require('obj23dtiles');
2732

2833
var objPath = './bin/barrel/barrel.obj';
2934
var b3dmPath = './bin/barrel/barrel.b3dm';
@@ -33,12 +38,12 @@
3338
Or use custom BatchTable.
3439

3540
```javascript
36-
var obj23dtiles = require('./lib/obj23dtiles');
41+
var obj23dtiles = require('obj23dtiles');
3742

3843
var objPath = './bin/barrel/barrel.obj';
3944
var b3dmPath = './bin/barrel/barrel.b3dm';
40-
var customBatchTable = './bin/barrel/customBatchTbale.json' // file or JS Object.
41-
obj23dtiles(objPath, glbPath, {
45+
var customBatchTable = './bin/barrel/customBatchTable.json' // file or JS Object.
46+
obj23dtiles(objPath, b3dmPath, {
4247
b3dm: true,
4348
customBatchTable: customBatchTable
4449
});
@@ -47,7 +52,7 @@ Or use custom BatchTable.
4752
## Convert to `.i3dm`
4853

4954
```javascript
50-
var obj23dtiles = require('./lib/obj23dtiles');
55+
var obj23dtiles = require('obj23dtiles');
5156

5257
var objPath = './bin/barrel/barrel.obj';
5358
var i3dmPath = './bin/barrel/barrel.i3dm';
@@ -73,7 +78,7 @@ Or use custom BatchTable.
7378
Or use custom BatchTable.
7479

7580
```javascript
76-
var obj23dtiles = require('./lib/obj23dtiles');
81+
var obj23dtiles = require('obj23dtiles');
7782

7883
var objPath = './bin/barrel/barrel.obj';
7984
var i3dmPath = './bin/barrel/barrel.i3dm';
@@ -111,7 +116,7 @@ Or use custom BatchTable.
111116
* Convert to `.b3dm` tileset.
112117

113118
```javascript
114-
var obj23dtiles = require('./lib/obj23dtiles');
119+
var obj23dtiles = require('obj23dtiles');
115120

116121
var objPath = './bin/barrel/barrel.obj';
117122
var tilesetPath = './bin/barrel/barrel.b3dm';
@@ -121,7 +126,7 @@ Or use custom BatchTable.
121126
Or use custom tileset options and BatchTable.
122127

123128
```javascript
124-
var obj23dtiles = require('./lib/obj23dtiles');
129+
var obj23dtiles = require('obj23dtiles');
125130

126131
var objPath = './bin/barrel/barrel.obj';
127132
var tilesetPath = './bin/barrel/barrel.b3dm';
@@ -138,14 +143,22 @@ Or use custom tileset options and BatchTable.
138143
geometricError: 200.0,
139144
region: true
140145
},
141-
customBatchTable: {
146+
customBatchTable: { // Cause default BatchTable 'batchId' length is 14
142147
name: [
143148
'model1',
144-
'model2'
145-
],
146-
id: [
147-
0,
148-
1
149+
'model2',
150+
'model3',
151+
'model4',
152+
'model5',
153+
'model6',
154+
'model7',
155+
'model8',
156+
'model9',
157+
'model10',
158+
'model11',
159+
'model12',
160+
'model13',
161+
'model14'
149162
]
150163
}
151164
});
@@ -154,7 +167,7 @@ Or use custom tileset options and BatchTable.
154167
* Convert to `.i3dm` tileset.
155168

156169
```javascript
157-
var obj23dtiles = require('./lib/obj23dtiles');
170+
var obj23dtiles = require('obj23dtiles');
158171

159172
var objPath = './bin/barrel/barrel.obj';
160173
var tilesetPath = './bin/barrel/barrel.i3dm';
@@ -181,7 +194,7 @@ Or use custom tileset options and BatchTable.
181194
Or use custom tileset options and BatchTable.
182195

183196
```javascript
184-
var obj23dtiles = require('./lib/obj23dtiles');
197+
var obj23dtiles = require('obj23dtiles');
185198

186199
var objPath = './bin/barrel/barrel.obj';
187200
var tilesetPath = './bin/barrel/barrel.i3dm';
@@ -229,11 +242,13 @@ Or use custom tileset options and BatchTable.
229242
## Combine tilesets
230243

231244
```javascript
245+
var obj23dtiles = require('obj23dtiles');
232246
var fs = require('fs');
233-
var combine = require('../lib/combineTileset');
234-
var outputPath = './bin/tilesets/tileset.json';
235247

236-
combine({inputDir : './bin/tilesets/'})
248+
var combine = obj23dtiles.combine;
249+
var outputPath = './bin/barrel/output/tileset.json';
250+
251+
combine({inputDir : './bin/barrel/output'})
237252
.then(function(result) {
238253
fs.writeFile(outputPath, JSON.stringify(result.tileset), 'utf8');
239254
})

package.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
{
2-
"name": "objto3d-tiles",
2+
"name": "obj23dtiles",
33
"version": "1.0.0",
44
"description": "obj to 3d tiles",
5-
"main": "index.js",
5+
"main": "lib/obj23dtiles.js",
66
"directories": {
77
"lib": "lib"
88
},
99
"scripts": {
10-
"test": "echo \"Error: no test specified\" && exit 1"
1110
},
1211
"repository": {
1312
"type": "git",
@@ -17,7 +16,7 @@
1716
"3d-tiles",
1817
"cesium"
1918
],
20-
"author": "PG",
19+
"author": "princessgod",
2120
"license": "ISC",
2221
"bugs": {
2322
"url": "https://github.com/PrincessGod/objTo3d-tiles/issues"
@@ -26,13 +25,14 @@
2625
"dependencies": {
2726
"bluebird": "^3.5.1",
2827
"cesium": "^1.38.0",
29-
"eslint": "^4.9.0",
30-
"eslint-config-cesium": "^2.0.1",
3128
"fs-extra": "^4.0.2",
3229
"jpeg-js": "^0.3.3",
3330
"mime": "^2.0.3",
3431
"pngjs": "^3.3.0",
3532
"yargs": "^10.0.3"
3633
},
37-
"devDependencies": {}
34+
"devDependencies": {
35+
"eslint": "^4.9.0",
36+
"eslint-config-cesium": "^2.0.1"
37+
}
3838
}

0 commit comments

Comments
 (0)