Repository navigation
Expand file tree
/
Copy pathlib3mf.xml
More file actions
4363 lines (4073 loc) · 214 KB
/
Copy pathlib3mf.xml
File metadata and controls
4363 lines (4073 loc) · 214 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<component xmlns="http://schemas.autodesk.com/netfabb/automaticcomponenttoolkit/2018" libraryname="the 3MF Library" namespace="Lib3MF" copyright="3MF Consortium (Original Author)" year="2024" basename="lib3mf" version="2.4.0">
<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="C" indentation="tabs" />
<binding language="CDynamic" indentation="tabs" />
<binding language="Cpp" indentation="tabs" />
<binding language="CppDynamic" indentation="tabs" />
<binding language="Pascal" indentation="tabs" />
<binding language="Python" 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="ELEMENTCOUNTEXCEEDSLIMIT" code="141"
description="An element buffer exceeds its spec limit" />
<error name="INVALIDRESOURCE" code="142" description="A resource is invalid" />
<error name="INVALIDLEVELSET" code="143" description="A level set is invalid" />
<error name="COULDNOTFINDTRIANGLESET" code="144" description="Could not find triangle set"/>
<error name="INVALIDTRIANGLESETINDEX" code="145" description="Invalid triangle set index"/>
<error name="BEAMLATTICE_INVALID_OBJECTTYPE" code="2000"
description="This object type is not valid for beamlattices" />
<error name="INVALIDKEYSTORE" code="3000" description="The keystore object is invalid" />
<error name="INVALIDKEYSTORECONSUMER" code="3001"
description="The consumer keystore object is invalid" />
<error name="KEYSTORECONSUMERNOTFOUND" code="3002"
description="A consumer has not been found" />
<error name="KEYSTORERESOURCEDATANOTFOUND" code="3003"
description="A resource data has not been found" />
<error name="SECURECONTEXTNOTREGISTERED" code="3004"
description="A Key or Conentent encryption callback has not been registered" />
<error name="INVALIDKEYSIZE" code="3005" description="The key size is invalid" />
<error name="INCOMPATIBLEPORTTYPES" code="4000"
description="Link could not be added, the port types are incompatible" />
<error name="GRAPHISCYCLIC" code="4001"
description="The functin graph is cyclic. Only dircected graphs are valid and can be topological sorted." />
<error name="INPUTNOTSET" code="4002" description="The input of a node is not set." />
<error name="INVALIDNODECONFIGURATION" code="4003"
description="The selected node configuration is not supported" />
</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="BeamLatticeBallMode">
<option name="BeamLatticeBallModeNone" value="0" />
<option name="Mixed" value="1" />
<option name="All" 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="READCUSTOMATTACHMENT" value="11" />
<option name="READTEXTURETACHMENTS" value="12" />
<option name="CREATEOPCPACKAGE" value="13" />
<option name="WRITEMODELSTOSTREAM" value="14" />
<option name="WRITEROOTMODEL" value="15" />
<option name="WRITENONROOTMODELS" value="16" />
<option name="WRITEATTACHMENTS" value="17" />
<option name="WRITECONTENTTYPES" value="18" />
<option name="WRITENOBJECTS" value="19" />
<option name="WRITENODES" value="20" />
<option name="WRITETRIANGLES" value="21" />
<option name="WRITESLICES" value="22" />
<option name="WRITEKEYSTORE" value="23" />
</enum>
<enum name="BlendMethod">
<option name="NoBlendMethod" value="0" />
<option name="Mix" value="1" />
<option name="Multiply" value="2" />
</enum>
<enum name="ChannelName">
<option name="Red" value="0" />
<option name="Green" value="1" />
<option name="Blue" value="2" />
<option name="Alpha" value="3" />
</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="Box">
<member name="MinCoordinate" type="single" rows="3" />
<member name="MaxCoordinate" type="single" 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>
<struct name="Ball">
<member name="Index" type="uint32" />
<member name="Radius" type="double" />
</struct>
<enum name="CompositionMethod">
<option name="WeightedSum" value="0" />
<option name="Multiply" value="1" />
<option name="Min" value="2" />
<option name="Max" value="3" />
<option name="Mask" value="4" />
</enum>
<enum name="CompositionSpace">
<option name="Raw" value="0" />
<option name="LinearColor" value="1" />
</enum>
<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>
<functiontype name="RandomNumberCallback" description="Callback to generate random numbers">
<param name="ByteData" type="uint64" pass="in"
description="Pointer to a buffer to read data into" />
<param name="NumBytes" type="uint64" pass="in"
description="Size of available bytes in the buffer" />
<param name="UserData" type="pointer" pass="in"
description="Userdata that is passed to the callback function" />
<param name="BytesWritten" type="uint64" pass="return"
description="Number of bytes generated when succeed. 0 or less if failed." />
</functiontype>
<class name="Base">
<method name="ClassTypeId" description="Get Class Type Id">
<param name="ClassTypeId" type="uint64" pass="return"
description="Class type as a 64 bits integer" />
</method>
</class>
<class name="Writer" parent="Base">
<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>
<method name="GetDecimalPrecision"
description="Returns the number of digits after the decimal point to be written in each vertex coordinate-value.">
<param name="DecimalPrecision" type="uint32" pass="return"
description="The number of digits to be written in each vertex coordinate-value after the decimal point." />
</method>
<method name="SetDecimalPrecision"
description="Sets the number of digits after the decimal point to be written in each vertex coordinate-value.">
<param name="DecimalPrecision" type="uint32" pass="in"
description="The number of digits to be written in each vertex coordinate-value after the decimal point." />
</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>
<method name="AddKeyWrappingCallback"
description="Registers a callback to deal with data key encryption/decryption from keystore">
<param name="ConsumerID" type="string" pass="in"
description="The ConsumerID to register for" />
<param name="TheCallback" type="functiontype" class="KeyWrappingCallback" pass="in"
description="The callback to be callede for wrapping and encryption key" />
<param name="UserData" type="pointer" pass="in"
description="Userdata that is passed to the callback function" />
</method>
<method name="SetContentEncryptionCallback"
description="Registers a callback to deal with encryption of content">
<param name="TheCallback" type="functiontype" class="ContentEncryptionCallback"
pass="in" description="The callback used to encrypt content" />
<param name="UserData" type="pointer" pass="in"
description="Userdata that is passed to the callback function" />
</method>
</class>
<class name="Reader" parent="Base">
<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>
<method name="AddKeyWrappingCallback"
description="Registers a callback to deal with key wrapping mechanism from keystore">
<param name="ConsumerID" type="string" pass="in"
description="The ConsumerID to register for" />
<param name="TheCallback" type="functiontype" class="KeyWrappingCallback" pass="in"
description="The callback used to decrypt data key" />
<param name="UserData" type="pointer" pass="in"
description="Userdata that is passed to the callback function" />
</method>
<method name="SetContentEncryptionCallback"
description="Registers a callback to deal with encryption of content">
<param name="TheCallback" type="functiontype" class="ContentEncryptionCallback"
pass="in" description="The callback used to encrypt content" />
<param name="UserData" type="pointer" pass="in"
description="Userdata that is passed to the callback function" />
</method>
</class>
<class name="PackagePart" parent="Base">
<method name="GetPath" description="Returns the absolute path of this PackagePart.">
<param name="Path" type="string" pass="return"
description="Returns the absolute path of this PackagePart" />
</method>
<method name="SetPath" description="Sets the absolute path of this PackagePart.">
<param name="Path" type="string" pass="in"
description="Sets the absolute path of this PackagePart." />
</method>
</class>
<class name="Resource" parent="Base">
<method name="GetResourceID"
description="Retrieves the unique id of this resource within a package. This function will be removed in a later release in favor of GetUniqueResourceID">
<param name="UniqueResourceID" type="uint32" pass="return"
description="Retrieves the unique id of this resource within a package." />
</method>
<method name="GetUniqueResourceID"
description="Retrieves the unique id of this resource within a package.">
<param name="UniqueResourceID" type="uint32" pass="return"
description="Retrieves the unique id of this resource within a package." />
</method>
<method name="PackagePart"
description="Returns the PackagePart within which this resource resides">
<param name="PackagePart" type="class" class="PackagePart" pass="return"
description="the PackagePart within which this resource resides." />
</method>
<method name="SetPackagePart"
description="Sets the new PackagePart within which this resource resides">
<param name="PackagePart" type="class" class="PackagePart" pass="in"
description="the new PackagePart within which this resource resides." />
</method>
<method name="GetModelResourceID"
description="Retrieves the id of this resource within a model.">
<param name="ModelResourceId" type="uint32" pass="return"
description="Retrieves the id of this resource within a model." />
</method>
</class>
<class name="ResourceIterator" parent="Base">
<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>
<method name="Count" description="Returns the number of resoucres the iterator captures.">
<param name="Count" type="uint64" pass="return"
description="returns the number of resoucres the iterator captures." />
</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="MeshObjectIterator" parent="ResourceIterator">
<method name="GetCurrentMeshObject"
description="Returns the MeshObject the iterator points at.">
<param name="Resource" type="handle" class="MeshObject" pass="return"
description="returns the MeshObject instance." />
</method>
</class>
<class name="ComponentsObjectIterator" parent="ResourceIterator">
<method name="GetCurrentComponentsObject"
description="Returns the ComponentsObject the iterator points at.">
<param name="Resource" type="handle" class="ComponentsObject" pass="return"
description="returns the ComponentsObject 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="Image3DIterator" parent="ResourceIterator">
<method name="GetCurrentImage3D" description="Returns the Image3D the iterator points at.">
<param name="Resource" type="handle" class="Image3D" pass="return"
description="returns the Image3D instance." />
</method>
</class>
<class name="FunctionIterator" parent="ResourceIterator">
<method name="GetCurrentFunction" description="Returns the Function the iterator points at.">
<param name="Resource" type="handle" class="Function" pass="return"
description="returns the Function instance." />
</method>
</class>
<class name="LevelSetIterator" parent="ResourceIterator">
<method name="GetCurrentLevelSet"
description="Returns the LevelSet the iterator points at.">
<param name="Resource" type="handle" class="LevelSet" pass="return"
description="returns the MeshObject instance." />
</method>
</class>
<class name="MetaData" parent="Base">
<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" parent="Base">
<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="should the metadata be preserved" />
<param name="MetaData" type="handle" class="MetaData" pass="return"
description="a new instance of the metadata" />
</method>
</class>
<class name="TriangleSet">
<method name="SetName" description="sets the name of the triangle set">
<param name="Name" type="string" pass="in" description="the new name"/>
</method>
<method name="GetName" description="returns the name of the triangle set">
<param name="Name" type="string" pass="return" description="returns the name"/>
</method>
<method name="SetIdentifier" description="sets the identifier of the triangle set.">
<param name="Identifier" type="string" pass="in" description="the new identifier. MUST be unique within the mesh. MUST NOT be an empty string"/>
</method>
<method name="GetIdentifier" description="returns the identifier of the triangle set">
<param name="Identifier" type="string" pass="return" description="returns the identifier"/>
</method>
<method name="AddTriangle" description="adds a triangle to the set. Does nothing if triangle is already in the set.">
<param name="TriangleIndex" type="uint32" pass="in" description="Triangle index to add. MUST be between 0 and TriangleCount - 1."/>
</method>
<method name="RemoveTriangle" description="removes a triangle from the set">
<param name="TriangleIndex" type="uint32" pass="in" description="Triangle index to remove. MUST be between 0 and TriangleCount - 1."/>
</method>
<method name="Clear" description="clears all triangles from the list">
</method>
<method name="SetTriangleList" description="Sets all triangles in the list, while clearing old values. Duplicates will be merged.">
<param name="TriangleIndices" type="basicarray" class="uint32" pass="in" description="Triangle indices to add. Every element MUST be between 0 and TriangleCount - 1."/>
</method>
<method name="GetTriangleList" description="Retrieves all the triangles in the TriangleSet">
<param name="TriangleIndices" type="basicarray" class="uint32" pass="out" description="retrieves the indices of the triangles in this TriangleSet"/>
</method>
<method name="AddTriangleList" description="Adds multiple triangles in the list. Duplicates will be merged.">
<param name="TriangleIndices" type="basicarray" class="uint32" pass="in" description="Triangle indices to add. Every element MUST be between 0 and TriangleCount - 1."/>
</method>
<method name="Merge" description="Merges another Triangle set.">
<param name="OtherTriangleSet" type="class" class="TriangleSet" pass="in" description="Other triangle set to merge."/>
<param name="DeleteOther" type="bool" pass="in" description="Flag if other triangle set is getting removed."/>
</method>
<method name="DeleteSet" description="Deletes the whole set from the mesh.">
</method>
<method name="Duplicate" description="Duplicates the set in the mesh.">
<param name="Identifier" type="string" pass="in" description="the new identifier. MUST be unique within the mesh. MUST NOT be an empty string"/>
<param name="NewSet" type="class" class="TriangleSet" pass="return" description="Copy of the triangle set."/>
</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="IsLevelSetObject"
description="Retrieves, if an object is a level set object">
<param name="IsLevelSetObject" type="bool" pass="return"
description="returns, whether the object is a level set 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>
<method name="SetAttachmentAsThumbnail"
description="Use an existing attachment as thumbnail for this object">
<param name="Attachment" type="handle" class="Attachment" pass="in"
description="Instance of a new or the existing thumbnailattachment object." />
</method>
<method name="GetThumbnailAttachment"
description="Get the attachment containing the object thumbnail.">
<param name="Attachment" type="optionalclass" class="Attachment" pass="return"
description="Instance of the thumbnailattachment object or NULL." />
</method>
<method name="ClearThumbnailAttachment"
description="Clears the attachment. The attachment instance is not removed from the package.">
</method>
<method name="GetOutbox" description="Returns the outbox of a build item">
<param name="Outbox" type="struct" class="Box" pass="return"
description="Outbox of this build item" />
</method>
<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="HasSlices"
description="returns whether the Object has a slice stack. If Recursive is true, also checks whether any references object has a slice stack">
<param name="Recursive" type="bool" pass="in"
description="check also all referenced objects?" />
<param name="HasSlices" 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="SetObjectLevelProperty"
description="Sets the property at the object-level of the mesh object.">
<param name="UniqueResourceID" type="uint32" pass="in"
description="the object-level Property UniqueResourceID." />
<param name="PropertyID" type="uint32" pass="in"
description="the object-level PropertyID." />
</method>
<method name="GetObjectLevelProperty"
description="Gets the property at the object-level of the mesh object.">
<param name="UniqueResourceID" type="uint32" pass="out"
description="the object-level Property UniqueResourceID." />
<param name="PropertyID" type="uint32" pass="out"
description="the object-level PropertyID." />
<param name="HasObjectLevelProperty" type="bool" pass="return"
description="Has an object-level property been specified?" />
</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"