2022-04-07 19:49:28 +08:00
|
|
|
/**************************************************************************/
|
|
|
|
/* animation_library.h */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* */
|
|
|
|
/* 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. */
|
|
|
|
/**************************************************************************/
|
|
|
|
|
|
|
|
#ifndef ANIMATION_LIBRARY_H
|
|
|
|
#define ANIMATION_LIBRARY_H
|
|
|
|
|
|
|
|
#include "core/variant/typed_array.h"
|
|
|
|
#include "scene/resources/animation.h"
|
|
|
|
|
|
|
|
class AnimationLibrary : public Resource {
|
|
|
|
GDCLASS(AnimationLibrary, Resource)
|
|
|
|
|
|
|
|
void _set_data(const Dictionary &p_data);
|
|
|
|
Dictionary _get_data() const;
|
|
|
|
|
|
|
|
TypedArray<StringName> _get_animation_list() const;
|
|
|
|
|
2022-06-12 09:14:40 +08:00
|
|
|
void _animation_changed(const StringName &p_name);
|
|
|
|
|
2023-07-20 23:34:06 +08:00
|
|
|
friend class AnimationMixer; // For faster access.
|
2022-05-13 21:04:37 +08:00
|
|
|
HashMap<StringName, Ref<Animation>> animations;
|
2022-04-07 19:49:28 +08:00
|
|
|
|
|
|
|
protected:
|
|
|
|
static void _bind_methods();
|
|
|
|
|
|
|
|
public:
|
2022-05-05 11:19:54 +08:00
|
|
|
static bool is_valid_animation_name(const String &p_name);
|
|
|
|
static bool is_valid_library_name(const String &p_name);
|
|
|
|
static String validate_library_name(const String &p_name);
|
2022-04-19 17:04:48 +08:00
|
|
|
|
2022-04-07 19:49:28 +08:00
|
|
|
Error add_animation(const StringName &p_name, const Ref<Animation> &p_animation);
|
|
|
|
void remove_animation(const StringName &p_name);
|
|
|
|
void rename_animation(const StringName &p_name, const StringName &p_new_name);
|
|
|
|
bool has_animation(const StringName &p_name) const;
|
|
|
|
Ref<Animation> get_animation(const StringName &p_name) const;
|
|
|
|
void get_animation_list(List<StringName> *p_animations) const;
|
|
|
|
|
2024-01-03 19:10:11 +08:00
|
|
|
#ifdef TOOLS_ENABLED
|
2024-01-05 03:49:27 +08:00
|
|
|
virtual void get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const override;
|
2024-01-03 19:10:11 +08:00
|
|
|
#endif
|
2024-01-05 03:49:27 +08:00
|
|
|
|
2022-04-07 19:49:28 +08:00
|
|
|
AnimationLibrary();
|
|
|
|
};
|
|
|
|
|
2022-07-24 05:41:51 +08:00
|
|
|
#endif // ANIMATION_LIBRARY_H
|