.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "_gallery/feature_demo/env_maps.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_env_maps.py>`
        to download the full example code.

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

.. _sphx_glr__gallery_feature_demo_env_maps.py:


Environment Map Effects
=======================

This example demonstrates the environment mapping effects
of the "CUBE-REFLECTION" and "CUBE-REFRACTION" mapping modes
in "MeshBasicMaterial", "MeshPhongMaterial", and "MeshStandardMaterial"
for a given object.

.. GENERATED FROM PYTHON SOURCE LINES 11-103



.. image-sg:: /_gallery/feature_demo/images/sphx_glr_env_maps_001.webp
   :alt: env maps
   :srcset: /_gallery/feature_demo/images/sphx_glr_env_maps_001.webp
   :class: sphx-glr-single-img





.. code-block:: Python



    import os
    import math

    import imageio.v3 as iio
    import trimesh
    from pathlib import Path
    import pylinalg as la
    from rendercanvas.auto import RenderCanvas, loop

    import pygfx as gfx

    try:
        # modify this line if your model is located elsewhere
        model_dir = Path(__file__).parents[1] / "data"
    except NameError:
        # compatibility with sphinx-gallery
        model_dir = Path(os.getcwd()).parent / "data"

    TEAPOT = model_dir / "teapot.stl"

    renderer = gfx.renderers.WgpuRenderer(RenderCanvas())
    scene = gfx.Scene()

    dir_light = gfx.DirectionalLight(1, 2)
    dir_light.local.position = (0, 0, 1)

    scene.add(gfx.AmbientLight(1, 0.2), dir_light)

    # Read cube image and turn it into a 3D image (a 4d array)
    env_img = iio.imread("imageio:meadow_cube.jpg")
    cube_size = env_img.shape[1]
    env_img.shape = 6, cube_size, cube_size, env_img.shape[-1]

    # Create environment map
    env_tex = gfx.Texture(
        env_img, dim=2, size=(cube_size, cube_size, 6), generate_mipmaps=True
    )

    teapot = trimesh.load(TEAPOT)

    rot = la.quat_from_euler(-math.pi / 2, order="X")


    def add_mesh(material, env_mapping_mode, pos_x, pos_y):
        material.env_map = env_tex
        material.env_mapping_mode = env_mapping_mode

        mesh = gfx.Mesh(gfx.geometry_from_trimesh(teapot), material)

        mesh.local.position = (pos_x, pos_y, 0)
        mesh.local.rotation = la.quat_mul(rot, mesh.local.rotation)
        scene.add(mesh)


    # BasicMaterial - CUBE-REFRACTION
    material = gfx.MeshBasicMaterial()
    add_mesh(material, "CUBE-REFRACTION", -60, 0)

    # BasicMaterial - CUBE-REFLECTION
    material = gfx.MeshBasicMaterial()
    add_mesh(material, "CUBE-REFLECTION", -60, -60)

    # PhongMaterial - CUBE-REFRACTION
    material = gfx.MeshPhongMaterial()
    material.env_combine_mode = "MIX"  # can be "MIX", "MULTIPLY" or "ADD"
    add_mesh(material, "CUBE-REFRACTION", 0, 0)

    # PhongMaterial - CUBE-REFLECTION
    material = gfx.MeshPhongMaterial()
    material.env_combine_mode = "MIX"  # can be "MIX", "MULTIPLY" or "ADD"
    add_mesh(material, "CUBE-REFLECTION", 0, -60)

    # StandardMaterial - CUBE-REFRACTION
    material = gfx.MeshStandardMaterial(roughness=0.1, metalness=1.0)
    add_mesh(material, "CUBE-REFRACTION", 60, 0)

    # StandardMaterial - CUBE-REFLECTION
    material = gfx.MeshStandardMaterial(roughness=0.1, metalness=1.0)
    add_mesh(material, "CUBE-REFLECTION", 60, -60)

    background = gfx.Background(None, gfx.BackgroundSkyboxMaterial(map=env_tex))
    scene.add(background)

    camera = gfx.PerspectiveCamera(45, 16 / 9)
    camera.show_object(scene, view_dir=(0, 0, -300))
    controller = gfx.OrbitController(camera, register_events=renderer)

    if __name__ == "__main__":
        renderer.request_draw(lambda: renderer.render(scene, camera))
        loop.run()


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

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


.. _sphx_glr_download__gallery_feature_demo_env_maps.py:

.. only:: html

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

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

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

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

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

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

      :download:`Download zipped: env_maps.zip <env_maps.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#env_maps.py"></iframe>