summaryrefslogtreecommitdiff
path: root/modules/gltf/doc_classes/GLTFState.xml
blob: b322c07cec0e64c41c3ae9d94e89cab3b0689b04 (plain)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFState" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
	</brief_description>
	<description>
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="add_used_extension">
			<return type="void" />
			<param index="0" name="extension_name" type="String" />
			<param index="1" name="required" type="bool" />
			<description>
				Appends an extension to the list of extensions used by this GLTF file during serialization. If [param required] is true, the extension will also be added to the list of required extensions. Do not run this in [method GLTFDocumentExtension._export_post], as that stage is too late to add extensions. The final list is sorted alphabetically.
			</description>
		</method>
		<method name="get_accessors">
			<return type="GLTFAccessor[]" />
			<description>
			</description>
		</method>
		<method name="get_additional_data">
			<return type="Variant" />
			<param index="0" name="extension_name" type="StringName" />
			<description>
				Gets additional arbitrary data in this [GLTFState] instance. This can be used to keep per-file state data in [GLTFDocumentExtension] classes, which is important because they are stateless.
				The argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the GLTF file), and the return value can be anything you set. If nothing was set, the return value is null.
			</description>
		</method>
		<method name="get_animation_player">
			<return type="AnimationPlayer" />
			<param index="0" name="idx" type="int" />
			<description>
			</description>
		</method>
		<method name="get_animation_players_count">
			<return type="int" />
			<param index="0" name="idx" type="int" />
			<description>
			</description>
		</method>
		<method name="get_animations">
			<return type="GLTFAnimation[]" />
			<description>
			</description>
		</method>
		<method name="get_buffer_views">
			<return type="GLTFBufferView[]" />
			<description>
			</description>
		</method>
		<method name="get_cameras">
			<return type="GLTFCamera[]" />
			<description>
			</description>
		</method>
		<method name="get_handle_binary_image">
			<return type="int" />
			<description>
			</description>
		</method>
		<method name="get_images">
			<return type="Texture2D[]" />
			<description>
			</description>
		</method>
		<method name="get_lights">
			<return type="GLTFLight[]" />
			<description>
			</description>
		</method>
		<method name="get_materials">
			<return type="Material[]" />
			<description>
			</description>
		</method>
		<method name="get_meshes">
			<return type="GLTFMesh[]" />
			<description>
			</description>
		</method>
		<method name="get_nodes">
			<return type="GLTFNode[]" />
			<description>
			</description>
		</method>
		<method name="get_scene_node">
			<return type="Node" />
			<param index="0" name="idx" type="int" />
			<description>
			</description>
		</method>
		<method name="get_skeleton_to_node">
			<return type="Dictionary" />
			<description>
			</description>
		</method>
		<method name="get_skeletons">
			<return type="GLTFSkeleton[]" />
			<description>
			</description>
		</method>
		<method name="get_skins">
			<return type="GLTFSkin[]" />
			<description>
			</description>
		</method>
		<method name="get_texture_samplers">
			<return type="GLTFTextureSampler[]" />
			<description>
				Retrieves the array of texture samplers that are used by the textures contained in the GLTF.
			</description>
		</method>
		<method name="get_textures">
			<return type="GLTFTexture[]" />
			<description>
			</description>
		</method>
		<method name="get_unique_animation_names">
			<return type="String[]" />
			<description>
			</description>
		</method>
		<method name="get_unique_names">
			<return type="String[]" />
			<description>
			</description>
		</method>
		<method name="set_accessors">
			<return type="void" />
			<param index="0" name="accessors" type="GLTFAccessor[]" />
			<description>
			</description>
		</method>
		<method name="set_additional_data">
			<return type="void" />
			<param index="0" name="extension_name" type="StringName" />
			<param index="1" name="additional_data" type="Variant" />
			<description>
				Sets additional arbitrary data in this [GLTFState] instance. This can be used to keep per-file state data in [GLTFDocumentExtension] classes, which is important because they are stateless.
				The first argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the GLTF file), and the second argument can be anything you want.
			</description>
		</method>
		<method name="set_animations">
			<return type="void" />
			<param index="0" name="animations" type="GLTFAnimation[]" />
			<description>
			</description>
		</method>
		<method name="set_buffer_views">
			<return type="void" />
			<param index="0" name="buffer_views" type="GLTFBufferView[]" />
			<description>
			</description>
		</method>
		<method name="set_cameras">
			<return type="void" />
			<param index="0" name="cameras" type="GLTFCamera[]" />
			<description>
			</description>
		</method>
		<method name="set_handle_binary_image">
			<return type="void" />
			<param index="0" name="method" type="int" />
			<description>
			</description>
		</method>
		<method name="set_images">
			<return type="void" />
			<param index="0" name="images" type="Texture2D[]" />
			<description>
			</description>
		</method>
		<method name="set_lights">
			<return type="void" />
			<param index="0" name="lights" type="GLTFLight[]" />
			<description>
			</description>
		</method>
		<method name="set_materials">
			<return type="void" />
			<param index="0" name="materials" type="Material[]" />
			<description>
			</description>
		</method>
		<method name="set_meshes">
			<return type="void" />
			<param index="0" name="meshes" type="GLTFMesh[]" />
			<description>
			</description>
		</method>
		<method name="set_nodes">
			<return type="void" />
			<param index="0" name="nodes" type="GLTFNode[]" />
			<description>
			</description>
		</method>
		<method name="set_skeleton_to_node">
			<return type="void" />
			<param index="0" name="skeleton_to_node" type="Dictionary" />
			<description>
			</description>
		</method>
		<method name="set_skeletons">
			<return type="void" />
			<param index="0" name="skeletons" type="GLTFSkeleton[]" />
			<description>
			</description>
		</method>
		<method name="set_skins">
			<return type="void" />
			<param index="0" name="skins" type="GLTFSkin[]" />
			<description>
			</description>
		</method>
		<method name="set_texture_samplers">
			<return type="void" />
			<param index="0" name="texture_samplers" type="GLTFTextureSampler[]" />
			<description>
				Sets the array of texture samplers that are used by the textures contained in the GLTF.
			</description>
		</method>
		<method name="set_textures">
			<return type="void" />
			<param index="0" name="textures" type="GLTFTexture[]" />
			<description>
			</description>
		</method>
		<method name="set_unique_animation_names">
			<return type="void" />
			<param index="0" name="unique_animation_names" type="String[]" />
			<description>
			</description>
		</method>
		<method name="set_unique_names">
			<return type="void" />
			<param index="0" name="unique_names" type="String[]" />
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="base_path" type="String" setter="set_base_path" getter="get_base_path" default="&quot;&quot;">
		</member>
		<member name="buffers" type="PackedByteArray[]" setter="set_buffers" getter="get_buffers" default="[]">
		</member>
		<member name="create_animations" type="bool" setter="set_create_animations" getter="get_create_animations" default="true">
		</member>
		<member name="glb_data" type="PackedByteArray" setter="set_glb_data" getter="get_glb_data" default="PackedByteArray()">
		</member>
		<member name="json" type="Dictionary" setter="set_json" getter="get_json" default="{}">
		</member>
		<member name="major_version" type="int" setter="set_major_version" getter="get_major_version" default="0">
		</member>
		<member name="minor_version" type="int" setter="set_minor_version" getter="get_minor_version" default="0">
		</member>
		<member name="root_nodes" type="PackedInt32Array" setter="set_root_nodes" getter="get_root_nodes" default="PackedInt32Array()">
		</member>
		<member name="scene_name" type="String" setter="set_scene_name" getter="get_scene_name" default="&quot;&quot;">
		</member>
		<member name="use_named_skin_binds" type="bool" setter="set_use_named_skin_binds" getter="get_use_named_skin_binds" default="false">
		</member>
	</members>
	<constants>
		<constant name="HANDLE_BINARY_DISCARD_TEXTURES" value="0">
			Discards all embedded textures and uses untextured materials.
		</constant>
		<constant name="HANDLE_BINARY_EXTRACT_TEXTURES" value="1">
			Extracts embedded textures to be reimported and compressed. Editor only. Acts as uncompressed at runtime.
		</constant>
		<constant name="HANDLE_BINARY_EMBED_AS_BASISU" value="2">
			Embeds textures VRAM compressed with Basis Universal into the generated scene.
		</constant>
		<constant name="HANDLE_BINARY_EMBED_AS_UNCOMPRESSED" value="3">
			Embeds textures compressed losslessly into the generated scene, matching old behavior.
		</constant>
	</constants>
</class>