brigl/HOWTO.txt at master · titilambert/brigl · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
How to prepare the software
===========================

The software can only run is it is hosted on a server. It will not run
opening the html files on the browser. This is becouse part files are
downloaded asyncronously from the server.

Included is a tiny webserver that you can use in your pc.

1. Download the official library

If you don't already have it, download the official library from:
http://www.ldraw.org/library/updates/complete.zip

Unzip it and copy the content of the subfolder "p" into "parts".
You must merge the folders becouse the program can't try different
directory as desktop software can.

2. (optional) Download the unofficial parts library

Usually models make use of unofficial parts. If you want, you can
download the unofficial parts library from:

http://www.ldraw.org/library/unofficial/ldrawunf.zip

Unzip the content and merge both "p" and "parts" of unofficial into
the official "parts". Overwrite when asked.

3. (optional) Subdivide all files in subfolder

The "parts" folder now contains 7000+ files. Many servers and pc
complains about so many files in a single dir, and performances
are degraded.
For any file or subdirectory in "parts", move it in a subfolder starting
with the same name:

a.dat -> a/a.dat
5776.dat -> 5/577a.dat
s/333.dat -> s/s/333.dat
48/1033.dat -> 4/48/1033.dat

If you decide not to subdivide folders, you must pass the option
dontUseSubfolders:true when creating the builder.

===============
Options
===============

BRIGL.Builder options, used like this: var builder = new BRIGL.Builder("parts/", {ajaxMethod:"jquery"});

- forceLowercase: forces partname to lowercase when downloading them from the server. Useful if you have inconsistencies in part name case. default false
- dontUseSubfolders: as explained above, avoid using subfolders for parts. default false
- ajaxMethod: choose which library to use for ajax calls. Valid values are "jquery" and "prototype". defaults "prototype"

loadModelByName options (also valid for other loadModelBy.... ):

- drawLines: draw edge lines. default false
- stepLimit: read a model only up to stepLimit number of steps. Useful to show partial build. Defaults -1 (no limit)
- dontCenter: don't calculate center of object, use model origin instead. Default false
- centerOffset: use this vector as the center offset (the displacement of the model). Default undefined;
- dontSmooth: avoid smoothing process. Default false
- blackLines: draw all edge lines in black instead of their color. Default false
- startColor: use value as starting color. Default 16
- startingMatrix: use value as the starting transformation matrix. Default undefined

BRIGL.BriglContainer options:

- antialias: use antialias. default true
- all other options supported by http://mrdoob.github.io/three.js/docs/53/#Reference/Renderers/WebGLRenderer