FreeCAD

1
<?xml version="1.0" encoding="UTF-8"?>
2
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
3
  <PythonExport
4
      Father="BaseClassPy"
5
      Name="MaterialPy"
6
      Twin="Material"
7
      TwinPointer="Material"
8
      Include="Mod/Material/App/Materials.h"
9
      Namespace="Materials"
10
      FatherInclude="Base/BaseClassPy.h"
11
      FatherNamespace="Base"
12
      Constructor="true"
13
      Delete="true">
14
    <Documentation>
15
      <Author Licence="LGPL" Name="DavidCarter" EMail="dcarter@davidcarter.ca" />
16
      <UserDocu>Material descriptions.</UserDocu>
17
    </Documentation>
18
    <Attribute Name="LibraryName" ReadOnly="true">
19
      <Documentation>
20
        <UserDocu>Model library name.</UserDocu>
21
      </Documentation>
22
      <Parameter Name="LibraryName" Type="String"/>
23
    </Attribute>
24
    <Attribute Name="LibraryRoot" ReadOnly="true">
25
      <Documentation>
26
        <UserDocu>Model library path.</UserDocu>
27
      </Documentation>
28
      <Parameter Name="LibraryRoot" Type="String"/>
29
    </Attribute>
30
    <Attribute Name="LibraryIcon" ReadOnly="true">
31
      <Documentation>
32
        <UserDocu>Model icon path.</UserDocu>
33
      </Documentation>
34
      <Parameter Name="LibraryIcon" Type="String"/>
35
    </Attribute>
36
    <Attribute Name="Name" ReadOnly="false">
37
      <Documentation>
38
        <UserDocu>Model name.</UserDocu>
39
      </Documentation>
40
      <Parameter Name="Name" Type="String"/>
41
    </Attribute>
42
    <Attribute Name="Directory" ReadOnly="true">
43
      <Documentation>
44
        <UserDocu>Model directory relative to the library root.</UserDocu>
45
      </Documentation>
46
      <Parameter Name="Directory" Type="String"/>
47
    </Attribute>
48
    <Attribute Name="UUID" ReadOnly="true">
49
      <Documentation>
50
        <UserDocu>Unique model identifier. This is only valid after the material is saved.</UserDocu>
51
      </Documentation>
52
      <Parameter Name="UUID" Type="String"/>
53
    </Attribute>
54
    <Attribute Name="Description" ReadOnly="false">
55
      <Documentation>
56
        <UserDocu>Description of the material.</UserDocu>
57
      </Documentation>
58
      <Parameter Name="Description" Type="String"/>
59
    </Attribute>
60
    <Attribute Name="URL" ReadOnly="false">
61
      <Documentation>
62
        <UserDocu>URL to a material reference.</UserDocu>
63
      </Documentation>
64
      <Parameter Name="URL" Type="String"/>
65
    </Attribute>
66
    <Attribute Name="Reference" ReadOnly="false">
67
      <Documentation>
68
        <UserDocu>Reference for material data.</UserDocu>
69
      </Documentation>
70
      <Parameter Name="Reference" Type="String"/>
71
    </Attribute>
72
    <Attribute Name="Parent" ReadOnly="true">
73
      <Documentation>
74
        <UserDocu>Parent material UUID.</UserDocu>
75
      </Documentation>
76
      <Parameter Name="Parent" Type="String"/>
77
    </Attribute>
78
    <Attribute Name="AuthorAndLicense" ReadOnly="true">
79
      <Documentation>
80
        <UserDocu>deprecated -- Author and license information.</UserDocu>
81
      </Documentation>
82
      <Parameter Name="AuthorAndLicense" Type="String"/>
83
    </Attribute>
84
    <Attribute Name="Author" ReadOnly="false">
85
      <Documentation>
86
        <UserDocu>Author information.</UserDocu>
87
      </Documentation>
88
      <Parameter Name="Author" Type="String"/>
89
    </Attribute>
90
    <Attribute Name="License" ReadOnly="false">
91
      <Documentation>
92
        <UserDocu>License information.</UserDocu>
93
      </Documentation>
94
      <Parameter Name="License" Type="String"/>
95
    </Attribute>
96
    <Attribute Name="PhysicalModels" ReadOnly="true">
97
      <Documentation>
98
        <UserDocu>List of implemented models.</UserDocu>
99
      </Documentation>
100
      <Parameter Name="PhysicalModels" Type="List"/>
101
    </Attribute>
102
    <Attribute Name="AppearanceModels" ReadOnly="true">
103
      <Documentation>
104
        <UserDocu>List of implemented models.</UserDocu>
105
      </Documentation>
106
      <Parameter Name="AppearanceModels" Type="List"/>
107
    </Attribute>
108
    <Attribute Name="Tags" ReadOnly="true">
109
      <Documentation>
110
        <UserDocu>List of searchable tags.</UserDocu>
