[GUI] Support drawing text on canvas #1070

archibate · 2020-05-28T16:34:11Z

Related issue = close #1045

[Click here for the format server]

archibate · 2020-05-28T16:35:16Z

Btw, why is our font resolution so bad?

archibate · 2020-05-29T01:44:19Z

Can't we just use the platform provided API to draw text? (e.g. TextOut in win32)

yuanming-hu · 2020-05-29T02:30:32Z

Thanks! Brain fried today but I'll take a look first thing tomorrow.

Can't we just use the platform provided API to draw text? (e.g. TextOut in win32)

GUI::text worked pretty well without these artifacts. I'll take a look.

yuanming-hu

Thank you so much! Please address the comments.

To make this feature available to users, please

Add a submodule containing https://github.com/yuanming-hu/taichi_assets/tree/master/fonts/go
Fix the font path:

taichi/taichi/gui/gui.h

Line 394 in 30701fc

auto ttf_path = root_dir + std::string("/assets/fonts/go/Go-Regular.ttf");
Make sure the font file is available in release mode. See the shipping of examples as an example: https://github.com/taichi-dev/taichi/pull/1010/files
Add doc

python/taichi/misc/gui.py

archibate · 2020-05-29T15:11:22Z

Can't we just load the system default font, or compile the font into libtaichi.so? It's tricky to copytree/rmtree nested-dir like external/fonts.

archibate · 2020-05-29T16:08:15Z

Problem:
When in release_mode, we ttf_path = "/fonts/Go.ttf".
When in dev_mode, we ttf_path = "/external/fonts/Go.ttf".
So how do I detect if it's dev_mode in C++?

archibate · 2020-05-29T17:08:32Z

Now I just use external/fonts to keep consistency in release_mode, sleeping now, ff2 mt oyo fuat :)

archibate · 2020-05-30T03:58:13Z

How to test in release mode?

yuanming-hu · 2020-05-30T14:22:07Z

Thanks for implementing everything here!

Can't we just load the system default font, or compile the font into libtaichi.so? It's tricky to copytree/rmtree nested-dir like external/fonts.

Loading a system font (for all platforms) can be tricky...

So how do I detect if it's dev_mode in C++?

Please use is_release() in C++.

How to test in release mode?

Usually I do

cd python
python3 build.py test

archibate · 2020-05-31T00:46:55Z

(aug) [bate@archit taichi]$ cd python
(aug) [bate@archit python]$ python build.py test
[Taichi] mode=development
[Taichi] preparing sandbox at /tmp/taichi-krj62zja
[Taichi] sandbox prepared
[Taichi] <dev mode>, supported archs: [cpu, cuda, opengl], commit 98138bdb, python 3.8.2
Traceback (most recent call last):
  File "build.py", line 26, in <module>
    assert False, "Missing environment variable PYPI_PWD"
AssertionError: Missing environment variable PYPI_PWD

Why it needs PYPI_PWD? Wasn't it just test?

yuanming-hu · 2020-05-31T00:48:24Z

Oh, my bad. Please use any value for that environment variable for now. In the future let's fix this on test mode.

archibate · 2020-05-31T01:06:21Z

FYI it also needs CXX=clang++ env.

(guitext) [bate@archit test_env]$ p keyboard.py 
[Taichi] mode=release
[Taichi] version 0.6.6, supported archs: [cpu, cuda, opengl], commit 5cab3f28, python 3.8.2
Traceback (most recent call last):
  File "keyboard.py", line 26, in <module>
    gui.text(f'({x:.3}, {y:.3})', (x, y))
AttributeError: 'GUI' object has no attribute 'text'

commit 5cab3f28? So build.py test only work for the latest [release]?

yuanming-hu · 2020-05-31T01:09:16Z

Maybe you have an existing v0.6.6 installation via pip? Please remove that first.

archibate · 2020-05-31T01:13:31Z

Fixed. Now comes to:

Traceback (most recent call last):
  File "keyboard.py", line 26, in <module>
    gui.text(f'({x:.3}, {y:.3})', (x, y))
  File "/home/bate/.local/lib/python3.8/site-packages/taichi/misc/gui.py", line 143, in text
    self.canvas.text(context, pos, font_size, color)
