1/**************************************************************************/
2/* rich_text_effect.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 RICH_TEXT_EFFECT_H
32#define RICH_TEXT_EFFECT_H
33
34#include "core/io/resource.h"
35#include "core/object/gdvirtual.gen.inc"
36
37class CharFXTransform : public RefCounted {
38 GDCLASS(CharFXTransform, RefCounted);
39
40protected:
41 static void _bind_methods();
42
43public:
44 Vector2i range;
45 bool visibility = true;
46 bool outline = false;
47 Point2 offset;
48 Color color;
49 double elapsed_time = 0.0f;
50 Dictionary environment;
51 uint32_t glyph_index = 0;
52 uint16_t glyph_flags = 0;
53 uint8_t glyph_count = 0;
54 int32_t relative_index = 0;
55 RID font;
56
57 CharFXTransform();
58 ~CharFXTransform();
59
60 Vector2i get_range() { return range; }
61 void set_range(const Vector2i &p_range) { range = p_range; }
62
63 double get_elapsed_time() { return elapsed_time; }
64 void set_elapsed_time(double p_elapsed_time) { elapsed_time = p_elapsed_time; }
65
66 bool is_visible() { return visibility; }
67 void set_visibility(bool p_visibility) { visibility = p_visibility; }
68
69 bool is_outline() { return outline; }
70 void set_outline(bool p_outline) { outline = p_outline; }
71
72 Point2 get_offset() { return offset; }
73 void set_offset(Point2 p_offset) { offset = p_offset; }
74
75 Color get_color() { return color; }
76 void set_color(Color p_color) { color = p_color; }
77
78 uint32_t get_glyph_index() const { return glyph_index; };
79 void set_glyph_index(uint32_t p_glyph_index) { glyph_index = p_glyph_index; };
80
81 uint16_t get_glyph_flags() const { return glyph_flags; };
82 void set_glyph_flags(uint16_t p_glyph_flags) { glyph_flags = p_glyph_flags; };
83
84 uint8_t get_glyph_count() const { return glyph_count; };
85 void set_glyph_count(uint8_t p_glyph_count) { glyph_count = p_glyph_count; };
86
87 int32_t get_relative_index() const { return relative_index; };
88 void set_relative_index(int32_t p_relative_index) { relative_index = p_relative_index; };
89
90 RID get_font() const { return font; };
91 void set_font(RID p_font) { font = p_font; };
92
93 Dictionary get_environment() { return environment; }
94 void set_environment(Dictionary p_environment) { environment = p_environment; }
95};
96
97class RichTextEffect : public Resource {
98 GDCLASS(RichTextEffect, Resource);
99 OBJ_SAVE_TYPE(RichTextEffect);
100
101protected:
102 static void _bind_methods();
103
104 GDVIRTUAL1RC(bool, _process_custom_fx, Ref<CharFXTransform>)
105
106public:
107 Variant get_bbcode() const;
108 bool _process_effect_impl(Ref<class CharFXTransform> p_cfx);
109
110 RichTextEffect();
111};
112
113#endif // RICH_TEXT_EFFECT_H
114