[misc] [refactor] 'ti.vec' and 'ti.veci' is deprecated, directly use a tuple in GUI system instead

docs/gui.rst

@@ -161,6 +161,24 @@ Paint on a window
     Draw a line of text on screen.
 
 
+.. function:: ti.rgb_to_hex(rgb):
+
+    :parameter rgb: (tuple of 3 floats) The (R, G, B) float values, in range [0, 1)
+    :return: (RGB hex or np.array of uint32) The translated hex value
+
+    Convert a (R, G, B) tuple of float into a single hex value, e.g.:
+
+    .. code-block:: python
+
+         rgb = (0.4, 0.8, 1.0)
+         hex = ti.rgb_to_hex(rgb)  # 0x66ccff
+
+         rgb = np.array([[0.4, 0.8, 1.0], [0.0, 0.5, 1.0]])
+         hex = ti.rgb_to_hex(rgb)  # np.array([0x66ccff, 0x007fff])
+
+    This is helpful since the return value could be used in other paint APIs.
+
+
 .. _gui_event:
 
 Event processing

examples/pbf2d.py

@@ -282,9 +282,9 @@ def render(gui):
         for j in range(dim):
             pos[j] *= screen_to_world_ratio / screen_res[j]
     gui.circles(pos_np, radius=particle_radius, color=particle_color)
-    canvas.rect(ti.vec(
-        0, 0), ti.vec(board_states[None][0] / boundary[0],
-                      1.0)).radius(1.5).color(boundary_color).close().finish()
+    gui.rect((0, 0), (board_states[None][0] / boundary[0], 1.0),
+             radius=1.5,
+             color=boundary_color)
     gui.show()
 
 

python/taichi/misc/gui.py

@@ -1,7 +1,7 @@
 import numbers
 import numpy as np
 from taichi.core import ti_core
-from .util import deprecated
+from .util import deprecated, core_veci
 
 
 class GUI:
@@ -35,14 +35,13 @@ class Event:
     RELEASE = ti_core.KeyEvent.EType.Release
 
     def __init__(self, name, res=512, background_color=0x0):
-        import taichi as ti
         self.name = name
         if isinstance(res, numbers.Number):
             res = (res, res)
         self.res = res
         # The GUI canvas uses RGBA for storage, therefore we need NxMx4 for an image.
         self.img = np.ascontiguousarray(np.zeros(self.res + (4, ), np.float32))
-        self.core = ti.core.GUI(name, ti.veci(*res))
+        self.core = ti_core.GUI(name, core_veci(*res))
         self.canvas = self.core.get_canvas()
         self.background_color = background_color
         self.key_pressed = set()
@@ -258,9 +257,9 @@ def text(self, content, pos, font_size=15, color=0xFFFFFF):
         import taichi as ti
         # TODO: refactor Canvas::text
         font_size = float(font_size)
-        pos = ti.vec(*pos)
-        r, g, b = (color >> 16) & 0xff, (color >> 8) & 0xff, color & 0xff
-        color = ti.vec(r / 255, g / 255, b / 255, 1)
+        pos = ti.core_vec(*pos)
+        r, g, b = hex_to_rgb(color)
+        color = ti.core_vec(r, g, b, 1)
         self.canvas.text(content, pos, font_size, color)
 
     def show(self, file=None):
@@ -377,7 +376,13 @@ def rgb_to_hex(c):
     return 65536 * to255(c[0]) + 256 * to255(c[1]) + to255(c[2])
 
 
+def hex_to_rgb(c):
+    r, g, b = (color >> 16) & 0xff, (color >> 8) & 0xff, color & 0xff
+    return r / 255, g / 255, b / 255
+
+
 __all__ = [
     'GUI',
     'rgb_to_hex',
+    'hex_to_rgb',
 ]

python/taichi/misc/util.py

@@ -15,7 +15,7 @@ def config_from_dict(args):
     return ti_core.config_from_dict(d)
 
 
-def veci(*args):
+def core_veci(*args):
     from taichi.core import ti_core
     if isinstance(args[0], ti_core.Vector2i):
         return args[0]
@@ -34,7 +34,7 @@ def veci(*args):
         assert False, type(args[0])
 
 
-def vec(*args):
+def core_vec(*args):
     from taichi.core import ti_core
     if isinstance(args[0], ti_core.Vector2f):
         return args[0]
@@ -200,9 +200,21 @@ def print_profile_info():
     taichi.ti_core.print_profile_info()
 
 
+@deprecated('ti.vec(x, y)', 'a tuple (x, y) for GUI system')
+def vec(*args, **kwargs):
+    return core_vec(*args, **kwargs)
+
+
+@deprecated('ti.veci(x, y)', 'a tuple (x, y) for GUI system')
+def veci(*args, **kwargs):
+    return core_veci(*args, **kwargs)
+
+
 __all__ = [
     'vec',
     'veci',
+    'core_vec',
+    'core_veci',
     'set_gdb_trigger',
     'print_profile_info',
     'set_logging_level',