l j'dZddlmZddlZgdZddlZddlZddlZddlm Z m Z m Z ddl m Z ddlmZddlmZdd lmZmZddlZddlZdd lmZmZmZdd lmZmZdd lTdd lm Z ddl!m"Z"ddl#m$Z$m%Z%ddl&m'Z'ddl(m)Z)m*Z*m+Z+er ddlm,Z,ddl&m'Z'dZ-dZ.dZ/gdZd$dZ0Gdde$Z1Gdde"Z2Gdde"Z3e d%d#Z4dS)&uMobjects used for displaying (non-LaTeX) text. .. note:: Just as you can use :class:`~.Tex` and :class:`~.MathTex` (from the module :mod:`~.tex_mobject`) to insert LaTeX to your videos, you can use :class:`~.Text` to to add normal text. .. important:: See the corresponding tutorial :ref:`using-text-objects`, especially for information about fonts. The simplest way to add text to your animations is to use the :class:`~.Text` class. It uses the Pango library to render text. With Pango, you are also able to render non-English alphabets like `你好` or `こんにちは` or `안녕하세요` or `مرحبا بالعالم`. Examples -------- .. manim:: HelloWorld :save_last_frame: class HelloWorld(Scene): def construct(self): text = Text('Hello world').scale(3) self.add(text) .. manim:: TextAlignment :save_last_frame: class TextAlignment(Scene): def construct(self): title = Text("K-means clustering and Logistic Regression", color=WHITE) title.scale(0.75) self.add(title.to_edge(UP)) t1 = Text("1. Measuring").set_color(WHITE) t2 = Text("2. Clustering").set_color(WHITE) t3 = Text("3. Regression").set_color(WHITE) t4 = Text("4. Prediction").set_color(WHITE) x = VGroup(t1, t2, t3, t4).arrange(direction=DOWN, aligned_edge=LEFT).scale(0.7).next_to(ORIGIN,DR) x.set_opacity(0.5) x.submobjects[1].set_opacity(1) self.add(x) ) annotationsN)Text Paragraph MarkupText register_font)IterableIteratorSequence)contextmanager)chain)Path) TYPE_CHECKINGAny) MarkupUtils PangoUtils TextSetting)configlogger)*)Dot) SVGMobject)VGroupVMobject)Point3D) ManimColorParsableManimColorcolor_gradient)Selfg?g333333?g333333@mobjectrreturnct}t|dtr2|D].}|td|D/n|jd|D|S)a8Function to remove unwanted invisible characters from some mobjects. Parameters ---------- mobject Any SVGMobject from which we want to remove unwanted invisible characters. Returns ------- :class:`~.SVGMobject` The SVGMobject without unwanted invisible characters. rc3DK|]}t|t|VdSN isinstancer.0ks Z/home/agentuser/manim-venv/lib/python3.11/site-packages/manim/mobject/text/text_mobject.py z)remove_invisible_chars..ks1CCQ 1c0B0BCqCCCCCCc3DK|]}t|t|VdSr#r$r&s r)r*z)remove_invisible_chars..ns1"P"PZ3=O=O"P1"P"P"P"P"P"Pr+)rr%add)rmobject_without_dotssubmobs r)remove_invisible_charsr0Zs"88'!*f%%R  F $ $CC&CCCCC      ! "P"Pg"P"P"PQQ r+c\eZdZdZddddfd ZddZddZddZddZd dZ d!dZ xZ S)"raDisplay a paragraph of text. For a given :class:`.Paragraph` ``par``, the attribute ``par.chars`` is a :class:`.VGroup` containing all the lines. In this context, every line is constructed as a :class:`.VGroup` of characters contained in the line. Parameters ---------- line_spacing Represents the spacing between lines. Defaults to -1, which means auto. alignment Defines the alignment of paragraph. Defaults to None. Possible values are "left", "right" or "center". Examples -------- Normal usage:: paragraph = Paragraph( "this is a awesome", "paragraph", "With \nNewlines", "\tWith Tabs", " With Spaces", "With Alignments", "center", "left", "right", ) Remove unwanted invisible characters:: self.play(Transform(remove_invisible_chars(paragraph.chars[0:2]), remove_invisible_chars(paragraph.chars[3][0:3])) N) line_spacing alignmenttextstrr3floatr4 str | Nonekwargsrc||_||_|dd|_t dt|}t|fd|i||_ | d}| ||_ t|j |jgt|j zg|_d|jdD|_|j|jd|t%jgd|jr||jdSdS)Ndisable_ligaturesF r3c6g|]}|S) get_center)r'lines r) z&Paragraph.__init__..s"'T'T'Td(9(9'T'T'Tr+r)rrr)r3r4getconsider_spaces_as_charssuper__init__joinlistr lines_textsplit _gen_charscharslenlineslines_initial_positionsr-move_tonparray_set_all_lines_alignments)selfr3r4r5r9 lines_strlines_str_list __class__s r)rEzParagraph.__init__sB)"(. 3F(N(N% IId4jj)) yNN|NvNN"..__^44 4:&&(83tz??(JK 'T'TdjQRm'T'T'T$$*Q-   RXiii(())) > ;  * *4> : : : : : ; ;r+rUrGr rcd}|}tt|D]}||}|jrt|}n d}|D]}|s|dz }||||j|jj|||z||z }|jr|dz }|S)a$Function to convert a list of plain strings to a VGroup of VGroups of chars. Parameters ---------- lines_str_list List of plain text strings. Returns ------- :class:`~.VGroup` The generated 2d-VGroup of chars. r)get_group_classrangerLrCisspacer-rHrK)rSrUchar_index_counterrKline_noline_str char_countchars r)rJzParagraph._gen_charss&$$&&((S0011 ( (G%g.H, ( ]]  $((D<<>>("a II,d**,,.. / / / E'N &&);j)HH   * , , (#a'" r+ctt|jdD]}||||S)zFunction to set all line's alignment to a specific value. Parameters ---------- alignment Defines the alignment of paragraph. Possible values are "left", "right", "center". r)rZrLrM_change_alignment_for_a_linerSr4r]s r)rRz#Paragraph._set_all_lines_alignmentssISA//00 B BG  - -i A A A A r+r]intc2||||S)a8Function to set one line's alignment to a specific value. Parameters ---------- alignment Defines the alignment of paragraph. Possible values are "left", "right", "center". line_no Defines the line number for which we want to set given alignment. )rbrcs r)_set_line_alignmentzParagraph._set_line_alignments )))W=== r+cdgt|jdz|jd<tt|jdD]=}||||j|z>|S)z)Set all lines to their initial positions.NrrX)rLrMrZrOr?rNrSr]s r)#_set_all_lines_to_initial_positionsz-Paragraph._set_all_lines_to_initial_positionssTZ]!3!33 1 SA//00  G M ! !!!D$@$II     r+cd|jd|<||||j|z|S)zFunction to set one line to initial positions. Parameters ---------- line_no Defines the line number for which we want to set given alignment. NrX)rMrOr?rNrhs r)_set_line_to_initial_positionz'Paragraph._set_line_to_initial_positionsH"& 1 g W doo//$2Nw2WWXXX r+Nonecd||jd|<|jd|dkrh||tj|d||ddgdS|jd|dkry||tj|d||jdz z ||ddgdS|jd|dkry||tj|d||jdz z||ddgdSdS)a;Function to change one line's alignment to a specific value. Parameters ---------- alignment Defines the alignment of paragraph. Possible values are "left", "right", "center". line_no Defines the line number for which we want to set given alignment. rXcenterrrightleftN)rMrOrPrQr? get_rightwidthget_leftrcs r)rbz&Paragraph._change_alignment_for_a_lines"+ 1 g :a= !X - - M ! !$//++A.W 0H0H0J0J10MqQRR     Z]7 #w . . M ! !((+d7m.AA.EEW 002215     Z]7 #v - - M ! ! *T']-@1-DDW 002215     . -r+)r5r6r3r7r4r8r9r)rUrGr r)r4r6r r)r4r6r]rdr r)r r)r]rdr r)r4r6r]rdr rl) __name__ __module__ __qualname____doc__rErJrRrfrirkrb __classcell__rVs@r)rrrs##P! $ ;;;;;;;;0&&&&P            """"""""r+rceZdZdZeejdLdZdddedd e e ddddddd d ddd d d fdMfd. Z dNd/Z e dOd0Z e jdPd3Z dQd5ZdRd8ZdSd:ZdTd@ZdUdDZdVdFZdWdGZdSdHZdXdYfdK ZxZS)ZruDisplay (non-LaTeX) text rendered using `Pango `_. Text objects behave like a :class:`.VGroup`-like iterable of all characters in the given text. In particular, slicing is possible. Parameters ---------- text The text that needs to be created as a mobject. font The font family to be used to render the text. This is either a system font or one loaded with `register_font()`. Note that font family names may be different across operating systems. warn_missing_font If True (default), Manim will issue a warning if the font does not exist in the (case-sensitive) list of fonts returned from `manimpango.list_fonts()`. Returns ------- :class:`Text` The mobject-like :class:`.VGroup`. Examples --------- .. manim:: Example1Text :save_last_frame: class Example1Text(Scene): def construct(self): text = Text('Hello world').scale(3) self.add(text) .. manim:: TextColorExample :save_last_frame: class TextColorExample(Scene): def construct(self): text1 = Text('Hello world', color=BLUE).scale(3) text2 = Text('Hello world', gradient=(BLUE, GREEN)).scale(3).next_to(text1, DOWN) self.add(text1, text2) .. manim:: TextItalicAndBoldExample :save_last_frame: class TextItalicAndBoldExample(Scene): def construct(self): text1 = Text("Hello world", slant=ITALIC) text2 = Text("Hello world", t2s={'world':ITALIC}) text3 = Text("Hello world", weight=BOLD) text4 = Text("Hello world", t2w={'world':BOLD}) text5 = Text("Hello world", t2c={'o':YELLOW}, disable_ligatures=True) text6 = Text( "Visit us at docs.manim.community", t2c={"docs.manim.community": YELLOW}, disable_ligatures=True, ) text6.scale(1.3).shift(DOWN) self.add(text1, text2, text3, text4, text5 , text6) Group(*self.mobjects).arrange(DOWN, buff=.8).set(height=config.frame_height-LARGE_BUFF) .. manim:: TextMoreCustomization :save_last_frame: class TextMoreCustomization(Scene): def construct(self): text1 = Text( 'Google', t2c={'[:1]': '#3174f0', '[1:2]': '#e53125', '[2:3]': '#fbb003', '[3:4]': '#3174f0', '[4:5]': '#269a43', '[5:]': '#e53125'}, font_size=58).scale(3) self.add(text1) As :class:`Text` uses Pango to render text, rendering non-English characters is easily possible: .. manim:: MultipleFonts :save_last_frame: class MultipleFonts(Scene): def construct(self): morning = Text("வணக்கம்", font="sans-serif") japanese = Text( "日本へようこそ", t2c={"日本": BLUE} ) # works same as ``Text``. mess = Text("Multi-Language", weight=BOLD) russ = Text("Здравствуйте मस नम म ", font="sans-serif") hin = Text("नमस्ते", font="sans-serif") arb = Text( "صباح الخير \n تشرفت بمقابلتك", font="sans-serif" ) # don't mix RTL and LTR languages nothing shows up then ;-) chinese = Text("臂猿「黛比」帶著孩子", font="sans-serif") self.add(morning, japanese, mess, russ, hin, arb, chinese) for i,mobj in enumerate(self.mobjects): mobj.shift(DOWN*(i-3)) .. manim:: PangoRender :quality: low class PangoRender(Scene): def construct(self): morning = Text("வணக்கம்", font="sans-serif") self.play(Write(morning)) self.wait(2) Tests ----- Check that the creation of :class:`~.Text` works:: >>> Text('The horse does not eat cucumber salad.') Text('The horse does not eat cucumber salad.') r list[str]c,tj}|Sr# manimpango list_fontsvalues r) font_listzText.font_list&022 r+g?rNr2TFr5r6 fill_opacityr7 stroke_widthcolorParsableManimColor | None font_sizer3fontslantweightt2cdict[str, str] | Nonet2ft2g.dict[str, Iterable[ParsableManimColor]] | Nonet2st2wgradient#Iterable[ParsableManimColor] | None tab_widthrdwarn_missing_fontboolheight float | Noners should_centerr; use_svg_cacher9rc j #||_|r|rt}|dkrd}||vr||vr|}nq||vr|}nF||vr|}nt jd|d|d||_t||_ ||_ | |_ ||_ ||_| i} | i} | i} | i} |i}|d| } |d| } |d| } |d | } |d |}| J| J| J| J|Jd | D|_| |_| |_| |_||_||_||_|}|d d kr|d d|jz}||_|jd kr|j |j t6zz|_n|j |j |jzz|_|rt9|nt;j}|| }tCj"|tGj$|f||||||d|||_|jrg|%|_&|'|j&|_(|dddd|_|j)}|D]}tU|j+dkr|j+}|d}tU||j,ks J|g#|dkrd#fd } nd#fd } t[|D]n\}!}"#.|"|!tU|dz kr>|!dz|zdkr2t_|"||!dzkr| |||!dz}o| |taj1#d|_+|||2tf|j4|_5dS)N sans-serifsansFont  not in . text2color text2font text2gradient text2slant text2weightcXi|]'\}}|t|(Sr>)rto_hex)r'r(vs r) z!Text.__init__..s0#V#V#V$!QAz!}}';';'='=#V#V#Vr+ r2 )rrrrsrrrr<rendrr rlc4d}|||zdz |gz dSNr2rpr>rstartclosed_curve_pointss r) add_line_toz"Text.__init__..add_line_to'5/3E'),'''r+cNd}|||z|zdz ||z|zdz |gz dSNr2rr>rs r)rz"Text.__init__..add_line_to2K/3E',1s*a/ ,'''r+rXrpndminrrr rl)6r3rrlower capitalizetitlerwarningrr7 _font_sizerrrrpopitemsrrrrr original_textr;findreplacer5DEFAULT_LINE_SPACING_SCALErrr _text2svgrr remove_last_MrDrErJ submobjectsrYrKn_points_per_curverLpointsdim enumerateappendanyrPrQscaleTEXT_MOB_SCALE_FACTORrinitial_height)%rSr5rrrrr3rrrrrrrrrrrrrsrr;rr9 fonts_listtext_without_tabs parsed_color file_namenppceachr curve_startrindexpointrrVs% @r)rEz Text.__init__sC6)  H% H))Jzz|||++:%%??$$ 22??,,DDZZ\\Z//::< %--c266>>tRHH &7 A7 AD4;1$$[F )K{##tx//////24 qyy!*& 1 1 4 4 u#**5111S[[1_,,d*a//EVEAI%66770 K ,,,"("3K K $ $ $(#6a@@@DKK >em JJ, - - -"kr+c2dt|jdS)NzText()reprrrSs r)__repr__z Text.__repr__Qs2tD.//2222r+cV|j|jz tz dz|jztz SNg333333@rrrrDEFAULT_FONT_SIZErs r)rzText.font_sizeTA K! "# $ o      r+font_valrlcj|dkrtd|||jz dSNrz!font_size must be greater than 0. ValueErrorrrrSrs r)rzText.font_size_; q==@AA A JJx$.0 1 1 1 1 1r+rc>|}d}tt|jD]}|j|rt ddd}|dkr3||j|n5||j|dz | || |j||dz }|S)Nr)radiusrstroke_opacityrX) rYrZrLr5r[rrOrr?r-)rSrKsubmobjects_char_index char_indexspaces r)rJzText._gen_charsgs&$$&&((!"DI// , ,Jy$,,.. ,11QGGG??MM$"23I"J"U"U"W"WXXXXMM()?!)CDOOQQ %     $*+ABCCC&!+&& r+wordlist[tuple[int, int]]ctjd|}|r|ddkr"t|dnd}|ddkr"t|dnt |}|dkrt ||zn|}|dkrt ||zn|}||fgSg}||}|dkrS|||t |zf|||t |z}|dkS|S)z*Finds the indexes of ``text`` in ``word``.z\[([0-9\-]{0,}):([0-9\-]{0,})\]rXrrrpr2)rematchgrouprdrLrr)rSrr5temprrindexesrs r) _find_indexeszText._find_indexesys<x:DAA  *.**Q--2*=*=C 1 &&&1E(, 1 (;(;#djjmm$$$TC).CII%%E%(1WW#d))c//#C   $rkk NNE53t99#45 6 6 6IIdECII$566Erkkr+rcvd|jz|jz|jzt|z}|t|jt|jzt|jzt|jzz }|t|jt|j zz }|t|j z }|t|j z }|j |z}tj}|||ddS)(Generates ``sha256`` hash for file name.PANGON)rrrr6rrrrr3rr;rr5hashlibsha256updateencode hexdigestrSrsettingsid_strhashers r) _text2hashzText._text2hashs di $* ,t{ :SZZ G  CMMCMM1CMMACMMQQC)**S-A-AAAC.///C &&&X%!! fmmoo&&&!!#2#&&r+ left_settingr right_setting default_argsdict[str, Iterable[str]]c |j|jk}|rtj|ntj|}|r|jn|j|_|j|_|s |j|_|D]}t||}t||}||} || krKt||| kr7t d|j|j|jdd|d|d|dzt |||| kr|n||S)NzAmbiguous style for text 'z':'z' cannot be both 'z' and 'z'.)rcopyrgetattrrr5setattr) rSrrr contained new_settingargrqrodefaults r)_merge_settingszText._merge_settingssC "% (88 1:Xdi --- -@X@X 1:PM-- @P (.  2 + 1M  L LC<--DM3//E"3'Gw7=##>#>'#I#I g=;NQ^Qb;b1cgggG#GGGGeGGGH M3U K K K Kr+t2xs$Sequence[tuple[dict[str, str], str]]list[TextSetting]c g}ttd|D}|D]Sfd|D}||jD]&\}}|t ||fi|'T|S)Nc3HK|]\}}g|VdSr#)keys)r't2x_s r)r*z/Text._get_settings_from_t2xs..s2@@a}}@@@@@@r+cZi|]'\}}||vrt|n|(Sr>)r6)r'r"rrrs r)rz0Text._get_settings_from_t2xs..sLCts{{ST^^^ S8Ir+)setr rr5rr) rSrrr t2xwords setting_argsrrrs ` @r)_get_settings_from_t2xszText._get_settings_from_t2xss u@@4@@@ABB I ID!% L#00tyAA I I s E3 G G, G GHHHH Ir+dict[str, Any]c g}tj|}|jrt|jt|j}t t|jD]C}|||d<|t||dzfi|D|j D]\}}t|t|}| ||jD]\\}} t || D]F}|||z |d<|t||dzfi|G]|S)NrrX) rrrrLr5rZrrrrrr) rSrr argscolorsirrrrs r)_get_settings_from_gradientz Text._get_settings_from_gradientsry&& = ?'5dmS^^'T'TF3ty>>** ? ? &q 0 0 2 2W  Aq1u = = = =>>>>"hnn.. C CND(#Hc$ii88F"00tyAA C C suc**CCA$*1u9$5$<$<$>$>DMOOK1q5$A$AD$A$ABBBBC Cr+cjdfjdfjdfjdfg}fd|D}||}|||dt|D]\}}|dzt|krn||dz}|j |j kr |||}|dz} | t|krD|| j |j kr.| dz } | t|kr|| j |j k.| | ||} d } |D]:}|j | kr&| t!| |j fi||j } ;| tjkr3| t!| tjfi|t%| d }d } t'jd jrd jD]\} }|D]{}|jd kr| |_| |j kr\| dz } tj|}||_ ||_ | |_|||dn||D]}|jd kr| |_|S)z7Converts the texts and styles to a setting for parsing.rrrrcHi|]\}}||dkrt|nS)r)r)r'r#rrrSs r)rz'Text._text2settings..sC( ( ( EKQCsg~~s###5( ( ( r+c|jSr#rsettings r)z%Text._text2settings..s'-r+)keyrXrc|jSr#r2r3s r)r5z%Text._text2settings..sW]r+z\nr<r2c|jSr#r2r3s r)r5z%Text._text2settings..s'-r+)rrrrr(extendr.sortrrLrrrinsertrrrr5sortedrsearchrline_num)rSrrrr rr4 next_settingr new_index temp_settingsrr> for_startfor_ends`` r)_text2settingszText._text2settingssRXv  Xw  Xx Xw  2 ( ( ( ( ( OS( ( ( //lCC88FFGGG  77 888'11 8 8NE7qyCMM))#EAI.L{\///"227L,WW !AI H -- +1K4EEENIH -- +1K4EEE ;777!    G}%%$$[ %V%V%V%VWWWKEE C NN " "  UC NN!S!Sl!S!S T T T--J-JKKK 9UDI & & &*&8&8ty&I&I  " 7'  G'2--+3( 7;.. A &*i&8&8 &- ,3 )/7 ,  444 *G*G HHH/  , ,G2%%#+ r+c D|j}|j}|tz}|tz}tjd}|dd||}||dzz }|r"t| }n| |}td} td} tj ||||j t| tt| | |j }|S)$Convert the text to SVG using Pango.text_dirTparentsexist_ok.svg pixel_width pixel_height)rr3TEXT2SVG_ADJUSTMENT_FACTORrget_dirmkdirr existsr6resolverDrtext2svgr;START_XSTART_Yr5) rSrsizer3dir_name hash_namersvg_filer rsrs r)rzText._text2svgs(  **22 >*--td333OOE**  F 23      9,,..//HH**511H=)EN+F!*&I%%''((   Hr+propagate_colorsrctjtjkr!t ns] ?l1 1 1 GG   ! ! ! ! _ 2 2 2 GG  1A  B B B r+r r|).r5r6rr7rr7rrrr7r3r7rr6rr6rr6rrrrrrrrrrrrrrdrrrrrsrrrr;rrrr9rr r6r r7rr7r rl)r r)rr6r5r6r rrrr r6)rrrrrrr r)rrrrr r)rr)r r)rrr r)T)rZrr r)rurvrwrx staticmethod functoolscacherrNORMALrErpropertyrsetterrJrr rr(r.rDrr_ryrzs@r)rr+srrh__\"+/, %)%)>B%)%)8<"&#"""'#1i*i*i*i*i*i*i*V3333   X 2222$$ ' ' ' '4&&AAAAF    Dr+rceZdZdZeejd7dZdddedd e e d dd ddd d d fd8fd' Z e d9d(Z e j d:d+Z d;d-Zdd2Zd?d4Zd>d5Zd@d6ZxZS)Aru2Display (non-LaTeX) text rendered using `Pango `_. Text objects behave like a :class:`.VGroup`-like iterable of all characters in the given text. In particular, slicing is possible. **What is PangoMarkup?** PangoMarkup is a small markup language like html and it helps you avoid using "range of characters" while coloring or styling a piece a Text. You can use this language with :class:`~.MarkupText`. A simple example of a marked-up string might be:: Blue text is cool!" and it can be used with :class:`~.MarkupText` as .. manim:: MarkupExample :save_last_frame: class MarkupExample(Scene): def construct(self): text = MarkupText('Blue text is cool!"') self.add(text) A more elaborate example would be: .. manim:: MarkupElaborateExample :save_last_frame: class MarkupElaborateExample(Scene): def construct(self): text = MarkupText( 'اَ' 'لْعَر' 'َبِي' 'َّة' 'ُ' ) self.add(text) PangoMarkup can also contain XML features such as numeric character entities such as ``©`` for © can be used too. The most general markup tag is ````, then there are some convenience tags. Here is a list of supported tags: - ``bold``, ``italic`` and ``bold+italic`` - ``underline`` and ``strike through`` - ``typewriter font`` - ``bigger font`` and ``smaller font`` - ``superscript`` and ``subscript`` - ``double underline`` - ``error underline`` - ``overline`` - ``strikethrough`` - ``temporary change of font`` - ``temporary change of color`` - ``temporary change of color`` - ``temporary gradient`` For ```` markup, colors can be specified either as hex triples like ``#aabbcc`` or as named CSS colors like ``AliceBlue``. The ```` tag is handled by Manim rather than Pango, and supports hex triplets or Manim constants like ``RED`` or ``RED_A``. If you want to use Manim constants like ``RED_A`` together with ````, you will need to use Python's f-String syntax as follows:: MarkupText(f'here you go') If your text contains ligatures, the :class:`MarkupText` class may incorrectly determine the first and last letter when creating the gradient. This is due to the fact that ``fl`` are two separate characters, but might be set as one single glyph - a ligature. If your language does not depend on ligatures, consider setting ``disable_ligatures`` to ``True``. If you must use ligatures, the ``gradient`` tag supports an optional attribute ``offset`` which can be used to compensate for that error. For example: - ``example`` to *start* the gradient one letter earlier - ``example`` to *end* the gradient one letter earlier - ``example`` to *start* the gradient two letters earlier and *end* it one letter earlier Specifying a second offset may be necessary if the text to be colored does itself contain ligatures. The same can happen when using HTML entities for special chars. When using ``underline``, ``overline`` or ``strikethrough`` together with ```` tags, you will also need to use the offset, because underlines are additional paths in the final :class:`SVGMobject`. Check out the following example. Escaping of special characters: ``>`` **should** be written as ``>`` whereas ``<`` and ``&`` *must* be written as ``<`` and ``&``. You can find more information about Pango markup formatting at the corresponding documentation page: `Pango Markup `_. Please be aware that not all features are supported by this class and that the ```` tag mentioned above is not supported by Pango. Parameters ---------- text The text that needs to be created as mobject. fill_opacity The fill opacity, with 1 meaning opaque and 0 meaning transparent. stroke_width Stroke width. font_size Font size. line_spacing Line spacing. font Global font setting for the entire text. Local overrides are possible. slant Global slant setting, e.g. `NORMAL` or `ITALIC`. Local overrides are possible. weight Global weight setting, e.g. `NORMAL` or `BOLD`. Local overrides are possible. gradient Global gradient setting. Local overrides are possible. warn_missing_font If True (default), Manim will issue a warning if the font does not exist in the (case-sensitive) list of fonts returned from `manimpango.list_fonts()`. Returns ------- :class:`MarkupText` The text displayed in form of a :class:`.VGroup`-like mobject. Examples --------- .. manim:: BasicMarkupExample :save_last_frame: class BasicMarkupExample(Scene): def construct(self): text1 = MarkupText("foo bar foobar") text2 = MarkupText("foo bar big small") text3 = MarkupText("H2O and H3O+") text4 = MarkupText("type help for help") text5 = MarkupText( 'foo bar' ) group = VGroup(text1, text2, text3, text4, text5).arrange(DOWN) self.add(group) .. manim:: ColorExample :save_last_frame: class ColorExample(Scene): def construct(self): text1 = MarkupText( f'all in red except this', color=RED ) text2 = MarkupText("nice gradient", gradient=(BLUE, GREEN)) text3 = MarkupText( 'nice intermediate gradient', gradient=(BLUE, GREEN), ) text4 = MarkupText( 'fl ligature causing trouble here' ) text5 = MarkupText( 'fl ligature defeated with offset' ) text6 = MarkupText( 'fl ligature floating inside' ) text7 = MarkupText( 'fl ligature floating inside' ) group = VGroup(text1, text2, text3, text4, text5, text6, text7).arrange(DOWN) self.add(group) .. manim:: UnderlineExample :save_last_frame: class UnderlineExample(Scene): def construct(self): text1 = MarkupText( 'bla' ) text2 = MarkupText( 'xxxaabby' ) text3 = MarkupText( 'xxxaabby' ) text4 = MarkupText( 'xxxaabby' ) text5 = MarkupText( 'xxxaabby' ) group = VGroup(text1, text2, text3, text4, text5).arrange(DOWN) self.add(group) .. manim:: FontExample :save_last_frame: class FontExample(Scene): def construct(self): text1 = MarkupText( 'all in sans except this', font="sans" ) text2 = MarkupText( 'mixing fonts is ugly' ) text3 = MarkupText("special char > or >") text4 = MarkupText("special char < and &") group = VGroup(text1, text2, text3, text4).arrange(DOWN) self.add(group) .. manim:: NewlineExample :save_last_frame: class NewlineExample(Scene): def construct(self): text = MarkupText('foooooo\nbaaaar') self.add(text) .. manim:: NoLigaturesExample :save_last_frame: class NoLigaturesExample(Scene): def construct(self): text1 = MarkupText('floating') text2 = MarkupText('floating', disable_ligatures=True) group = VGroup(text1, text2).arrange(DOWN) self.add(group) As :class:`MarkupText` uses Pango to render text, rendering non-English characters is easily possible: .. manim:: MultiLanguage :save_last_frame: class MultiLanguage(Scene): def construct(self): morning = MarkupText("வணக்கம்", font="sans-serif") japanese = MarkupText( '日本へようこそ' ) # works as in ``Text``. mess = MarkupText("Multi-Language", weight=BOLD) russ = MarkupText("Здравствуйте मस नम म ", font="sans-serif") hin = MarkupText("नमस्ते", font="sans-serif") chinese = MarkupText("臂猿「黛比」帶著孩子", font="sans-serif") group = VGroup(morning, japanese, mess, russ, hin, chinese).arrange(DOWN) self.add(group) You can justify the text by passing :attr:`justify` parameter. .. manim:: JustifyText class JustifyText(Scene): def construct(self): ipsum_text = ( "Lorem ipsum dolor sit amet, consectetur adipiscing elit." "Praesent feugiat metus sit amet iaculis pulvinar. Nulla posuere " "quam a ex aliquam, eleifend consectetur tellus viverra. Aliquam " "fermentum interdum justo, nec rutrum elit pretium ac. Nam quis " "leo pulvinar, dignissim est at, venenatis nisi." ) justified_text = MarkupText(ipsum_text, justify=True).scale(0.4) not_justified_text = MarkupText(ipsum_text, justify=False).scale(0.4) just_title = Title("Justified") njust_title = Title("Not Justified") self.add(njust_title, not_justified_text) self.play( FadeOut(not_justified_text), FadeIn(justified_text), FadeOut(njust_title), FadeIn(just_title), ) self.wait(1) Tests ----- Check that the creation of :class:`~.MarkupText` works:: >>> MarkupText('The horse does not eat cucumber salad.') MarkupText('The horse does not eat cucumber salad.') r r|c,tj}|Sr#r~rs r)rzMarkupText.font_listprr+rXrNr2rFrTr5r6rr7rrrrr3rrrjustifyrrrrrdr int | Nonersrr;rr9rc  #||_||_|r|rt}|dkrd}||vr||vr|}nq||vr|}nF||vr|}ntjd|d|d||_ t||_ ||_ | |_ | |_| |_| |_||_||_|}d|vr|dd|jz}|}t+|dkrtjd |}t/j|j}|rt3||jd kr|j |j t4zz|_n|j |j |jzz|_|rt7|nt9j}||}t?j |tCj"|f||| ||d ||#|j$|_%|dd d d |_|j&}|D]}t+|j'dkr|j'}|d}t+||j(ks J|g#|dkrd#fd }nd#fd }tS|D]n\}} #*| |t+|dz kr>|dz|zdkr2tW| ||dzkr||||dz}o||tYj-#d|_'|jr|j.|j|D]d}!|j%|!d|!dz |!d|!dz |!dz /|0|!de|D]t}"|j%|"d|"dz |"d|"dz |"dz j.|0|"d|0|"dfu| ||1td|j3|_4dS)Nrrrrrrrrz[Using tags in MarkupText is deprecated. Please use instead.r2)rrrrsrrr<rrrr rlc4d}|||zdz |gz dSrr>rs r)rz(MarkupText.__init__..add_line_torr+cNd}|||z|zdz ||z|zdz |gz dSrr>rs r)rz(MarkupText.__init__..add_line_torr+rXrprr start_offset end_offsetrfromtor)5r5r3rrrrrrrrr7rrrrrrnrr;r_extract_color_tagsrL_extract_gradient_tagsrvalidaterrrrrrrrrDrErYrrKrrrrrrrPrQset_color_by_gradient set_color _parse_colorrrrr)%rSr5rrrrr3rrrrnrrrrsrr;rr9rrcolormap gradientmapvalidate_errorrrrrrrrrrcolgradrrVs% @r)rEzMarkupText.__init__vs* #/  H% H))Jzz|||++:%%??$$ 22??,,DDZZ\\Z//::< %--c266>>tRHH &5 A5 AD4;1$$[F )K{##tx//////24 qyy!*& 1 1 4 4 u#**5111S[[1_,,d*a//EVEAI%66770  K ,,,"("3K K $ $ $(#6a@@@DKK = 7 &D & 6 6 9 9C JG s>22SZn%6&l#6$$ i))#g,778888  D $DJW ^ 44tE{~&8'|$8%% $##DL1143D3DT$Z3P3PQ     >em JJ, - - -"kr+cV|j|jz tz dz|jztz Srrrs r)rzMarkupText.font_sizerr+rrlcj|dkrtd|||jz dSrrrs r)rzMarkupText.font_size%rr+rcd|jz|jz|jzt|z}|t |jt |jzz }|t |j z }|t |j z }|j |z}tj }|||ddS)r MARKUPPANGONr)rrrrrrr6r3rr;rnr5rrrrrr s r)r zMarkupText._text2hash-s i j k &&((..00  1  C)**S-A-AAAC.///C %%%X%!! fmmoo&&&!!#2#&&r+ct|}|j}|j}|tz}|tz}t jd}|dd||}||dzz }|r"t| }n| d| d|j dn|j }tjd |j tj||j|j|j|||jt| t*t,d d |jd }|S)rFrGTrHrKNzzz Setting Text iXii)rn pango_width)rrr3rNrrOrPr rQr6rRrr5rdebugrrSrrrr;rTrUrn) rSrrVr3rWrXrrY final_texts r)rzMarkupText._text2svg>sd5!!"/  **22 >*--td333OOE**  F 23       1 1 3 344HH$JU\\^^IItyIIIIY  L444 5 5 5"+   &I%%''(( H r+scd}d}tjdd|}|D]6}|dkr|dz }|dkr |dkr|dz}|dkr|dkr |dkr|dz }7|S) zCounts characters that will be displayed. This is needed for partial coloring or gradients, because space counts to the text's `len`, but has no corresponding character. rz&[^;]+;xrr)rsub)rSrcountlevelcs r)_count_real_charszMarkupText._count_real_charsfs  F9c1 % %  ACxx CxxEAII ca4iiEQJJ  r+list[dict[str, Any]]c "tjd|jtj}g}|D]6}||jd|d}|||dz}|dr(|ddndg}|drt|dnd}t|dkr|drt|dnd}| |||d|d||d 8tj d d |j dtj |_ |S) zUsed to determine which parts (if any) of the string should be formatted with a gradient. Removes the ```` tag, as it is not part of Pango's markup and would cause an error. zP(.+?)Nrr,rprX)rrrurvrsrtz]+>(.+?)\1rflags rfinditerrSrrrrIrdrLrrr5) rStagsr~tagrroffsetsrsrts r)rxz!MarkupText._extract_gradient_tagsys { _   D   -/   C**4+=n ! n+MNNE$001>>>C141Fciill((---A3G.5aj?3wqz???aL,/LLA,=,='!*,=WQZRSJ   "IIaLL))A,,$0",     F -udiqPRPT    r+rcrtjd|r|St|S)z8Parse color given in ```` or ```` tags.z #[0-9a-f]{6})rrrr)rSrs r)r|zMarkupText._parse_colors3 8NC ( ( ,Jc??))++ +r+c tjd|jtj}g}|D]"}||jd|d}|||dz}|dr(|ddndg}|drt|dnd}t|dkr|drt|dnd}| |||d||d $tj d d |j dtj |_ |S) aXUsed to determine which parts (if any) of the string should be formatted with a custom color. Removes the ```` tag, as it is not part of Pango's markup and would cause an error. Note: Using the ```` tags is deprecated. As soon as the legacy syntax is gone, this function will be removed. z:(.+?)NrrrrrprX)rrrrsrtz]+>(.+?)rrr) rSrr}rrrrrsrts r)rwzMarkupText._extract_color_tagssn{ I   D   *,  C**4+=n ! n+MNNE$001>>>C141Fciill((---A3G.5aj?3wqz???aL,/LLA,=,='!*,=WQZRSJ OO" YYq\\$0",     F ' "$    r+c2dt|jdS)Nz MarkupText(rrrs r)rzMarkupText.__repr__s8T$"4558888r+ra)$r5r6rr7rr7rrrr7r3r7rr6rr6rr6rnrrrrrdrrorsrorrr;rrrr9rrcrdre)rrr r6)rr6r rd)r r)rr6r r6rb)rurvrwrxrfrgrhrrrirErjrrkr rrrxr|rwrryrzs@r)rrFsggR __\ +/, 8<! ""'"&%b*b*b*b*b*b*b*H   X 2222''''"&&&&P&    D,,,,####J99999999r+r font_file str | PathIterator[None]c#jKttjj}t||dz |z |dz |z ||z g}|D]U}|}|r+|}t jd|nVd|d|}t| tj t|sJdVtj t|dS#tj t|wxYw)aTemporarily add a font file to Pango's search path. This searches for the font_file at various places. The order it searches it described below. 1. Absolute path. 2. In ``assets/fonts`` folder. 3. In ``font/`` folder. 4. In the same directory. Parameters ---------- font_file The font file to add. Examples -------- Use ``with register_font(...)`` to add a font file to search path. .. code-block:: python with register_font("path/to/font_file.ttf"): a = Text("Hello", font="Custom Font Name") Raises ------ FileNotFoundError: If the font doesn't exists. AttributeError: If this method is used on macOS. .. important :: This method is available for macOS for ``ManimPango>=v0.2.3``. Using this method with previous releases will raise an :class:`AttributeError` on macOS. z assets/fontsfontszFound file at %sz Can't find z. Checked paths: N)r r input_fileparentrRrQrrabsoluteFileNotFoundErrorrrr6unregister_font)r input_folderpossible_pathspath file_patherrors r)rrsAN)**199;;L Y~% 1w*y N ''||~~ ;;== I L+Y-?-?-A-A B B B E  KiJJ.JJ&&&3'I77777 "3y>>22222 "3y>>2222s 'D#D2)rrr r)rrr r)5rx __future__rrg__all__rrrcollections.abcrr r contextlibr itertoolsr pathlibr typingrrrnumpyrPrrrmanimrrmanim.constantsmanim.mobject.geometry.arcrmanim.mobject.svg.svg_mobjectr&manim.mobject.types.vectorized_mobjectrr manim.typingrmanim.utils.colorrrrrrrrNr0rrrrr>r+r)rs//b#""""" > > >  8888888888%%%%%%%%%%%%%%;;;;;;;;;; ******444444CCCCCCCC LLLLLLLLLL%$$$$$$   > > >    0vvvvvvvvrXXXXX:XXXvB 9B 9B 9B 9B 9B 9B 9B 9J;3;3;3;3;3;3r+