This repository has been archived by the owner on Mar 11, 2018. It is now read-only.
/
sIBL_GUI_Manual.html
3323 lines (3313 loc) · 124 KB
/
sIBL_GUI_Manual.html
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8"?>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.11: http://docutils.sourceforge.net/" />
<title></title>
<style type="text/css">
/*<![CDATA[*/
body {
background-color: rgb(252, 252, 252);
color: rgb(64, 64, 64);
font-family: "Lato", "proxima-nova", "Helvetica Neue", Arial, sans-serif;
text-align: justify;
margin: 10px 10px 10px 10px;
}
A:link {
color: rgb(41, 128, 185);
text-decoration: none;
}
A:visited {
text-decoration: none;
color: rgb(155, 89, 182);
}
A:active {
text-decoration: none;
color: rgb(41, 128, 185);
}
A:hover {
text-decoration: underline;
color: rgb(48, 145, 209);
}
h1, h2, h3, h4, h5, h6 {
font-family: "Roboto Slab", "ff-tisa-web-pro", "Georgia", Arial, sans-serif;
font-weight: 700;
margin-top: 0;
}
p {
font-size: 16px;
line-height: 24px;
margin: 0;
margin-bottom: 24px;
}
table {
border-color: rgb(225, 228, 229);
border-collapse: collapse;
border-style: solid;
border-width: 1px;
}
tt {
background-color: rgb(255, 255, 255);
color: rgb(80, 80, 80);
padding: 5px;
white-space: -moz-pre-wrap !important;
}
pre {
background: rgb(255, 255, 255);
border: 1px solid rgb(225, 228, 229);
display: block;
font-size: 12px;
font-family: "Incosolata", "Consolata", "Monaco", monospace;
line-height: 1.5;
margin: 1px 0px 24px 0px;
overflow: auto;
padding: 12px 12px;
white-space: pre;
}
/*]]>*/
</style>
</head>
<body>
<div class="document">
<img alt="resources/pictures/sIBL_GUI_Logo.png" src="resources/pictures/sIBL_GUI_Logo.png" />
<div class="section" id="manual-help-file">
<h1>
Manual - Help File
</h1><br />
</div>
<div class="section" id="table-of-content">
<h1>
Table Of Content
</h1><!-- .tocTree -->
<ul class="simple">
<li>
<a class="reference internal" href="#introduction">Introduction</a>
<ul>
<li>
<a class="reference internal" href="#donations">Donations</a>
</li>
</ul>
</li>
<li>
<a class="reference internal" href="#features">Features</a>
</li>
<li>
<a class="reference internal" href="#installation">Installation</a>
<ul>
<li>
<a class="reference internal" href="#windows-platform">Windows Platform</a>
</li>
<li>
<a class="reference internal" href="#mac-os-x-platform">Mac Os X Platform</a>
</li>
<li>
<a class="reference internal" href="#linux-platform">Linux Platform</a>
</li>
</ul>
</li>
<li>
<a class="reference internal" href="#usage">Usage</a>
<ul>
<li>
<a class="reference internal" href="#user-preferences">User Preferences</a>
</li>
<li>
<a class="reference internal" href="#command-line-parameters">Command Line Parameters</a>
</li>
<li>
<a class="reference internal" href="#shared-database-configuration">Shared Database Configuration</a>
</li>
<li>
<a class="reference internal" href="#ibl-sets-wizard">IBL Sets Wizard</a>
</li>
<li>
<a class="reference internal" href="#interface">Interface</a>
<ul>
<li>
<a class="reference internal" href="#toolbar">Toolbar</a>
</li>
<li>
<a class="reference internal" href="#library-layout">Library Layout</a>
</li>
<li>
<a class="reference internal" href="#inspect-layout">Inspect Layout</a>
</li>
<li>
<a class="reference internal" href="#export-layout">Export Layout</a>
</li>
<li>
<a class="reference internal" href="#preferences-layout">Preferences Layout</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a class="reference internal" href="#components">Components</a>
<ul>
<li>
<a class="reference internal" href="#factory">Factory</a>
<ul>
<li>
<a class="reference internal" href="#components-manager-ui">Components Manager Ui</a>
</li>
<li>
<a class="reference internal" href="#preferences-manager">Preferences Manager</a>
</li>
<li>
<a class="reference internal" href="#script-editor">Script Editor</a>
</li>
</ul>
</li>
<li>
<a class="reference internal" href="#core">Core</a>
<ul>
<li>
<a class="reference internal" href="#collections-outliner">Collections Outliner</a>
</li>
<li>
<a class="reference internal" href="#database">Database</a>
</li>
<li>
<a class="reference internal" href="#ibl-sets-outliner">Ibl Sets Outliner</a>
</li>
<li>
<a class="reference internal" href="#inspector">Inspector</a>
</li>
<li>
<a class="reference internal" href="#templates-outliner">Templates Outliner</a>
</li>
</ul>
</li>
<li>
<a class="reference internal" href="#addons">Addons</a>
<ul>
<li>
<a class="reference internal" href="#about-sibl-gui">About sIBL_GUI</a>
</li>
<li>
<a class="reference internal" href="#caches-operations">Caches Operations</a>
</li>
<li>
<a class="reference internal" href="#database-operations">Database Operations</a>
</li>
<li>
<a class="reference internal" href="#gps-map">Gps Map</a>
</li>
<li>
<a class="reference internal" href="#ibl-sets-scanner">Ibl Sets Scanner</a>
</li>
<li>
<a class="reference internal" href="#loader-script">Loader Script</a>
</li>
<li>
<a class="reference internal" href="#loader-script-options">Loader Script Options</a>
</li>
<li>
<a class="reference internal" href="#locations-browser">Locations Browser</a>
</li>
<li>
<a class="reference internal" href="#logging-notifier">Logging Notifier</a>
</li>
<li>
<a class="reference internal" href="#online-updater">Online Updater</a>
</li>
<li>
<a class="reference internal" href="#projects-explorer">Projects Explorer</a>
</li>
<li>
<a class="reference internal" href="#preview">Preview</a>
</li>
<li>
<a class="reference internal" href="#raw-editing-utilities">Raw Editing Utilities</a>
</li>
<li>
<a class="reference internal" href="#rewiring-tool">Rewiring Tool</a>
</li>
<li>
<a class="reference internal" href="#search-database">Search Database</a>
</li>
<li>
<a class="reference internal" href="#sibledit-utilities">sIBLedit Utilities</a>
</li>
<li>
<a class="reference internal" href="#tcp-client-ui">TCP Client Ui</a>
</li>
<li>
<a class="reference internal" href="#tcp-server-ui">TCP Server Ui</a>
</li>
<li>
<a class="reference internal" href="#trace-ui">Trace Ui</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a class="reference internal" href="#api">Api</a>
</li>
<li>
<a class="reference internal" href="#faq">Faq</a>
<ul>
<li>
<a class="reference internal" href="#general-questions">General Questions</a>
<ul>
<li>
<a class="reference internal" href="#overall">Overall</a>
</li>
<li>
<a class="reference internal" href="#rendering">Rendering</a>
</li>
</ul>
</li>
<li>
<a class="reference internal" href="#operating-system-questions">Operating System Questions</a>
<ul>
<li>
<a class="reference internal" href="#windows">Windows</a>
</li>
<li>
<a class="reference internal" href="#mac-os-x">Mac Os X</a>
</li>
</ul>
</li>
<li>
<a class="reference internal" href="#d-packages-questions">3D Packages Questions</a>
<ul>
<li>
<a class="reference internal" href="#autodesk-maya">Autodesk Maya</a>
</li>
<li>
<a class="reference internal" href="#autodesk-softimage">Autodesk Softimage</a>
</li>
<li>
<a class="reference internal" href="#autodesk-3ds-max">Autodesk 3ds Max</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a class="reference internal" href="#changes">Changes</a>
</li>
<li>
<a class="reference internal" href="#about">About</a>
</li>
</ul><br />
<!-- .introduction -->
</div>
<div class="section" id="id1">
<h1>
<span class="target" id="introduction">Introduction</span>
</h1>
<div class="line-block">
<div class="line">
<strong>sIBL_GUI</strong> is an open source lighting assistant making the Image Based Lighting process easier and straight forward through the use of sIbl files (<em>.Ibl</em>).
</div>
<div class="line">
What is sIBL? It’s a short for <em>Smart IBL</em>, a standard describing all informations and files needed to provide a fast and easy Image Based Lighting Setup in the 3d package of your choice.
</div>
</div>
<p>
More detailed informations are available here: <a class="reference external" href="http://www.smartibl.com">http://www.smartibl.com</a>
</p><br />
<div class="section" id="id2">
<h2>
<span class="target" id="donations">Donations</span>
</h2>
<p>
With <em>sIBL_GUI 4</em> release I decided to accept donations, so if you think the application is worth something you can use the following <a class="reference external" href="https://www.paypal.com/">Paypal</a> button:
</p>
<form action="https://www.paypal.com/cgi-bin/webscr" method="post">
<input type="hidden" name="cmd" value="_s-xclick" /><input type="hidden" name="encrypted" value="-----BEGIN PKCS7-----MIIHbwYJKoZIhvcNAQcEoIIHYDCCB1wCAQExggEwMIIBLAIBADCBlDCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20CAQAwDQYJKoZIhvcNAQEBBQAEgYAFDRqkmH/C4R0n1MYSt6lwoGGs7rJfsMPGIZ+dzjYtXZXEEMaMvERxtEKwX3AtSRp1C1wBnI4EUEEX+PBwEGwLG4qPcHqCY+1V5xcuePYRGc6Gw5WK0syBN/mW3hexe02WTrn1YbPvUKm98qeSyv6QL8Pe9UhP6BNT/nxDTwflPDELMAkGBSsOAwIaBQAwgewGCSqGSIb3DQEHATAUBggqhkiG9w0DBwQImdu2aXjyCy2Agcgr36pY7tmJ4SzxM1mx0/ANpnkwmybqpIQyTMSTw41mnA/N43zd3NztmGnhbM8dzXbYsPFGCyIIK6lXe41dzswzGMWmFnywEeRQHuvtWTUjI7ROdHaAmAGpuF7z26Q2yerQOmgmQ8KxdzmX3qrh4XNLEc0zj4B/R+2YyRrlYXd+mdNwDFBmOb7ILem44tWo3+3Bs9te3/zA1bvsXDSNK8OtdYk0fvfbOlth5wPr8O9fW7N8g5sm2ARSN90bvSAH1mIuTQANsdge7KCCA4cwggODMIIC7KADAgECAgEAMA0GCSqGSIb3DQEBBQUAMIGOMQswCQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExFjAUBgNVBAcTDU1vdW50YWluIFZpZXcxFDASBgNVBAoTC1BheVBhbCBJbmMuMRMwEQYDVQQLFApsaXZlX2NlcnRzMREwDwYDVQQDFAhsaXZlX2FwaTEcMBoGCSqGSIb3DQEJARYNcmVAcGF5cGFsLmNvbTAeFw0wNDAyMTMxMDEzMTVaFw0zNTAyMTMxMDEzMTVaMIGOMQswCQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExFjAUBgNVBAcTDU1vdW50YWluIFZpZXcxFDASBgNVBAoTC1BheVBhbCBJbmMuMRMwEQYDVQQLFApsaXZlX2NlcnRzMREwDwYDVQQDFAhsaXZlX2FwaTEcMBoGCSqGSIb3DQEJARYNcmVAcGF5cGFsLmNvbTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAwUdO3fxEzEtcnI7ZKZL412XvZPugoni7i7D7prCe0AtaHTc97CYgm7NsAtJyxNLixmhLV8pyIEaiHXWAh8fPKW+R017+EmXrr9EaquPmsVvTywAAE1PMNOKqo2kl4Gxiz9zZqIajOm1fZGWcGS0f5JQ2kBqNbvbg2/Za+GJ/qwUCAwEAAaOB7jCB6zAdBgNVHQ4EFgQUlp98u8ZvF71ZP1LXChvsENZklGswgbsGA1UdIwSBszCBsIAUlp98u8ZvF71ZP1LXChvsENZklGuhgZSkgZEwgY4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDQTEWMBQGA1UEBxMNTW91bnRhaW4gVmlldzEUMBIGA1UEChMLUGF5UGFsIEluYy4xEzARBgNVBAsUCmxpdmVfY2VydHMxETAPBgNVBAMUCGxpdmVfYXBpMRwwGgYJKoZIhvcNAQkBFg1yZUBwYXlwYWwuY29tggEAMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADgYEAgV86VpqAWuXvX6Oro4qJ1tYVIT5DgWpE692Ag422H7yRIr/9j/iKG4Thia/Oflx4TdL+IFJBAyPK9v6zZNZtBgPBynXb048hsP16l2vi0k5Q2JKiPDsEfBhGI+HnxLXEaUWAcVfCsQFvd2A1sxRr67ip5y2wwBelUecP3AjJ+YcxggGaMIIBlgIBATCBlDCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20CAQAwCQYFKw4DAhoFAKBdMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTExMTIwMzE3MDAyOFowIwYJKoZIhvcNAQkEMRYEFKV11/V8/IKSIlE0yQ67mCwZ0sHzMA0GCSqGSIb3DQEBAQUABIGAuY7c5MKgTgJy2YuOXtmVDJC8q6+HG0t2yf2aEv89O3hPie2u1Ndc0YTdaR8f08lcKCy3/KjXC2ZJybQ3aSpfrsy5+NhTgsNFrluzdRpDj0i2QjO1ARBSVGh2Tdh5sbMHb6RDee3e0S7lXB3LxkNnSGFH3XeWt2mom/kKHfdXrFg=-----END PKCS7-----" /><input type="image" src="http://kelsolaar.hdrlabs.com/sIBL_GUI/Support/Pictures/Make_A_Donation.png" border="0" name="submit" alt="PayPal — The safer, easier way to pay online." /><img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1" />
</form><br />
<!-- .features -->
</div>
</div>
<div class="section" id="id3">
<h1>
<span class="target" id="features">Features</span>
</h1>
<p>
Why an external application instead of directly using scripting capabilities of the 3d package itself? There are advantages and inconvenient with both methods.
</p>
<p>
With an external application, <em>.Ibl</em> files format parsing, Collections management and database inspection are handled by that application, you write that Framework once and then you can reuse it for other 3d packages.
</p>
<p>
The bridge between <strong>sIBL_GUI</strong> and the 3d package is done through Templates that output simple loader scripts. That’s one of <strong>sIBL_GUI</strong> strength: It only took a few hours to convert the Autodesk Softimage Mental Ray Template into an Autodesk Maya Mental Ray one. Scripting a native tool with a good interface offering same functionalities as <strong>sIBL_GUI</strong> would have taken days if not weeks.
</p>
<p>
<strong>sIBL_GUI</strong> is built around <a class="reference external" href="https://github.com/KelSolaar/Umbra">Umbra</a> Framework in <a class="reference external" href="http://www.python.org/">Python</a> and uses some others major libraries / tools:
</p>
<ul class="simple">
<li>
<a class="reference external" href="http://qt.nokia.com/">Nokia Qt Ui Framework</a> is used for the Interface thanks to <a class="reference external" href="http://www.riverbankcomputing.co.uk/">PyQt</a> bindings.
</li>
<li>
<a class="reference external" href="http://www.sqlalchemy.org/">SQLAlchemy</a> provides the database backbone.
</li>
<li>
<a class="reference external" href="http://code.google.com/p/sqlalchemy-migrate/">SQLAlchemy-migrate</a> adds support for database migrations.
</li>
<li>
<a class="reference external" href="http://sphinx.pocoo.org/">Sphinx</a> provides the documentation build system.
</li>
<li>
<a class="reference external" href="http://tidy.sourceforge.net/">Tidy</a> is used to cleanup docutils documentation html files.
</li>
</ul>
<p>
The following softwares are used to generate the Windows and Mac Os X installers:
</p>
<ul class="simple">
<li>
<a class="reference external" href="http://www.actualinstaller.com/">Actual Installer</a>
</li>
<li>
<a class="reference external" href="http://c-command.com/dropdmg/">Drop DMG</a>
</li>
</ul>
<p>
Some highlights:
</p>
<ul class="simple">
<li>Components based Framework.
</li>
<li>Configurable Ui Layout.
</li>
<li>SQlite Database.
</li>
<li>Online Updater.
</li>
<li>Microsoft Bing Maps Gps map.
</li>
<li>Internal Images Previewer.
</li>
<li>Online Exceptions Reporter.
</li>
</ul>
<p>
and much more…
</p>
<p>
Additional informations about <strong>sIBL_GUI</strong> are available into this development thread: <a class="reference external" href="http://www.hdrlabs.com/cgi-bin/forum/YaBB.pl?num=1271609371">sIBL_GUI Thread</a>
</p><br />
<!-- .installation -->
</div>
<div class="section" id="id4">
<h1>
<span class="target" id="installation">Installation</span>
</h1><br />
<div class="section" id="id5">
<h2>
<span class="target" id="windows-platform">Windows Platform</span>
</h2>
<p>
Installation on Windows is pretty straightforward, just launch <em>sIBL_GUI.exe</em>. In order to support third party images formats through FreeImage you may need to install <a class="reference external" href="http://download.microsoft.com/download/A/8/0/A80747C3-41BD-45DF-B505-E9710D2744E0/vcredist_x64.exe">Microsoft Visual C++ 2010 Redistributable Package (x64)</a>.
</p><br />
</div>
<div class="section" id="id6">
<h2>
<span class="target" id="mac-os-x-platform">Mac Os X Platform</span>
</h2>
<p>
Open <em>sIBL_GUI.dmg</em> and drag <em>sIBL_GUI 4.app</em> into the <em>Application</em> directory.
</p><br />
</div>
<div class="section" id="id7">
<h2>
<span class="target" id="linux-platform">Linux Platform</span>
</h2>
<div class="line-block">
<div class="line">
<em>sIBL_GUI 4</em> is currently not built on Linux because of several issues.
</div>
</div>
<p>
The following dependencies are needed:
</p>
<ul class="simple">
<li>
<strong>Python 2.6.7</strong> or <strong>Python 2.7.3</strong>: <a class="reference external" href="http://www.python.org/">http://www.python.org/</a>
</li>
<li>
<strong>PyQt</strong>: <a class="reference external" href="http://www.riverbankcomputing.co.uk/">http://www.riverbankcomputing.co.uk/</a>
</li>
</ul>
<p>
To install <strong>sIBL_GUI</strong> from the <a class="reference external" href="http://pypi.python.org/pypi/sIBL_GUI">Python Package Index</a> you can issue this command in a shell:
</p>
<pre class="literal-block">
pip install sIBL_GUI
</pre>
<p>
or this alternative command:
</p>
<pre class="literal-block">
easy install sIBL_GUI
</pre>
<p>
Templates are not included by default and can be downloaded from <a class="reference external" href="https://github.com/KelSolaar/sIBL_GUI_Templates">sIBL_GUI_Templates</a> repository.
</p>
<p>
If you want to support third party images formats through FreeImage, you will need to recompile <a class="reference external" href="https://github.com/KelSolaar/FreeImage">FreeImage</a> with the following patch over it:
</p>
<ul class="simple">
<li>
<strong>FreeImage_For_sIBL_GUI</strong>: <a class="reference external" href="https://github.com/KelSolaar/FreeImage_For_sIBL_GUI">https://github.com/KelSolaar/FreeImage_For_sIBL_GUI</a>
</li>
</ul>
<p>
You can also directly install from <a class="reference external" href="http://github.com/KelSolaar/sIBL_GUI">Github</a> source repository:
</p>
<pre class="literal-block">
git clone git://github.com/KelSolaar/sIBL_GUI.git
cd sIBL_GUI
python setup.py install
</pre>
<p>
If you want to build the documentation you will also need:
</p>
<ul class="simple">
<li>
<strong>Tidy</strong> <a class="reference external" href="http://tidy.sourceforge.net/">http://tidy.sourceforge.net/</a>
</li>
</ul><br />
<!-- .usage -->
</div>
</div>
<div class="section" id="id8">
<h1>
<span class="target" id="usage">Usage</span>
</h1><br />
<p>
Once installed, you can launch <strong>sIBL_GUI</strong> using this shell command:
</p>
<pre class="literal-block">
sIBL_GUI
</pre>
<div class="section" id="id9">
<h2>
<span class="target" id="user-preferences">User Preferences</span>
</h2>
<p>
<strong>sIBL_GUI</strong> preferences are stored per user in their home directory:
</p>
<ul class="simple">
<li>C:\Users\$USER\AppData\Roaming\HDRLabs\sIBL_GUI on Windows 7
</li>
<li>C:\Documents and Settings\$USER\Application Data\HDRLabs\sIBL_GUI on Windows XP
</li>
<li>/Users/$USER/Library/Preferences/HDRLabs/sIBL_GUI on Mac Os X
</li>
<li>/home/$USER/.HDRLabs/sIBL_GUI on Linux
</li>
</ul>
<p>
The typical <strong>sIBL_GUI</strong> preferences directory structure is the following:
</p>
<table border="1" class="docutils">
<colgroup>
<col width="100%" />
</colgroup>
<tbody valign="top">
<tr>
<td>
<img alt="resources/pictures/sIBL_GUI_PreferencesFolder.jpg" class="first last" src="resources/pictures/sIBL_GUI_PreferencesFolder.jpg" />
</td>
</tr>
</tbody>
</table>
<p>
Structure Description:
</p>
<ul class="simple">
<li>
<strong>$MAJOR_VERSION.$MINOR_VERSION</strong>: Current <strong>sIBL_GUI</strong> version.
<ul>
<li>
<strong>components</strong>: Directory storing user Components.
</li>
<li>
<strong>database</strong>: Directory storing the SQLite database.
<ul>
<li>
<strong>backup</strong>: Directory used by the <em>Database</em> Component when it backups the database.
</li>
<li>
<strong>migrations</strong>: Directory used by the <em>Database</em> migration mechanism responsible to migrate the database.
<ul>
<li>
<strong>versions</strong>: Directory used by to store the various migrations scripts.
</li>
</ul>
</li>
</ul>
</li>
<li>
<strong>io</strong>: Directory used for <strong>sIBL_GUI</strong> input / output operations.
<ul>
<li>
<strong>loaderScripts</strong>: Directory used as output directory by the <em>Loader Script</em> Component.
</li>
<li>
<strong>remote</strong>: Directory used by the <em>Online Updater</em> Component when it downloads online files.
</li>
<li>
<strong>scriptEditor</strong>: Directory containing the default scripts used by the <em>Script Editor</em> Component.
</li>
</ul>
</li>
<li>
<strong>logging</strong>: Directory storing <strong>sIBL_GUI</strong> logging file.
</li>
<li>
<strong>patches</strong>: Directory storing <strong>sIBL_GUI</strong> patches file.
</li>
<li>
<strong>settings</strong>: Directory storing <strong>sIBL_GUI</strong> settings file.
<ul>
<li>
<strong>templates</strong>: Directory storing Templates settings.
</li>
</ul>
</li>
<li>
<strong>templates</strong>: Directory storing user Templates (This directory is scanned by <strong>sIBL_GUI</strong> when importing default Templates).
</li>
</ul>
</li>
</ul><br />
</div>
<div class="section" id="id10">
<h2>
<span class="target" id="command-line-parameters">Command Line Parameters</span>
</h2>
<p>
<strong>sIBL_GUI</strong> accepts various command line parameters:
</p>
<ul class="simple">
<li>
<strong>-h, —help</strong>: Display the command line parameters help message and exit. (Mac Os X and Linux only)
</li>
<li>
<strong>-a, —about</strong>: Display application <em>About</em> message. (Mac Os X and Linux only)
</li>
<li>
<strong>-v VERBOSITYLEVEL, —verbose=VERBOSITYLEVEL</strong>: Application verbosity levels: 0 = Critical | 1 = Error | 2 = Warning | 3 = Info | 4 = Debug.
</li>
<li>
<strong>-f LOGGINGFORMATER, —loggingFormatter=LOGGINGFORMATER</strong>: Application Logging Formatter: 'Default, Extended, Standard’.
</li>
<li>
<strong>-u USERAPPLICATIONDATADIRECTORY, —userApplicationDataDirectory=USERAPPLICATIONDATADIRECTORY</strong>: User application data directory (Preferences directory).
</li>
<li>
<strong>-s, —hideSplashScreen</strong>: The SplashScreen is not displayed during application startup.
</li>
<li>
<strong>-w, —deactivateWorkerThreads</strong>: The Worker Threads are deactivated.
</li>
<li>
<strong>-x STARTUPSCRIPT, --startupScript=STARTUPSCRIPT</strong>: Execute given startup script.
</li>
<li>
<strong>-t TRACEMODULES, --traceModules=TRACEMODULES</strong>: Trace given modules.
</li>
<li>
<strong>-d DATABASEDIRECTORY, —databaseDirectory=DATABASEDIRECTORY</strong>: Database directory.
</li>
<li>
<strong>-r, —databaseReadOnly</strong>: Database is read only, database write access methods are not exposed into the interface.
</li>
<li>
<strong>-o LOADERSCRIPTSOUTPUTDIRECTORY, —loaderScriptsOutputDirectory=LOADERSCRIPTSOUTPUTDIRECTORY</strong>: Loader scripts output directory.
</li>
</ul>
<p>
Note: On Mac Os X, <strong>sIBL_GUI</strong> is launched from command line doing the following:
</p>
<pre class="literal-block">
cd sIBL_GUI.app
./Contents/MacOS/sIBL_GUI
</pre><br />
</div>
<div class="section" id="id11">
<h2>
<span class="target" id="shared-database-configuration">Shared Database Configuration</span>
</h2>
<p>
If you want to share the same Database between multiple installed versions of <strong>sIBL_GUI</strong> there are 2 solutions:
</p>
<p>
<strong>Dirty Method</strong>
</p>
<p>
Copy the Database file <strong>sIBL_Database.sqlite</strong> on every machine that have <strong>sIBL_GUI</strong> installed.
</p>
<p>
The file is located in one of those directory depending your OS:
</p>
<ul class="simple">
<li>C:\Users\$USER\AppData\Roaming\HDRLabs\sIBL_GUI\$MAJOR_VERSION.$MINOR_VERSION\database\ on Windows 7
</li>
<li>C:\Documents and Settings\$USER\Application Data\HDRLabs\sIBL_GUI\$MAJOR_VERSION.$MINOR_VERSION\database\ on Windows XP
</li>
<li>/Users/$USER/Library/Preferences/HDRLabs/sIBL_GUI/$MAJOR_VERSION.$MINOR_VERSION/database/ on Mac Os X
</li>
<li>/home/$USER/.HDRLabs/sIBL_GUI/$MAJOR_VERSION.$MINOR_VERSION/database/ on Linux
</li>
</ul>
<p>
<strong>Recommended Method</strong>
</p>
<p>
It’s possible to share one Database file between multiple <strong>sIBL_GUI</strong> install. In order to do that you need to start <strong>sIBL_GUI</strong> with some command line parameters:
</p>
<ul class="simple">
<li>
<strong>-d DATABASEDIRECTORY, —databaseDirectory=DATABASEDIRECTORY</strong>: This one is mandatory for what you want to do, it will tell <strong>sIBL_GUI</strong> to store / use the database on the provided path.
</li>
<li>
<strong>-r, —databaseReadOnly</strong>: This one is optional, but HIGHLY recommended: It will hide / unexpose from the UI all methods that can write to the Database. That’s something important because the last thing you want is someone screwing the whole database by doing a mistake.
</li>
</ul>
<p>
Example Command Line:
</p>
<pre class="literal-block">
C:\\HDRLabs\\sIBL_GUI\\sIBL_GUI.exe -d “Z:/sIBL_Database/” -r
</pre>
<p>
When the Database is read only, the automatic scanner adding new IBL Sets is deactivated meaning that newly IBL Sets dropped into your library directory won’t be added automatically.
</p>
<p>
It’s a good idea to put the Database with a real file system write lock in case someone launch a <strong>sIBL_GUI</strong> instance without the command line arguments.
</p>
<p>
That way you can have artists using the Database a supervisor has defined, and even using different Databases depending on their current production.
</p><br />
</div>
<div class="section" id="id12">
<h2>
<span class="target" id="ibl-sets-wizard">IBL Sets Wizard</span>
</h2>
<p>
The first time <strong>sIBL_GUI</strong> is started a wizard asks to add IBL Sets into the database:
</p>
<table border="1" class="docutils">
<colgroup>
<col width="100%" />
</colgroup>
<tbody valign="top">
<tr>
<td>
<img alt="resources/pictures/sIBL_GUI_EmptyDatabaseWizard_A.jpg" class="first last" src="resources/pictures/sIBL_GUI_EmptyDatabaseWizard_A.jpg" />
</td>
</tr>
</tbody>
</table>
<p>
Choose a directory where are stored some IBL Sets and they will be added to the Default Ibl Sets Collection.
</p>
<table border="1" class="docutils">
<colgroup>
<col width="100%" />
</colgroup>
<tbody valign="top">
<tr>
<td>
<img alt="resources/pictures/sIBL_GUI_EmptyDatabaseWizard_B.jpg" class="first last" src="resources/pictures/sIBL_GUI_EmptyDatabaseWizard_B.jpg" />
</td>
</tr>
</tbody>
</table><br />
</div>
<div class="section" id="id13">
<h2>
<span class="target" id="interface">Interface</span>
</h2>
<p>
<strong>sIBL_GUI</strong> Interface is customizable and comes with 3 main layouts directly available from the main toolbar:
</p>
<ul class="simple">
<li>
<a class="reference internal" href="#library-layout">Library Layout</a>
</li>
<li>
<a class="reference internal" href="#inspect-layout">Inspect Layout</a>
</li>
<li>
<a class="reference internal" href="#export-layout">Export Layout</a>
</li>
<li>
<a class="reference internal" href="#edit-layout">Edit Layout</a>
</li>
<li>
<a class="reference internal" href="#preferences-layout">Preferences Layout</a>
</li>
</ul><br />
<div class="section" id="id14">
<h3>
<span class="target" id="toolbar">Toolbar</span>
</h3>
<table border="1" class="docutils">
<colgroup>
<col width="100%" />
</colgroup>
<tbody valign="top">
<tr>
<td>
<img alt="resources/pictures/sIBL_GUI_Toolbar.jpg" class="first last" src="resources/pictures/sIBL_GUI_Toolbar.jpg" />
</td>
</tr>
</tbody>
</table>
<p>
Interactions:
</p>
<p>
<strong>Right clic</strong>: raises a context menu with the Ui Widgets list:
</p>
<table border="1" class="docutils">
<colgroup>
<col width="100%" />
</colgroup>
<tbody valign="top">
<tr>
<td>
<img alt="resources/pictures/sIBL_GUI_ToolbarContextMenu.jpg" class="first last" src="resources/pictures/sIBL_GUI_ToolbarContextMenu.jpg" />
</td>
</tr>
</tbody>
</table>
<p>
<strong>Central Widget icon</strong>: Shows / Hides the <em>Ibl Sets Outliner</em> Component widget Ui.
</p>
<p>
<strong>Layouts icon</strong>: Raises a context menu where the user can store / restore up to 5 custom layouts and recall them whenever needed:
</p>
<table border="1" class="docutils">
<colgroup>
<col width="100%" />
</colgroup>
<tbody valign="top">
<tr>
<td>
<img alt="resources/pictures/sIBL_GUI_LayoutsContextMenu.jpg" class="first last" src="resources/pictures/sIBL_GUI_LayoutsContextMenu.jpg" />
</td>
</tr>
</tbody>
</table>
<p>
<strong>Miscellaneous icon</strong>: Raises a context menu with some links and miscellaneous functionalities:
</p>
<table border="1" class="docutils">
<colgroup>
<col width="100%" />
</colgroup>
<tbody valign="top">
<tr>
<td>
<img alt="resources/pictures/sIBL_GUI_MiscellaneousContextMenu.jpg" class="first last" src="resources/pictures/sIBL_GUI_MiscellaneousContextMenu.jpg" />
</td>
</tr>
</tbody>
</table><br />
</div>
<div class="section" id="id15">
<h3>
<span class="target" id="library-layout">Library Layout</span>
</h3>
<p>
The <em>Library layout</em> is where most of the IBL Sets management is done.
</p>
<p>
This layout is built around 4 Components:
</p>
<ul class="simple">
<li>
<a class="reference internal" href="#collections-outliner">Collections Outliner</a> (core.collectionsOutliner)
</li>
<li>
<a class="reference internal" href="#ibl-sets-outliner">Ibl Sets Outliner</a> (core.iblSetsOutliner)
</li>
<li>
<a class="reference internal" href="#search-database">Search Database</a> (addons.searchDatabase)
</li>
<li>
<a class="reference internal" href="#gps-map">Gps Map</a> (addons.gpsMap)
</li>
</ul>
<table border="1" class="docutils">
<colgroup>
<col width="100%" />
</colgroup>
<tbody valign="top">
<tr>
<td>
<img alt="resources/pictures/sIBL_GUI_SetsCentricLayout.jpg" class="first last" src="resources/pictures/sIBL_GUI_SetsCentricLayout.jpg" />
</td>
</tr>
</tbody>
</table><br />
</div>
<div class="section" id="id16">
<h3>
<span class="target" id="inspect-layout">Inspect Layout</span>
</h3>
<p>
The <em>Inspect layout</em> is where Ibl Set inspection is done.
</p>
<p>
This layout is built around 3 Components:
</p>
<ul class="simple">
<li>
<a class="reference internal" href="#collections-outliner">Collections Outliner</a> (core.collectionsOutliner)
</li>
<li>
<a class="reference internal" href="#inspector">Inspector</a> (core.inspector)
</li>
<li>
<a class="reference internal" href="#gps-map">Gps Map</a> (addons.gpsMap)
</li>
</ul>
<table border="1" class="docutils">
<colgroup>
<col width="100%" />
</colgroup>
<tbody valign="top">
<tr>
<td>
<img alt="resources/pictures/sIBL_GUI_InspectCentricLayout.jpg" class="first last" src="resources/pictures/sIBL_GUI_InspectCentricLayout.jpg" />
</td>
</tr>
</tbody>
</table><br />
</div>
<div class="section" id="id17">
<h3>
<span class="target" id="export-layout">Export Layout</span>
</h3>
<p>
The <em>Export layout</em> is where the bridge between <strong>sIBL_GUI</strong> and the 3d packages is created.
</p>
<p>
This layout is built around 4 Components:
</p>
<ul class="simple">
<li>
<a class="reference internal" href="#templates-outliner">Templates Outliner</a> (core.templatesOutliner)
</li>
<li>
<a class="reference internal" href="#ibl-sets-outliner">Ibl Sets Outliner</a> (core.iblSetsOutliner)
</li>
<li>
<a class="reference internal" href="#loader-script">Loader Script</a> (addons.loaderScript)
</li>
<li>
<a class="reference internal" href="#loader-script-options">Loader Script Options</a> (addons.loaderScriptOptions)
</li>
</ul>
<p>
An additional but extremely powerful export related Component is available by right clicking the main toolbar:
</p>
<ul class="simple">
<li>
<a class="reference internal" href="#rewiring-tool">Rewiring Tool</a> (addons.rewiringTool)
</li>
</ul>
<table border="1" class="docutils">
<colgroup>
<col width="100%" />
</colgroup>
<tbody valign="top">
<tr>
<td>
<img alt="resources/pictures/sIBL_GUI_TemplatesCentricLayout.jpg" class="first last" src="resources/pictures/sIBL_GUI_TemplatesCentricLayout.jpg" />
</td>
</tr>
</tbody>
</table><br />
</div>
<div class="section" id="id18">
<h3>
<span class="target" id="edit-layout">Edit Layout</span>
</h3>
<p>
The <em>Edit layout</em> is where Ibl Set are edited.
</p>
<p>
This layout is built around 2 Component:
</p>
<ul class="simple">
<li>
<a class="reference internal" href="#projects-explorer">Projects Explorer</a> (addons.projectsExplorer)
</li>
<li>
<a class="reference internal" href="#script-editor">Script Editor</a> (factory.scriptEditor)
</li>
</ul>
<table border="1" class="docutils">
<colgroup>
<col width="100%" />
</colgroup>
<tbody valign="top">
<tr>
<td>
<img alt="resources/pictures/sIBL_GUI_EditCentricLayout.jpg" class="first last" src="resources/pictures/sIBL_GUI_EditCentricLayout.jpg" />
</td>
</tr>
</tbody>
</table><br />
</div>
<div class="section" id="id19">
<h3>
<span class="target" id="preferences-layout">Preferences Layout</span>
</h3>
<p>
The <em>Preferences layout</em> is where <strong>sIBL_GUI</strong> behavior is configured.
</p>
<p>
This layout is built around 2 Components:
</p>
<ul class="simple">
<li>
<a class="reference internal" href="#components-manager-ui">Components Manager Ui</a> (factory.componentsManagerUi)
</li>
<li>
<a class="reference internal" href="#preferences-manager">Preferences Manager</a> (factory.preferencesManager)
</li>
</ul>
<table border="1" class="docutils">
<colgroup>
<col width="100%" />
</colgroup>
<tbody valign="top">
<tr>
<td>