2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2020-03-26 22:49:16 +01:00
|
|
|
/* animated_sprite_2d.cpp */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 14:16:55 +02:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2022-01-03 21:27:34 +01:00
|
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
2014-02-10 02:10:30 +01:00
|
|
|
/* */
|
|
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
|
|
/* a copy of this software and associated documentation files (the */
|
|
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
|
|
/* the following conditions: */
|
|
|
|
/* */
|
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
|
|
|
/* */
|
|
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
|
|
/*************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
#include "animated_sprite_2d.h"
|
2019-07-25 09:11:41 +02:00
|
|
|
|
2020-10-29 22:09:16 +01:00
|
|
|
#include "scene/main/viewport.h"
|
2016-05-15 04:48:23 +02:00
|
|
|
#include "scene/scene_string_names.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2019-10-21 23:37:07 +02:00
|
|
|
#ifdef TOOLS_ENABLED
|
2020-03-26 22:49:16 +01:00
|
|
|
Dictionary AnimatedSprite2D::_edit_get_state() const {
|
2017-11-07 08:58:35 +01:00
|
|
|
Dictionary state = Node2D::_edit_get_state();
|
|
|
|
state["offset"] = offset;
|
|
|
|
return state;
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::_edit_set_state(const Dictionary &p_state) {
|
2017-11-07 08:58:35 +01:00
|
|
|
Node2D::_edit_set_state(p_state);
|
|
|
|
set_offset(p_state["offset"]);
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::_edit_set_pivot(const Point2 &p_pivot) {
|
2017-11-07 08:58:35 +01:00
|
|
|
set_offset(get_offset() - p_pivot);
|
|
|
|
set_position(get_transform().xform(p_pivot));
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
Point2 AnimatedSprite2D::_edit_get_pivot() const {
|
2017-11-07 08:58:35 +01:00
|
|
|
return Vector2();
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
bool AnimatedSprite2D::_edit_use_pivot() const {
|
2017-11-07 08:58:35 +01:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
Rect2 AnimatedSprite2D::_edit_get_rect() const {
|
2018-05-05 16:59:00 +02:00
|
|
|
return _get_rect();
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
bool AnimatedSprite2D::_edit_use_rect() const {
|
2017-11-07 08:58:35 +01:00
|
|
|
if (!frames.is_valid() || !frames->has_animation(animation) || frame < 0 || frame >= frames->get_frame_count(animation)) {
|
2018-05-05 16:59:00 +02:00
|
|
|
return false;
|
|
|
|
}
|
2019-06-11 20:43:37 +02:00
|
|
|
Ref<Texture2D> t;
|
2020-05-14 16:41:43 +02:00
|
|
|
if (animation) {
|
2018-05-05 16:59:00 +02:00
|
|
|
t = frames->get_frame(animation, frame);
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2019-06-26 15:08:25 +02:00
|
|
|
return t.is_valid();
|
2018-05-05 16:59:00 +02:00
|
|
|
}
|
2019-10-21 23:37:07 +02:00
|
|
|
#endif
|
2018-05-05 16:59:00 +02:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
Rect2 AnimatedSprite2D::get_anchorable_rect() const {
|
2018-05-05 16:59:00 +02:00
|
|
|
return _get_rect();
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
Rect2 AnimatedSprite2D::_get_rect() const {
|
2018-05-05 16:59:00 +02:00
|
|
|
if (!frames.is_valid() || !frames->has_animation(animation) || frame < 0 || frame >= frames->get_frame_count(animation)) {
|
|
|
|
return Rect2();
|
2017-11-07 08:58:35 +01:00
|
|
|
}
|
|
|
|
|
2019-06-11 20:43:37 +02:00
|
|
|
Ref<Texture2D> t;
|
2020-05-14 16:41:43 +02:00
|
|
|
if (animation) {
|
2017-11-07 08:58:35 +01:00
|
|
|
t = frames->get_frame(animation, frame);
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
|
|
|
if (t.is_null()) {
|
2018-05-05 16:59:00 +02:00
|
|
|
return Rect2();
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2017-11-07 08:58:35 +01:00
|
|
|
Size2 s = t->get_size();
|
|
|
|
|
|
|
|
Point2 ofs = offset;
|
2020-05-14 16:41:43 +02:00
|
|
|
if (centered) {
|
2021-09-25 12:18:18 +02:00
|
|
|
ofs -= s / 2;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2017-11-07 08:58:35 +01:00
|
|
|
|
2020-05-14 16:41:43 +02:00
|
|
|
if (s == Size2(0, 0)) {
|
2017-11-07 08:58:35 +01:00
|
|
|
s = Size2(1, 1);
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2017-11-07 08:58:35 +01:00
|
|
|
|
|
|
|
return Rect2(ofs, s);
|
|
|
|
}
|
2016-05-15 04:48:23 +02:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::_validate_property(PropertyInfo &property) const {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (!frames.is_valid()) {
|
2016-05-15 04:48:23 +02:00
|
|
|
return;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2017-03-05 16:44:50 +01:00
|
|
|
if (property.name == "animation") {
|
|
|
|
property.hint = PROPERTY_HINT_ENUM;
|
2016-05-15 04:48:23 +02:00
|
|
|
List<StringName> names;
|
|
|
|
frames->get_animation_list(&names);
|
|
|
|
names.sort_custom<StringName::AlphCompare>();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
bool current_found = false;
|
2016-05-15 04:48:23 +02:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
for (List<StringName>::Element *E = names.front(); E; E = E->next()) {
|
2016-05-15 04:48:23 +02:00
|
|
|
if (E->prev()) {
|
2017-03-05 16:44:50 +01:00
|
|
|
property.hint_string += ",";
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
property.hint_string += String(E->get());
|
2021-12-08 23:44:07 +01:00
|
|
|
if (animation == E->get()) {
|
2017-03-05 16:44:50 +01:00
|
|
|
current_found = true;
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!current_found) {
|
2021-12-09 10:42:46 +01:00
|
|
|
if (property.hint_string.is_empty()) {
|
2017-03-05 16:44:50 +01:00
|
|
|
property.hint_string = String(animation);
|
2016-05-15 04:48:23 +02:00
|
|
|
} else {
|
2017-03-05 16:44:50 +01:00
|
|
|
property.hint_string = String(animation) + "," + property.hint_string;
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
if (property.name == "frame") {
|
2019-07-25 09:11:41 +02:00
|
|
|
property.hint = PROPERTY_HINT_RANGE;
|
2017-10-11 10:46:22 +02:00
|
|
|
if (frames->has_animation(animation) && frames->get_frame_count(animation) > 1) {
|
2017-03-05 16:44:50 +01:00
|
|
|
property.hint_string = "0," + itos(frames->get_frame_count(animation) - 1) + ",1";
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
2019-07-25 09:11:41 +02:00
|
|
|
property.usage |= PROPERTY_USAGE_KEYING_INCREMENTS;
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::_notification(int p_what) {
|
2017-03-05 16:44:50 +01:00
|
|
|
switch (p_what) {
|
2017-01-10 22:02:19 +01:00
|
|
|
case NOTIFICATION_INTERNAL_PROCESS: {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (frames.is_null()) {
|
2016-05-15 04:48:23 +02:00
|
|
|
return;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
|
|
|
if (!frames->has_animation(animation)) {
|
2016-05-15 04:48:23 +02:00
|
|
|
return;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
|
|
|
if (frame < 0) {
|
2016-05-15 04:48:23 +02:00
|
|
|
return;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2016-05-15 04:48:23 +02:00
|
|
|
|
2021-02-02 03:16:37 +01:00
|
|
|
double remaining = get_process_delta_time();
|
2016-05-15 04:48:23 +02:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
while (remaining) {
|
2022-02-28 09:00:45 +01:00
|
|
|
double speed = frames->get_animation_speed(animation) * speed_scale;
|
|
|
|
if (speed == 0) {
|
|
|
|
return; // Do nothing.
|
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
if (timeout <= 0) {
|
2018-05-13 23:29:06 +02:00
|
|
|
timeout = _get_frame_duration();
|
2016-05-15 04:48:23 +02:00
|
|
|
|
|
|
|
int fc = frames->get_frame_count(animation);
|
2019-03-17 08:03:23 +01:00
|
|
|
if ((!backwards && frame >= fc - 1) || (backwards && frame <= 0)) {
|
2016-05-15 04:48:23 +02:00
|
|
|
if (frames->get_animation_loop(animation)) {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (backwards) {
|
2019-03-17 08:03:23 +01:00
|
|
|
frame = fc - 1;
|
2020-05-14 16:41:43 +02:00
|
|
|
} else {
|
2019-03-17 08:03:23 +01:00
|
|
|
frame = 0;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2019-03-17 08:03:23 +01:00
|
|
|
|
2019-01-27 17:31:55 +01:00
|
|
|
emit_signal(SceneStringNames::get_singleton()->animation_finished);
|
2016-05-15 04:48:23 +02:00
|
|
|
} else {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (backwards) {
|
2019-03-17 08:03:23 +01:00
|
|
|
frame = 0;
|
2020-05-14 16:41:43 +02:00
|
|
|
} else {
|
2019-03-17 08:03:23 +01:00
|
|
|
frame = fc - 1;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2019-03-17 08:03:23 +01:00
|
|
|
|
2018-10-04 12:51:45 +02:00
|
|
|
if (!is_over) {
|
|
|
|
is_over = true;
|
2018-11-23 16:53:25 +01:00
|
|
|
emit_signal(SceneStringNames::get_singleton()->animation_finished);
|
2018-10-04 12:51:45 +02:00
|
|
|
}
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
|
|
|
} else {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (backwards) {
|
2019-03-17 08:03:23 +01:00
|
|
|
frame--;
|
2020-05-14 16:41:43 +02:00
|
|
|
} else {
|
2019-03-17 08:03:23 +01:00
|
|
|
frame++;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
update();
|
2021-02-10 21:18:45 +01:00
|
|
|
|
2017-08-05 21:32:34 +02:00
|
|
|
emit_signal(SceneStringNames::get_singleton()->frame_changed);
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
|
|
|
|
2021-02-02 03:16:37 +01:00
|
|
|
double to_process = MIN(timeout, remaining);
|
2017-03-05 16:44:50 +01:00
|
|
|
remaining -= to_process;
|
|
|
|
timeout -= to_process;
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
|
|
|
} break;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
case NOTIFICATION_DRAW: {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (frames.is_null()) {
|
2016-05-15 04:48:23 +02:00
|
|
|
return;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
|
|
|
if (frame < 0) {
|
2014-02-10 02:10:30 +01:00
|
|
|
return;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
|
|
|
if (!frames->has_animation(animation)) {
|
2014-02-10 02:10:30 +01:00
|
|
|
return;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2019-06-11 20:43:37 +02:00
|
|
|
Ref<Texture2D> texture = frames->get_frame(animation, frame);
|
2020-05-14 16:41:43 +02:00
|
|
|
if (texture.is_null()) {
|
2014-02-10 02:10:30 +01:00
|
|
|
return;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
RID ci = get_canvas_item();
|
|
|
|
|
2021-09-25 12:18:18 +02:00
|
|
|
Size2 s = texture->get_size();
|
2017-03-05 16:44:50 +01:00
|
|
|
Point2 ofs = offset;
|
2020-05-14 16:41:43 +02:00
|
|
|
if (centered) {
|
2017-03-05 16:44:50 +01:00
|
|
|
ofs -= s / 2;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-10-29 22:09:16 +01:00
|
|
|
if (get_viewport() && get_viewport()->is_snap_2d_transforms_to_pixel_enabled()) {
|
2017-03-05 16:44:50 +01:00
|
|
|
ofs = ofs.floor();
|
2015-10-13 20:53:34 +02:00
|
|
|
}
|
2017-03-05 16:44:50 +01:00
|
|
|
Rect2 dst_rect(ofs, s);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-05-14 16:41:43 +02:00
|
|
|
if (hflip) {
|
2017-03-05 16:44:50 +01:00
|
|
|
dst_rect.size.x = -dst_rect.size.x;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
|
|
|
if (vflip) {
|
2017-03-05 16:44:50 +01:00
|
|
|
dst_rect.size.y = -dst_rect.size.y;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-10-24 17:15:43 +02:00
|
|
|
texture->draw_rect_region(ci, dst_rect, Rect2(Vector2(), texture->get_size()), Color(1, 1, 1), false);
|
2014-02-10 02:10:30 +01:00
|
|
|
} break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::set_sprite_frames(const Ref<SpriteFrames> &p_frames) {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (frames.is_valid()) {
|
2020-03-26 22:49:16 +01:00
|
|
|
frames->disconnect("changed", callable_mp(this, &AnimatedSprite2D::_res_changed));
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2017-03-05 16:44:50 +01:00
|
|
|
frames = p_frames;
|
2020-05-14 16:41:43 +02:00
|
|
|
if (frames.is_valid()) {
|
2020-03-26 22:49:16 +01:00
|
|
|
frames->connect("changed", callable_mp(this, &AnimatedSprite2D::_res_changed));
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
if (!frames.is_valid()) {
|
2017-03-05 16:44:50 +01:00
|
|
|
frame = 0;
|
2014-02-10 02:10:30 +01:00
|
|
|
} else {
|
|
|
|
set_frame(frame);
|
|
|
|
}
|
2016-05-15 04:48:23 +02:00
|
|
|
|
2021-02-10 21:18:45 +01:00
|
|
|
notify_property_list_changed();
|
2016-05-15 04:48:23 +02:00
|
|
|
_reset_timeout();
|
2014-02-10 02:10:30 +01:00
|
|
|
update();
|
2020-10-29 11:01:28 +01:00
|
|
|
update_configuration_warnings();
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
Ref<SpriteFrames> AnimatedSprite2D::get_sprite_frames() const {
|
2014-02-10 02:10:30 +01:00
|
|
|
return frames;
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::set_frame(int p_frame) {
|
2014-02-10 02:10:30 +01:00
|
|
|
if (!frames.is_valid()) {
|
|
|
|
return;
|
|
|
|
}
|
2016-05-15 04:48:23 +02:00
|
|
|
|
|
|
|
if (frames->has_animation(animation)) {
|
|
|
|
int limit = frames->get_frame_count(animation);
|
2020-05-14 16:41:43 +02:00
|
|
|
if (p_frame >= limit) {
|
2017-03-05 16:44:50 +01:00
|
|
|
p_frame = limit - 1;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
|
|
|
|
2020-05-14 16:41:43 +02:00
|
|
|
if (p_frame < 0) {
|
2017-03-05 16:44:50 +01:00
|
|
|
p_frame = 0;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-05-14 16:41:43 +02:00
|
|
|
if (frame == p_frame) {
|
2014-02-10 02:10:30 +01:00
|
|
|
return;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
frame = p_frame;
|
2016-05-15 04:48:23 +02:00
|
|
|
_reset_timeout();
|
2014-02-10 02:10:30 +01:00
|
|
|
update();
|
2021-02-10 21:18:45 +01:00
|
|
|
|
2014-12-07 06:04:20 +01:00
|
|
|
emit_signal(SceneStringNames::get_singleton()->frame_changed);
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2020-05-14 14:29:06 +02:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
int AnimatedSprite2D::get_frame() const {
|
2014-02-10 02:10:30 +01:00
|
|
|
return frame;
|
|
|
|
}
|
|
|
|
|
2021-02-02 03:16:37 +01:00
|
|
|
void AnimatedSprite2D::set_speed_scale(double p_speed_scale) {
|
|
|
|
double elapsed = _get_frame_duration() - timeout;
|
2018-05-13 23:29:06 +02:00
|
|
|
|
2018-04-26 21:08:21 +02:00
|
|
|
speed_scale = MAX(p_speed_scale, 0.0f);
|
2018-05-13 23:29:06 +02:00
|
|
|
|
|
|
|
// We adapt the timeout so that the animation speed adapts as soon as the speed scale is changed
|
|
|
|
_reset_timeout();
|
|
|
|
timeout -= elapsed;
|
2018-04-26 21:08:21 +02:00
|
|
|
}
|
|
|
|
|
2021-02-02 03:16:37 +01:00
|
|
|
double AnimatedSprite2D::get_speed_scale() const {
|
2018-04-26 21:08:21 +02:00
|
|
|
return speed_scale;
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::set_centered(bool p_center) {
|
2017-03-05 16:44:50 +01:00
|
|
|
centered = p_center;
|
2014-02-10 02:10:30 +01:00
|
|
|
update();
|
|
|
|
item_rect_changed();
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
bool AnimatedSprite2D::is_centered() const {
|
2014-02-10 02:10:30 +01:00
|
|
|
return centered;
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::set_offset(const Point2 &p_offset) {
|
2017-03-05 16:44:50 +01:00
|
|
|
offset = p_offset;
|
2014-02-10 02:10:30 +01:00
|
|
|
update();
|
|
|
|
item_rect_changed();
|
|
|
|
}
|
2020-05-14 14:29:06 +02:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
Point2 AnimatedSprite2D::get_offset() const {
|
2014-02-10 02:10:30 +01:00
|
|
|
return offset;
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::set_flip_h(bool p_flip) {
|
2017-03-05 16:44:50 +01:00
|
|
|
hflip = p_flip;
|
2014-02-10 02:10:30 +01:00
|
|
|
update();
|
|
|
|
}
|
2020-05-14 14:29:06 +02:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
bool AnimatedSprite2D::is_flipped_h() const {
|
2014-02-10 02:10:30 +01:00
|
|
|
return hflip;
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::set_flip_v(bool p_flip) {
|
2017-03-05 16:44:50 +01:00
|
|
|
vflip = p_flip;
|
2014-02-10 02:10:30 +01:00
|
|
|
update();
|
|
|
|
}
|
2020-05-14 14:29:06 +02:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
bool AnimatedSprite2D::is_flipped_v() const {
|
2014-02-10 02:10:30 +01:00
|
|
|
return vflip;
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::_res_changed() {
|
2014-02-10 02:10:30 +01:00
|
|
|
set_frame(frame);
|
2021-02-10 21:18:45 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
update();
|
|
|
|
}
|
|
|
|
|
2021-08-04 11:46:40 +02:00
|
|
|
void AnimatedSprite2D::set_playing(bool p_playing) {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (playing == p_playing) {
|
2016-05-15 04:48:23 +02:00
|
|
|
return;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2017-03-05 16:44:50 +01:00
|
|
|
playing = p_playing;
|
2016-05-15 04:48:23 +02:00
|
|
|
_reset_timeout();
|
2017-01-10 22:02:19 +01:00
|
|
|
set_process_internal(playing);
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
|
|
|
|
2021-08-04 11:46:40 +02:00
|
|
|
bool AnimatedSprite2D::is_playing() const {
|
2016-05-15 04:48:23 +02:00
|
|
|
return playing;
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::play(const StringName &p_animation, const bool p_backwards) {
|
2019-09-04 00:59:54 +02:00
|
|
|
backwards = p_backwards;
|
|
|
|
|
|
|
|
if (p_animation) {
|
2016-05-15 04:48:23 +02:00
|
|
|
set_animation(p_animation);
|
2021-04-05 14:40:44 +02:00
|
|
|
if (frames.is_valid() && backwards && get_frame() == 0) {
|
2019-09-04 00:59:54 +02:00
|
|
|
set_frame(frames->get_frame_count(p_animation) - 1);
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2019-09-04 00:59:54 +02:00
|
|
|
}
|
2019-03-17 08:03:23 +01:00
|
|
|
|
2021-08-04 11:46:40 +02:00
|
|
|
set_playing(true);
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::stop() {
|
2021-08-04 11:46:40 +02:00
|
|
|
set_playing(false);
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
|
|
|
|
2021-02-02 03:16:37 +01:00
|
|
|
double AnimatedSprite2D::_get_frame_duration() {
|
2016-05-15 04:48:23 +02:00
|
|
|
if (frames.is_valid() && frames->has_animation(animation)) {
|
2021-02-02 03:16:37 +01:00
|
|
|
double speed = frames->get_animation_speed(animation) * speed_scale;
|
2017-03-05 16:44:50 +01:00
|
|
|
if (speed > 0) {
|
2018-05-13 23:29:06 +02:00
|
|
|
return 1.0 / speed;
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
|
|
|
}
|
2018-05-13 23:29:06 +02:00
|
|
|
return 0.0;
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::_reset_timeout() {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (!playing) {
|
2018-05-13 23:29:06 +02:00
|
|
|
return;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2018-05-13 23:29:06 +02:00
|
|
|
|
|
|
|
timeout = _get_frame_duration();
|
2018-10-04 12:51:45 +02:00
|
|
|
is_over = false;
|
2016-05-15 04:48:23 +02:00
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::set_animation(const StringName &p_animation) {
|
2020-04-02 01:20:12 +02:00
|
|
|
ERR_FAIL_COND_MSG(frames == nullptr, vformat("There is no animation with name '%s'.", p_animation));
|
2022-02-01 19:19:13 +01:00
|
|
|
ERR_FAIL_COND_MSG(!frames->get_animation_names().has(p_animation), vformat("There is no animation with name '%s'.", p_animation));
|
2018-12-19 23:38:19 +01:00
|
|
|
|
2020-05-14 16:41:43 +02:00
|
|
|
if (animation == p_animation) {
|
2016-05-15 04:48:23 +02:00
|
|
|
return;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2016-05-15 04:48:23 +02:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
animation = p_animation;
|
2016-05-15 04:48:23 +02:00
|
|
|
_reset_timeout();
|
|
|
|
set_frame(0);
|
2021-02-10 21:18:45 +01:00
|
|
|
notify_property_list_changed();
|
2016-05-15 04:48:23 +02:00
|
|
|
update();
|
|
|
|
}
|
2020-05-14 14:29:06 +02:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
StringName AnimatedSprite2D::get_animation() const {
|
2016-05-15 04:48:23 +02:00
|
|
|
return animation;
|
|
|
|
}
|
|
|
|
|
2020-10-29 11:01:28 +01:00
|
|
|
TypedArray<String> AnimatedSprite2D::get_configuration_warnings() const {
|
|
|
|
TypedArray<String> warnings = Node::get_configuration_warnings();
|
2020-05-14 22:59:27 +02:00
|
|
|
|
2016-05-17 23:27:15 +02:00
|
|
|
if (frames.is_null()) {
|
2022-03-28 15:24:14 +02:00
|
|
|
warnings.push_back(RTR("A SpriteFrames resource must be created or set in the \"Frames\" property in order for AnimatedSprite to display frames."));
|
2016-05-17 23:27:15 +02:00
|
|
|
}
|
|
|
|
|
2020-10-29 11:01:28 +01:00
|
|
|
return warnings;
|
2016-05-17 23:27:15 +02:00
|
|
|
}
|
|
|
|
|
2022-05-04 14:56:20 +02:00
|
|
|
void AnimatedSprite2D::get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const {
|
|
|
|
if (p_idx == 0 && p_function == "play" && frames.is_valid()) {
|
|
|
|
List<StringName> al;
|
|
|
|
frames->get_animation_list(&al);
|
|
|
|
for (const StringName &name : al) {
|
|
|
|
r_options->push_back(String(name).quote());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
Node::get_argument_options(p_function, p_idx, r_options);
|
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
void AnimatedSprite2D::_bind_methods() {
|
|
|
|
ClassDB::bind_method(D_METHOD("set_sprite_frames", "sprite_frames"), &AnimatedSprite2D::set_sprite_frames);
|
|
|
|
ClassDB::bind_method(D_METHOD("get_sprite_frames"), &AnimatedSprite2D::get_sprite_frames);
|
2016-05-15 04:48:23 +02:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
ClassDB::bind_method(D_METHOD("set_animation", "animation"), &AnimatedSprite2D::set_animation);
|
|
|
|
ClassDB::bind_method(D_METHOD("get_animation"), &AnimatedSprite2D::get_animation);
|
2016-05-15 04:48:23 +02:00
|
|
|
|
2021-08-04 11:46:40 +02:00
|
|
|
ClassDB::bind_method(D_METHOD("set_playing", "playing"), &AnimatedSprite2D::set_playing);
|
|
|
|
ClassDB::bind_method(D_METHOD("is_playing"), &AnimatedSprite2D::is_playing);
|
2016-05-15 04:48:23 +02:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
ClassDB::bind_method(D_METHOD("play", "anim", "backwards"), &AnimatedSprite2D::play, DEFVAL(StringName()), DEFVAL(false));
|
|
|
|
ClassDB::bind_method(D_METHOD("stop"), &AnimatedSprite2D::stop);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
ClassDB::bind_method(D_METHOD("set_centered", "centered"), &AnimatedSprite2D::set_centered);
|
|
|
|
ClassDB::bind_method(D_METHOD("is_centered"), &AnimatedSprite2D::is_centered);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
ClassDB::bind_method(D_METHOD("set_offset", "offset"), &AnimatedSprite2D::set_offset);
|
|
|
|
ClassDB::bind_method(D_METHOD("get_offset"), &AnimatedSprite2D::get_offset);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
ClassDB::bind_method(D_METHOD("set_flip_h", "flip_h"), &AnimatedSprite2D::set_flip_h);
|
|
|
|
ClassDB::bind_method(D_METHOD("is_flipped_h"), &AnimatedSprite2D::is_flipped_h);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
ClassDB::bind_method(D_METHOD("set_flip_v", "flip_v"), &AnimatedSprite2D::set_flip_v);
|
|
|
|
ClassDB::bind_method(D_METHOD("is_flipped_v"), &AnimatedSprite2D::is_flipped_v);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
ClassDB::bind_method(D_METHOD("set_frame", "frame"), &AnimatedSprite2D::set_frame);
|
|
|
|
ClassDB::bind_method(D_METHOD("get_frame"), &AnimatedSprite2D::get_frame);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
ClassDB::bind_method(D_METHOD("set_speed_scale", "speed_scale"), &AnimatedSprite2D::set_speed_scale);
|
|
|
|
ClassDB::bind_method(D_METHOD("get_speed_scale"), &AnimatedSprite2D::get_speed_scale);
|
2018-04-26 21:08:21 +02:00
|
|
|
|
2014-12-07 06:04:20 +01:00
|
|
|
ADD_SIGNAL(MethodInfo("frame_changed"));
|
2017-01-08 21:35:11 +01:00
|
|
|
ADD_SIGNAL(MethodInfo("animation_finished"));
|
2014-12-07 06:04:20 +01:00
|
|
|
|
2019-07-05 03:54:32 +02:00
|
|
|
ADD_GROUP("Animation", "");
|
2018-11-08 15:30:02 +01:00
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "frames", PROPERTY_HINT_RESOURCE_TYPE, "SpriteFrames"), "set_sprite_frames", "get_sprite_frames");
|
2020-02-20 22:58:05 +01:00
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::STRING_NAME, "animation"), "set_animation", "get_animation");
|
2019-07-25 09:11:41 +02:00
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::INT, "frame"), "set_frame", "get_frame");
|
Variant: Added 64-bit packed arrays, renamed Variant::REAL to FLOAT.
- Renames PackedIntArray to PackedInt32Array.
- Renames PackedFloatArray to PackedFloat32Array.
- Adds PackedInt64Array and PackedFloat64Array.
- Renames Variant::REAL to Variant::FLOAT for consistency.
Packed arrays are for storing large amount of data and creating stuff like
meshes, buffers. textures, etc. Forcing them to be 64 is a huge waste of
memory. That said, many users requested the ability to have 64 bits packed
arrays for their games, so this is just an optional added type.
For Variant, the float datatype is always 64 bits, and exposed as `float`.
We still have `real_t` which is the datatype that can change from 32 to 64
bits depending on a compile flag (not entirely working right now, but that's
the idea). It affects math related datatypes and code only.
Neither Variant nor PackedArray make use of real_t, which is only intended
for math precision, so the term is removed from there to keep only float.
2020-02-24 19:20:53 +01:00
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "speed_scale"), "set_speed_scale", "get_speed_scale");
|
2021-08-04 11:46:40 +02:00
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "playing"), "set_playing", "is_playing");
|
2019-07-05 03:54:32 +02:00
|
|
|
ADD_GROUP("Offset", "");
|
2018-11-08 15:30:02 +01:00
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "centered"), "set_centered", "is_centered");
|
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::VECTOR2, "offset"), "set_offset", "get_offset");
|
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "flip_h"), "set_flip_h", "is_flipped_h");
|
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "flip_v"), "set_flip_v", "is_flipped_v");
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
AnimatedSprite2D::AnimatedSprite2D() {
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|