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
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Spatial" inherits="Node" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Most basic 3D game object, parent of all 3D related nodes.
</brief_description>
<description>
Most basic 3D game object, with a 3D [Transform] and visibility settings. All other 3D game objects inherit from Spatial. Use Spatial as a parent node to move, scale, rotate and show/hide children in a 3D project.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_gizmo" qualifiers="const">
<return type="SpatialGizmo">
</return>
<description>
Returns the SpatialGizmo for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor.
</description>
</method>
<method name="get_global_transform" qualifiers="const">
<return type="Transform">
</return>
<description>
Returns the global transform, relative to worldspace.
</description>
</method>
<method name="get_parent_spatial" qualifiers="const">
<return type="Spatial">
</return>
<description>
Returns the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [Spatial].
</description>
</method>
<method name="get_rotation" qualifiers="const">
<return type="Vector3">
</return>
<description>
Returns the rotation (in radians).
</description>
</method>
<method name="get_rotation_deg" qualifiers="const">
<return type="Vector3">
</return>
<description>
Returns the rotation (in degrees).
</description>
</method>
<method name="get_scale" qualifiers="const">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="get_transform" qualifiers="const">
<return type="Transform">
</return>
<description>
Returns the local transform, relative to the bone parent.
</description>
</method>
<method name="get_translation" qualifiers="const">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="get_world" qualifiers="const">
<return type="World">
</return>
<description>
Returns the current [World] resource this Spatial node is registered to.
</description>
</method>
<method name="global_rotate">
<return type="void">
</return>
<argument index="0" name="normal" type="Vector3">
</argument>
<argument index="1" name="radians" type="float">
</argument>
<description>
Rotates the current node along normal [Vector3] by angle in radians in Global space.
</description>
</method>
<method name="global_translate">
<return type="void">
</return>
<argument index="0" name="offset" type="Vector3">
</argument>
<description>
Moves the node by [Vector3] offset in Global space.
</description>
</method>
<method name="hide">
<return type="void">
</return>
<description>
Disables rendering of this node. Change Spatial Visible property to false.
</description>
</method>
<method name="is_local_transform_notification_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether node notifies about its local transformation changes. Spatial will not propagate this by default.
</description>
</method>
<method name="is_set_as_toplevel" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether this node is set as Toplevel, that is whether it ignores its parent nodes transformations.
</description>
</method>
<method name="is_transform_notification_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default.
</description>
</method>
<method name="is_visible" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether the node is set to be visible.
</description>
</method>
<method name="is_visible_in_tree" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether the node is visible, taking into consideration that its parents visibility.
</description>
</method>
<method name="look_at">
<return type="void">
</return>
<argument index="0" name="target" type="Vector3">
</argument>
<argument index="1" name="up" type="Vector3">
</argument>
<description>
Rotates itself to point into direction of target position. Operations take place in global space.
</description>
</method>
<method name="look_at_from_pos">
<return type="void">
</return>
<argument index="0" name="pos" type="Vector3">
</argument>
<argument index="1" name="target" type="Vector3">
</argument>
<argument index="2" name="up" type="Vector3">
</argument>
<description>
Moves the node to specified position and then rotates itself to point into direction of target position. Operations take place in global space.
</description>
</method>
<method name="orthonormalize">
<return type="void">
</return>
<description>
Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation. Performs orthonormalization on this node [Transform3D].
</description>
</method>
<method name="rotate">
<return type="void">
</return>
<argument index="0" name="normal" type="Vector3">
</argument>
<argument index="1" name="radians" type="float">
</argument>
<description>
Rotates the node in local space on given normal [Vector3] by angle in radians.
</description>
</method>
<method name="rotate_x">
<return type="void">
</return>
<argument index="0" name="radians" type="float">
</argument>
<description>
Rotates the node in local space on X axis by angle in radians.
</description>
</method>
<method name="rotate_y">
<return type="void">
</return>
<argument index="0" name="radians" type="float">
</argument>
<description>
Rotates the node in local space on Y axis by angle in radians.
</description>
</method>
<method name="rotate_z">
<return type="void">
</return>
<argument index="0" name="radians" type="float">
</argument>
<description>
Rotates the node in local space on Z axis by angle in radians.
</description>
</method>
<method name="set_as_toplevel">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Makes the node ignore its parents tranformations. Node tranformations are only in global space.
</description>
</method>
<method name="set_gizmo">
<return type="void">
</return>
<argument index="0" name="gizmo" type="SpatialGizmo">
</argument>
<description>
Set [SpatialGizmo] for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor.
</description>
</method>
<method name="set_global_transform">
<return type="void">
</return>
<argument index="0" name="global" type="Transform">
</argument>
<description>
Set the transform globally, relative to world space.
</description>
</method>
<method name="set_identity">
<return type="void">
</return>
<description>
Reset all tranformations for this node. Set its [Transform3D] to identity matrix.
</description>
</method>
<method name="set_ignore_transform_notification">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set whether the node ignores notification that its transformation (global or local) changed.
</description>
</method>
<method name="set_notify_local_transform">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set whether the node notifies about its local transformation changes. Spatial will not propagate this by default.
</description>
</method>
<method name="set_notify_transform">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default.
</description>
</method>
<method name="set_rotation">
<return type="void">
</return>
<argument index="0" name="rotation_rad" type="Vector3">
</argument>
<description>
Set the rotation (in radians).
</description>
</method>
<method name="set_rotation_deg">
<return type="void">
</return>
<argument index="0" name="rotation_deg" type="Vector3">
</argument>
<description>
Set the rotation (in degrees).
</description>
</method>
<method name="set_scale">
<return type="void">
</return>
<argument index="0" name="scale" type="Vector3">
</argument>
<description>
Set the scale.
</description>
</method>
<method name="set_transform">
<return type="void">
</return>
<argument index="0" name="local" type="Transform">
</argument>
<description>
Set the transform locally, relative to the parent spatial node.
</description>
</method>
<method name="set_translation">
<return type="void">
</return>
<argument index="0" name="translation" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="set_visible">
<return type="void">
</return>
<argument index="0" name="visible" type="bool">
</argument>
<description>
</description>
</method>
<method name="show">
<return type="void">
</return>
<description>
Enables rendering of this node. Change Spatial Visible property to "True".
</description>
</method>
<method name="to_global" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="local_point" type="Vector3">
</argument>
<description>
Tranforms [Vector3] "local_point" from this node's local space to world space.
</description>
</method>
<method name="to_local" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="global_point" type="Vector3">
</argument>
<description>
Tranforms [Vector3] "global_point" from world space to this node's local space.
</description>
</method>
<method name="translate">
<return type="void">
</return>
<argument index="0" name="offset" type="Vector3">
</argument>
<description>
Changes the node's position by given offset [Vector3].
</description>
</method>
<method name="update_gizmo">
<return type="void">
</return>
<description>
Updates the [SpatialGizmo] of this node.
</description>
</method>
</methods>
<members>
<member name="global_transform" type="Transform" setter="set_global_transform" getter="get_global_transform">
World space (global) [Transform] of this node.
</member>
<member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation">
Local euler rotation in radians of this node.
</member>
<member name="rotation_deg" type="Vector3" setter="set_rotation_deg" getter="get_rotation_deg">
Local euler rotation in degrees of this node.
</member>
<member name="scale" type="Vector3" setter="set_scale" getter="get_scale">
Local scale of this node.
</member>
<member name="transform" type="Transform" setter="set_transform" getter="get_transform">
Local space [Transform] of this node.
</member>
<member name="translation" type="Vector3" setter="set_translation" getter="get_translation">
Local translation of this node.
</member>
<member name="visible" type="bool" setter="set_visible" getter="is_visible">
Visibility of this node. Toggles if this node is rendered.
</member>
</members>
<signals>
<signal name="visibility_changed">
<description>
Emitted when node visibility changes.
</description>
</signal>
</signals>
<constants>
<constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29" enum="">
Spatial nodes receives this notification when their global transform changes. This means that either the current or a parent node changed its transform.
In order for NOTIFICATION_TRANSFORM_CHANGED to work user first needs to ask for it, with set_notify_transform(true).
</constant>
<constant name="NOTIFICATION_ENTER_WORLD" value="41" enum="">
Spatial nodes receives this notification when they are registered to new [World] resource.
</constant>
<constant name="NOTIFICATION_EXIT_WORLD" value="42" enum="">
Spatial nodes receives this notification when they are unregistered from current [World] resource.
</constant>
<constant name="NOTIFICATION_VISIBILITY_CHANGED" value="43" enum="">
Spatial nodes receives this notification when their visibility changes.
</constant>
</constants>
</class>
|