1/**************************************************************************/
2/* animation_library.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
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
31#ifndef ANIMATION_LIBRARY_H
32#define ANIMATION_LIBRARY_H
33
34#include "core/variant/typed_array.h"
35#include "scene/resources/animation.h"
36
37class AnimationLibrary : public Resource {
38 GDCLASS(AnimationLibrary, Resource)
39
40 void _set_data(const Dictionary &p_data);
41 Dictionary _get_data() const;
42
43 TypedArray<StringName> _get_animation_list() const;
44
45 void _animation_changed(const StringName &p_name);
46
47 friend class AnimationPlayer; //for faster access
48 HashMap<StringName, Ref<Animation>> animations;
49
50protected:
51 static void _bind_methods();
52
53public:
54 static bool is_valid_animation_name(const String &p_name);
55 static bool is_valid_library_name(const String &p_name);
56 static String validate_library_name(const String &p_name);
57
58 Error add_animation(const StringName &p_name, const Ref<Animation> &p_animation);
59 void remove_animation(const StringName &p_name);
60 void rename_animation(const StringName &p_name, const StringName &p_new_name);
61 bool has_animation(const StringName &p_name) const;
62 Ref<Animation> get_animation(const StringName &p_name) const;
63 void get_animation_list(List<StringName> *p_animations) const;
64
65 AnimationLibrary();
66};
67
68#endif // ANIMATION_LIBRARY_H
69