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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<title> Misfit Model 3D Help - Scripting Reference </title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
</head>
<body bgcolor="#e0e0e0">
<h1> Overview </h1>
<p>
This is a guide to the Misfit Model 3D scripting language. It includes
only functions that are specific to Misfit Model 3D. Standard lua
control structures and functions are not documented here.
</p>
<p>
For more information on using the scripting language, you may also want
to review the <a href="olh_scriptguide.html">Scripting Guide</a>.
</p>
<h1> Contents </h1>
<ul>
<li> <a href="#anchor0">General</a>
<ul>
<li> <a href="#anchor1">modelGetName</a>
<li> <a href="#anchor2">modelSaveAs</a>
<li> <a href="#anchor3">modelGetVertexCount</a>
<li> <a href="#anchor4">modelGetFaceCount</a>
<li> <a href="#anchor5">modelGetGroupCount</a>
<li> <a href="#anchor6">modelGetJointCount</a>
<li> <a href="#anchor7">modelGetTextureCount</a>
<li> <a href="#anchor8">modelGetGroupByName</a>
<li> <a href="#anchor9">groupGetName</a>
<li> <a href="#anchor10">modelGetTextureByName</a>
<li> <a href="#anchor11">textureGetName</a>
<li> <a href="#anchor12">textureGetFilename</a>
</ul>
<li> <a href="#anchor13">Primitive Creation</a>
<ul>
<li> <a href="#anchor14">modelCreateMeshRectangle</a>
<li> <a href="#anchor15">modelCreateBoneJoint</a>
<li> <a href="#anchor16">vertexSetCoords</a>
<li> <a href="#anchor17">modelAddTexture</a>
<li> <a href="#anchor18">vertexSetCoords</a>
<li> <a href="#anchor19">faceSetTextureCoords</a>
</ul>
<li> <a href="#anchor20">Selection manipulation</a>
<ul>
<li> <a href="#anchor21">selectedRotate</a>
<li> <a href="#anchor22">selectedTranslate</a>
<li> <a href="#anchor23">selectedScale</a>
<li> <a href="#anchor24">selectedApplyMatrix</a>
<li> <a href="#anchor25">selectedWeldVertices</a>
<li> <a href="#anchor26">selectedInvertNormals</a>
<li> <a href="#anchor27">selectedGroupFaces</a>
<li> <a href="#anchor28">selectedAddToGroup</a>
</ul>
<li> <a href="#anchor29">Animation</a>
<ul>
<li> <a href="#anchor30">modelCreateAnimation</a>
<li> <a href="#anchor31">setAnimByIndex</a>
<li> <a href="#anchor32">setAnimByName</a>
<li> <a href="#anchor33">animSetFrame</a>
<li> <a href="#anchor34">animGetCount</a>
<li> <a href="#anchor35">animGetName</a>
<li> <a href="#anchor36">animGetFrameCount</a>
<li> <a href="#anchor37">animSetName</a>
<li> <a href="#anchor38">animSetFrameCount</a>
<li> <a href="#anchor39">animSetFPS</a>
<li> <a href="#anchor40">animClearFrame</a>
<li> <a href="#anchor41">animCopyFrame</a>
</ul>
<li> <a href="#anchor42">Animation set manipulation</a>
<ul>
<li> <a href="#anchor43">animMove</a>
<li> <a href="#anchor44">animCopy</a>
<li> <a href="#anchor45">animSplit</a>
<li> <a href="#anchor46">animJoin</a>
<li> <a href="#anchor47">animConvertToFrame</a>
</ul>
<li> <a href="#anchor48">Mode-specific animation manipulations</a>
<ul>
<li> <a href="#anchor49">skelAnimSetKeyframe</a>
<li> <a href="#anchor50">skelAnimDeleteKeyframe</a>
<li> <a href="#anchor51">frameAnimSetVertex</a>
</ul>
<li> <a href="#anchor52">Selection</a>
<ul>
<li> <a href="#anchor53">modelSelectAll</a>
<li> <a href="#anchor54">modelSelectAllVertices</a>
<li> <a href="#anchor55">modelSelectAllFaces</a>
<li> <a href="#anchor56">modelSelectAllGroups</a>
<li> <a href="#anchor57">modelSelectVertices</a>
<li> <a href="#anchor58">modelSelectVertex</a>
<li> <a href="#anchor59">modelSelectFace</a>
<li> <a href="#anchor60">modelSelectGroup</a>
<li> <a href="#anchor61">modelSelectJoint</a>
<li> <a href="#anchor62">modelUnselectAll</a>
</ul>
<li> <a href="#anchor63">Logging</a>
<ul>
<li> <a href="#anchor64">logDebug</a>
<li> <a href="#anchor65">logWarning</a>
<li> <a href="#anchor66">logError</a>
</ul>
</ul>
<a name="anchor0"><hr>
<h2>General</h2>
<a name="anchor1"><hr>
<h3> modelGetName </h3>
<p>
<b> Descritption: </b> Get the filename of the model
</p>
Arguments:
<ul>
<li> None
</ul>
Returns:
<ul>
<li> <b> string </b> - filename (or empty string)
</ul>
<p>
<b> Notes: </b> If the model does not have a filename this function
will return an empty string.
</p>
<a name="anchor2"><hr>
<h3> modelSaveAs </h3>
<p>
<b> Descritption: </b> Save the model as a specified format.
</p>
Arguments:
<ul>
<li> <b> string format </b> - Format to save as (file extension)
</ul>
Returns:
<ul>
<li> <b> string </b> - filename
</ul>
<p>
<b> Notes: </b> Existing files will not be over-written. If writing
the file in the specified format would cause an over-write, a number is
added to the filename and incremented until the filename is unique.
</p>
<a name="anchor3"><hr>
<h3> modelGetVertexCount </h3>
<p>
<b> Descritption: </b> Get the number of vertices in the model.
</p>
Arguments:
<ul>
<li> None
</ul>
Returns:
<ul>
<li> <b> int </b> - number of vertices
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor4"><hr>
<h3> modelGetFaceCount </h3>
<p>
<b> Descritption: </b> Get the number of faces (polygons (triangles)) in the model.
</p>
Arguments:
<ul>
<li> None
</ul>
Returns:
<ul>
<li> <b> int </b> - number of faces
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor5"><hr>
<h3> modelGetGroupCount </h3>
<p>
<b> Descritption: </b> Get the number of polygon groups in the model.
</p>
Arguments:
<ul>
<li> None
</ul>
Returns:
<ul>
<li> <b> int </b> - number of groups
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor6"><hr>
<h3> modelGetJointCount </h3>
<p>
<b> Descritption: </b> Get the number of bone joints in the model.
</p>
Arguments:
<ul>
<li> None
</ul>
Returns:
<ul>
<li> <b> int </b> - number of bone joints
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor7"><hr>
<h3> modelGetTextureCount </h3>
<p>
<b> Descritption: </b> Get the number of textures in the model.
</p>
Arguments:
<ul>
<li> None
</ul>
Returns:
<ul>
<li> <b> int </b> - number of textures
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor8"><hr>
<h3> modelGetGroupByName </h3>
<p>
<b> Descritption: </b> Get the ID of a group from its name.
</p>
Arguments:
<ul>
<li> <b> string name </b> - Name of group
</ul>
Returns:
<ul>
<li> <b> int </b> - Group ID (-1 if not found)
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor9"><hr>
<h3> groupGetName </h3>
<p>
<b> Descritption: </b> Get the name of the specified group.
</p>
Arguments:
<ul>
<li> <b> int groupID </b> - ID number of group
</ul>
Returns:
<ul>
<li> <b> string </b> - Name of group
</ul>
<p>
<b> Notes: </b> IDs of any type are integers from zero to count-1 inclusive.
Negative numbers are invalid.
</p>
<a name="anchor10"><hr>
<h3> modelGetTextureByName </h3>
<p>
<b> Descritption: </b> Get the ID of a texture from its name.
</p>
Arguments:
<ul>
<li> <b> string name </b> - Name of texture
</ul>
Returns:
<ul>
<li> <b> int </b> - Texture ID (-1 if not found)
</ul>
<p>
<b> Notes: </b> In most circumstances the name of the texture is the
filename without its
full path or extension. The exeption to this is if the model did not
have textures explicitly associated with it and the model filter had
to guess at texture file names. In this case the texture name will
be the texture filename including the extension, but without the full path.
</p>
<a name="anchor11"><hr>
<h3> textureGetName </h3>
<p>
<b> Descritption: </b> Get the name of the specified texture.
</p>
Arguments:
<ul>
<li> <b> int textureID </b> - ID number of texture
</ul>
Returns:
<ul>
<li> <b> string </b> - Name of texture
</ul>
<p>
<b> Notes: </b> IDs of any type are integers from zero to count-1 inclusive.
Negative numbers are invalid.
</p>
<a name="anchor12"><hr>
<h3> textureGetFilename </h3>
<p>
<b> Descritption: </b> Get the filename of the specified texture.
</p>
Arguments:
<ul>
<li> <b> int textureID </b> - ID number of texture
</ul>
Returns:
<ul>
<li> <b> string </b> - Filename of texture (full path)
</ul>
<p>
<b> Notes: </b> IDs of any type are integers from zero to count-1 inclusive.
Negative numbers are invalid.
</p>
<a name="anchor13"><hr>
<h2>Primitive Creation</h2>
<a name="anchor14"><hr>
<h3> modelCreateMeshRectangle </h3>
<p>
<b> Descritption: </b> Create a rectangular mesh.
</p>
Arguments:
<ul>
<li> <b> float x1 </b> - X coordinate of vertex 1
<li> <b> float y1 </b> - Y coordinate of vertex 1
<li> <b> float z1 </b> - Z coordinate of vertex 1
<li> <b> float x2 </b> - X coordinate of vertex 2
<li> <b> float y2 </b> - Y coordinate of vertex 2
<li> <b> float z2 </b> - Z coordinate of vertex 2
<li> <b> float x3 </b> - X coordinate of vertex 3
<li> <b> float y3 </b> - Y coordinate of vertex 3
<li> <b> float z3 </b> - Z coordinate of vertex 3
<li> <b> float x4 </b> - X coordinate of vertex 4
<li> <b> float y4 </b> - Y coordinate of vertex 4
<li> <b> float z4 </b> - Z coordinate of vertex 4
<li> <b> segments </b> (opt) - Number of rows/columns in rectangle (defaults to 1)
</ul>
Returns:
<ul>
<li> <b> int </b> - Mesh ID
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor15"><hr>
<h3> modelCreateBoneJoint </h3>
<p>
<b> Descritption: </b> Get the number of vertices in the model.
</p>
Arguments:
<ul>
<li> <b> string name </b> - Name of bone joint
<li> <b> float x </b> - X coordinate of bone joint
<li> <b> float y </b> - Y coordinate of bone joint
<li> <b> float z </b> - Z coordinate of bone joint
<li> <b> float xrot </b> - X rotation of bone joint (in degrees)
<li> <b> float yrot </b> - Y rotation of bone joint (in degrees)
<li> <b> float zrot </b> - Z rotation of bone joint (in degrees)
<li> <b> int parentID </b> - ID of parent joint (-1 is no parent, root joint)
</ul>
Returns:
<ul>
<li> <b> int </b> - Joint ID
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor16"><hr>
<h3> vertexSetCoords </h3>
<p>
<b> Descritption: </b> Move a vertex to a new position
</p>
Arguments:
<ul>
<li> <b> int vertexID </b> ID of vertex to move
<li> <b> float x </b> New X coordinate
<li> <b> float y </b> New Y coordinate
<li> <b> float z </b> New Z coordinate
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> IDs of any type are integers from zero to count-1 inclusive.
Negative numbers are invalid.
</p>
<a name="anchor17"><hr>
<h3> modelAddTexture </h3>
<p>
<b> Descritption: </b> Add an image file to a model as a texture.
</p>
Arguments:
<ul>
<li> <b> string filename </b> - Filename of texture to add (can be relative)
</ul>
Returns:
<ul>
<li> <b> int </b> - Texture ID
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor18"><hr>
<h3> vertexSetCoords </h3>
<p>
<b> Descritption: </b> Assign a texture to a group.
</p>
Arguments:
<ul>
<li> <b> int groupID </b> ID of group
<li> <b> int textureID </b> ID of texture for group
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> IDs of any type are integers from zero to count-1 inclusive.
Negative numbers are invalid.
</p>
<a name="anchor19"><hr>
<h3> faceSetTextureCoords </h3>
<p>
<b> Descritption: </b> Set the UV texture coordinates for a vertex of a polygon
</p>
Arguments:
<ul>
<li> <b> int faceID </b> Polygon ID
<li> <b> int vertexIndex </b> Index of polygon vertex to assign (0-2 for triangles)
<li> <b> float u </b> U (horizontal) coordinate for vertex on the group texture (0.0 - 1.0)
<li> <b> float v </b> V (vertical) coordinate for vertex on the group texture (0.0 - 1.0)
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> IDs of any type are integers from zero to count-1 inclusive.
Negative numbers are invalid.
</p>
<p>
Texture coordinates are from 0.0 to 1.0. The origin (0.0, 0.0) is the
<b>lower-left</b> corner of the texture, not the <b>upper-right</b> corner.
</p>
<a name="anchor20"><hr>
<h2>Selection manipulation</h2>
<a name="anchor21"><hr>
<h3> selectedRotate </h3>
<p>
<b> Descritption: </b> Rotate the selected vertices and bone joints around the
origin.
</p>
Arguments:
<ul>
<li> <b> float x </b> - Rotation around X axis in degrees
<li> <b> float y </b> - Rotation around Y axis in degrees
<li> <b> float z </b> - Rotation around Z axis in degrees
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> Rotation is around the origin. If you want to rotate around an
arbitrary point (x0,y0,z0) you can use the following steps:
</p>
<ol>
<li> selectedTranslate ( -x0, -y0, -z0 )
<li> selectedRotate( x, y, z )
<li> selectedTranslate ( x0, y0, z0 )
</ol>
<a name="anchor22"><hr>
<h3> selectedTranslate </h3>
<p>
<b> Descritption: </b> Translate the selected vertices and bone joints.
</p>
Arguments:
<ul>
<li> <b> float x </b> - Units to translate on the X axis
<li> <b> float y </b> - Units to translate on the Y axis
<li> <b> float z </b> - Units to translate on the Z axis
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor23"><hr>
<h3> selectedScale </h3>
<p>
<b> Descritption: </b> Scale the distance between selected vertices and bone joints.
</p>
Arguments:
<ul>
<li> <b> float x </b> - Units to scale on the X axis
<li> <b> float y </b> - Units to scale on the Y axis
<li> <b> float z </b> - Units to scale on the Z axis
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor24"><hr>
<h3> selectedApplyMatrix </h3>
<p>
<b> Descritption: </b> Apply an arbitrary 4x4 matrix to the selected vertices and joints.
</p>
Arguments:
<ul>
<li> <b> float m1 </b> - First matrix element
<li> <b> m2 ... m14 </b>
<li> <b> float m15 </b> - Last matrix element
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> The m13, m14, m15 elements are the translation elements.
</p>
<a name="anchor25"><hr>
<h3> selectedWeldVertices </h3>
<p>
<b> Descritption: </b> Any selected vertcies that share coordinates
into one vertex.
</p>
Arguments:
<ul>
<li> None
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> This does not weld all verticies into one. It only welds
vertices that are very, very close to each other.
</p>
<a name="anchor26"><hr>
<h3> selectedInvertNormals </h3>
<p>
<b> Descritption: </b> Invertes the normals on any selected faces (polygons (triangles)).
Effectively this turns objects inside-out so that light reflects off the opposite sides of the faces.
</p>
Arguments:
<ul>
<li> None
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor27"><hr>
<h3> selectedGroupFaces </h3>
<p>
<b> Descritption: </b> Assigns all selected faces to a group specified by name.
The group is created if it does not exist.
</p>
Arguments:
<ul>
<li> <b> string name </b> - Name of group for faces
</ul>
Returns:
<ul>
<li> <b> int groupID </b> - Group ID
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor28"><hr>
<h3> selectedAddToGroup </h3>
<p>
<b> Descritption: </b> Adds selected faces to an existing group.
</p>
Arguments:
<ul>
<li> <b> int groupID </b> ID of group
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> IDs of any type are integers from zero to count-1 inclusive.
Negative numbers are invalid.
</p>
<a name="anchor29"><hr>
<h2>Animation</h2>
<a name="anchor30"><hr>
<h3> modelCreateAnimation </h3>
<p>
<b> Descritption: </b> Creates a new animation
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> string name </b> - Name of new animation
<li> <b> int frameIndex </b> - Frame count
<li> <b> float fps </b> - Frames per second
</ul>
Returns:
<ul>
<li> <b> int </b> - AnimationID
</ul>
<p>
<b> Notes: </b> Animation IDs are unique to their type, but can be the same for
two different types. In other words, the first skeletal animation and the first
frame animation are always zero (0). This is why you must use an
animation type/mode string when you specify an animation ID.
</p>
<a name="anchor31"><hr>
<h3> setAnimByIndex </h3>
<p>
<b> Descritption: </b> Sets the current animation from a mode string
and an ID value.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animID </b> - Animation ID
</ul>
Returns:
<ul>
<li> <b> bool </b> - Returns true if animation exists, false otherwise.
</ul>
<p>
<b> Notes: </b> IDs of any type are integers from zero to count-1 inclusive.
Negative numbers are invalid.
</p>
<p>
You can set frame animation vertex positions or skeletal animation keyframes
directly using functions below. You only need to use this function if you want
to use matrix transformations to manipulate several animated primitives at once;
for example, translating or rotating many vertex positions at one time.
</p>
<a name="anchor32"><hr>
<h3> setAnimByName </h3>
<p>
<b> Descritption: </b> Sets the current animation from a mode string
and a name string.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> string name </b> - Name of animation
</ul>
Returns:
<ul>
<li> <b> bool </b> - Returns true if animation exists, false otherwise.
</ul>
<p>
<b> Notes: </b> You can set frame animation vertex positions or skeletal animation keyframes
directly using functions below. You only need to use this function if you want
to use matrix transformations to manipulate several animated primitives at once;
for example, translating or rotating many vertex positions at one time.
</p>
<a name="anchor33"><hr>
<h3> animSetFrame </h3>
<p>
<b> Descritption: </b> Sets the current frame of the current animation.
</p>
Arguments:
<ul>
<li> <b> int frameIndex </b> - Frame index of current animation (0 to frame_count-1)
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> You can set frame animation vertex positions or skeletal animation keyframes
directly using functions below. You only need to use this function if you want
to use matrix transformations to manipulate several animated primitives at once;
for example, translating or rotating many vertex positions at one time.
</p>
<a name="anchor34"><hr>
<h3> animGetCount </h3>
<p>
<b> Descritption: </b> Get the number of animations of a specified type.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
</ul>
Returns:
<ul>
<li> <b> int </b> - The number of animations of this type
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor35"><hr>
<h3> animGetName </h3>
<p>
<b> Descritption: </b> Get the name of an animation.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animationID </b> - The ID number of the animation
</ul>
Returns:
<ul>
<li> <b> string </b> - The animation name
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor36"><hr>
<h3> animGetFrameCount </h3>
<p>
<b> Descritption: </b> Get the frame count of an animation.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animationID </b> - The ID number of the animation
</ul>
Returns:
<ul>
<li> <b> int </b> - The frame count of the animation
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor37"><hr>
<h3> animSetName </h3>
<p>
<b> Descritption: </b> Change the name of the specified animation.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animationID </b> - The ID number of the animation
<li> <b> string name </b> - New animation name
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor38"><hr>
<h3> animSetFrameCount </h3>
<p>
<b> Descritption: </b> Change the frame count of the specified animation.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animationID </b> - The ID number of the animation
<li> <b> int frameCount </b> - New animation frame count
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor39"><hr>
<h3> animSetFPS </h3>
<p>
<b> Descritption: </b> Change the animation speed.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animationID </b> - The ID number of the animation
<li> <b> float fps </b> - New animation speed in frames per second
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor40"><hr>
<h3> animClearFrame </h3>
<p>
<b> Descritption: </b> Clear an animation frame so that all primitives are in
their default position and orientation.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animationID </b> - The ID number of the animation
<li> <b> int frame </b> - Frame number (0 to frame_count-1, inclusive)
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor41"><hr>
<h3> animCopyFrame </h3>
<p>
<b> Descritption: </b> Copy an animation frame to another frame so that each
frame is identical.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animationID </b> - The ID number of the animation
<li> <b> int src </b> - Source frame number (0 to frame_count-1, inclusive), the
frame you want to make a copy of
<li> <b> int dest </b> - Destination frame number (0 to frame_count-1, inclusive),
the frame you want to copy to
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor42"><hr>
<h2>Animation set manipulation</h2>
<a name="anchor43"><hr>
<h3> animMove </h3>
<p>
<b> Descritption: </b> Move an animation from one index to another. This changes
the order in which animations are listed.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animIndex1 </b> - The current animation index (ID number)
<li> <b> int animIndex2 </b> - The new animation index
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> Animation indices and IDs are the same thing. If you move an
animation its ID changes to its new index position. Other animation IDs may
be changed as well if they appear after the old or new animation index.
</p>
<a name="anchor44"><hr>
<h3> animCopy </h3>
<p>
<b> Descritption: </b> Create a new animation that is a copy of an existing
animation.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animationID </b> - The ID number of the animation
<li> <b> string name </b> - Name of new animation
</ul>
Returns:
<ul>
<li> <b> int </b> - ID number of the new animation
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor45"><hr>
<h3> animSplit </h3>
<p>
<b> Descritption: </b> Split an animation into two separate animations at a
specified frame.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animationID </b> - The ID number of the animation
<li> <b> string name </b> - Name of new animation
<li> <b> int frame </b> - The frame at which to split the animation (0 to frame_count-1, inclusive)
</ul>
Returns:
<ul>
<li> <b> int </b> - ID number of the new animation
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor46"><hr>
<h3> animJoin </h3>
<p>
<b> Descritption: </b> Join two animations together into one.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animationID1 </b> - The ID number of the animation to join to
<li> <b> int animationID2 </b> - The ID number of the animation to join from
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> In case the above argument descriptions are unclear,
animation 2 will be appended to animation 1.
</p>
<a name="anchor47"><hr>
<h3> animConvertToFrame </h3>
<p>
<b> Descritption: </b> Convert a skeletal animation to a frame animation.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animationID </b> - The ID number of the animation to convert
<li> <b> string name </b> - The name of the new animation
<li> <b> int frame_count </b> - The number of frames in the new animation
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> The two animations will complete in the same amount of time.
The existing animation may be resampled if the frame count of
the new animation is different from the existing animation. The new animation's
frames per second will be changed to make the two animations compelte in the same
amount of time.
</p>
<p> In other words: <code>frame_count1 * fps1 = frame_count2 * fps2</code>
</p>
<a name="anchor48"><hr>
<h2>Mode-specific animation manipulations</h2>
<a name="anchor49"><hr>
<h3> skelAnimSetKeyframe </h3>
<p>
<b> Descritption: </b> Set a keyframe for a specified animation, frame, and
joint. Keyframe may be rotation or translation.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animationID </b> - The ID number of the animation
<li> <b> int frame </b> - The index of the frame (0 to frame_count-1, inclusive)
<li> <b> int jointID </b> - The ID number of the joint
<li> <b> bool isRotation </b> - Is true for rotation keyframe, false for translation keyframe
<li> <b> float x </b> - Coordinate or rotation on X axis
<li> <b> float y </b> - Coordinate or rotation on Y axis
<li> <b> float z </b> - Coordinate or rotation on Z axis
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor50"><hr>
<h3> skelAnimDeleteKeyframe </h3>
<p>
<b> Descritption: </b> Deletes a keyframe for a specified animation, frame, and
joint. Keyframe may be rotation or translation.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animationID </b> - The ID number of the animation
<li> <b> int frame </b> - The index of the frame (0 to frame_count-1, inclusive)
<li> <b> int jointID </b> - The ID number of the joint
<li> <b> bool isRotation </b> - Is true for rotation keyframe, false for translation keyframe
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> The joint will have its default position or orientation after
calling this function. If there are rotation and translation keyframes, you must
call this function twice to delete both; once with isRotation true, and once
with isRotation false.
</p>
<a name="anchor51"><hr>
<h3> frameAnimSetVertex </h3>
<p>
<b> Descritption: </b> Deletes a keyframe for a specified animation, frame, and
joint. Keyframe may be rotation or translation.
</p>
Arguments:
<ul>
<li> <b> string mode </b> - Animation mode: "skeletal" or "frame"
<li> <b> int animationID </b> - The ID number of the animation
<li> <b> int frame </b> - The index of the frame (0 to frame_count-1, inclusive)
<li> <b> int vertexID </b> - The ID number of the joint
<li> <b> float x </b> - New X coordinate
<li> <b> float y </b> - New Y coordinate
<li> <b> float z </b> - New Z coordinate
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor52"><hr>
<h2>Selection</h2>
<a name="anchor53"><hr>
<h3> modelSelectAll </h3>
<p>
<b> Descritption: </b> Selects all primitives (vertices, faces, and bone joints)
</p>
Arguments:
<ul>
<li> None
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor54"><hr>
<h3> modelSelectAllVertices </h3>
<p>
<b> Descritption: </b> Selects all vertices
</p>
Arguments:
<ul>
<li> None
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor55"><hr>
<h3> modelSelectAllFaces </h3>
<p>
<b> Descritption: </b> Selects all faces
</p>
Arguments:
<ul>
<li> None
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor56"><hr>
<h3> modelSelectAllGroups </h3>
<p>
<b> Descritption: </b> Selects all faces of all groups
</p>
Arguments:
<ul>
<li> None
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor57"><hr>
<h3> modelSelectVertices </h3>
<p>
<b> Descritption: </b> Selects all vertices
</p>
Arguments:
<ul>
<li> None
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor58"><hr>
<h3> modelSelectVertex </h3>
<p>
<b> Descritption: </b> Selects specified vertex
</p>
Arguments:
<ul>
<li> <b> int vertexID </b> - ID of vertex to select
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> IDs of any type are integers from zero to count-1 inclusive.
Negative numbers are invalid.
</p>
<a name="anchor59"><hr>
<h3> modelSelectFace </h3>
<p>
<b> Descritption: </b> Selects specified face
</p>
Arguments:
<ul>
<li> <b> int faceID </b> - ID of face to select
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> IDs of any type are integers from zero to count-1 inclusive.
Negative numbers are invalid.
</p>
<a name="anchor60"><hr>
<h3> modelSelectGroup </h3>
<p>
<b> Descritption: </b> Selects faces of specified group
</p>
Arguments:
<ul>
<li> <b> int groupID </b> - ID of group to select
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> IDs of any type are integers from zero to count-1 inclusive.
Negative numbers are invalid.
</p>
<a name="anchor61"><hr>
<h3> modelSelectJoint </h3>
<p>
<b> Descritption: </b> Selects specified joint
</p>
Arguments:
<ul>
<li> <b> int jointID </b> - ID of joint to select
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> IDs of any type are integers from zero to count-1 inclusive.
Negative numbers are invalid.
</p>
<a name="anchor62"><hr>
<h3> modelUnselectAll </h3>
<p>
<b> Descritption: </b> Unselects all primitives (vertices, faces, bone joints)
</p>
Arguments:
<ul>
<li> None
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor63"><hr>
<h2>Logging</h2>
<a name="anchor64"><hr>
<h3> logDebug </h3>
<p>
<b> Descritption: </b> Send a message string to the debug log.
</p>
Arguments:
<ul>
<li> <b> string message </b> - message to log
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor65"><hr>
<h3> logWarning </h3>
<p>
<b> Descritption: </b> Send a message string to the warning log.
</p>
Arguments:
<ul>
<li> <b> string message </b> - message to log
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<a name="anchor66"><hr>
<h3> logError </h3>
<p>
<b> Descritption: </b> Send a message string to the error log.
</p>
Arguments:
<ul>
<li> <b> string message </b> - message to log
</ul>
Returns:
<ul>
<li> None
</ul>
<p>
<b> Notes: </b> None
</p>
<hr/>
<center>
[
<a href="olh_index.html">Contents</a>
|
<a href="olh_use.html">Using</a>
|
<a href="olh_tools.html">Tools</a>
|
<a href="olh_commands.html">Commands</a>
]
<br/>
Copyright © 2004-2007, Kevin Worcester
</center>
</body></html>
|