RuntimeError: [image_buffer.cpp:write_text@120] Font file not found: /home/bate/.taichi//external/fonts/NotoSansMono-Regular.ttf

/home/bate/.taichi/?
I want /home/bate/.local/lib/python/site-packages/taichi/.
UPDATE: get_python_package_dir() doesn't work in dev_mode.

yuanming-hu · 2020-05-31T03:26:47Z

libdevice_path might be a good reference.

taichi/taichi/llvm/llvm_context.cpp

Lines 165 to 175 in 8502f82

    
           std::string libdevice_path() { 
        
             std::string folder; 
        
             if (is_release()) { 
        
               folder = compiled_lib_dir; 
        
             } else { 
        
               folder = fmt::format("{}/external/cuda_libdevice", get_repo_dir()); 
        
             } 
        
             auto cuda_version_string = get_cuda_version_string(); 
        
             auto cuda_version_major = int(std::atof(cuda_version_string.c_str())); 
        
             return fmt::format("{}/slim_libdevice.{}.bc", folder, cuda_version_major); 
        
           }

Btw, we should avoid committing huge binary files in the repo. Could you make the font file a submodule? Also how about sticking to the font file in taichi_assets, which I'm sure has a friendly license?

Thanks for working on this!

archibate · 2020-05-31T06:09:59Z

I added https://github.com/taichi-dev/taichi_assets for storing font files, and may have other binary files in future (that's why I want the name taichi_assets instead of taichi_fonts, the latter is to limited).
So can we remove or rename https://github.com/yuanming-hu/taichi_assets to taichi_legacy_assets now? It's legacy and no longer used except for it's release page (CI resources) anyway.

Btw, I'll add ti rel_test as an alias of

rm -rf ~/.local/lib/python3.8/site-packages/taichi{,-0*.dist-info}/ && nc && (pushd python; PYPI_PWD=233 CXX=clang++ python build.py test; popd)

after #1085.

archibate · 2020-05-31T06:24:34Z

Working very well in release mode!

yuanming-hu

LGTM! Feel free to merge after committing the RGB conversion suggestion and adding brief documentation on this new function.

python/taichi/misc/gui.py

yuanming-hu

Thanks! Some final nits. Feel free to merge after applying them.

yuanming-hu · 2020-05-31T14:23:32Z

docs/gui.rst

+.. function:: gui.text(context, pos, font_size = 15, color = 0xFFFFFF)
+
+    :parameter gui: (GUI) the window object
+    :parameter pow: (tuple of 2) the top-left point position of the fonts / texts
+    :parameter font_size: (optional, scalar) the size of font (in height)
+    :parameter color: (optional, RGB hex) the foreground color of text
+
+    Draw a line of text on screen.


Suggested change

.. function:: gui.text(context, pos, font_size = 15, color = 0xFFFFFF)

:parameter gui: (GUI) the window object

:parameter pow: (tuple of 2) the top-left point position of the fonts / texts

:parameter font_size: (optional, scalar) the size of font (in height)

:parameter color: (optional, RGB hex) the foreground color of text

Draw a line of text on screen.

.. function:: gui.text(content, font_size = 15, color = 0xFFFFFF)

:parameter gui: (GUI) the GUI object

:parameter content: (``str``) the text to print

:parameter pos: (tuple of 2) the top-left anchor position of the text

:parameter font_size: (optional, scalar) font size (height, in pixels)

:parameter color: (optional, RGB hex) text foreground color

Draw text on the screen.

python/taichi/misc/gui.py

[skip ci] [GUI] Support draw text on canvas

76e0137

archibate requested a review from yuanming-hu May 28, 2020 16:34

archibate requested review from k-ye and yuanming-hu and removed request for yuanming-hu May 28, 2020 16:35

yuanming-hu reviewed May 29, 2020

View reviewed changes

python/taichi/misc/gui.py Outdated Show resolved Hide resolved

python/taichi/misc/gui.py Outdated Show resolved Hide resolved

apply

63f115f

[skip travis] well done font

d2580a1

archibate requested a review from taichi-gardener May 29, 2020 16:24

[skip ci] enforce code format

254b84e

yuanming-hu mentioned this pull request May 29, 2020

