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
<?xml version="1.0" encoding="UTF-8"?>
<component xmlns="http://schemas.autodesk.com/netfabb/automaticcomponenttoolkit/2018"
libraryname="the 3MF Library"
namespace="Lib3MF"
copyright="3MF Consortium (Original Author)"
year="2019"
basename="lib3mf"
version="2.0.0-alpha"
>
<license>
<line value="All rights reserved." />
<line value="" />
<line value="Redistribution and use in source and binary forms, with or without modification," />
<line value="are permitted provided that the following conditions are met:" />
<line value="" />
<line value="1. Redistributions of source code must retain the above copyright notice, this" />
<line value="list of conditions and the following disclaimer." />
<line value="2. Redistributions in binary form must reproduce the above copyright notice," />
<line value="this list of conditions and the following disclaimer in the documentation" />
<line value="and/or other materials provided with the distribution." />
<line value="" />
<line value="THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND" />
<line value="ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED" />
<line value="WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE" />
<line value="DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR" />
<line value="ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES" />
<line value="(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;" />
<line value="LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND" />
<line value="ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT" />
<line value="(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS" />
<line value="SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." />
</license>
<bindings>
<binding language="Cpp" indentation="tabs" />
<binding language="Pascal" indentation="tabs" />
<binding language="Python" indentation="tabs" />
<binding language="CppDynamic" indentation="tabs" />
<binding language="Node" indentation="tabs" />
<binding language="Go" indentation="tabs" />
<binding language="CSharp" indentation="tabs" />
</bindings>
<implementations>
<implementation language="Cpp" indentation="tabs" />
</implementations>
<errors>
<error name="NOTIMPLEMENTED" code="1" description="functionality not implemented" />
<error name="INVALIDPARAM" code="2" description="an invalid parameter was passed" />
<error name="INVALIDCAST" code="3" description="a type cast failed" />
<error name="BUFFERTOOSMALL" code="4" description="a provided buffer is too small" />
<error name="GENERICEXCEPTION" code="5" description="a generic exception occurred" />
<error name="COULDNOTLOADLIBRARY" code="6" description="the library could not be loaded" />
<error name="COULDNOTFINDLIBRARYEXPORT" code="7" description="a required exported symbol could not be found in the library" />
<error name="INCOMPATIBLEBINARYVERSION" code="8" description="the version of the binary interface does not match the bindings interface" />
<error name="CALCULATIONABORTED" code="10" description="a calculation has been aborted" />
<error name="SHOULDNOTBECALLED" code="11" description="functionality should not be called" />
<error name="READERCLASSUNKNOWN" code="100" description="the queried reader class is unknown" />
<error name="WRITERCLASSUNKNOWN" code="101" description="the queried writer class is unknown" />
<error name="ITERATORINVALIDINDEX" code="102" description="the current index of an iterator is invalid" />
<error name="INVALIDMODELRESOURCE" code="103" description="no Model Resource has been given" />
<error name="RESOURCENOTFOUND" code="104" description="Resource not found" />
<error name="INVALIDMODEL" code="105" description="A model is invalid" />
<error name="INVALIDOBJECT" code="106" description="An object is invalid" />
<error name="INVALIDMESHOBJECT" code="107" description="A mesh object is invalid" />
<error name="INVALIDCOMPONENTSOBJECT" code="108" description="A components object is invalid" />
<error name="INVALIDCOMPONENT" code="109" description="A component is invalid" />
<error name="INVALIDBUILDITEM" code="110" description="A build item is invalid" />
<error name="INVALIDBASEMATERIALGROUP" code="111" description="A basematerialgroup is invalid" />
<error name="INVALIDSLICESTACKRESOURCE" code="112" description="A slicestack resource is invalid" />
<error name="INVALIDTEXTURERESOURCE" code="113" description="A texture resource is invalid" />
<error name="INVALIDCOLORGROUP" code="114" description="A color group resource is invalid" />
<error name="INVALIDTEXTURE2DGROUP" code="115" description="A texture2d group resource is invalid" />
<error name="INVALIDCOMPOSITEMATERIALS" code="116" description="A composite materials resource is invalid" />
<error name="INVALIDMULTIPROPERTYGROUP" code="117" description="A MultiPropertyGroup resource is invalid" />
<error name="INVALIDRESOURCEINDEX" code="120" description="A resource index is invalid" />
<error name="ATTACHMENTNOTFOUND" code="121" description="Attachment not found" />
<error name="FORBIDDENCYCLICREFERENCE" code="130" description="A component references one of its ancestors" />
<error name="INVALIDATTACHMENTSTREAM" code="131" description="An attachment stream is invalid" />
<error name="INVALIDPROPERTYCOUNT" code="132" description="Invalid property count." />
<error name="UNKOWNPROGRESSIDENTIFIER" code="140" description="A progress identifier is unknown" />
<error name="BEAMLATTICE_INVALID_OBJECTTYPE" code="2000" description="This object type is not valid for beamlattices" />
</errors>
<enum name="PropertyType">
<option name="NoPropertyType" value="0" />
<option name="BaseMaterial" value="1" />
<option name="TexCoord" value="2" />
<option name="Colors" value="3" />
<option name="Composite" value="4" />
<option name="Multi" value="5" />
</enum>
<enum name="SlicesMeshResolution">
<option name="Fullres" value="0" />
<option name="Lowres" value="1" />
</enum>
<enum name="ModelUnit">
<option name="MicroMeter" value="0" />
<option name="MilliMeter" value="1" />
<option name="CentiMeter" value="2" />
<option name="Inch" value="3" />
<option name="Foot" value="4" />
<option name="Meter" value="5" />
</enum>
<enum name="ObjectType">
<option name="Other" value="0" />
<option name="Model" value="1" />
<option name="Support" value="2" />
<option name="SolidSupport" value="3" />
</enum>
<enum name="TextureType">
<option name="Unknown" value="0" />
<option name="PNG" value="1" />
<option name="JPEG" value="2" />
</enum>
<enum name="TextureTileStyle">
<option name="Wrap" value="0" />
<option name="Mirror" value="1" />
<option name="Clamp" value="2" />
<option name="NoTileStyle" value="3" />
</enum>
<enum name="TextureFilter">
<option name="Auto" value="0" />
<option name="Linear" value="1" />
<option name="Nearest" value="2" />
</enum>
<enum name="BeamLatticeCapMode">
<option name="Sphere" value="0" />
<option name="HemiSphere" value="1" />
<option name="Butt" value="2" />
</enum>
<enum name="BeamLatticeClipMode">
<option name="NoClipMode" value="0" />
<option name="Inside" value="1" />
<option name="Outside" value="2" />
</enum>
<enum name="ProgressIdentifier">
<option name="QUERYCANCELED" value="0" />
<option name="DONE" value="1" />
<option name="CLEANUP" value="2" />
<option name="READSTREAM" value="3" />
<option name="EXTRACTOPCPACKAGE" value="4" />
<option name="READNONROOTMODELS" value="5" />
<option name="READROOTMODEL" value="6" />
<option name="READRESOURCES" value="7" />
<option name="READMESH" value="8" />
<option name="READSLICES" value="9" />
<option name="READBUILD" value="10" />
<option name="CREATEOPCPACKAGE" value="11" />
<option name="WRITEMODELSTOSTREAM" value="12" />
<option name="WRITEROOTMODEL" value="13" />
<option name="WRITENONROOTMODELS" value="14" />
<option name="WRITEATTACHMENTS" value="15" />
<option name="WRITECONTENTTYPES" value="16" />
<option name="WRITENOBJECTS" value="17" />
<option name="WRITENODES" value="18" />
<option name="WRITETRIANGLES" value="19" />
<option name="WRITESLICES" value="20" />
</enum>
<enum name="BlendMethod">
<option name="NoBlendMethod" value="0"/>
<option name="Mix" value="1"/>
<option name="Multiply" value="2"/>
</enum>
<struct name="Triangle">
<member name="Indices" type="uint32" rows="3" />
</struct>
<struct name="TriangleProperties">
<member name="ResourceID" type="uint32" />
<member name="PropertyIDs" type="uint32" rows="3" />
</struct>
<struct name="Position">
<member name="Coordinates" type="single" rows="3" />
</struct>
<struct name="Position2D">
<member name="Coordinates" type="single" rows="2" />
</struct>
<struct name="CompositeConstituent">
<member name="PropertyID" type="uint32"/>
<member name="MixingRatio" type="double"/>
</struct>
<struct name="MultiPropertyLayer">
<member name="ResourceID" type="uint32"/>
<member name="TheBlendMethod" type="enum" class="BlendMethod"/>
</struct>
<struct name="Tex2Coord">
<member name="U" type="double"/>
<member name="V" type="double"/>
</struct>
<struct name="Transform">
<member name="Fields" type="single" columns="4" rows="3"/>
</struct>
<struct name="Color">
<member name="Red" type="uint8" />
<member name="Green" type="uint8" />
<member name="Blue" type="uint8" />
<member name="Alpha" type="uint8" />
</struct>
<struct name="Beam">
<member name="Indices" type="uint32" rows="2" />
<member name="Radii" type="double" rows="2" />
<member name="CapModes" type="enum" class="BeamLatticeCapMode" rows="2" />
</struct>
<functiontype name="ProgressCallback" description="A callback function">
<param name="Abort" type="bool" pass="return" description="Returns whether the calculation should be aborted"/>
<param name="ProgressValue" type="double" pass="in" description="The value of the progress function: values in the interval [0,1] are progress; < mean no progress update"/>
<param name="ProgressIdentifier" type="enum" class="ProgressIdentifier" pass="in" description="An identifier of progress"/>
<param name="UserData" type="pointer" pass="in" description="Userdata that is passed to the callback function"/>
</functiontype>
<functiontype name="WriteCallback" description="Callback to call for writing a data chunk">
<param name="ByteData" type="uint64" pass="in" description="Pointer to the data to be written"/>
<param name="NumBytes" type="uint64" pass="in" description="Number of bytes to write"/>
<param name="UserData" type="pointer" pass="in" description="Userdata that is passed to the callback function"/>
</functiontype>
<functiontype name="ReadCallback" description="Callback to call for reading a data chunk">
<param name="ByteData" type="uint64" pass="in" description="Pointer to a buffer to read data into"/>
<param name="NumBytes" type="uint64" pass="in" description="Number of bytes to read"/>
<param name="UserData" type="pointer" pass="in" description="Userdata that is passed to the callback function"/>
</functiontype>
<functiontype name="SeekCallback" description="Callback to call for seeking in the stream">
<param name="Position" type="uint64" pass="in" description="Position in the stream to move to"/>
<param name="UserData" type="pointer" pass="in" description="Userdata that is passed to the callback function"/>
</functiontype>
<class name="Base">
</class>
<class name="Writer">
<method name="WriteToFile" description = "Writes out the model as file. The file type is specified by the Model Writer class.">
<param name="Filename" type="string" pass="in" description="Filename to write into" />
</method>
<method name="GetStreamSize" description = "Retrieves the size of the full 3MF file stream.">
<param name="StreamSize" type="uint64" pass="return" description="the stream size" />
</method>
<method name="WriteToBuffer" description = "Writes out the 3MF file into a memory buffer">
<param name="Buffer" type="basicarray" class="uint8" pass="out" description="buffer to write into" />
</method>
<method name="WriteToCallback" description = "Writes out the model and passes the data to a provided callback function. The file type is specified by the Model Writer class.">
<param name="TheWriteCallback" type="functiontype" class="WriteCallback" pass="in" description="Callback to call for writing a data chunk" />
<param name="TheSeekCallback" type="functiontype" class="SeekCallback" pass="in" description="Callback to call for seeking in the stream" />
<param name="UserData" type="pointer" pass="in" description="Userdata that is passed to the callback function" />
</method>
<method name="SetProgressCallback" description = "Set the progress callback for calls to this writer">
<param name="ProgressCallback" type="functiontype" class="ProgressCallback" pass="in" description="pointer to the callback function."/>
<param name="UserData" type="pointer" pass="in" description="pointer to arbitrary user data that is passed without modification to the callback."/>
</method>
</class>
<class name="Reader">
<method name="ReadFromFile" description = "Reads a model from a file. The file type is specified by the Model Reader class">
<param name="Filename" type="string" pass="in" description="Filename to read from" />
</method>
<method name="ReadFromBuffer" description = "Reads a model from a memory buffer.">
<param name="Buffer" type="basicarray" class="uint8" pass="in" description="Buffer to read from" />
</method>
<method name="ReadFromCallback" description = "Reads a model and from the data provided by a callback function">
<param name="TheReadCallback" type="functiontype" class="ReadCallback" pass="in" description="Callback to call for reading a data chunk" />
<param name="StreamSize" type="uint64" pass="in" description="number of bytes the callback returns" />
<param name="TheSeekCallback" type="functiontype" class="SeekCallback" pass="in" description="Callback to call for seeking in the stream." />
<param name="UserData" type="pointer" pass="in" description="Userdata that is passed to the callback function" />
</method>
<method name="SetProgressCallback" description = "Set the progress callback for calls to this writer">
<param name="ProgressCallback" type="functiontype" class="ProgressCallback" pass="in" description="pointer to the callback function."/>
<param name="UserData" type="pointer" pass="in" description="pointer to arbitrary user data that is passed without modification to the callback."/>
</method>
<method name="AddRelationToRead" description = "Adds a relationship type which shall be read as attachment in memory while loading">
<param name="RelationShipType" type="string" pass="in" description="String of the relationship type" />
</method>
<method name="RemoveRelationToRead" description = "Removes a relationship type which shall be read as attachment in memory while loading">
<param name="RelationShipType" type="string" pass="in" description="String of the relationship type" />
</method>
<method name="SetStrictModeActive" description="Activates (deactivates) the strict mode of the reader.">
<param name="StrictModeActive" type="bool" pass="in" description="flag whether strict mode is active or not." />
</method>
<method name="GetStrictModeActive" description="Queries whether the strict mode of the reader is active or not">
<param name="StrictModeActive" type="bool" pass="return" description="returns flag whether strict mode is active or not." />
</method>
<method name="GetWarning" description="Returns Warning and Error Information of the read process">
<param name="Index" type="uint32" pass="in" description="Index of the Warning. Valid values are 0 to WarningCount - 1"/>
<param name="ErrorCode" type="uint32" pass="out" description="filled with the error code of the warning" />
<param name="Warning" type="string" pass="return" description="the message of the warning" />
</method>
<method name="GetWarningCount" description="Returns Warning and Error Count of the read process">
<param name="Count" type="uint32" pass="return" description="filled with the count of the occurred warnings." />
</method>
</class>
<class name="Resource">
<method name="GetResourceID" description="Retrieves the resource id of the resource instance.">
<param name="Id" type="uint32" pass="return" description="Retrieves the ID of a Model Resource Instance." />
</method>
</class>
<class name="ResourceIterator">
<method name="MoveNext" description="Iterates to the next resource in the list.">
<param name="HasNext" type="bool" pass="return" description="Iterates to the next resource in the list." />
</method>
<method name="MovePrevious" description="Iterates to the previous resource in the list.">
<param name="HasPrevious" type="bool" pass="return" description="Iterates to the previous resource in the list." />
</method>
<method name="GetCurrent" description="Returns the resource the iterator points at.">
<param name="Resource" type="handle" class="Resource" pass="return" description="returns the resource instance." />
</method>
<method name="Clone" description="Creates a new resource iterator with the same resource list.">
<param name="OutResourceIterator" type="handle" class="ResourceIterator" pass="return" description="returns the cloned Iterator instance" />
</method>
</class>
<class name="SliceStackIterator" parent="ResourceIterator">
<method name="GetCurrentSliceStack" description="Returns the SliceStack the iterator points at.">
<param name="Resource" type="handle" class="SliceStack" pass="return" description="returns the SliceStack instance." />
</method>
</class>
<class name="ObjectIterator" parent="ResourceIterator">
<method name="GetCurrentObject" description="Returns the Object the iterator points at.">
<param name="Resource" type="handle" class="Object" pass="return" description="returns the Object instance." />
</method>
</class>
<class name="Texture2DIterator" parent="ResourceIterator">
<method name="GetCurrentTexture2D" description="Returns the Texture2D the iterator points at.">
<param name="Resource" type="handle" class="Texture2D" pass="return" description="returns the Texture2D instance." />
</method>
</class>
<class name="BaseMaterialGroupIterator" parent="ResourceIterator">
<method name="GetCurrentBaseMaterialGroup" description="Returns the MaterialGroup the iterator points at.">
<param name="Resource" type="handle" class="BaseMaterialGroup" pass="return" description="returns the BaseMaterialGroup instance." />
</method>
</class>
<class name="ColorGroupIterator" parent="ResourceIterator">
<method name="GetCurrentColorGroup" description="Returns the ColorGroup the iterator points at.">
<param name="Resource" type="handle" class="ColorGroup" pass="return" description="returns the ColorGroup instance." />
</method>
</class>
<class name="Texture2DGroupIterator" parent="ResourceIterator">
<method name="GetCurrentTexture2DGroup" description="Returns the Texture2DGroup the iterator points at.">
<param name="Resource" type="handle" class="Texture2DGroup" pass="return" description="returns the Texture2DGroup instance." />
</method>
</class>
<class name="CompositeMaterialsIterator" parent="ResourceIterator">
<method name="GetCurrentCompositeMaterials" description="Returns the CompositeMaterials the iterator points at.">
<param name="Resource" type="handle" class="CompositeMaterials" pass="return" description="returns the CompositeMaterials instance." />
</method>
</class>
<class name="MultiPropertyGroupIterator" parent="ResourceIterator">
<method name="GetCurrentMultiPropertyGroup" description="Returns the MultiPropertyGroup the iterator points at.">
<param name="Resource" type="handle" class="MultiPropertyGroup" pass="return" description="returns the MultiPropertyGroup instance." />
</method>
</class>
<class name="MetaData">
<method name="GetNameSpace" description = "returns the namespace URL of the metadata">
<param name="NameSpace" type="string" pass="return" description="the namespace URL of the metadata" />
</method>
<method name="SetNameSpace" description = "sets a new namespace URL of the metadata">
<param name="NameSpace" type="string" pass="in" description="the new namespace URL of the metadata" />
</method>
<method name="GetName" description = "returns the name of a metadata">
<param name="Name" type="string" pass="return" description="the name of the metadata" />
</method>
<method name="SetName" description = "sets a new name of a metadata">
<param name="Name" type="string" pass="in" description="the new name of the metadata" />
</method>
<method name="GetKey" description = "returns the (namespace+name) of a metadata">
<param name="Key" type="string" pass="return" description="the key (namespace+name) of the metadata" />
</method>
<method name="GetMustPreserve" description = "returns, whether a metadata must be preserved">
<param name="MustPreserve" type="bool" pass="return" description="returns, whether a metadata must be preserved" />
</method>
<method name="SetMustPreserve" description = "sets whether a metadata must be preserved">
<param name="MustPreserve" type="bool" pass="in" description="a new value whether a metadata must be preserved" />
</method>
<method name="GetType" description = "returns the type of a metadata">
<param name="Type" type="string" pass="return" description="the type of the metadata" />
</method>
<method name="SetType" description = "sets a new type of a metadata. This must be a simple XML type">
<param name="Type" type="string" pass="in" description="a new type of the metadata" />
</method>
<method name="GetValue" description = "returns the value of the metadata">
<param name="Value" type="string" pass="return" description="the value of the metadata" />
</method>
<method name="SetValue" description = "sets a new value of the metadata">
<param name="Value" type="string" pass="in" description="a new value of the metadata" />
</method>
</class>
<class name="MetaDataGroup">
<method name="GetMetaDataCount" description = "returns the number of metadata in this metadatagroup">
<param name="Count" type="uint32" pass="return" description="returns the number metadata" />
</method>
<method name="GetMetaData" description = "returns a metadata value within this metadatagroup">
<param name="Index" type="uint32" pass="in" description="Index of the Metadata." />
<param name="MetaData" type="handle" class="MetaData" pass="return" description="an instance of the metadata" />
</method>
<method name="GetMetaDataByKey" description = "returns a metadata value within this metadatagroup">
<param name="NameSpace" type="string" pass="in" description="the namespace of the metadata" />
<param name="Name" type="string" pass="in" description="the name of the Metadata" />
<param name="MetaData" type="handle" class="MetaData" pass="return" description="an instance of the metadata" />
</method>
<method name="RemoveMetaDataByIndex" description = "removes metadata by index from the model.">
<param name="Index" type="uint32" pass="in" description=" Index of the metadata to remove" />
</method>
<method name="RemoveMetaData" description = "removes metadata from the model.">
<param name="TheMetaData" type="handle" class="MetaData" pass="in" description="The metadata to remove" />
</method>
<method name="AddMetaData" description = "adds a new metadata to this metadatagroup">
<param name="NameSpace" type="string" pass="in" description="the namespace of the metadata" />
<param name="Name" type="string" pass="in" description="the name of the metadata" />
<param name="Value" type="string" pass="in" description="the value of the metadata" />
<param name="Type" type="string" pass="in" description="the type of the metadata" />
<param name="MustPreserve" type="bool" pass="in" description="shuold the metadata be preserved" />
<param name="MetaData" type="handle" class="MetaData" pass="return" description="a new instance of the metadata" />
</method>
</class>
<class name="Object" parent="Resource">
<method name="GetType" description="Retrieves an object's type">
<param name="ObjectType" type="enum" class="ObjectType" pass="return" description="returns object type enum." />
</method>
<method name="SetType" description="Sets an object's type">
<param name="ObjectType" type="enum" class="ObjectType" pass="in" description="object type enum." />
</method>
<method name="GetName" description="Retrieves an object's name">
<param name="Name" type="string" pass="return" description="returns object name." />
</method>
<method name="SetName" description="Sets an object's name string">
<param name="Name" type="string" pass="in" description="new object name." />
</method>
<method name="GetPartNumber" description="Retrieves an object's part number">
<param name="PartNumber" type="string" pass="return" description="returns object part number." />
</method>
<method name="SetPartNumber" description="Sets an objects partnumber string">
<param name="PartNumber" type="string" pass="in" description="new object part number." />
</method>
<method name="IsMeshObject" description="Retrieves, if an object is a mesh object">
<param name="IsMeshObject" type="bool" pass="return" description="returns, whether the object is a mesh object" />
</method>
<method name="IsComponentsObject" description="Retrieves, if an object is a components object">
<param name="IsComponentsObject" type="bool" pass="return" description="returns, whether the object is a components object" />
</method>
<method name="IsValid" description="Retrieves, if the object is valid according to the core spec. For mesh objects, we distinguish between the type attribute of the object:In case of object type other, this always means false.In case of object type model or solidsupport, this means, if the mesh suffices all requirements of the core spec chapter 4.1.In case of object type support or surface, this always means true.A component objects is valid if and only if it contains at least one component and all child components are valid objects.">
<param name="IsValid" type="bool" pass="return" description="returns whether the object is a valid object description" />
</method>
<!-- property handling -->
<!-- object thumbnails -->
<method name="GetUUID" description="Retrieves an object's uuid string (see production extension specification)">
<param name="HasUUID" type="bool" pass="out" description="flag whether the build item has a UUID"/>
<param name="UUID" type="string" pass="return" description="returns object uuid." />
</method>
<method name="SetUUID" description="Sets a build object's uuid string (see production extension specification)">
<param name="UUID" type="string" pass="in" description="new object uuid string." />
</method>
<method name="GetMetaDataGroup" description="Returns the metadatagroup of this object">
<param name="MetaDataGroup" type="handle" class="MetaDataGroup" pass="return" description="returns an Instance of the metadatagroup of this object" />
</method>
<method name="SetSlicesMeshResolution" description="set the meshresolution of the mesh object">
<param name="MeshResolution" type="enum" class="SlicesMeshResolution" pass="in" description="meshresolution of this object" />
</method>
<method name="GetSlicesMeshResolution" description="get the meshresolution of the mesh object">
<param name="MeshResolution" type="enum" class="SlicesMeshResolution" pass="return" description="meshresolution of this object" />
</method>
<method name="HasSliceStack" description="returns whether the Object has a slice stack">
<param name="HasStack" type="bool" pass="return" description="does the object have a slice stack" />
</method>
<method name="ClearSliceStack" description="unlinks the attached slicestack from this object. If no slice stack is attached, do noting.">
</method>
<method name="GetSliceStack" description="get the Slicestack attached to the object">
<param name="SliceStackInstance" type="handle" class="SliceStack" pass="return" description="returns the slicestack instance" />
</method>
<method name="AssignSliceStack" description="assigns a slicestack to the object">
<param name="SliceStackInstance" type="handle" class="SliceStack" pass="in" description="the new slice stack of this Object" />
</method>
</class>
<class name="MeshObject" parent="Object">
<method name="GetVertexCount" description="Returns the vertex count of a mesh object.">
<param name="VertexCount" type="uint32" pass="return" description="filled with the vertex count." />
</method>
<method name="GetTriangleCount" description="Returns the triangle count of a mesh object.">
<param name="VertexCount" type="uint32" pass="return" description="filled with the triangle count." />
</method>
<method name="GetVertex" description="Returns the vertex count of a mesh object.">
<param name="Index" type="uint32" pass="in" description="Index of the vertex (0 to vertexcount - 1)" />
<param name="Coordinates" type="struct" class="Position" pass="return" description="filled with the vertex coordinates." />
</method>
<method name="SetVertex" description="Sets the coordinates of a single vertex of a mesh object">
<param name="Index" type="uint32" pass="in" description="Index of the vertex (0 to vertexcount - 1)" />
<param name="Coordinates" type="struct" class="Position" pass="in" description="contains the vertex coordinates." />
</method>
<method name="AddVertex" description="Adds a single vertex to a mesh object">
<param name="Coordinates" type="struct" class="Position" pass="in" description="contains the vertex coordinates." />
<param name="NewIndex" type="uint32" pass="return" description="Index of the new vertex" />
</method>
<method name="GetVertices" description="Obtains all vertex positions of a mesh object">
<param name="Vertices" type="structarray" class="Position" pass="out" description="contains the vertex coordinates." />
</method>
<method name="GetTriangle" description="Returns indices of a single triangle of a mesh object.">
<param name="Index" type="uint32" pass="in" description="Index of the triangle (0 to trianglecount - 1)" />
<param name="Indices" type="struct" class="Triangle" pass="return" description="filled with the triangle indices." />
</method>
<method name="SetTriangle" description="Sets the indices of a single triangle of a mesh object.">
<param name="Index" type="uint32" pass="in" description="Index of the triangle (0 to trianglecount - 1)" />
<param name="Indices" type="struct" class="Triangle" pass="in" description="contains the triangle indices." />
</method>
<method name="AddTriangle" description="Adds a single triangle to a mesh object">
<param name="Indices" type="struct" class="Triangle" pass="in" description="contains the triangle indices." />
<param name="NewIndex" type="uint32" pass="return" description="Index of the new triangle" />
</method>
<method name="GetTriangleIndices" description="Get all triangles of a mesh object">
<param name="Indices" type="structarray" class="Triangle" pass="out" description="contains the triangle indices." />
</method>
<method name="SetTriangleProperties" description="Sets the properties of a single triangle of a mesh object.">
<param name="Index" type="uint32" pass="in" description="Index of the triangle (0 to trianglecount - 1)" />
<param name="Properties" type="struct" class="TriangleProperties" pass="in" description="contains the triangle properties." />
</method>
<method name="GetTriangleProperties" description="Gets the properties of a single triangle of a mesh object.">
<param name="Index" type="uint32" pass="in" description="Index of the triangle (0 to trianglecount - 1)" />
<param name="Property" type="struct" class="TriangleProperties" pass="out" description="returns the triangle properties." />
</method>
<method name="SetAllTriangleProperties" description="Sets the properties of all triangles of a mesh object.">
<param name="PropertiesArray" type="structarray" class="TriangleProperties" pass="in" description="contains the triangle properties array. Must have trianglecount elements." />
</method>
<method name="GetAllTriangleProperties" description="Gets the properties of all triangles of a mesh object.">
<param name="PropertiesArray" type="structarray" class="TriangleProperties" pass="out" description="returns the triangle properties array. Must have trianglecount elements." />
</method>
<method name="SetGeometry" description="Set all triangles of a mesh object">
<param name="Vertices" type="structarray" class="Position" pass="in" description="contains the positions." />
<param name="Indices" type="structarray" class="Triangle" pass="in" description="contains the triangle indices." />
</method>
<method name="IsManifoldAndOriented" description="Retrieves, if an object describes a topologically oriented and manifold mesh, according to the core spec.">
<param name="IsManifoldAndOriented" type="bool" pass="return" description="returns, if the object is oriented and manifold." />
</method>
<method name="BeamLattice" description="Retrieves the BeamLattice within this MeshObject.">
<param name="TheBeamLattice" type="handle" class="BeamLattice" pass="return" description="the BeamLattice within this MeshObject" />
</method>
</class>
<class name="BeamLattice">
<method name="GetMinLength" description="Returns the minimal length of beams for the beamlattice.">
<param name="MinLength" type="double" pass="return" description="minimal length of beams for the beamlattice" />
</method>
<method name="SetMinLength" description="Sets the minimal length of beams for the beamlattice.">
<param name="MinLength" type="double" pass="in" description="minimal length of beams for the beamlattice" />
</method>
<method name="GetClipping" description="Returns the clipping mode and the clipping-mesh for the beamlattice of this mesh.">
<param name="ClipMode" type="enum" class="BeamLatticeClipMode" pass="out" description="contains the clip mode of this mesh" />
<param name="ResourceID" type="uint32" pass="out" description="filled with the resourceID of the clipping mesh-object or an undefined value if pClipMode is MODELBEAMLATTICECLIPMODE_NONE" />
</method>
<method name="SetClipping" description="Sets the clipping mode and the clipping-mesh for the beamlattice of this mesh.">
<param name="ClipMode" type="enum" class="BeamLatticeClipMode" pass="in" description="contains the clip mode of this mesh" />
<param name="ResourceID" type="uint32" pass="in" description="the resourceID of the clipping mesh-object. This mesh-object has to be defined before setting the Clipping." />
</method>
<method name="GetRepresentation" description="Returns the representation-mesh for the beamlattice of this mesh.">
<param name="HasRepresentation" type="bool" pass="return" description="flag whether the beamlattice has a representation mesh." />
<param name="ResourceID" type="uint32" pass="out" description="filled with the resourceID of the clipping mesh-object." />
</method>
<method name="SetRepresentation" description="Sets the representation-mesh for the beamlattice of this mesh.">
<param name="ResourceID" type="uint32" pass="in" description="the resourceID of the representation mesh-object. This mesh-object has to be defined before setting the representation." />
</method>
<method name="GetBeamCount" description="Returns the beam count of a mesh object.">
<param name="Count" type="uint32" pass="return" description="filled with the beam count." />
</method>
<method name="GetBeam" description="Returns indices, radii and capmodes of a single beam of a mesh object.">
<param name="Index" type="uint32" pass="in" description="Index of the beam (0 to beamcount - 1)." />
<param name="BeamInfo" type="struct" class="Beam" pass="return" description="filled with the beam indices, radii and capmodes." />
</method>
<method name="AddBeam" description="Adds a single beam to a mesh object.">
<param name="BeamInfo" type="struct" class="Beam" pass="in" description="contains the node indices, radii and capmodes." />
<param name="Index" type="uint32" pass="return" description="filled with the new Index of the beam." />
</method>
<method name="SetBeam" description="Sets the indices, radii and capmodes of a single beam of a mesh object.">
<param name="Index" type="uint32" pass="in" description="Index of the beam (0 to beamcount - 1)." />
<param name="BeamInfo" type="struct" class="Beam" pass="in" description="filled with the beam indices, radii and capmodes." />
</method>
<method name="SetBeams" description="Sets all beam indices, radii and capmodes of a mesh object.">
<param name="BeamInfo" type="structarray" class="Beam" pass="in" description="contains information of a number of beams" />
</method>
<method name="GetBeams" description="obtains all beam indices, radii and capmodes of a mesh object.">
<param name="BeamInfo" type="structarray" class="Beam" pass="out" description="contains information of all beams" />
</method>
<method name="GetBeamSetCount" description="Returns the number of beamsets of a mesh object.">
<param name="Count" type="uint32" pass="return" description="filled with the beamset count." />
</method>
<method name="AddBeamSet" description="Adds an empty beamset to a mesh object">
<param name="BeamSet" type="handle" class="BeamSet" pass="return" description="the new beamset" />
</method>
<method name="GetBeamSet" description="Returns a beamset of a mesh object">
<param name="Index" type="uint32" pass="in" description="index of the requested beamset (0 ... beamsetcount-1)." />
<param name="BeamSet" type="handle" class="BeamSet" pass="return" description="the requested beamset" />
</method>
</class>
<class name="Component">
<method name="GetObjectResource" description="Returns the Resource Instance of the component..">
<param name="ObjectResource" type="handle" class="Object" pass="return" description="filled with the Resource Instance." />
</method>
<method name="GetObjectResourceID" description="Returns the Resource ID of the component.">
<param name="ObjectResourceID" type="uint32" pass="return" description="returns the Resource ID." />
</method>
<method name="GetUUID" description="returns, whether a component has a UUID and, if true, the component's UUID">
<param name="HasUUID" type="bool" pass="out" description="flag whether the component has a UUID"/>
<param name="UUID" type="string" pass="return" description="the UUID as string of the form 'xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx'"/>
</method>
<method name="SetUUID" description="sets the component's UUID">
<param name="UUID" type="string" pass="in" description="the UUID as string of the form 'xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx'"/>
</method>
<method name="HasTransform" description="Returns, if the component has a different transformation than the identity matrix">
<param name="HasTransform" type="bool" pass="return" description="if true is returned, the transformation is not equal than the identity"/>
</method>
<method name="GetTransform" description="Returns the transformation matrix of the component.">
<param name="Transform" type="struct" class="Transform" pass="return" description="filled with the component transformation matrix"/>
</method>
<method name="SetTransform" description="Sets the transformation matrix of the component.">
<param name="Transform" type="struct" class="Transform" pass="in" description="new transformation matrix"/>
</method>
</class>
<class name="ComponentsObject" parent="Object">
<method name="AddComponent" description="Adds a new component to a components object.">
<param name="ObjectResource" type="handle" class="Object" pass="in" description="object to add as component. Must not lead to circular references!" />
<param name="Transform" type="struct" class="Transform" pass="in" description="optional transform matrix for the component." />
<param name="ComponentInstance" type="handle" class="Component" pass="return" description="new component instance" />
</method>
<method name="GetComponent" description="Retrieves a component from a component object.">
<param name="Index" type="uint32" pass="in" description="index of the component to retrieve (0 to componentcount - 1)" />
<param name="ComponentInstance" type="handle" class="Component" pass="return" description="component instance" />
</method>
<method name="GetComponentCount" description="Retrieves a component count of a component object.">
<param name="Count" type="uint32" pass="return" description="returns the component count" />
</method>
</class>
<class name="BeamSet">
<method name="SetName" description="Sets a beamset's name string">
<param name="Name" type="string" pass="in" description="new name of the beamset." />
</method>
<method name="GetName" description="Retrieves a beamset's name string">
<param name="Name" type="string" pass="return" description="returns the name of the beamset." />
</method>
<method name="SetIdentifier" description="Sets a beamset's identifier string">
<param name="Identifier" type="string" pass="in" description="new name of the beamset." />
</method>
<method name="GetIdentifier" description="Retrieves a beamset's identifier string">
<param name="Identifier" type="string" pass="return" description="returns the identifier of the beamset." />
</method>
<method name="GetReferenceCount" description="Retrieves the reference count of a beamset">
<param name="Count" type="uint32" pass="return" description="returns the reference count" />
</method>
<method name="SetReferences" description="Sets the references of a beamset">
<param name="References" type="basicarray" class="uint32" pass="in" description="the new indices of all beams in this beamset" />
</method>
<method name="GetReferences" description="Retrieves the references of a beamset">
<param name="References" type="basicarray" class="uint32" pass="out" description="retrieves the indices of all beams in this beamset" />
</method>
</class>
<class name="BaseMaterialGroup" parent="Resource" description="The BaseMaterialGroup corresponds to a basematerials-element within a 3MF document">
<method name="GetCount" description="Retrieves the count of base materials in the material group.">
<param name="Count" type="uint32" pass="return" description="returns the count of base materials." />
</method>
<method name="GetAllPropertyIDs" description="returns all the PropertyIDs of all materials in this group">
<param name="PropertyIDs" type="basicarray" class="uint32" pass="out" description="PropertyID of the material in the material group." />
</method>
<method name="AddMaterial" description="Adds a new material to the material group">
<param name="Name" type="string" pass="in" description="new name of the base material." />
<param name="DisplayColor" type="struct" class="Color" pass="in" description="Display color of the material" />
<param name="PropertyID" type="uint32" pass="return" description="returns new PropertyID of the new material in the material group." />
</method>
<method name="RemoveMaterial" description="Removes a material from the material group.">
<param name="PropertyID" type="uint32" pass="in" description="PropertyID of the material in the material group." />
</method>
<method name="GetName" description="Returns the base material's name">
<param name="PropertyID" type="uint32" pass="in" description="PropertyID of the material in the material group." />
<param name="Name" type="string" pass="return" description="returns the name of the base material." />
</method>
<method name="SetName" description="Sets a base material's name">
<param name="PropertyID" type="uint32" pass="in" description="PropertyID of the material in the material group." />
<param name="Name" type="string" pass="in" description="new name of the base material." />
</method>
<method name="SetDisplayColor" description="Sets a base material's display color.">
<param name="PropertyID" type="uint32" pass="in" description="PropertyID of the material in the material group." />
<param name="TheColor" type="struct" class="Color" pass="in" description="The base material's display color" />
</method>
<method name="GetDisplayColor" description="Returns a base material's display color.">
<param name="PropertyID" type="uint32" pass="in" description="PropertyID of the material in the material group." />
<param name="TheColor" type="struct" class="Color" pass="return" description="The base material's display color" />
</method>
</class>
<class name="ColorGroup" parent="Resource">
<method name="GetCount" description="Retrieves the count of base materials in this Color Group.">
<param name="Count" type="uint32" pass="return" description="returns the count of colors within this color group." />
</method>
<method name="GetAllPropertyIDs" description="returns all the PropertyIDs of all colors within this group">
<param name="PropertyIDs" type="basicarray" class="uint32" pass="out" description="PropertyID of the color in the color group." />
</method>
<method name="AddColor" description="Adds a new value.">
<param name="TheColor" type="struct" class="Color" pass="in" description="The new color" />
<param name="PropertyID" type="uint32" pass="return" description="PropertyID of the new color within this color group." />
</method>
<method name="RemoveColor" description="Removes a color from the color group.">
<param name="PropertyID" type="uint32" pass="in" description="PropertyID of the color to be removed from the color group." />
</method>
<method name="SetColor" description="Sets a color value.">
<param name="PropertyID" type="uint32" pass="in" description="PropertyID of a color within this color group." />
<param name="TheColor" type="struct" class="Color" pass="in" description="The color" />
</method>
<method name="GetColor" description="Sets a color value.">
<param name="PropertyID" type="uint32" pass="in" description="PropertyID of a color within this color group." />
<param name="TheColor" type="struct" class="Color" pass="return" description="The color" />
</method>
</class>
<class name="Texture2DGroup" parent="Resource">
<method name="GetCount" description="Retrieves the count of tex2coords in the Texture2DGroup.">
<param name="Count" type="uint32" pass="return" description="returns the count of tex2coords." />
</method>
<method name="GetAllPropertyIDs" description="returns all the PropertyIDs of all tex2coords in this Texture2DGroup">
<param name="PropertyIDs" type="basicarray" class="uint32" pass="out" description="PropertyID of the tex2coords in the Texture2DGroup." />
</method>
<method name="AddTex2Coord" description="Adds a new tex2coord to the Texture2DGroup">
<param name="UVCoordinate" type="struct" class="Tex2Coord" pass="in" description="The u/v-coordinate within the texture, horizontally right/vertically up from the origin in the lower left of the texture." />
<param name="PropertyID" type="uint32" pass="return" description="returns new PropertyID of the new tex2coord in the Texture2DGroup." />
</method>
<method name="GetTex2Coord" description="Obtains a tex2coord to the Texture2DGroup">
<param name="PropertyID" type="uint32" pass="in" description="the PropertyID of the tex2coord in the Texture2DGroup." />
<param name="UVCoordinate" type="struct" class="Tex2Coord" pass="return" description="The u/v-coordinate within the texture, horizontally right/vertically up from the origin in the lower left of the texture." />
</method>
<method name="RemoveTex2Coord" description="Removes a tex2coords from the Texture2DGroup.">
<param name="PropertyID" type="uint32" pass="in" description="PropertyID of the tex2coords in the Texture2DGroup." />
</method>
<method name="GetTexture2D" description="Obtains the texture2D instance of this group.">
<param name="Texture2DInstance" type="handle" class="Texture2D" pass="return" description="the texture2D instance of this group." />
</method>
</class>
<class name="CompositeMaterials" parent="Resource">
<method name="GetCount" description="Retrieves the count of Composite-s in the CompositeMaterials.">
<param name="Count" type="uint32" pass="return" description="returns the count of Composite-s" />
</method>
<method name="GetAllPropertyIDs" description="returns all the PropertyIDs of all Composite-Mixing Values in this CompositeMaterials">
<param name="PropertyIDs" type="basicarray" class="uint32" pass="out" description="PropertyID of the Composite-Mixing Values in the CompositeMaterials." />
</method>
<method name="GetBaseMaterialGroup" description="Obtains the BaseMaterialGroup instance of this CompositeMaterials.">
<param name="BaseMaterialGroupInstance" type="handle" class="BaseMaterialGroup" pass="return" description="returns the BaseMaterialGroup instance of this CompositeMaterials" />
</method>
<method name="AddComposite" description="Adds a new Composite-Mixing Values to the CompositeMaterials.">
<param name="Composite" type="structarray" class="CompositeConstituent" pass="in" description="The Composite Constituents to be added as composite" />
<param name="PropertyID" type="uint32" pass="return" description="returns new PropertyID of the new Composite in the CompositeMaterials." />
</method>
<method name="RemoveComposite" description="Removes a Composite-Maxing Ratio from the CompositeMaterials.">
<param name="PropertyID" type="uint32" pass="in" description="PropertyID of the Composite-Mixing Values in the CompositeMaterials to be removed." />
</method>
<method name="GetComposite" description="Obtains a Composite-Maxing Ratio of this CompositeMaterials.">
<param name="PropertyID" type="uint32" pass="in" description="the PropertyID of the Composite-Maxing Ratio in the CompositeMaterials." />
<param name="Composite" type="structarray" class="CompositeConstituent" pass="out" description="The Composite-Mixing Values with the given PropertyID" />
</method>
</class>
<class name="MultiPropertyGroup" parent="Resource">
<method name="GetCount" description="Retrieves the count of MultiProperty-s in the MultiPropertyGroup.">
<param name="Count" type="uint32" pass="return" description="returns the count of MultiProperty-s" />
</method>
<method name="GetAllPropertyIDs" description="returns all the PropertyIDs of all MultiProperty-s in this MultiPropertyGroup">
<param name="PropertyIDs" type="basicarray" class="uint32" pass="out" description="PropertyID of the MultiProperty-s in the MultiPropertyGroup." />
</method>
<method name="AddMultiProperty" description="Adds a new MultiProperty to the MultiPropertyGroup.">
<param name="PropertyIDs" type="basicarray" class="uint32" pass="in" description="The PropertyIDs of the new MultiProperty." />
<param name="PropertyID" type="uint32" pass="return" description="returns the PropertyID of the new MultiProperty in the MultiPropertyGroup." />
</method>
<method name="SetMultiProperty" description="Sets the PropertyIDs of a MultiProperty.">
<param name="PropertyID" type="uint32" pass="in" description="the PropertyID of the MultiProperty to be changed." />
<param name="PropertyIDs" type="basicarray" class="uint32" pass="in" description="The new PropertyIDs of the MultiProperty" />
</method>
<method name="GetMultiProperty" description="Obtains the PropertyIDs of a MultiProperty.">
<param name="PropertyID" type="uint32" pass="in" description="the PropertyID of the MultiProperty to be queried." />
<param name="PropertyIDs" type="basicarray" class="uint32" pass="out" description="The PropertyIDs of the MultiProperty" />
</method>
<method name="RemoveMultiProperty" description="Removes a MultiProperty from this MultiPropertyGroup.">
<param name="PropertyID" type="uint32" pass="in" description="the PropertyID of the MultiProperty to be removed." />
</method>
<method name="GetLayerCount" description="Retrieves the number of layers of this MultiPropertyGroup.">
<param name="Count" type="uint32" pass="return" description="returns the number of layers" />
</method>
<method name="AddLayer" description="Adds a MultiPropertyLayer to this MultiPropertyGroup.">
<param name="TheLayer" type="struct" class="MultiPropertyLayer" pass="in" description="The MultiPropertyLayer to add to this MultiPropertyGroup" />
<param name="LayerIndex" type="uint32" pass="return" description="returns the index of this MultiPropertyLayer" />
</method>
<method name="GetLayer" description="Obtains a MultiPropertyLayer of this MultiPropertyGroup.">
<param name="LayerIndex" type="uint32" pass="in" description="The Index of the MultiPropertyLayer queried" />
<param name="TheLayer" type="struct" class="MultiPropertyLayer" pass="return" description="The MultiPropertyLayer with index LayerIndex within MultiPropertyGroup" />
</method>
<method name="RemoveLayer" description="Removes a MultiPropertyLayer from this MultiPropertyGroup.">
<param name="LayerIndex" type="uint32" pass="in" description="The Index of the MultiPropertyLayer to be removed" />
</method>
</class>
<class name="Attachment">
<method name="GetPath" description = "Retrieves an attachment's package path.">
<param name="Path" type="string" pass="return" description="returns the attachment's package path string" />
</method>
<method name="SetPath" description = "Sets an attachment's package path.">
<param name="Path" type="string" pass="in" description="new path of the attachment." />
</method>
<method name="GetRelationShipType" description = "Retrieves an attachment's relationship type">
<param name="Path" type="string" pass="return" description="returns the attachment's package relationship type string" />
</method>
<method name="SetRelationShipType" description = "Sets an attachment's relationship type.">
<param name="Path" type="string" pass="in" description="new relationship type string." />
</method>
<method name="WriteToFile" description = "Writes out the attachment as file.">
<param name="FileName" type="string" pass="in" description="file to write into." />
</method>
<method name="ReadFromFile" description = "Reads an attachment from a file.">
<param name="FileName" type="string" pass="in" description="file to read from." />
</method>
<method name="GetStreamSize" description = "Retrieves the size of the attachment stream">
<param name="StreamSize" type="uint64" pass="return" description="the stream size" />
</method>
<method name="WriteToBuffer" description = "Writes out the attachment into a buffer">
<param name="Buffer" type="basicarray" class="uint8" pass="out" description="Buffer to write into" />
</method>
<method name="ReadFromBuffer" description = "Reads an attachment from a memory buffer">
<param name="Buffer" type="basicarray" class="uint8" pass="in" description="Buffer to read from" />
</method>
<!--
<method name="WriteToCallback" description = "Writes out the attachment and passes the data to a provided callback function. The file type is specified by the type (and potentially path) of the attachment">
<param name="WriteCallback" type="callback" pass="in" description="Callback to call for writing a data chunk" />
<param name="UserData" type="pointer" pass="in" description="Userdata that is passed to the callback function" />
</method>
-->
</class>
<class name="Texture2D" parent="Resource">
<method name="GetAttachment" description = "Retrieves the attachment located at the path of the texture.">
<param name="Attachment" type="handle" class="Attachment" pass="return" description="attachment that holds the texture's image information." />
</method>
<method name="SetAttachment" description = "Sets the texture's package path to the path of the attachment.">
<param name="Attachment" type="handle" class="Attachment" pass="in" description="attachment that holds the texture's image information." />
</method>
<method name="GetContentType" description = "Retrieves a texture's content type.">
<param name="ContentType" type="enum" class="TextureType" pass="return" description="returns content type enum." />
</method>
<method name="SetContentType" description = "Retrieves a texture's content type.">
<param name="ContentType" type="enum" class="TextureType" pass="in" description="new Content Type" />
</method>
<method name="GetTileStyleUV" description = "Retrieves a texture's tilestyle type.">
<param name="TileStyleU" type="enum" class="TextureTileStyle" pass="out" description="returns tilestyle type enum." />
<param name="TileStyleV" type="enum" class="TextureTileStyle" pass="out" description="returns tilestyle type enum." />
</method>
<method name="SetTileStyleUV" description = "Sets a texture's tilestyle type.">
<param name="TileStyleU" type="enum" class="TextureTileStyle" pass="in" description="new tilestyle type enum." />
<param name="TileStyleV" type="enum" class="TextureTileStyle" pass="in" description="new tilestyle type enum." />
</method>
<method name="GetFilter" description = "Retrieves a texture's filter type.">
<param name="Filter" type="enum" class="TextureFilter" pass="return" description="returns filter type enum." />
</method>
<method name="SetFilter" description = "Sets a texture's filter type.">
<param name="Filter" type="enum" class="TextureFilter" pass="in" description="sets new filter type enum." />
</method>
</class>
<class name="BuildItem">
<method name="GetObjectResource" description="Retrieves the object resource associated to a build item">
<param name="ObjectResource" type="handle" class="Object" pass="return" description="returns the associated resource instance"/>
</method>
<method name="GetUUID" description="returns, whether a build item has a UUID and, if true, the build item's UUID">
<param name="HasUUID" type="bool" pass="out" description="flag whether the build item has a UUID"/>
<param name="UUID" type="string" pass="return" description="the UUID as string of the form 'xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx'"/>
</method>
<method name="SetUUID" description="sets the build item's UUID">
<param name="UUID" type="string" pass="in" description="the UUID as string of the form 'xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx'"/>
</method>
<method name="GetObjectResourceID" description="Retrieves the object resource id associated to a build item">
<param name="Id" type="uint32" pass="return" description=" eturns the ID of the object"/>
</method>
<method name="HasObjectTransform" description="Checks, if a build item has a non-identity transformation matrix">
<param name="HasTransform" type="bool" pass="return" description="returns true, if the transformation matrix is not the identity"/>
</method>
<method name="GetObjectTransform" description="Retrieves a build item's transformation matrix.">
<param name="Transform" type="struct" class="Transform" pass="return" description="returns the transformation matrix"/>
</method>
<method name="SetObjectTransform" description="Sets a build item's transformation matrix.">
<param name="Transform" type="struct" class="Transform" pass="in" description="new transformation matrix"/>
</method>
<method name="GetPartNumber" description="Retrieves a build item's part number string">
<param name="PartNumber" type="string" pass="return" description="Returns a build item's part number string"/>
</method>
<method name="SetPartNumber" description="Sets a build item's part number string">
<param name="SetPartnumber" type="string" pass="in" description="new part number string for referencing parts from the outside world" />
</method>
<method name="GetMetaDataGroup" description="Returns the metadatagroup of this build item">
<param name="MetaDataGroup" type="handle" class="MetaDataGroup" pass="return" description="returns an Instance of the metadatagroup of this build item" />
</method>
</class>
<class name="BuildItemIterator">
<method name="MoveNext" description="Iterates to the next build item in the list.">
<param name="HasNext" type="bool" pass="return" description="Iterates to the next build item in the list." />
</method>
<method name="MovePrevious" description="Iterates to the previous build item in the list.">
<param name="HasPrevious" type="bool" pass="return" description="Iterates to the previous build item in the list." />
</method>
<method name="GetCurrent" description="Returns the build item the iterator points at.">
<param name="BuildItem" type="handle" class="BuildItem" pass="return" description="returns the build item instance." />
</method>
<method name="Clone" description="Creates a new build item iterator with the same build item list.">
<param name="OutBuildItemIterator" type="handle" class="BuildItemIterator" pass="return" description="returns the cloned Iterator instance" />
</method>
</class>
<class name="Slice">
<method name="SetVertices" description="Set all vertices of a slice. All polygons will be cleared.">
<param name="Vertices" type="structarray" class="Position2D" pass="in" description="contains the positions." />
</method>
<method name="GetVertices" description="Get all vertices of a slice">
<param name="Vertices" type="structarray" class="Position2D" pass="out" description="contains the positions." />
</method>
<method name="GetVertexCount" description="Get the number of vertices in a slice">
<param name="Count" type="uint64" pass="return" description="the number of vertices in the slice" />
</method>
<method name="AddPolygon" description="Add a new polygon to this slice">
<param name="Indices" type="basicarray" class="uint32" pass="in" description="the new indices of the new polygon" />
<param name="Index" type="uint64" pass="return" description="the index of the new polygon" />
</method>
<method name="GetPolygonCount" description="Get the number of polygons in the slice">
<param name="Count" type="uint64" pass="return" description="the number of polygons in the slice" />
</method>
<method name="SetPolygonIndices" description="Set all indices of a polygon">
<param name="Index" type="uint64" pass="in" description="the index of the polygon to manipulate" />
<param name="Indices" type="basicarray" class="uint32" pass="in" description="the new indices of the index-th polygon" />
</method>
<method name="GetPolygonIndices" description="Get all vertices of a slice">
<param name="Index" type="uint64" pass="in" description="the index of the polygon to manipulate" />
<param name="Indices" type="basicarray" class="uint32" pass="out" description="the indices of the index-th polygon " />
</method>
<method name="GetPolygonIndexCount" description="Get the number of vertices in a slice">
<param name="Index" type="uint64" pass="in" description="the index of the polygon to manipulate" />
<param name="Count" type="uint64" pass="return" description="the number of indices of the index-th polygon" />
</method>
<method name="GetZTop" description="Get the upper Z-Coordinate of this slice.">
<param name="ZTop" type="double" pass="return" description="the upper Z-Coordinate of this slice" />
</method>
</class>
<class name="SliceStack" parent="Resource">
<method name="GetBottomZ" description="Get the lower Z-Coordinate of the slice stack.">
<param name="ZBottom" type="double" pass="return" description="the lower Z-Coordinate the slice stack" />
</method>
<method name="GetSliceCount" description="Returns the number of slices">
<param name="Count" type="uint64" pass="return" description="the number of slices" />
</method>
<method name="GetSlice" description="Query a slice from the slice stack">
<param name="SliceIndex" type="uint64" pass="in" description="the index of the slice" />
<param name="TheSlice" type="handle" class="Slice" pass="return" description="the Slice instance" />
</method>
<method name="AddSlice" description="Returns the number of slices">
<param name="ZTop" type="double" pass="in" description="upper Z coordinate of the slice"/>
<param name="TheSlice" type="handle" class="Slice" pass="return" description="a new Slice instance" />
</method>
<method name="GetSliceRefCount" description="Returns the number of slice refs">
<param name="Count" type="uint64" pass="return" description="the number of slicereferences" />
</method>
<method name="AddSliceStackReference" description="Adds another existing slicestack as sliceref in this slicestack">
<param name="TheSliceStack" type="handle" class="SliceStack" pass="in" description="the slicestack to use as sliceref" />
</method>
<method name="GetSliceStackReference" description="Adds another existing slicestack as sliceref in this slicestack">
<param name="SliceRefIndex" type="uint64" pass="in" description="the index of the slice ref" />
<param name="TheSliceStack" type="handle" class="SliceStack" pass="return" description="the slicestack that is used as sliceref" />
</method>
<method name="CollapseSliceReferences" description="Removes the indirection of slices via slice-refs, i.e. creates the slices of all slice refs of this SliceStack as actual slices of this SliceStack. All previously existing slices or slicerefs will be removed.">
</method>
<method name="SetOwnPath" description="Sets the package path where this Slice should be stored. Input an empty string to reset the path">
<param name="Path" type="string" pass="in" description="the package path where this Slice should be stored" />
</method>
<method name="GetOwnPath" description="Obtains the package path where this Slice should be stored. Returns an empty string if the slicestack is stored within the root model.">
<param name="Path" type="string" pass="return" description="the package path where this Slice will be stored" />
</method>
</class>
<class name="Model">
<method name="SetUnit" description = "sets the units of a model.">
<param name="Unit" type="enum" class="ModelUnit" pass="in" description="Unit enum value for the model unit" />
</method>
<method name="GetUnit" description = "returns the units of a model.">
<param name="Unit" type="enum" class="ModelUnit" pass="return" description="Unit enum value for the model unit" />
</method>
<method name="GetLanguage" description="retrieves the language of a model">
<param name="Language" type="string" pass="return" description="language identifier"/>
</method>
<method name="SetLanguage" description="sets the language of a model">
<param name="Language" type="string" pass="in" description="language identifier" />
</method>
<method name="QueryWriter" description="creates a model writer instance for a specific file type">
<param name="WriterClass" type="string" pass="in" description=" string identifier for the file type" />
<param name="WriterInstance" type="handle" class="Writer" pass="return" description=" string identifier for the file type" />
</method>
<method name="QueryReader" description="creates a model reader instance for a specific file type">
<param name="ReaderClass" type="string" pass="in" description=" string identifier for the file type" />
<param name="ReaderInstance" type="handle" class="Reader" pass="return" description=" string identifier for the file type" />
</method>
<method name="GetTexture2DByID" description="finds a model texture by its id">
<param name="ResourceID" type="uint32" pass="in" description="Resource ID" />
<param name="TextureInstance" type="handle" class="Texture2D" pass="return" description="returns the texture2d instance" />
</method>
<method name="GetPropertyTypeByID" description="returns a Property's type">
<param name="ResourceID" type="uint32" pass="in" description="Resource ID of the Property to Query" />
<param name="ThePropertyType" type="enum" class="PropertyType" pass="return" description="returns a Property's type" />
</method>
<method name="GetBaseMaterialGroupByID" description="finds a model base material group by its id">
<param name="ResourceID" type="uint32" pass="in" description="Resource ID" />
<param name="BaseMaterialGroupInstance" type="handle" class="BaseMaterialGroup" pass="return" description="returns the BaseMaterialGroup instance" />
</method>
<method name="GetTexture2DGroupByID" description="finds a model texture2d group by its id">
<param name="ResourceID" type="uint32" pass="in" description="Resource ID" />
<param name="Texture2DGroupInstance" type="handle" class="Texture2DGroup" pass="return" description="returns the Texture2DGroup instance" />
</method>
<method name="GetCompositeMaterialsByID" description="finds a model CompositeMaterials by its id">
<param name="ResourceID" type="uint32" pass="in" description="Resource ID" />
<param name="CompositeMaterialsInstance" type="handle" class="CompositeMaterials" pass="return" description="returns the CompositeMaterials instance" />
</method>
<method name="GetMultiPropertyGroupByID" description="finds a model MultiPropertyGroup by its id">
<param name="ResourceID" type="uint32" pass="in" description="Resource ID" />
<param name="MultiPropertyGroupInstance" type="handle" class="MultiPropertyGroup" pass="return" description="returns the MultiPropertyGroup instance" />
</method>
<method name="GetMeshObjectByID" description="finds a mesh object by its id">
<param name="ResourceID" type="uint32" pass="in" description="Resource ID" />
<param name="MeshObjectInstance" type="handle" class="MeshObject" pass="return" description="returns the mesh object instance" />
</method>
<method name="GetComponentsObjectByID" description="finds a components object by its id">
<param name="ResourceID" type="uint32" pass="in" description="Resource ID" />
<param name="ComponentsObjectInstance" type="handle" class="ComponentsObject" pass="return" description="returns the components object instance" />
</method>
<method name="GetColorGroupByID" description="finds a model color group by its id">
<param name="ResourceID" type="uint32" pass="in" description="Resource ID" />
<param name="ColorGroupInstance" type="handle" class="ColorGroup" pass="return" description="returns the ColorGroup instance" />
</method>
<method name="GetSliceStackByID" description="finds a model slicestack by its id">
<param name="ResourceID" type="uint32" pass="in" description="Resource ID" />
<param name="SliceStacInstance" type="handle" class="SliceStack" pass="return" description="returns the slicestack instance" />
</method>
<method name="GetBuildUUID" description="returns, whether a build has a UUID and, if true, the build's UUID">
<param name="HasUUID" type="bool" pass="out" description="flag whether the build has a UUID"/>
<param name="UUID" type="string" pass="return" description="the UUID as string of the form 'xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx'"/>
</method>
<method name="SetBuildUUID" description="sets the build's UUID">
<param name="UUID" type="string" pass="in" description="the UUID as string of the form 'xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx'"/>
</method>
<method name="GetBuildItems" description="creates a build item iterator instance with all build items.">
<param name="BuildItemIterator" type="handle" class="BuildItemIterator" pass="return" description="returns the iterator instance." />
</method>
<method name="GetResources" description="creates a resource iterator instance with all resources.">
<param name="ResourceIterator" type="handle" class="ResourceIterator" pass="return" description="returns the iterator instance." />
</method>
<method name="GetObjects" description="creates a resource iterator instance with all object resources.">
<param name="ResourceIterator" type="handle" class="ObjectIterator" pass="return" description="returns the iterator instance." />
</method>
<method name="GetMeshObjects" description="creates a resource iterator instance with all mesh object resources.">
<param name="ResourceIterator" type="handle" class="ResourceIterator" pass="return" description="returns the iterator instance." />
</method>
<method name="GetComponentsObjects" description="creates a resource iterator instance with all components object resources.">
<param name="ResourceIterator" type="handle" class="ResourceIterator" pass="return" description="returns the iterator instance." />
</method>
<method name="GetTexture2Ds" description="creates a Texture2DIterator instance with all texture2d resources.">
<param name="ResourceIterator" type="handle" class="Texture2DIterator" pass="return" description="returns the iterator instance." />
</method>
<method name="GetBaseMaterialGroups" description="creates a BaseMaterialGroupIterator instance with all base material resources.">
<param name="ResourceIterator" type="handle" class="BaseMaterialGroupIterator" pass="return" description="returns the iterator instance." />
</method>
<method name="GetColorGroups" description="creates a ColorGroupIterator instance with all ColorGroup resources.">
<param name="ResourceIterator" type="handle" class="ColorGroupIterator" pass="return" description="returns the iterator instance." />
</method>
<method name="GetTexture2DGroups" description="creates a Texture2DGroupIterator instance with all base material resources.">
<param name="ResourceIterator" type="handle" class="Texture2DGroupIterator" pass="return" description="returns the iterator instance." />
</method>
<method name="GetCompositeMaterials" description="creates a CompositeMaterialsIterator instance with all CompositeMaterials resources.">
<param name="ResourceIterator" type="handle" class="CompositeMaterialsIterator" pass="return" description="returns the iterator instance." />
</method>
<method name="GetMultiPropertyGroups" description="creates a MultiPropertyGroupsIterator instance with all MultiPropertyGroup resources.">
<param name="ResourceIterator" type="handle" class="MultiPropertyGroupIterator" pass="return" description="returns the iterator instance." />
</method>
<method name="GetSliceStacks" description="creates a resource iterator instance with all slice stack resources.">
<param name="ResourceIterator" type="handle" class="SliceStackIterator" pass="return" description="returns the iterator instance." />
</method>
<method name="MergeToModel" description = "Merges all components and objects which are referenced by a build item into a mesh. The memory is duplicated and a new model is created.">
<param name="MergedModelInstance" type="handle" class="Model" pass="return" description="returns the merged model instance" />
</method>
<method name="AddMeshObject" description = "adds an empty mesh object to the model.">
<param name="MeshObjectInstance" type="handle" class="MeshObject" pass="return" description=" returns the mesh object instance" />
</method>
<method name="AddComponentsObject" description = "adds an empty component object to the model.">
<param name="ComponentsObjectInstance" type="handle" class="ComponentsObject" pass="return" description=" returns the components object instance" />
</method>
<method name="AddSliceStack" description="creates a new model slicestack by its id">
<param name="ZBottom" type="double" pass="in" description="Bottom Z value of the slicestack"/>
<param name="SliceStackInstance" type="handle" class="SliceStack" pass="return" description="returns the new slicestack instance" />
</method>
<method name="AddTexture2DFromAttachment" description = "adds a texture2d resource to the model. Its path is given by that of an existing attachment.">
<param name="TextureAttachment" type="handle" class="Attachment" pass="in" description="attachment containing the image data." />
<param name="Texture2DInstance" type="handle" class="Texture2D" pass="return" description="returns the new texture instance." />
</method>
<method name="AddBaseMaterialGroup" description = "adds an empty BaseMaterialGroup resource to the model.">
<param name="BaseMaterialGroupInstance" type="handle" class="BaseMaterialGroup" pass="return" description="returns the new base material instance." />
</method>
<method name="AddColorGroup" description = "adds an empty ColorGroup resource to the model.">
<param name="ColorGroupInstance" type="handle" class="ColorGroup" pass="return" description="returns the new ColorGroup instance." />
</method>
<method name="AddTexture2DGroup" description = "adds an empty Texture2DGroup resource to the model.">
<param name="Texture2DInstance" type="handle" class="Texture2D" pass="in" description="The texture2D instance of the created Texture2DGroup." />
<param name="Texture2DGroupInstance" type="handle" class="Texture2DGroup" pass="return" description="returns the new Texture2DGroup instance." />
</method>
<method name="AddCompositeMaterials" description = "adds an empty CompositeMaterials resource to the model.">
<param name="BaseMaterialGroupInstance" type="handle" class="BaseMaterialGroup" pass="in" description="The BaseMaterialGroup instance of the created CompositeMaterials." />
<param name="CompositeMaterialsInstance" type="handle" class="CompositeMaterials" pass="return" description="returns the new CompositeMaterials instance." />
</method>
<method name="AddMultiPropertyGroup" description = "adds an empty MultiPropertyGroup resource to the model.">
<param name="MultiPropertyGroupInstance" type="handle" class="MultiPropertyGroup" pass="return" description="returns the new MultiPropertyGroup instance." />
</method>
<method name="AddBuildItem" description = "adds a build item to the model.">
<param name="Object" type="handle" class="Object" pass="in" description="Object instance." />
<param name="Transform" type="struct" class="Transform" pass="in" description="Transformation matrix." />
<param name="BuildItemInstance" type="handle" class="BuildItem" pass="return" description="returns the build item instance." />
</method>
<method name="RemoveBuildItem" description = "removes a build item from the model">
<param name="BuildItemInstance" type="handle" class="BuildItem" pass="in" description="Build item to remove." />
</method>
<method name="GetMetaDataGroup" description="Returns the metadata of the model as MetaDataGroup">
<param name="TheMetaDataGroup" type="handle" class="MetaDataGroup" pass="return" description="returns an Instance of the metadatagroup of the model" />
</method>
<method name="AddAttachment" description = "adds an attachment stream to the model. The OPC part will be related to the model stream with a certain relationship type..">
<param name="URI" type="string" pass="in" description="Path of the attachment" />
<param name="RelationShipType" type="string" pass="in" description="Relationship type of the attachment" />
<param name="AttachmentInstance" type="handle" class="Attachment" pass="return" description="Instance of the attachment object" />
</method>
<method name="RemoveAttachment" description = "Removes attachment from the model.">
<param name="AttachmentInstance" type="handle" class="Attachment" pass="in" description="Attachment instance to remov" />
</method>
<method name="GetAttachment" description = "retrieves an attachment stream object from the model..">
<param name="Index" type="uint32" pass="in" description="Index of the attachment stream" />
<param name="AttachmentInstance" type="handle" class="Attachment" pass="return" description="Instance of the attachment object" />
</method>
<method name="FindAttachment" description = "retrieves an attachment stream object from the model.">
<param name="URI" type="string" pass="in" description="Path URI in the package" />
<param name="AttachmentInstance" type="handle" class="Attachment" pass="return" description="Instance of the attachment object" />
</method>
<method name="GetAttachmentCount" description = "retrieves the number of attachments of the model.">
<param name="AttachmentCount" type="uint32" pass="return" description="Returns the number of attachments." />
</method>
<method name="HasPackageThumbnailAttachment" description = "Retrieve whether the OPC package contains a package thumbnail.">
<param name="HasThumbnail" type="bool" pass="return" description="returns whether the OPC package contains a package thumbnail" />
</method>
<method name="CreatePackageThumbnailAttachment" description = "Create a new a package thumbnail for the OPC package.">
<param name="Attachment" type="handle" class="Attachment" pass="return" description="Instance of a new thumbnailattachment object." />
</method>
<method name="GetPackageThumbnailAttachment" description = "Get the attachment to the OPC package containing the package thumbnail.">
<param name="Attachment" type="handle" class="Attachment" pass="return" description="Instance of the thumbnailattachment object." />
</method>
<method name="RemovePackageThumbnailAttachment" description = "Remove the attachment to the OPC package containing the package thumbnail.">
</method>
<method name="AddCustomContentType" description = "adds a new Content Type to the model.">
<param name="Extension" type="string" pass="in" description="File Extension" />
<param name="ContentType" type="string" pass="in" description="Content Type Identifier" />
</method>
<method name="RemoveCustomContentType" description = "removes a custom Content Type from the model (UTF8 version).">
<param name="Extension" type="string" pass="in" description="File Extension" />
</method>
</class>
<global baseclassname="Base" releasemethod="Release" journalmethod="SetJournal" versionmethod="GetLibraryVersion" errormethod="GetLastError"
prereleasemethod="GetPrereleaseInformation" buildinfomethod="GetBuildInformation">
<method name="GetLibraryVersion" description = "retrieves the binary version of this library.">
<param name="Major" type="uint32" pass="out" description="returns the major version of this library" />
<param name="Minor" type="uint32" pass="out" description="returns the minor version of this library" />
<param name="Micro" type="uint32" pass="out" description="returns the micro version of this library" />
</method>
<method name="GetPrereleaseInformation" description = "retrieves prerelease information of this library.">
<param name="HasPrereleaseInfo" type="bool" pass="return" description="Does the library provide prerelease version?"/>
<param name="PrereleaseInfo" type="string" pass="out" description="retrieves prerelease information of this library."/>
</method>
<method name="GetBuildInformation" description = "retrieves build information of this library.">
<param name="HasBuildInfo" type="bool" pass="return" description="Does the library provide build version?"/>
<param name="BuildInformation" type="string" pass="out" description="retrieves build information of this library."/>
</method>
<method name="GetSpecificationVersion" description = "retrieves whether a specification is supported, and if so, which version.">
<param name="SpecificationURL" type="string" pass="in" description="URL of extension to check" />
<param name="IsSupported" type="bool" pass="out" description="returns whether this specification is supported" />
<param name="Major" type="uint32" pass="out" description="returns the major version of the extension (if IsSupported)" />
<param name="Minor" type="uint32" pass="out" description="returns the minor version of the extension (if IsSupported)" />
<param name="Micro" type="uint32" pass="out" description="returns the micro version of the extension (if IsSupported)" />
</method>
<method name="CreateModel" description = "creates an empty model instance.">
<param name="Model" type="handle" class="Model" pass="return" description="returns an empty model instance" />
</method>
<method name="Release" description = "releases an object instance">
<param name="Instance" type="handle" class="Base" pass="in" description="releases the memory of the passed object." />
</method>
<method name="SetJournal" description = "Sets the journal file path">
<param name="JournalPath" type="string" pass="in" description="File name of the journal file" />
</method>
<method name="GetLastError" description="Retrieves the last error string of an instance">
<param name="Instance" type="handle" class="Base" pass="in" description="Object where the error occured." />
<param name="LastErrorString" type="string" pass="out" description="Last Error String" />
<param name="HasLastError" type="bool" pass="return" description="Returns if the instance has a last error." />
</method>
<method name="RetrieveProgressMessage" description = "Return an English text for a progress identifier.|Note: this is the only function you can call from your callback function.">
<param name="ProrgessIdentifier" type="enum" class="ProgressIdentifier" pass="in" description="the progress identifier that is passed to the callback function" />
<param name="ProgressMessage" type="string" pass="out" description="English text for the progress identifier" />
</method>
<method name="RGBAToColor" description = "Creates a Color from uint8 RGBA values">
<param name="Red" type="uint8" pass="in" description="Red value of color (0-255)" />
<param name="Green" type="uint8" pass="in" description="Green value of color (0-255)" />
<param name="Blue" type="uint8" pass="in" description="Blue value of color (0-255)" />
<param name="Alpha" type="uint8" pass="in" description="Alpha value of color (0-255)" />
<param name="TheColor" type="struct" class="Color" pass="return" description="Assembled color" />
</method>
<method name="FloatRGBAToColor" description = "Creates a Color from uint8 RGBA values">
<param name="Red" type="single" pass="in" description="Red value of color (0-1)" />
<param name="Green" type="single" pass="in" description="Green value of color (0-1)" />
<param name="Blue" type="single" pass="in" description="Blue value of color (0-1)" />
<param name="Alpha" type="single" pass="in" description="Alpha value of color (0-1)" />
<param name="TheColor" type="struct" class="Color" pass="return" description="Assembled color" />
</method>
<method name="ColorToRGBA" description = "Calculates uint8-RGBA-values from a Color">
<param name="TheColor" type="struct" class="Color" pass="in" description="Color to handle" />
<param name="Red" type="uint8" pass="out" description="Red value of color (0-255)" />
<param name="Green" type="uint8" pass="out" description="Green value of color (0-255)" />
<param name="Blue" type="uint8" pass="out" description="Blue value of color (0-255)" />
<param name="Alpha" type="uint8" pass="out" description="Alpha value of color (0-255)" />
</method>
<method name="ColorToFloatRGBA" description = "Calculates float-RGBA-values from a Color">
<param name="TheColor" type="struct" class="Color" pass="in" description="Color to handle" />
<param name="Red" type="single" pass="out" description="Red value of color (0-1)" />
<param name="Green" type="single" pass="out" description="Green value of color (0-1)" />
<param name="Blue" type="single" pass="out" description="Blue value of color (0-1)" />
<param name="Alpha" type="single" pass="out" description="Alpha value of color (0-1)" />
</method>
<method name="GetIdentityTransform" description = "Creates an identity transform">
<param name="Transform" type="struct" class="Transform" pass="return" description="Transformation matrix." />
</method>
<method name="GetUniformScaleTransform" description = "Creates a uniform scale transform">
<param name="Factor" type="single" pass="in" description="Factor in X, Y and Z" />
<param name="Transform" type="struct" class="Transform" pass="return" description="Transformation matrix." />
</method>
<method name="GetScaleTransform" description = "Creates a scale transform">
<param name="FactorX" type="single" pass="in" description="Factor in X" />
<param name="FactorY" type="single" pass="in" description="Factor in Y" />
<param name="FactorZ" type="single" pass="in" description="Factor in Z" />
<param name="Transform" type="struct" class="Transform" pass="return" description="Transformation matrix." />
</method>
<method name="GetTranslationTransform" description = "Creates an translation transform">
<param name="VectorX" type="single" pass="in" description="Translation in X" />
<param name="VectorY" type="single" pass="in" description="Translation in Y" />
<param name="VectorZ" type="single" pass="in" description="Translation in Z" />
<param name="Transform" type="struct" class="Transform" pass="return" description="Transformation matrix." />
</method>
</global>
</component>