1 /*************************************************************************/
2 /* node_2d.cpp */
3 /*************************************************************************/
4 /* This file is part of: */
5 /* GODOT ENGINE */
6 /* https://godotengine.org */
7 /*************************************************************************/
8 /* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
9 /* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */
10 /* */
11 /* Permission is hereby granted, free of charge, to any person obtaining */
12 /* a copy of this software and associated documentation files (the */
13 /* "Software"), to deal in the Software without restriction, including */
14 /* without limitation the rights to use, copy, modify, merge, publish, */
15 /* distribute, sublicense, and/or sell copies of the Software, and to */
16 /* permit persons to whom the Software is furnished to do so, subject to */
17 /* the following conditions: */
18 /* */
19 /* The above copyright notice and this permission notice shall be */
20 /* included in all copies or substantial portions of the Software. */
21 /* */
22 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23 /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
25 /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26 /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27 /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29 /*************************************************************************/
30 #include "node_2d.h"
31
32 #include "message_queue.h"
33 #include "scene/gui/control.h"
34 #include "scene/main/viewport.h"
35 #include "servers/visual_server.h"
36
edit_set_pivot(const Point2 & p_pivot)37 void Node2D::edit_set_pivot(const Point2 &p_pivot) {
38 }
39
edit_get_pivot() const40 Point2 Node2D::edit_get_pivot() const {
41
42 return Point2();
43 }
edit_has_pivot() const44 bool Node2D::edit_has_pivot() const {
45
46 return false;
47 }
48
edit_get_state() const49 Variant Node2D::edit_get_state() const {
50
51 Array state;
52 state.push_back(get_pos());
53 state.push_back(get_rot());
54 state.push_back(get_scale());
55
56 return state;
57 }
edit_set_state(const Variant & p_state)58 void Node2D::edit_set_state(const Variant &p_state) {
59
60 Array state = p_state;
61 ERR_FAIL_COND(state.size() != 3);
62
63 pos = state[0];
64 angle = state[1];
65 _scale = state[2];
66 _update_transform();
67 _change_notify("transform/rot");
68 _change_notify("transform/scale");
69 _change_notify("transform/pos");
70 }
71
edit_set_rect(const Rect2 & p_edit_rect)72 void Node2D::edit_set_rect(const Rect2 &p_edit_rect) {
73
74 Rect2 r = get_item_rect();
75
76 Vector2 zero_offset;
77 if (r.size.x != 0)
78 zero_offset.x = -r.pos.x / r.size.x;
79 if (r.size.y != 0)
80 zero_offset.y = -r.pos.y / r.size.y;
81
82 Size2 new_scale(1, 1);
83
84 if (r.size.x != 0)
85 new_scale.x = p_edit_rect.size.x / r.size.x;
86 if (r.size.y != 0)
87 new_scale.y = p_edit_rect.size.y / r.size.y;
88
89 Point2 new_pos = p_edit_rect.pos + p_edit_rect.size * zero_offset; //p_edit_rect.pos - r.pos;
90
91 Matrix32 postxf;
92 postxf.set_rotation_and_scale(angle, _scale);
93 new_pos = postxf.xform(new_pos);
94
95 pos += new_pos;
96 _scale *= new_scale;
97
98 _update_transform();
99 _change_notify("transform/scale");
100 _change_notify("transform/pos");
101 }
102
edit_rotate(float p_rot)103 void Node2D::edit_rotate(float p_rot) {
104
105 angle += p_rot;
106 _update_transform();
107 _change_notify("transform/rot");
108 }
109
_update_xform_values()110 void Node2D::_update_xform_values() {
111
112 pos = _mat.elements[2];
113 angle = _mat.get_rotation();
114 _scale = _mat.get_scale();
115 _xform_dirty = false;
116 }
117
_update_transform()118 void Node2D::_update_transform() {
119
120 Matrix32 mat(angle, pos);
121 _mat.set_rotation_and_scale(angle, _scale);
122 _mat.elements[2] = pos;
123
124 VisualServer::get_singleton()->canvas_item_set_transform(get_canvas_item(), _mat);
125
126 if (!is_inside_tree())
127 return;
128
129 _notify_transform();
130 }
131
set_pos(const Point2 & p_pos)132 void Node2D::set_pos(const Point2 &p_pos) {
133
134 if (_xform_dirty)
135 ((Node2D *)this)->_update_xform_values();
136 pos = p_pos;
137 _update_transform();
138 _change_notify("transform/pos");
139 }
140
set_rot(float p_radians)141 void Node2D::set_rot(float p_radians) {
142
143 if (_xform_dirty)
144 ((Node2D *)this)->_update_xform_values();
145 angle = p_radians;
146 _update_transform();
147 _change_notify("transform/rot");
148 }
149
set_rotd(float p_degrees)150 void Node2D::set_rotd(float p_degrees) {
151
152 set_rot(Math::deg2rad(p_degrees));
153 }
154
155 // Kept for compatibility after rename to set_rotd.
156 // Could be removed after a couple releases.
_set_rotd(float p_degrees)157 void Node2D::_set_rotd(float p_degrees) {
158
159 WARN_PRINT("Deprecated method Node2D._set_rotd(): This method was renamed to set_rotd. Please adapt your code accordingly, as the old method will be obsoleted.");
160 set_rotd(p_degrees);
161 }
162
set_scale(const Size2 & p_scale)163 void Node2D::set_scale(const Size2 &p_scale) {
164
165 if (_xform_dirty)
166 ((Node2D *)this)->_update_xform_values();
167 _scale = p_scale;
168 if (_scale.x == 0)
169 _scale.x = CMP_EPSILON;
170 if (_scale.y == 0)
171 _scale.y = CMP_EPSILON;
172 _update_transform();
173 _change_notify("transform/scale");
174 }
175
get_pos() const176 Point2 Node2D::get_pos() const {
177
178 if (_xform_dirty)
179 ((Node2D *)this)->_update_xform_values();
180 return pos;
181 }
get_rot() const182 float Node2D::get_rot() const {
183 if (_xform_dirty)
184 ((Node2D *)this)->_update_xform_values();
185
186 return angle;
187 }
get_rotd() const188 float Node2D::get_rotd() const {
189
190 return Math::rad2deg(get_rot());
191 }
192 // Kept for compatibility after rename to get_rotd.
193 // Could be removed after a couple releases.
_get_rotd() const194 float Node2D::_get_rotd() const {
195
196 WARN_PRINT("Deprecated method Node2D._get_rotd(): This method was renamed to get_rotd. Please adapt your code accordingly, as the old method will be obsoleted.");
197 return get_rotd();
198 }
get_scale() const199 Size2 Node2D::get_scale() const {
200 if (_xform_dirty)
201 ((Node2D *)this)->_update_xform_values();
202
203 return _scale;
204 }
205
_notification(int p_what)206 void Node2D::_notification(int p_what) {
207
208 switch (p_what) {
209 }
210 }
211
get_transform() const212 Matrix32 Node2D::get_transform() const {
213
214 return _mat;
215 }
216
get_item_rect() const217 Rect2 Node2D::get_item_rect() const {
218
219 if (get_script_instance()) {
220 Variant::CallError err;
221 Rect2 r = get_script_instance()->call("_get_item_rect", NULL, 0, err);
222 if (err.error == Variant::CallError::CALL_OK)
223 return r;
224 }
225 return Rect2(Point2(-32, -32), Size2(64, 64));
226 }
227
rotate(float p_radians)228 void Node2D::rotate(float p_radians) {
229
230 set_rot(get_rot() + p_radians);
231 }
232
translate(const Vector2 & p_amount)233 void Node2D::translate(const Vector2 &p_amount) {
234
235 set_pos(get_pos() + p_amount);
236 }
237
global_translate(const Vector2 & p_amount)238 void Node2D::global_translate(const Vector2 &p_amount) {
239
240 set_global_pos(get_global_pos() + p_amount);
241 }
242
scale(const Size2 & p_amount)243 void Node2D::scale(const Size2 &p_amount) {
244
245 set_scale(get_scale() * p_amount);
246 }
247
move_x(float p_delta,bool p_scaled)248 void Node2D::move_x(float p_delta, bool p_scaled) {
249
250 Matrix32 t = get_transform();
251 Vector2 m = t[0];
252 if (!p_scaled)
253 m.normalize();
254 set_pos(t[2] + m * p_delta);
255 }
256
move_y(float p_delta,bool p_scaled)257 void Node2D::move_y(float p_delta, bool p_scaled) {
258
259 Matrix32 t = get_transform();
260 Vector2 m = t[1];
261 if (!p_scaled)
262 m.normalize();
263 set_pos(t[2] + m * p_delta);
264 }
265
get_global_pos() const266 Point2 Node2D::get_global_pos() const {
267
268 return get_global_transform().get_origin();
269 }
270
set_global_pos(const Point2 & p_pos)271 void Node2D::set_global_pos(const Point2 &p_pos) {
272
273 Matrix32 inv;
274 CanvasItem *pi = get_parent_item();
275 if (pi) {
276 inv = pi->get_global_transform().affine_inverse();
277 set_pos(inv.xform(p_pos));
278 } else {
279 set_pos(p_pos);
280 }
281 }
282
get_global_rot() const283 float Node2D::get_global_rot() const {
284
285 return get_global_transform().get_rotation();
286 }
287
set_global_rot(float p_radians)288 void Node2D::set_global_rot(float p_radians) {
289
290 CanvasItem *pi = get_parent_item();
291 if (pi) {
292 const float parent_global_rot = pi->get_global_transform().get_rotation();
293 set_rot(p_radians - parent_global_rot);
294 } else {
295 set_rot(p_radians);
296 }
297 }
298
get_global_rotd() const299 float Node2D::get_global_rotd() const {
300
301 return Math::rad2deg(get_global_rot());
302 }
303
set_global_rotd(float p_degrees)304 void Node2D::set_global_rotd(float p_degrees) {
305
306 set_global_rot(Math::deg2rad(p_degrees));
307 }
308
get_global_scale() const309 Size2 Node2D::get_global_scale() const {
310
311 return get_global_transform().get_scale();
312 }
313
set_global_scale(const Size2 & p_scale)314 void Node2D::set_global_scale(const Size2 &p_scale) {
315
316 CanvasItem *pi = get_parent_item();
317 if (pi) {
318 const Size2 parent_global_scale = pi->get_global_transform().get_scale();
319 set_scale(p_scale / parent_global_scale);
320 } else {
321 set_scale(p_scale);
322 }
323 }
324
set_transform(const Matrix32 & p_transform)325 void Node2D::set_transform(const Matrix32 &p_transform) {
326
327 _mat = p_transform;
328 _xform_dirty = true;
329
330 VisualServer::get_singleton()->canvas_item_set_transform(get_canvas_item(), _mat);
331
332 if (!is_inside_tree())
333 return;
334
335 _notify_transform();
336 }
337
set_global_transform(const Matrix32 & p_transform)338 void Node2D::set_global_transform(const Matrix32 &p_transform) {
339
340 CanvasItem *pi = get_parent_item();
341 if (pi)
342 set_transform(pi->get_global_transform().affine_inverse() * p_transform);
343 else
344 set_transform(p_transform);
345 }
346
set_z(int p_z)347 void Node2D::set_z(int p_z) {
348
349 ERR_FAIL_COND(p_z < VS::CANVAS_ITEM_Z_MIN);
350 ERR_FAIL_COND(p_z > VS::CANVAS_ITEM_Z_MAX);
351 z = p_z;
352 VS::get_singleton()->canvas_item_set_z(get_canvas_item(), z);
353 }
354
set_z_as_relative(bool p_enabled)355 void Node2D::set_z_as_relative(bool p_enabled) {
356
357 if (z_relative == p_enabled)
358 return;
359 z_relative = p_enabled;
360 VS::get_singleton()->canvas_item_set_z_as_relative_to_parent(get_canvas_item(), p_enabled);
361 }
362
is_z_relative() const363 bool Node2D::is_z_relative() const {
364
365 return z_relative;
366 }
367
get_z() const368 int Node2D::get_z() const {
369
370 return z;
371 }
372
get_relative_transform_to_parent(const Node * p_parent) const373 Matrix32 Node2D::get_relative_transform_to_parent(const Node *p_parent) const {
374
375 if (p_parent == this)
376 return Matrix32();
377
378 Node2D *parent_2d = get_parent()->cast_to<Node2D>();
379
380 ERR_FAIL_COND_V(!parent_2d, Matrix32());
381 if (p_parent == parent_2d)
382 return get_transform();
383 else
384 return parent_2d->get_relative_transform_to_parent(p_parent) * get_transform();
385 }
386
look_at(const Vector2 & p_pos)387 void Node2D::look_at(const Vector2 &p_pos) {
388
389 rotate(get_angle_to(p_pos));
390 }
391
get_angle_to(const Vector2 & p_pos) const392 float Node2D::get_angle_to(const Vector2 &p_pos) const {
393
394 return (get_global_transform().affine_inverse().xform(p_pos)).angle();
395 }
396
_bind_methods()397 void Node2D::_bind_methods() {
398
399 // TODO: Obsolete those two methods (old name) properly (GH-4397)
400 ObjectTypeDB::bind_method(_MD("_get_rotd"), &Node2D::_get_rotd);
401 ObjectTypeDB::bind_method(_MD("_set_rotd", "degrees"), &Node2D::_set_rotd);
402
403 ObjectTypeDB::bind_method(_MD("set_pos", "pos"), &Node2D::set_pos);
404 ObjectTypeDB::bind_method(_MD("set_rot", "radians"), &Node2D::set_rot);
405 ObjectTypeDB::bind_method(_MD("set_rotd", "degrees"), &Node2D::set_rotd);
406 ObjectTypeDB::bind_method(_MD("set_scale", "scale"), &Node2D::set_scale);
407
408 ObjectTypeDB::bind_method(_MD("get_pos"), &Node2D::get_pos);
409 ObjectTypeDB::bind_method(_MD("get_rot"), &Node2D::get_rot);
410 ObjectTypeDB::bind_method(_MD("get_rotd"), &Node2D::get_rotd);
411 ObjectTypeDB::bind_method(_MD("get_scale"), &Node2D::get_scale);
412
413 ObjectTypeDB::bind_method(_MD("rotate", "radians"), &Node2D::rotate);
414 ObjectTypeDB::bind_method(_MD("move_local_x", "delta", "scaled"), &Node2D::move_x, DEFVAL(false));
415 ObjectTypeDB::bind_method(_MD("move_local_y", "delta", "scaled"), &Node2D::move_y, DEFVAL(false));
416 ObjectTypeDB::bind_method(_MD("translate", "offset"), &Node2D::translate);
417 ObjectTypeDB::bind_method(_MD("global_translate", "offset"), &Node2D::global_translate);
418 ObjectTypeDB::bind_method(_MD("scale", "ratio"), &Node2D::scale);
419
420 ObjectTypeDB::bind_method(_MD("set_global_pos", "pos"), &Node2D::set_global_pos);
421 ObjectTypeDB::bind_method(_MD("get_global_pos"), &Node2D::get_global_pos);
422 ObjectTypeDB::bind_method(_MD("set_global_rot", "radians"), &Node2D::set_global_rot);
423 ObjectTypeDB::bind_method(_MD("get_global_rot"), &Node2D::get_global_rot);
424 ObjectTypeDB::bind_method(_MD("set_global_rotd", "degrees"), &Node2D::set_global_rotd);
425 ObjectTypeDB::bind_method(_MD("get_global_rotd"), &Node2D::get_global_rotd);
426 ObjectTypeDB::bind_method(_MD("set_global_scale", "scale"), &Node2D::set_global_scale);
427 ObjectTypeDB::bind_method(_MD("get_global_scale"), &Node2D::get_global_scale);
428
429 ObjectTypeDB::bind_method(_MD("set_transform", "xform"), &Node2D::set_transform);
430 ObjectTypeDB::bind_method(_MD("set_global_transform", "xform"), &Node2D::set_global_transform);
431
432 ObjectTypeDB::bind_method(_MD("look_at", "point"), &Node2D::look_at);
433 ObjectTypeDB::bind_method(_MD("get_angle_to", "point"), &Node2D::get_angle_to);
434
435 ObjectTypeDB::bind_method(_MD("set_z", "z"), &Node2D::set_z);
436 ObjectTypeDB::bind_method(_MD("get_z"), &Node2D::get_z);
437
438 ObjectTypeDB::bind_method(_MD("set_z_as_relative", "enable"), &Node2D::set_z_as_relative);
439 ObjectTypeDB::bind_method(_MD("is_z_relative"), &Node2D::is_z_relative);
440
441 ObjectTypeDB::bind_method(_MD("edit_set_pivot", "pivot"), &Node2D::edit_set_pivot);
442
443 ObjectTypeDB::bind_method(_MD("get_relative_transform_to_parent", "parent"), &Node2D::get_relative_transform_to_parent);
444
445 ADD_PROPERTYNZ(PropertyInfo(Variant::VECTOR2, "transform/pos"), _SCS("set_pos"), _SCS("get_pos"));
446 ADD_PROPERTYNZ(PropertyInfo(Variant::REAL, "transform/rot", PROPERTY_HINT_RANGE, "-1440,1440,0.1"), _SCS("set_rotd"), _SCS("get_rotd"));
447 ADD_PROPERTYNO(PropertyInfo(Variant::VECTOR2, "transform/scale"), _SCS("set_scale"), _SCS("get_scale"));
448 ADD_PROPERTYNZ(PropertyInfo(Variant::INT, "z/z", PROPERTY_HINT_RANGE, itos(VS::CANVAS_ITEM_Z_MIN) + "," + itos(VS::CANVAS_ITEM_Z_MAX) + ",1"), _SCS("set_z"), _SCS("get_z"));
449 ADD_PROPERTYNO(PropertyInfo(Variant::BOOL, "z/relative"), _SCS("set_z_as_relative"), _SCS("is_z_relative"));
450 }
451
Node2D()452 Node2D::Node2D() {
453
454 angle = 0;
455 _scale = Vector2(1, 1);
456 _xform_dirty = false;
457 z = 0;
458 z_relative = true;
459 }
460