.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "_gallery/feature_demo/labelled_image_grid.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download__gallery_feature_demo_labelled_image_grid.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr__gallery_feature_demo_labelled_image_grid.py:


Labelled Image Grid
===================

This example demonstrates how to create a grid of images with labels that change color when hovered over.

.. GENERATED FROM PYTHON SOURCE LINES 7-114



.. image-sg:: /_gallery/feature_demo/images/sphx_glr_labelled_image_grid_001.webp
   :alt: labelled image grid
   :srcset: /_gallery/feature_demo/images/sphx_glr_labelled_image_grid_001.webp
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    Imageio: 'wikkie.png' was not found on your computer; downloading it now.
    Try 1. Download from https://github.com/imageio/imageio-binaries/raw/master/images/wikkie.png (461 kB)
    Downloading: 8192/472047 bytes (1.7%)472047/472047 bytes (100.0%)
      Done
    File saved as /home/docs/.imageio/images/wikkie.png.
    Imageio: 'immunohistochemistry.png' was not found on your computer; downloading it now.
    Try 1. Download from https://github.com/imageio/imageio-binaries/raw/master/images/immunohistochemistry.png (459 kB)
    Downloading: 8192/470201 bytes (1.7%)470201/470201 bytes (100.0%)
      Done
    File saved as /home/docs/.imageio/images/immunohistochemistry.png.






|

.. code-block:: Python



    import random

    import imageio.v3 as iio
    import numpy as np
    from rendercanvas.auto import RenderCanvas, loop

    import pygfx as gfx

    random.seed(333)

    image_names = [
        "astronaut.png",
        "wood.jpg",
        "bricks.jpg",
        "wikkie.png",
        "immunohistochemistry.png",
    ]
    images = [iio.imread(f"imageio:{name}") for name in image_names]

    grid_shape = (24, 16)

    canvas = RenderCanvas()
    renderer = gfx.renderers.WgpuRenderer(canvas, show_fps=True)
    scene = gfx.Scene()

    labels_group = gfx.Group()
    scene.add(labels_group)

    image_array = np.empty(grid_shape, dtype=object)
    label_array = np.empty(grid_shape, dtype=object)


    def add_image(img, position, spacing=10):
        texture = gfx.Texture(img, dim=2)
        geometry = gfx.Geometry(grid=texture)
        material = gfx.ImageBasicMaterial(clim=(0, 255), pick_write=True)
        image = gfx.Image(geometry, material)
        scene.add(image)

        image.world.x = (img.shape[1] + spacing) * position[0]
        image.world.y = (img.shape[0] + spacing) * position[1]

        label = add_label(image.world.x, image.world.y, text=str(position))

        image_array[position] = image
        label_array[position] = label

        def on_pointer_enter(event):
            label_array[position].material.color = gfx.Color("#FFFF00")
            renderer.request_draw()

        def on_pointer_leave(event):
            label_array[position].material.color = gfx.Color("#FFFFFF")
            renderer.request_draw()

        image.add_event_handler(on_pointer_enter, "pointer_enter")
        image.add_event_handler(on_pointer_leave, "pointer_leave")


    def add_label(x, y, text):
        label = gfx.Text(
            text=text,
            font_size=20,
            screen_space=True,
            anchor="top-left",
            material=gfx.TextMaterial(
                color="#FFFFFF",
                outline_color="#000000",
                outline_thickness=0.2,
            ),
        )
        labels_group.add(label)
        label.world.x = x
        label.world.y = y
        label.world.z = 1
        return label


    for position in np.ndindex(grid_shape):
        img = random.choice(images)
        add_image(img, position)

    camera = gfx.PerspectiveCamera(70)
    camera.show_object(scene, match_aspect=True)
    camera.local.scale_y = -1


    def update_text_visibility():
        min_height = 100
        max_height = 3000
        camera_height = camera.world.position[2]

        labels_group.visible = min_height <= camera_height <= max_height


    controller = gfx.PanZoomController(camera, register_events=renderer)


    def update_scene():
        update_text_visibility()
        renderer.render(scene, camera)


    canvas.request_draw(update_scene)
    loop.run()


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 4.045 seconds)


.. _sphx_glr_download__gallery_feature_demo_labelled_image_grid.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: labelled_image_grid.ipynb <labelled_image_grid.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: labelled_image_grid.py <labelled_image_grid.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: labelled_image_grid.zip <labelled_image_grid.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_

.. only:: html

    Interactive example
    -------------------

    Try this example in your browser using Pyodide. Might not work with all examples and all devices. Check the output and your browser's console for details.

    .. raw:: html

        <iframe src="./../pyodide.html#labelled_image_grid.py"></iframe>