GAMES 201 TODO items #1016

Closed

18 tasks

archibate requested a review from yuanming-hu May 30, 2020 03:57

Merge branch 'master' into guitext

1fea516

archibate added 2 commits May 31, 2020 12:14

[skip ci] try to fix but didn't work

1c2c9aa

[skip travis] workinggaga

7d76c01

add submodule taichi-dev/taichi_assets

379fdc2

yuanming-hu reviewed May 31, 2020

View reviewed changes

python/taichi/misc/gui.py Outdated Show resolved Hide resolved

[skip ci] apply

c8a9f3d

archibate requested a review from yuanming-hu May 31, 2020 14:01

yuanming-hu approved these changes May 31, 2020

View reviewed changes

[skip ci] content

9602916

archibate added the GAMES201 GAMES 201 students' wishlist label May 31, 2020

archibate merged commit c8b2e94 into taichi-dev:master May 31, 2020

yuanming-hu mentioned this pull request May 31, 2020

[release] v0.6.7 #1094

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GUI] Support drawing text on canvas #1070

[GUI] Support drawing text on canvas #1070

archibate commented May 28, 2020

archibate commented May 28, 2020

archibate commented May 29, 2020

yuanming-hu commented May 29, 2020 •

edited

yuanming-hu left a comment •

edited

archibate commented May 29, 2020

archibate commented May 29, 2020

archibate commented May 29, 2020

archibate commented May 30, 2020

yuanming-hu commented May 30, 2020 •

edited

archibate commented May 31, 2020

yuanming-hu commented May 31, 2020

archibate commented May 31, 2020

yuanming-hu commented May 31, 2020 •

edited

archibate commented May 31, 2020 •

edited

yuanming-hu commented May 31, 2020 •

edited

archibate commented May 31, 2020 •

edited

archibate commented May 31, 2020

yuanming-hu left a comment •

edited

yuanming-hu left a comment

yuanming-hu May 31, 2020

-.. function:: gui.text(context, pos, font_size = 15, color = 0xFFFFFF)
-    :parameter gui: (GUI) the window object
-    :parameter pow: (tuple of 2) the top-left point position of the fonts / texts
-    :parameter font_size: (optional, scalar) the size of font (in height)
-    :parameter color: (optional, RGB hex) the foreground color of text
-    Draw a line of text on screen.
+.. function:: gui.text(content, font_size = 15, color = 0xFFFFFF)
+    :parameter gui: (GUI) the GUI object
+    :parameter content: (``str``) the text to print
+    :parameter pos: (tuple of 2) the top-left anchor position of the text
+    :parameter font_size: (optional, scalar) font size (height, in pixels)
+    :parameter color: (optional, RGB hex) text foreground color
+    Draw text on the screen.

[GUI] Support drawing text on canvas #1070

[GUI] Support drawing text on canvas #1070

Conversation

archibate commented May 28, 2020

archibate commented May 28, 2020

archibate commented May 29, 2020

yuanming-hu commented May 29, 2020 • edited

yuanming-hu left a comment • edited

Choose a reason for hiding this comment

archibate commented May 29, 2020

archibate commented May 29, 2020

archibate commented May 29, 2020

archibate commented May 30, 2020

yuanming-hu commented May 30, 2020 • edited

archibate commented May 31, 2020

yuanming-hu commented May 31, 2020

archibate commented May 31, 2020

yuanming-hu commented May 31, 2020 • edited

archibate commented May 31, 2020 • edited

yuanming-hu commented May 31, 2020 • edited

archibate commented May 31, 2020 • edited

archibate commented May 31, 2020

yuanming-hu left a comment • edited

Choose a reason for hiding this comment

yuanming-hu left a comment

Choose a reason for hiding this comment

yuanming-hu May 31, 2020

Choose a reason for hiding this comment

yuanming-hu commented May 29, 2020 •

edited

yuanming-hu left a comment •

edited

yuanming-hu commented May 30, 2020 •

edited

yuanming-hu commented May 31, 2020 •

edited

archibate commented May 31, 2020 •

edited

yuanming-hu commented May 31, 2020 •

edited

archibate commented May 31, 2020 •

edited

yuanming-hu left a comment •

edited