| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962 |
- /*************************************************************************/
- /* text_paragraph.cpp */
- /*************************************************************************/
- /* This file is part of: */
- /* GODOT ENGINE */
- /* https://godotengine.org */
- /*************************************************************************/
- /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
- /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
- /* */
- /* 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. */
- /*************************************************************************/
- #include "scene/resources/text_paragraph.h"
- void TextParagraph::_bind_methods() {
- ClassDB::bind_method(D_METHOD("clear"), &TextParagraph::clear);
- ClassDB::bind_method(D_METHOD("set_direction", "direction"), &TextParagraph::set_direction);
- ClassDB::bind_method(D_METHOD("get_direction"), &TextParagraph::get_direction);
- ADD_PROPERTY(PropertyInfo(Variant::INT, "direction", PROPERTY_HINT_ENUM, "Auto,Light-to-right,Right-to-left"), "set_direction", "get_direction");
- ClassDB::bind_method(D_METHOD("set_custom_punctuation", "custom_punctuation"), &TextParagraph::set_custom_punctuation);
- ClassDB::bind_method(D_METHOD("get_custom_punctuation"), &TextParagraph::get_custom_punctuation);
- ADD_PROPERTY(PropertyInfo(Variant::STRING, "custom_punctuation"), "set_custom_punctuation", "get_custom_punctuation");
- ClassDB::bind_method(D_METHOD("set_orientation", "orientation"), &TextParagraph::set_orientation);
- ClassDB::bind_method(D_METHOD("get_orientation"), &TextParagraph::get_orientation);
- ADD_PROPERTY(PropertyInfo(Variant::INT, "orientation", PROPERTY_HINT_ENUM, "Horizontal,Orientation"), "set_orientation", "get_orientation");
- ClassDB::bind_method(D_METHOD("set_preserve_invalid", "enabled"), &TextParagraph::set_preserve_invalid);
- ClassDB::bind_method(D_METHOD("get_preserve_invalid"), &TextParagraph::get_preserve_invalid);
- ADD_PROPERTY(PropertyInfo(Variant::BOOL, "preserve_invalid"), "set_preserve_invalid", "get_preserve_invalid");
- ClassDB::bind_method(D_METHOD("set_preserve_control", "enabled"), &TextParagraph::set_preserve_control);
- ClassDB::bind_method(D_METHOD("get_preserve_control"), &TextParagraph::get_preserve_control);
- ADD_PROPERTY(PropertyInfo(Variant::BOOL, "preserve_control"), "set_preserve_control", "get_preserve_control");
- ClassDB::bind_method(D_METHOD("set_bidi_override", "override"), &TextParagraph::set_bidi_override);
- ClassDB::bind_method(D_METHOD("set_dropcap", "text", "font", "font_size", "dropcap_margins", "language"), &TextParagraph::set_dropcap, DEFVAL(Rect2()), DEFVAL(""));
- ClassDB::bind_method(D_METHOD("clear_dropcap"), &TextParagraph::clear_dropcap);
- ClassDB::bind_method(D_METHOD("add_string", "text", "font", "font_size", "language", "meta"), &TextParagraph::add_string, DEFVAL(""), DEFVAL(Variant()));
- ClassDB::bind_method(D_METHOD("add_object", "key", "size", "inline_align", "length"), &TextParagraph::add_object, DEFVAL(INLINE_ALIGNMENT_CENTER), DEFVAL(1));
- ClassDB::bind_method(D_METHOD("resize_object", "key", "size", "inline_align"), &TextParagraph::resize_object, DEFVAL(INLINE_ALIGNMENT_CENTER));
- ClassDB::bind_method(D_METHOD("set_alignment", "alignment"), &TextParagraph::set_alignment);
- ClassDB::bind_method(D_METHOD("get_alignment"), &TextParagraph::get_alignment);
- ADD_PROPERTY(PropertyInfo(Variant::INT, "alignment", PROPERTY_HINT_ENUM, "Left,Center,Right,Fill"), "set_alignment", "get_alignment");
- ClassDB::bind_method(D_METHOD("tab_align", "tab_stops"), &TextParagraph::tab_align);
- ClassDB::bind_method(D_METHOD("set_break_flags", "flags"), &TextParagraph::set_break_flags);
- ClassDB::bind_method(D_METHOD("get_break_flags"), &TextParagraph::get_break_flags);
- ADD_PROPERTY(PropertyInfo(Variant::INT, "break_flags", PROPERTY_HINT_FLAGS, "Mandatory,Word Bound,Grapheme Bound,Adaptive,Trim Spaces"), "set_break_flags", "get_break_flags");
- ClassDB::bind_method(D_METHOD("set_justification_flags", "flags"), &TextParagraph::set_justification_flags);
- ClassDB::bind_method(D_METHOD("get_justification_flags"), &TextParagraph::get_justification_flags);
- ADD_PROPERTY(PropertyInfo(Variant::INT, "justification_flags", PROPERTY_HINT_FLAGS, "Kashida Justification,Word Justification,Trim Edge Spaces After Justification,Justify Only After Last Tab,Constrain Ellipsis"), "set_justification_flags", "get_justification_flags");
- ClassDB::bind_method(D_METHOD("set_text_overrun_behavior", "overrun_behavior"), &TextParagraph::set_text_overrun_behavior);
- ClassDB::bind_method(D_METHOD("get_text_overrun_behavior"), &TextParagraph::get_text_overrun_behavior);
- ADD_PROPERTY(PropertyInfo(Variant::INT, "text_overrun_behavior", PROPERTY_HINT_ENUM, "Trim Nothing,Trim Characters,Trim Words,Ellipsis,Word Ellipsis"), "set_text_overrun_behavior", "get_text_overrun_behavior");
- ClassDB::bind_method(D_METHOD("set_width", "width"), &TextParagraph::set_width);
- ClassDB::bind_method(D_METHOD("get_width"), &TextParagraph::get_width);
- ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "width"), "set_width", "get_width");
- ClassDB::bind_method(D_METHOD("get_non_wrapped_size"), &TextParagraph::get_non_wrapped_size);
- ClassDB::bind_method(D_METHOD("get_size"), &TextParagraph::get_size);
- ClassDB::bind_method(D_METHOD("get_rid"), &TextParagraph::get_rid);
- ClassDB::bind_method(D_METHOD("get_line_rid", "line"), &TextParagraph::get_line_rid);
- ClassDB::bind_method(D_METHOD("get_dropcap_rid"), &TextParagraph::get_dropcap_rid);
- ClassDB::bind_method(D_METHOD("get_line_count"), &TextParagraph::get_line_count);
- ClassDB::bind_method(D_METHOD("set_max_lines_visible", "max_lines_visible"), &TextParagraph::set_max_lines_visible);
- ClassDB::bind_method(D_METHOD("get_max_lines_visible"), &TextParagraph::get_max_lines_visible);
- ADD_PROPERTY(PropertyInfo(Variant::INT, "max_lines_visible"), "set_max_lines_visible", "get_max_lines_visible");
- ClassDB::bind_method(D_METHOD("get_line_objects", "line"), &TextParagraph::get_line_objects);
- ClassDB::bind_method(D_METHOD("get_line_object_rect", "line", "key"), &TextParagraph::get_line_object_rect);
- ClassDB::bind_method(D_METHOD("get_line_size", "line"), &TextParagraph::get_line_size);
- ClassDB::bind_method(D_METHOD("get_line_range", "line"), &TextParagraph::get_line_range);
- ClassDB::bind_method(D_METHOD("get_line_ascent", "line"), &TextParagraph::get_line_ascent);
- ClassDB::bind_method(D_METHOD("get_line_descent", "line"), &TextParagraph::get_line_descent);
- ClassDB::bind_method(D_METHOD("get_line_width", "line"), &TextParagraph::get_line_width);
- ClassDB::bind_method(D_METHOD("get_line_underline_position", "line"), &TextParagraph::get_line_underline_position);
- ClassDB::bind_method(D_METHOD("get_line_underline_thickness", "line"), &TextParagraph::get_line_underline_thickness);
- ClassDB::bind_method(D_METHOD("get_dropcap_size"), &TextParagraph::get_dropcap_size);
- ClassDB::bind_method(D_METHOD("get_dropcap_lines"), &TextParagraph::get_dropcap_lines);
- ClassDB::bind_method(D_METHOD("draw", "canvas", "pos", "color", "dc_color"), &TextParagraph::draw, DEFVAL(Color(1, 1, 1)), DEFVAL(Color(1, 1, 1)));
- ClassDB::bind_method(D_METHOD("draw_outline", "canvas", "pos", "outline_size", "color", "dc_color"), &TextParagraph::draw_outline, DEFVAL(1), DEFVAL(Color(1, 1, 1)), DEFVAL(Color(1, 1, 1)));
- ClassDB::bind_method(D_METHOD("draw_line", "canvas", "pos", "line", "color"), &TextParagraph::draw_line, DEFVAL(Color(1, 1, 1)));
- ClassDB::bind_method(D_METHOD("draw_line_outline", "canvas", "pos", "line", "outline_size", "color"), &TextParagraph::draw_line_outline, DEFVAL(1), DEFVAL(Color(1, 1, 1)));
- ClassDB::bind_method(D_METHOD("draw_dropcap", "canvas", "pos", "color"), &TextParagraph::draw_dropcap, DEFVAL(Color(1, 1, 1)));
- ClassDB::bind_method(D_METHOD("draw_dropcap_outline", "canvas", "pos", "outline_size", "color"), &TextParagraph::draw_dropcap_outline, DEFVAL(1), DEFVAL(Color(1, 1, 1)));
- ClassDB::bind_method(D_METHOD("hit_test", "coords"), &TextParagraph::hit_test);
- }
- void TextParagraph::_shape_lines() {
- if (lines_dirty) {
- for (int i = 0; i < (int)lines_rid.size(); i++) {
- TS->free_rid(lines_rid[i]);
- }
- lines_rid.clear();
- if (!tab_stops.is_empty()) {
- TS->shaped_text_tab_align(rid, tab_stops);
- }
- float h_offset = 0.f;
- float v_offset = 0.f;
- int start = 0;
- dropcap_lines = 0;
- if (TS->shaped_text_get_orientation(dropcap_rid) == TextServer::ORIENTATION_HORIZONTAL) {
- h_offset = TS->shaped_text_get_size(dropcap_rid).x + dropcap_margins.size.x + dropcap_margins.position.x;
- v_offset = TS->shaped_text_get_size(dropcap_rid).y + dropcap_margins.size.y + dropcap_margins.position.y;
- } else {
- h_offset = TS->shaped_text_get_size(dropcap_rid).y + dropcap_margins.size.y + dropcap_margins.position.y;
- v_offset = TS->shaped_text_get_size(dropcap_rid).x + dropcap_margins.size.x + dropcap_margins.position.x;
- }
- if (h_offset > 0) {
- // Dropcap, flow around.
- PackedInt32Array line_breaks = TS->shaped_text_get_line_breaks(rid, width - h_offset, 0, brk_flags);
- for (int i = 0; i < line_breaks.size(); i = i + 2) {
- RID line = TS->shaped_text_substr(rid, line_breaks[i], line_breaks[i + 1] - line_breaks[i]);
- float h = (TS->shaped_text_get_orientation(line) == TextServer::ORIENTATION_HORIZONTAL) ? TS->shaped_text_get_size(line).y : TS->shaped_text_get_size(line).x;
- if (v_offset < h) {
- TS->free_rid(line);
- break;
- }
- if (!tab_stops.is_empty()) {
- TS->shaped_text_tab_align(line, tab_stops);
- }
- dropcap_lines++;
- v_offset -= h;
- start = line_breaks[i + 1];
- lines_rid.push_back(line);
- }
- }
- // Use fixed for the rest of lines.
- PackedInt32Array line_breaks = TS->shaped_text_get_line_breaks(rid, width, start, brk_flags);
- for (int i = 0; i < line_breaks.size(); i = i + 2) {
- RID line = TS->shaped_text_substr(rid, line_breaks[i], line_breaks[i + 1] - line_breaks[i]);
- if (!tab_stops.is_empty()) {
- TS->shaped_text_tab_align(line, tab_stops);
- }
- lines_rid.push_back(line);
- }
- BitField<TextServer::TextOverrunFlag> overrun_flags = TextServer::OVERRUN_NO_TRIM;
- if (overrun_behavior != TextServer::OVERRUN_NO_TRIMMING) {
- switch (overrun_behavior) {
- case TextServer::OVERRUN_TRIM_WORD_ELLIPSIS:
- overrun_flags.set_flag(TextServer::OVERRUN_TRIM);
- overrun_flags.set_flag(TextServer::OVERRUN_TRIM_WORD_ONLY);
- overrun_flags.set_flag(TextServer::OVERRUN_ADD_ELLIPSIS);
- break;
- case TextServer::OVERRUN_TRIM_ELLIPSIS:
- overrun_flags.set_flag(TextServer::OVERRUN_TRIM);
- overrun_flags.set_flag(TextServer::OVERRUN_ADD_ELLIPSIS);
- break;
- case TextServer::OVERRUN_TRIM_WORD:
- overrun_flags.set_flag(TextServer::OVERRUN_TRIM);
- overrun_flags.set_flag(TextServer::OVERRUN_TRIM_WORD_ONLY);
- break;
- case TextServer::OVERRUN_TRIM_CHAR:
- overrun_flags.set_flag(TextServer::OVERRUN_TRIM);
- break;
- case TextServer::OVERRUN_NO_TRIMMING:
- break;
- }
- }
- bool autowrap_enabled = brk_flags.has_flag(TextServer::BREAK_WORD_BOUND) || brk_flags.has_flag(TextServer::BREAK_GRAPHEME_BOUND);
- // Fill after min_size calculation.
- if (autowrap_enabled) {
- int visible_lines = (max_lines_visible >= 0) ? MIN(max_lines_visible, (int)lines_rid.size()) : (int)lines_rid.size();
- bool lines_hidden = visible_lines > 0 && visible_lines < (int)lines_rid.size();
- if (lines_hidden) {
- overrun_flags.set_flag(TextServer::OVERRUN_ENFORCE_ELLIPSIS);
- }
- if (alignment == HORIZONTAL_ALIGNMENT_FILL) {
- for (int i = 0; i < (int)lines_rid.size(); i++) {
- if (i < visible_lines - 1 || (int)lines_rid.size() == 1) {
- TS->shaped_text_fit_to_width(lines_rid[i], width, jst_flags);
- } else if (i == (visible_lines - 1)) {
- TS->shaped_text_overrun_trim_to_width(lines_rid[visible_lines - 1], width, overrun_flags);
- }
- }
- } else if (lines_hidden) {
- TS->shaped_text_overrun_trim_to_width(lines_rid[visible_lines - 1], width, overrun_flags);
- }
- } else {
- // Autowrap disabled.
- for (int i = 0; i < (int)lines_rid.size(); i++) {
- if (alignment == HORIZONTAL_ALIGNMENT_FILL) {
- TS->shaped_text_fit_to_width(lines_rid[i], width, jst_flags);
- overrun_flags.set_flag(TextServer::OVERRUN_JUSTIFICATION_AWARE);
- TS->shaped_text_overrun_trim_to_width(lines_rid[i], width, overrun_flags);
- TS->shaped_text_fit_to_width(lines_rid[i], width, jst_flags | TextServer::JUSTIFICATION_CONSTRAIN_ELLIPSIS);
- } else {
- TS->shaped_text_overrun_trim_to_width(lines_rid[i], width, overrun_flags);
- }
- }
- }
- lines_dirty = false;
- }
- }
- RID TextParagraph::get_rid() const {
- return rid;
- }
- RID TextParagraph::get_line_rid(int p_line) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- ERR_FAIL_COND_V(p_line < 0 || p_line >= (int)lines_rid.size(), RID());
- return lines_rid[p_line];
- }
- RID TextParagraph::get_dropcap_rid() const {
- return dropcap_rid;
- }
- void TextParagraph::clear() {
- _THREAD_SAFE_METHOD_
- for (int i = 0; i < (int)lines_rid.size(); i++) {
- TS->free_rid(lines_rid[i]);
- }
- lines_rid.clear();
- TS->shaped_text_clear(rid);
- TS->shaped_text_clear(dropcap_rid);
- }
- void TextParagraph::set_preserve_invalid(bool p_enabled) {
- _THREAD_SAFE_METHOD_
- TS->shaped_text_set_preserve_invalid(rid, p_enabled);
- TS->shaped_text_set_preserve_invalid(dropcap_rid, p_enabled);
- lines_dirty = true;
- }
- bool TextParagraph::get_preserve_invalid() const {
- _THREAD_SAFE_METHOD_
- return TS->shaped_text_get_preserve_invalid(rid);
- }
- void TextParagraph::set_preserve_control(bool p_enabled) {
- _THREAD_SAFE_METHOD_
- TS->shaped_text_set_preserve_control(rid, p_enabled);
- TS->shaped_text_set_preserve_control(dropcap_rid, p_enabled);
- lines_dirty = true;
- }
- bool TextParagraph::get_preserve_control() const {
- _THREAD_SAFE_METHOD_
- return TS->shaped_text_get_preserve_control(rid);
- }
- void TextParagraph::set_direction(TextServer::Direction p_direction) {
- _THREAD_SAFE_METHOD_
- TS->shaped_text_set_direction(rid, p_direction);
- TS->shaped_text_set_direction(dropcap_rid, p_direction);
- lines_dirty = true;
- }
- TextServer::Direction TextParagraph::get_direction() const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- return TS->shaped_text_get_direction(rid);
- }
- void TextParagraph::set_custom_punctuation(const String &p_punct) {
- _THREAD_SAFE_METHOD_
- TS->shaped_text_set_custom_punctuation(rid, p_punct);
- lines_dirty = true;
- }
- String TextParagraph::get_custom_punctuation() const {
- _THREAD_SAFE_METHOD_
- return TS->shaped_text_get_custom_punctuation(rid);
- }
- void TextParagraph::set_orientation(TextServer::Orientation p_orientation) {
- _THREAD_SAFE_METHOD_
- TS->shaped_text_set_orientation(rid, p_orientation);
- TS->shaped_text_set_orientation(dropcap_rid, p_orientation);
- lines_dirty = true;
- }
- TextServer::Orientation TextParagraph::get_orientation() const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- return TS->shaped_text_get_orientation(rid);
- }
- bool TextParagraph::set_dropcap(const String &p_text, const Ref<Font> &p_font, int p_font_size, const Rect2 &p_dropcap_margins, const String &p_language) {
- _THREAD_SAFE_METHOD_
- ERR_FAIL_COND_V(p_font.is_null(), false);
- TS->shaped_text_clear(dropcap_rid);
- dropcap_margins = p_dropcap_margins;
- bool res = TS->shaped_text_add_string(dropcap_rid, p_text, p_font->get_rids(), p_font_size, p_font->get_opentype_features(), p_language);
- for (int i = 0; i < TextServer::SPACING_MAX; i++) {
- TS->shaped_text_set_spacing(dropcap_rid, TextServer::SpacingType(i), p_font->get_spacing(TextServer::SpacingType(i)));
- }
- lines_dirty = true;
- return res;
- }
- void TextParagraph::clear_dropcap() {
- _THREAD_SAFE_METHOD_
- dropcap_margins = Rect2();
- TS->shaped_text_clear(dropcap_rid);
- lines_dirty = true;
- }
- bool TextParagraph::add_string(const String &p_text, const Ref<Font> &p_font, int p_font_size, const String &p_language, const Variant &p_meta) {
- _THREAD_SAFE_METHOD_
- ERR_FAIL_COND_V(p_font.is_null(), false);
- bool res = TS->shaped_text_add_string(rid, p_text, p_font->get_rids(), p_font_size, p_font->get_opentype_features(), p_language, p_meta);
- for (int i = 0; i < TextServer::SPACING_MAX; i++) {
- TS->shaped_text_set_spacing(rid, TextServer::SpacingType(i), p_font->get_spacing(TextServer::SpacingType(i)));
- }
- lines_dirty = true;
- return res;
- }
- void TextParagraph::set_bidi_override(const Array &p_override) {
- _THREAD_SAFE_METHOD_
- TS->shaped_text_set_bidi_override(rid, p_override);
- lines_dirty = true;
- }
- bool TextParagraph::add_object(Variant p_key, const Size2 &p_size, InlineAlignment p_inline_align, int p_length) {
- _THREAD_SAFE_METHOD_
- bool res = TS->shaped_text_add_object(rid, p_key, p_size, p_inline_align, p_length);
- lines_dirty = true;
- return res;
- }
- bool TextParagraph::resize_object(Variant p_key, const Size2 &p_size, InlineAlignment p_inline_align) {
- _THREAD_SAFE_METHOD_
- bool res = TS->shaped_text_resize_object(rid, p_key, p_size, p_inline_align);
- lines_dirty = true;
- return res;
- }
- void TextParagraph::set_alignment(HorizontalAlignment p_alignment) {
- _THREAD_SAFE_METHOD_
- if (alignment != p_alignment) {
- if (alignment == HORIZONTAL_ALIGNMENT_FILL || p_alignment == HORIZONTAL_ALIGNMENT_FILL) {
- alignment = p_alignment;
- lines_dirty = true;
- } else {
- alignment = p_alignment;
- }
- }
- }
- HorizontalAlignment TextParagraph::get_alignment() const {
- return alignment;
- }
- void TextParagraph::tab_align(const Vector<float> &p_tab_stops) {
- _THREAD_SAFE_METHOD_
- tab_stops = p_tab_stops;
- lines_dirty = true;
- }
- void TextParagraph::set_justification_flags(BitField<TextServer::JustificationFlag> p_flags) {
- _THREAD_SAFE_METHOD_
- if (jst_flags != p_flags) {
- jst_flags = p_flags;
- lines_dirty = true;
- }
- }
- BitField<TextServer::JustificationFlag> TextParagraph::get_justification_flags() const {
- return jst_flags;
- }
- void TextParagraph::set_break_flags(BitField<TextServer::LineBreakFlag> p_flags) {
- _THREAD_SAFE_METHOD_
- if (brk_flags != p_flags) {
- brk_flags = p_flags;
- lines_dirty = true;
- }
- }
- BitField<TextServer::LineBreakFlag> TextParagraph::get_break_flags() const {
- return brk_flags;
- }
- void TextParagraph::set_text_overrun_behavior(TextServer::OverrunBehavior p_behavior) {
- _THREAD_SAFE_METHOD_
- if (overrun_behavior != p_behavior) {
- overrun_behavior = p_behavior;
- lines_dirty = true;
- }
- }
- TextServer::OverrunBehavior TextParagraph::get_text_overrun_behavior() const {
- return overrun_behavior;
- }
- void TextParagraph::set_width(float p_width) {
- _THREAD_SAFE_METHOD_
- if (width != p_width) {
- width = p_width;
- lines_dirty = true;
- }
- }
- float TextParagraph::get_width() const {
- return width;
- }
- Size2 TextParagraph::get_non_wrapped_size() const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- if (TS->shaped_text_get_orientation(rid) == TextServer::ORIENTATION_HORIZONTAL) {
- return Size2(TS->shaped_text_get_size(rid).x, TS->shaped_text_get_size(rid).y);
- } else {
- return Size2(TS->shaped_text_get_size(rid).x, TS->shaped_text_get_size(rid).y);
- }
- }
- Size2 TextParagraph::get_size() const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- Size2 size;
- int visible_lines = (max_lines_visible >= 0) ? MIN(max_lines_visible, (int)lines_rid.size()) : (int)lines_rid.size();
- for (int i = 0; i < visible_lines; i++) {
- Size2 lsize = TS->shaped_text_get_size(lines_rid[i]);
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- size.x = MAX(size.x, lsize.x);
- size.y += lsize.y;
- } else {
- size.x += lsize.x;
- size.y = MAX(size.y, lsize.y);
- }
- }
- return size;
- }
- int TextParagraph::get_line_count() const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- return (int)lines_rid.size();
- }
- void TextParagraph::set_max_lines_visible(int p_lines) {
- _THREAD_SAFE_METHOD_
- if (p_lines != max_lines_visible) {
- max_lines_visible = p_lines;
- lines_dirty = true;
- }
- }
- int TextParagraph::get_max_lines_visible() const {
- return max_lines_visible;
- }
- Array TextParagraph::get_line_objects(int p_line) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- ERR_FAIL_COND_V(p_line < 0 || p_line >= (int)lines_rid.size(), Array());
- return TS->shaped_text_get_objects(lines_rid[p_line]);
- }
- Rect2 TextParagraph::get_line_object_rect(int p_line, Variant p_key) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- ERR_FAIL_COND_V(p_line < 0 || p_line >= (int)lines_rid.size(), Rect2());
- Rect2 xrect = TS->shaped_text_get_object_rect(lines_rid[p_line], p_key);
- for (int i = 0; i < p_line; i++) {
- Size2 lsize = TS->shaped_text_get_size(lines_rid[i]);
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- xrect.position.y += lsize.y;
- } else {
- xrect.position.x += lsize.x;
- }
- }
- return xrect;
- }
- Size2 TextParagraph::get_line_size(int p_line) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- ERR_FAIL_COND_V(p_line < 0 || p_line >= (int)lines_rid.size(), Size2());
- if (TS->shaped_text_get_orientation(lines_rid[p_line]) == TextServer::ORIENTATION_HORIZONTAL) {
- return Size2(TS->shaped_text_get_size(lines_rid[p_line]).x, TS->shaped_text_get_size(lines_rid[p_line]).y);
- } else {
- return Size2(TS->shaped_text_get_size(lines_rid[p_line]).x, TS->shaped_text_get_size(lines_rid[p_line]).y);
- }
- }
- Vector2i TextParagraph::get_line_range(int p_line) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- ERR_FAIL_COND_V(p_line < 0 || p_line >= (int)lines_rid.size(), Vector2i());
- return TS->shaped_text_get_range(lines_rid[p_line]);
- }
- float TextParagraph::get_line_ascent(int p_line) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- ERR_FAIL_COND_V(p_line < 0 || p_line >= (int)lines_rid.size(), 0.f);
- return TS->shaped_text_get_ascent(lines_rid[p_line]);
- }
- float TextParagraph::get_line_descent(int p_line) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- ERR_FAIL_COND_V(p_line < 0 || p_line >= (int)lines_rid.size(), 0.f);
- return TS->shaped_text_get_descent(lines_rid[p_line]);
- }
- float TextParagraph::get_line_width(int p_line) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- ERR_FAIL_COND_V(p_line < 0 || p_line >= (int)lines_rid.size(), 0.f);
- return TS->shaped_text_get_width(lines_rid[p_line]);
- }
- float TextParagraph::get_line_underline_position(int p_line) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- ERR_FAIL_COND_V(p_line < 0 || p_line >= (int)lines_rid.size(), 0.f);
- return TS->shaped_text_get_underline_position(lines_rid[p_line]);
- }
- float TextParagraph::get_line_underline_thickness(int p_line) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- ERR_FAIL_COND_V(p_line < 0 || p_line >= (int)lines_rid.size(), 0.f);
- return TS->shaped_text_get_underline_thickness(lines_rid[p_line]);
- }
- Size2 TextParagraph::get_dropcap_size() const {
- _THREAD_SAFE_METHOD_
- return TS->shaped_text_get_size(dropcap_rid) + dropcap_margins.size + dropcap_margins.position;
- }
- int TextParagraph::get_dropcap_lines() const {
- return dropcap_lines;
- }
- void TextParagraph::draw(RID p_canvas, const Vector2 &p_pos, const Color &p_color, const Color &p_dc_color) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- Vector2 ofs = p_pos;
- float h_offset = 0.f;
- if (TS->shaped_text_get_orientation(dropcap_rid) == TextServer::ORIENTATION_HORIZONTAL) {
- h_offset = TS->shaped_text_get_size(dropcap_rid).x + dropcap_margins.size.x + dropcap_margins.position.x;
- } else {
- h_offset = TS->shaped_text_get_size(dropcap_rid).y + dropcap_margins.size.y + dropcap_margins.position.y;
- }
- if (h_offset > 0) {
- // Draw dropcap.
- Vector2 dc_off = ofs;
- if (TS->shaped_text_get_inferred_direction(dropcap_rid) == TextServer::DIRECTION_RTL) {
- if (TS->shaped_text_get_orientation(dropcap_rid) == TextServer::ORIENTATION_HORIZONTAL) {
- dc_off.x += width - h_offset;
- } else {
- dc_off.y += width - h_offset;
- }
- }
- TS->shaped_text_draw(dropcap_rid, p_canvas, dc_off + Vector2(0, TS->shaped_text_get_ascent(dropcap_rid) + dropcap_margins.size.y + dropcap_margins.position.y / 2), -1, -1, p_dc_color);
- }
- int lines_visible = (max_lines_visible >= 0) ? MIN(max_lines_visible, (int)lines_rid.size()) : (int)lines_rid.size();
- for (int i = 0; i < lines_visible; i++) {
- float l_width = width;
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.x = p_pos.x;
- ofs.y += TS->shaped_text_get_ascent(lines_rid[i]);
- if (i <= dropcap_lines) {
- if (TS->shaped_text_get_inferred_direction(dropcap_rid) == TextServer::DIRECTION_LTR) {
- ofs.x -= h_offset;
- }
- l_width -= h_offset;
- }
- } else {
- ofs.y = p_pos.y;
- ofs.x += TS->shaped_text_get_ascent(lines_rid[i]);
- if (i <= dropcap_lines) {
- if (TS->shaped_text_get_inferred_direction(dropcap_rid) == TextServer::DIRECTION_LTR) {
- ofs.x -= h_offset;
- }
- l_width -= h_offset;
- }
- }
- float line_width = TS->shaped_text_get_width(lines_rid[i]);
- if (width > 0) {
- switch (alignment) {
- case HORIZONTAL_ALIGNMENT_FILL:
- if (TS->shaped_text_get_inferred_direction(lines_rid[i]) == TextServer::DIRECTION_RTL) {
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.x += l_width - line_width;
- } else {
- ofs.y += l_width - line_width;
- }
- }
- break;
- case HORIZONTAL_ALIGNMENT_LEFT:
- break;
- case HORIZONTAL_ALIGNMENT_CENTER: {
- if (line_width <= l_width) {
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.x += Math::floor((l_width - line_width) / 2.0);
- } else {
- ofs.y += Math::floor((l_width - line_width) / 2.0);
- }
- } else if (TS->shaped_text_get_inferred_direction(lines_rid[i]) == TextServer::DIRECTION_RTL) {
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.x += l_width - line_width;
- } else {
- ofs.y += l_width - line_width;
- }
- }
- } break;
- case HORIZONTAL_ALIGNMENT_RIGHT: {
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.x += l_width - line_width;
- } else {
- ofs.y += l_width - line_width;
- }
- } break;
- }
- }
- float clip_l;
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- clip_l = MAX(0, p_pos.x - ofs.x);
- } else {
- clip_l = MAX(0, p_pos.y - ofs.y);
- }
- TS->shaped_text_draw(lines_rid[i], p_canvas, ofs, clip_l, clip_l + l_width, p_color);
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.x = p_pos.x;
- ofs.y += TS->shaped_text_get_descent(lines_rid[i]);
- } else {
- ofs.y = p_pos.y;
- ofs.x += TS->shaped_text_get_descent(lines_rid[i]);
- }
- }
- }
- void TextParagraph::draw_outline(RID p_canvas, const Vector2 &p_pos, int p_outline_size, const Color &p_color, const Color &p_dc_color) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- Vector2 ofs = p_pos;
- float h_offset = 0.f;
- if (TS->shaped_text_get_orientation(dropcap_rid) == TextServer::ORIENTATION_HORIZONTAL) {
- h_offset = TS->shaped_text_get_size(dropcap_rid).x + dropcap_margins.size.x + dropcap_margins.position.x;
- } else {
- h_offset = TS->shaped_text_get_size(dropcap_rid).y + dropcap_margins.size.y + dropcap_margins.position.y;
- }
- if (h_offset > 0) {
- // Draw dropcap.
- Vector2 dc_off = ofs;
- if (TS->shaped_text_get_inferred_direction(dropcap_rid) == TextServer::DIRECTION_RTL) {
- if (TS->shaped_text_get_orientation(dropcap_rid) == TextServer::ORIENTATION_HORIZONTAL) {
- dc_off.x += width - h_offset;
- } else {
- dc_off.y += width - h_offset;
- }
- }
- TS->shaped_text_draw_outline(dropcap_rid, p_canvas, dc_off + Vector2(dropcap_margins.position.x, TS->shaped_text_get_ascent(dropcap_rid) + dropcap_margins.position.y), -1, -1, p_outline_size, p_dc_color);
- }
- for (int i = 0; i < (int)lines_rid.size(); i++) {
- float l_width = width;
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.x = p_pos.x;
- ofs.y += TS->shaped_text_get_ascent(lines_rid[i]);
- if (i <= dropcap_lines) {
- if (TS->shaped_text_get_inferred_direction(dropcap_rid) == TextServer::DIRECTION_LTR) {
- ofs.x -= h_offset;
- }
- l_width -= h_offset;
- }
- } else {
- ofs.y = p_pos.y;
- ofs.x += TS->shaped_text_get_ascent(lines_rid[i]);
- if (i <= dropcap_lines) {
- if (TS->shaped_text_get_inferred_direction(dropcap_rid) == TextServer::DIRECTION_LTR) {
- ofs.x -= h_offset;
- }
- l_width -= h_offset;
- }
- }
- float length = TS->shaped_text_get_width(lines_rid[i]);
- if (width > 0) {
- switch (alignment) {
- case HORIZONTAL_ALIGNMENT_FILL:
- if (TS->shaped_text_get_inferred_direction(lines_rid[i]) == TextServer::DIRECTION_RTL) {
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.x += l_width - length;
- } else {
- ofs.y += l_width - length;
- }
- }
- break;
- case HORIZONTAL_ALIGNMENT_LEFT:
- break;
- case HORIZONTAL_ALIGNMENT_CENTER: {
- if (length <= l_width) {
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.x += Math::floor((l_width - length) / 2.0);
- } else {
- ofs.y += Math::floor((l_width - length) / 2.0);
- }
- } else if (TS->shaped_text_get_inferred_direction(lines_rid[i]) == TextServer::DIRECTION_RTL) {
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.x += l_width - length;
- } else {
- ofs.y += l_width - length;
- }
- }
- } break;
- case HORIZONTAL_ALIGNMENT_RIGHT: {
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.x += l_width - length;
- } else {
- ofs.y += l_width - length;
- }
- } break;
- }
- }
- float clip_l;
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- clip_l = MAX(0, p_pos.x - ofs.x);
- } else {
- clip_l = MAX(0, p_pos.y - ofs.y);
- }
- TS->shaped_text_draw_outline(lines_rid[i], p_canvas, ofs, clip_l, clip_l + l_width, p_outline_size, p_color);
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.x = p_pos.x;
- ofs.y += TS->shaped_text_get_descent(lines_rid[i]);
- } else {
- ofs.y = p_pos.y;
- ofs.x += TS->shaped_text_get_descent(lines_rid[i]);
- }
- }
- }
- int TextParagraph::hit_test(const Point2 &p_coords) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- Vector2 ofs;
- if (TS->shaped_text_get_orientation(rid) == TextServer::ORIENTATION_HORIZONTAL) {
- if (ofs.y < 0) {
- return 0;
- }
- } else {
- if (ofs.x < 0) {
- return 0;
- }
- }
- for (int i = 0; i < (int)lines_rid.size(); i++) {
- if (TS->shaped_text_get_orientation(lines_rid[i]) == TextServer::ORIENTATION_HORIZONTAL) {
- if ((p_coords.y >= ofs.y) && (p_coords.y <= ofs.y + TS->shaped_text_get_size(lines_rid[i]).y)) {
- return TS->shaped_text_hit_test_position(lines_rid[i], p_coords.x);
- }
- ofs.y += TS->shaped_text_get_size(lines_rid[i]).y;
- } else {
- if ((p_coords.x >= ofs.x) && (p_coords.x <= ofs.x + TS->shaped_text_get_size(lines_rid[i]).x)) {
- return TS->shaped_text_hit_test_position(lines_rid[i], p_coords.y);
- }
- ofs.y += TS->shaped_text_get_size(lines_rid[i]).x;
- }
- }
- return TS->shaped_text_get_range(rid).y;
- }
- void TextParagraph::draw_dropcap(RID p_canvas, const Vector2 &p_pos, const Color &p_color) const {
- _THREAD_SAFE_METHOD_
- Vector2 ofs = p_pos;
- float h_offset = 0.f;
- if (TS->shaped_text_get_orientation(dropcap_rid) == TextServer::ORIENTATION_HORIZONTAL) {
- h_offset = TS->shaped_text_get_size(dropcap_rid).x + dropcap_margins.size.x + dropcap_margins.position.x;
- } else {
- h_offset = TS->shaped_text_get_size(dropcap_rid).y + dropcap_margins.size.y + dropcap_margins.position.y;
- }
- if (h_offset > 0) {
- // Draw dropcap.
- if (TS->shaped_text_get_inferred_direction(dropcap_rid) == TextServer::DIRECTION_RTL) {
- if (TS->shaped_text_get_orientation(dropcap_rid) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.x += width - h_offset;
- } else {
- ofs.y += width - h_offset;
- }
- }
- TS->shaped_text_draw(dropcap_rid, p_canvas, ofs + Vector2(dropcap_margins.position.x, TS->shaped_text_get_ascent(dropcap_rid) + dropcap_margins.position.y), -1, -1, p_color);
- }
- }
- void TextParagraph::draw_dropcap_outline(RID p_canvas, const Vector2 &p_pos, int p_outline_size, const Color &p_color) const {
- _THREAD_SAFE_METHOD_
- Vector2 ofs = p_pos;
- float h_offset = 0.f;
- if (TS->shaped_text_get_orientation(dropcap_rid) == TextServer::ORIENTATION_HORIZONTAL) {
- h_offset = TS->shaped_text_get_size(dropcap_rid).x + dropcap_margins.size.x + dropcap_margins.position.x;
- } else {
- h_offset = TS->shaped_text_get_size(dropcap_rid).y + dropcap_margins.size.y + dropcap_margins.position.y;
- }
- if (h_offset > 0) {
- // Draw dropcap.
- if (TS->shaped_text_get_inferred_direction(dropcap_rid) == TextServer::DIRECTION_RTL) {
- if (TS->shaped_text_get_orientation(dropcap_rid) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.x += width - h_offset;
- } else {
- ofs.y += width - h_offset;
- }
- }
- TS->shaped_text_draw_outline(dropcap_rid, p_canvas, ofs + Vector2(dropcap_margins.position.x, TS->shaped_text_get_ascent(dropcap_rid) + dropcap_margins.position.y), -1, -1, p_outline_size, p_color);
- }
- }
- void TextParagraph::draw_line(RID p_canvas, const Vector2 &p_pos, int p_line, const Color &p_color) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- ERR_FAIL_COND(p_line < 0 || p_line >= (int)lines_rid.size());
- Vector2 ofs = p_pos;
- if (TS->shaped_text_get_orientation(lines_rid[p_line]) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.y += TS->shaped_text_get_ascent(lines_rid[p_line]);
- } else {
- ofs.x += TS->shaped_text_get_ascent(lines_rid[p_line]);
- }
- return TS->shaped_text_draw(lines_rid[p_line], p_canvas, ofs, -1, -1, p_color);
- }
- void TextParagraph::draw_line_outline(RID p_canvas, const Vector2 &p_pos, int p_line, int p_outline_size, const Color &p_color) const {
- _THREAD_SAFE_METHOD_
- const_cast<TextParagraph *>(this)->_shape_lines();
- ERR_FAIL_COND(p_line < 0 || p_line >= (int)lines_rid.size());
- Vector2 ofs = p_pos;
- if (TS->shaped_text_get_orientation(lines_rid[p_line]) == TextServer::ORIENTATION_HORIZONTAL) {
- ofs.y += TS->shaped_text_get_ascent(lines_rid[p_line]);
- } else {
- ofs.x += TS->shaped_text_get_ascent(lines_rid[p_line]);
- }
- return TS->shaped_text_draw_outline(lines_rid[p_line], p_canvas, ofs, -1, -1, p_outline_size, p_color);
- }
- TextParagraph::TextParagraph(const String &p_text, const Ref<Font> &p_font, int p_font_size, const String &p_language, float p_width, TextServer::Direction p_direction, TextServer::Orientation p_orientation) {
- rid = TS->create_shaped_text(p_direction, p_orientation);
- if (p_font.is_valid()) {
- TS->shaped_text_add_string(rid, p_text, p_font->get_rids(), p_font_size, p_font->get_opentype_features(), p_language);
- for (int i = 0; i < TextServer::SPACING_MAX; i++) {
- TS->shaped_text_set_spacing(rid, TextServer::SpacingType(i), p_font->get_spacing(TextServer::SpacingType(i)));
- }
- }
- width = p_width;
- }
- TextParagraph::TextParagraph() {
- rid = TS->create_shaped_text();
- dropcap_rid = TS->create_shaped_text();
- }
- TextParagraph::~TextParagraph() {
- for (int i = 0; i < (int)lines_rid.size(); i++) {
- TS->free_rid(lines_rid[i]);
- }
- lines_rid.clear();
- TS->free_rid(rid);
- TS->free_rid(dropcap_rid);
- }
|