111
      </Documentation>
112
      <Parameter Name="Tags" Type="List"/>
113
    </Attribute>
114
    <Methode Name="addPhysicalModel" ReadOnly="false">
115
      <Documentation>
116
        <UserDocu>Add the physical model with the given UUID</UserDocu>
117
      </Documentation>
118
    </Methode>
119
    <Methode Name="removePhysicalModel" ReadOnly="false">
120
      <Documentation>
121
        <UserDocu>Remove the physical model with the given UUID</UserDocu>
122
      </Documentation>
123
    </Methode>
124
    <Methode Name="hasPhysicalModel" ReadOnly="true">
125
      <Documentation>
126
        <UserDocu>Check if the material implements the physical model with the given UUID</UserDocu>
127
      </Documentation>
128
    </Methode>
129
    <Methode Name="addAppearanceModel" ReadOnly="false">
130
      <Documentation>
131
        <UserDocu>Add the appearance model with the given UUID</UserDocu>
132
      </Documentation>
133
    </Methode>
134
    <Methode Name="removeAppearanceModel" ReadOnly="false">
135
      <Documentation>
136
        <UserDocu>Remove the appearance model with the given UUID</UserDocu>
137
      </Documentation>
138
    </Methode>
139
    <Methode Name="hasAppearanceModel" ReadOnly="true">
140
      <Documentation>
141
        <UserDocu>Check if the material implements the appearance model with the given UUID</UserDocu>
142
      </Documentation>
143
    </Methode>
144
    <Methode Name="isPhysicalModelComplete" ReadOnly="true">
145
      <Documentation>
146
        <UserDocu>Check if the material implements the physical model with the given UUID, and has values defined for each property</UserDocu>
147
      </Documentation>
148
    </Methode>
149
    <Methode Name="isAppearanceModelComplete" ReadOnly="true">
150
      <Documentation>
151
        <UserDocu>Check if the material implements the appearance model with the given UUID, and has values defined for each property</UserDocu>
152
      </Documentation>
153
    </Methode>
154
    <Methode Name="hasPhysicalProperty" ReadOnly="true">
155
      <Documentation>
156
        <UserDocu>Check if the material implements the physical property with the given name</UserDocu>
157
      </Documentation>
158
    </Methode>
159
    <Methode Name="hasAppearanceProperty" ReadOnly="true">
160
      <Documentation>
161
        <UserDocu>Check if the material implements the appearance property with the given name</UserDocu>
162
      </Documentation>
163
    </Methode>
164
    <Methode Name="hasLegacyProperties" ReadOnly="true">
165
      <Documentation>
166
        <UserDocu>Returns true of there are legacy properties</UserDocu>
167
      </Documentation>
168
    </Methode>
169
    <Attribute Name="Properties" ReadOnly="true">
170
      <Documentation>
171
        <UserDocu>deprecated -- Dictionary of all material properties.</UserDocu>
172
      </Documentation>
173
      <Parameter Name="Properties" Type="Dict"/>
174
    </Attribute>
175
    <Attribute Name="PhysicalProperties" ReadOnly="true">
176
      <Documentation>
177
        <UserDocu>deprecated -- Dictionary of material physical properties.</UserDocu>
178
      </Documentation>
179
      <Parameter Name="PhysicalProperties" Type="Dict"/>
180
    </Attribute>
181
    <Attribute Name="AppearanceProperties" ReadOnly="true">
182
      <Documentation>
183
        <UserDocu>deprecated -- Dictionary of material appearance properties.</UserDocu>
184
      </Documentation>
185
      <Parameter Name="AppearanceProperties" Type="Dict"/>
186
    </Attribute>
187
    <Attribute Name="LegacyProperties" ReadOnly="true">
188
      <Documentation>
189
        <UserDocu>deprecated -- Dictionary of material legacy properties.</UserDocu>
190
      </Documentation>
191
      <Parameter Name="LegacyProperties" Type="Dict"/>
192
    </Attribute>
193
    <Methode Name="getPhysicalValue" ReadOnly="true">
194
      <Documentation>
195
        <UserDocu>Get the value associated with the property</UserDocu>
196
      </Documentation>
197
    </Methode>
198
    <Methode Name="setPhysicalValue" ReadOnly="true">
199
      <Documentation>
200
        <UserDocu>Set the value associated with the property</UserDocu>
201
      </Documentation>
202
    </Methode>
203
    <Methode Name="getAppearanceValue" ReadOnly="true">
204
      <Documentation>
205
        <UserDocu>Get the value associated with the property</UserDocu>
206
      </Documentation>
207
    </Methode>
208
    <Methode Name="setAppearanceValue" ReadOnly="true">
209
      <Documentation>
210
        <UserDocu>Set the value associated with the property</UserDocu>
211
      </Documentation>
212
    </Methode>
213
  </PythonExport>
214
</GenerateModel>
215