NF: Adding actor for arrow, TEST: Adding uni tests for arrow actor.

fury/actor.py

@@ -830,3 +830,90 @@ def octagonalprism(
         material=material,
         enable_picking=enable_picking,
     )
+
+
+def arrow(
+    centers,
+    *,
+    directions=(0, 0, 0),
+    colors=(1, 1, 1),
+    height=1.0,
+    resolution=10,
+    tip_length=0.35,
+    tip_radius=0.1,
+    shaft_radius=0.03,
+    scales=(1, 1, 1),
+    opacity=None,
+    material="phong",
+    enable_picking=True,
+):
+    """Visualize one or many arrows with different features.
+
+    Parameters
+    ----------
+    centers : ndarray, shape (N, 3)
+        arrow positions.
+    directions : ndarray, shape (N, 3), optional
+        The orientation vector of the arrow.
+    colors : ndarray (N,3) or (N, 4) or tuple (3,) or tuple (4,), optional
+        RGB or RGBA (for opacity) R, G, B and A should be at the range [0, 1].
+    height : float, optional
+        The total height of the arrow, including the shaft and tip. Default is 1.0.
+    resolution : int, optional
+        The number of divisions along the arrow's circular cross-sections.
+        Higher values produce smoother arrows. Default is 10.
+    tip_length : float, optional
+        The length of the arrowhead tip relative to the total height. Default is 0.35.
+    tip_radius : float, optional
+        The radius of the arrowhead tip. Default is 0.1.
+    shaft_radius : float, optional
+        The radius of the arrow shaft. Default is 0.03.
+    scales : int or ndarray (N,3) or tuple (3,), optional
+        The size of the arrow in each dimension. If a single value is
+        provided, the same size will be used for all arrow.
+    opacity : float, optional
+        Takes values from 0 (fully transparent) to 1 (opaque).
+        If both `opacity` and RGBA are provided, the final alpha will be:
+        final_alpha = alpha_in_RGBA * opacity
+    material : str, optional
+        The material type for the arrows. Options are 'phong' and 'basic'.
+    enable_picking : bool, optional
+        Whether the arrows should be pickable in a 3D scene.
+
+    Returns
+    -------
+    mesh_actor : Actor
+        A mesh actor containing the generated arrows, with the specified
+        material and properties.
+
+    Examples
+    --------
+    >>> from fury import window, actor
+    >>> import numpy as np
+    >>> scene = window.Scene()
+    >>> centers = np.random.rand(5, 3) * 10
+    >>> colors = np.random.rand(5, 3)
+    >>> arrow_actor = actor.arrow(centers=centers, colors=colors)
+    >>> scene.add(arrow_actor)
+    >>> show_manager = window.ShowManager(scene=scene, size=(600, 600))
+    >>> show_manager.start()
+    """
+
+    vertices, faces = fp.prim_arrow(
+        height=height,
+        resolution=resolution,
+        tip_length=tip_length,
+        tip_radius=tip_radius,
+        shaft_radius=shaft_radius,
+    )
+    return actor_from_primitive(
+        vertices,
+        faces,
+        centers=centers,
+        colors=colors,
+        scales=scales,
+        directions=directions,
+        opacity=opacity,
+        material=material,
+        enable_picking=enable_picking,
+    )

fury/tests/test_actor.py

@@ -573,3 +573,55 @@ def test_octagonalprism():
     assert g == 0 and b == 0
     assert r == 255
     scene.remove(octagonalprism_actor_2)
+
+
+def test_arrow():
+    scene = window.Scene()
+    centers = np.array([[0, 0, 0]])
+    colors = np.array([[1, 0, 0]])
+
+    arrow_actor = actor.arrow(centers=centers, colors=colors)
+    scene.add(arrow_actor)
+
+    npt.assert_array_equal(arrow_actor.local.position, centers[0])
+
+    assert arrow_actor.prim_count == 1
+
+    window.snapshot(scene=scene, fname="arrow_test_1.png")
+
+    img = Image.open("arrow_test_1.png")
+    img_array = np.array(img)
+
+    mean_r, mean_g, mean_b, mean_a = np.mean(
+        img_array.reshape(-1, img_array.shape[2]), axis=0
+    )
+
+    assert mean_r > mean_b and mean_r > mean_g
+
+    middle_pixel = img_array[img_array.shape[0] // 2, img_array.shape[1] // 2]
+    r, g, b, a = middle_pixel
+    assert r > g and r > b
+    assert g == b
+    scene.remove(arrow_actor)
+
+    arrow_actor_2 = actor.arrow(centers=centers, colors=colors, material="basic")
+    scene.add(arrow_actor_2)
+    window.snapshot(scene=scene, fname="arrow_test_2.png")
+
+    img = Image.open("arrow_test_2.png")
+    img_array = np.array(img)
+
+    mean_r, mean_g, mean_b, mean_a = np.mean(
+        img_array.reshape(-1, img_array.shape[2]), axis=0
+    )
+
+    assert mean_r > mean_b and mean_r > mean_g
+    assert 0 < mean_r < 255
+    assert mean_g == 0 and mean_b == 0
+
+    middle_pixel = img_array[img_array.shape[0] // 2, img_array.shape[1] // 2]
+    r, g, b, a = middle_pixel
+    assert r > g and r > b
+    assert g == 0 and b == 0
+    assert r == 255
+    scene.remove(arrow_actor_2)