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

.. only:: html

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

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

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

.. _sphx_glr_auto_examples_Widgets_plot_widget3d_plane.py:


3D Plane Widget
===============

A draggable axis-aligned plane in a 3-D panel, rendered as a translucent quad
spanning the panel's bounds.  Drag it in the browser to slide it along its
normal — ideal as a slice selector through a volume or point cloud.  Add it
with ``plot.add_widget("plane", axis=..., position=...)``.

.. GENERATED FROM PYTHON SOURCE LINES 10-13

.. code-block:: Python

    import numpy as np
    import anyplotlib as apl








.. GENERATED FROM PYTHON SOURCE LINES 14-17

A point cloud to slice
----------------------
A Gaussian blob of points; the plane widget will pick out a z-slab.

.. GENERATED FROM PYTHON SOURCE LINES 17-32

.. code-block:: Python


    rng = np.random.default_rng(0)
    n = 4000
    pts = rng.normal(0, 8, size=(n, 3)) + 24    # centred in a 0..48 box
    xs, ys, zs = pts[:, 0], pts[:, 1], pts[:, 2]

    fig, ax = apl.subplots(1, 1, figsize=(520, 500))
    cloud = ax.scatter3d(xs, ys, zs, color="#4fc3f7", point_size=3,
                         x_label="x", y_label="y", z_label="z")

    plane = cloud.add_widget("plane", axis="z", position=24,
                             color="#40c4ff", alpha=0.15)

    fig





.. raw:: html

    <div style="display:block;text-align:center;line-height:0;margin:12px 0;"><div id="sphx_glr_plot_widget3d_plane_001" class="awi-fig-wrap" data-awi-fig="sphx_glr_plot_widget3d_plane_001" style="display:inline-block;overflow:hidden;position:relative;width:536px;height:516px;"><iframe src="../../_static/viewer_widgets/sphx_glr_plot_widget3d_plane_001.html" data-awi-fig="sphx_glr_plot_widget3d_plane_001" frameborder="0" scrolling="no" style="width:536px;height:516px;border:none;overflow:hidden;display:block;transform-origin:top left;transform:scale(1);position:absolute;top:0;left:0;"></iframe></div><script>(function(){var wrap=document.getElementById('sphx_glr_plot_widget3d_plane_001'),ifr=wrap.querySelector('iframe'),nw=536,nh=516;function r(){var avail=wrap.parentElement?wrap.parentElement.offsetWidth:0;if(!avail)return;var s=Math.min(1,avail/nw);wrap.style.width=Math.round(nw*s)+'px';wrap.style.height=Math.round(nh*s)+'px';ifr.style.transform='scale('+s+')';}requestAnimationFrame(r);window.addEventListener('resize',r);})()</script></div>






.. GENERATED FROM PYTHON SOURCE LINES 33-38

Read the slice position on drag
-------------------------------
``pointer_move`` fires as the plane slides; ``plane.position`` is the current
location along its normal.  You can also move it from Python with
``plane.set(position=...)``.

.. GENERATED FROM PYTHON SOURCE LINES 38-48

.. code-block:: Python



    @plane.add_event_handler("pointer_move")
    def _on_drag(event):
        print("z-slice at", round(plane.position, 1))


    fig.set_help("Drag the blue plane along z to move the slice.")

    fig  # Interactive




.. raw:: html

    <div style="display:block;text-align:center;line-height:0;margin:12px 0;"><div id="sphx_glr_plot_widget3d_plane_002" class="awi-fig-wrap" data-awi-fig="sphx_glr_plot_widget3d_plane_002" style="display:inline-block;overflow:hidden;position:relative;width:536px;height:516px;"><iframe src="../../_static/viewer_widgets/sphx_glr_plot_widget3d_plane_002.html" data-awi-fig="sphx_glr_plot_widget3d_plane_002" frameborder="0" scrolling="no" style="width:536px;height:516px;border:none;overflow:hidden;display:block;transform-origin:top left;transform:scale(1);position:absolute;top:0;left:0;"></iframe><div class="awi-badge" data-awi-badge="sphx_glr_plot_widget3d_plane_002"><button class="awi-badge-icon awi-activate-btn" data-awi-fig="sphx_glr_plot_widget3d_plane_002" title="Make interactive (boots Pyodide — may take ~10 s)">&#x26A1;</button></div></div><script>(function(){var wrap=document.getElementById('sphx_glr_plot_widget3d_plane_002'),ifr=wrap.querySelector('iframe'),nw=536,nh=516;function r(){var avail=wrap.parentElement?wrap.parentElement.offsetWidth:0;if(!avail)return;var s=Math.min(1,avail/nw);wrap.style.width=Math.round(nw*s)+'px';wrap.style.height=Math.round(nh*s)+'px';ifr.style.transform='scale('+s+')';}requestAnimationFrame(r);window.addEventListener('resize',r);})()</script></div>



.. raw:: html

    <script type="text/x-python" data-fig-id="sphx_glr_plot_widget3d_plane_002" data-fig-index="1" data-src-file="plot_widget3d_plane" data-src="&quot;\&quot;\&quot;\&quot;\n3D Plane Widget\n===============\n\nA draggable axis-aligned plane in a 3-D panel, rendered as a translucent quad\nspanning the panel&#x27;s bounds.  Drag it in the browser to slide it along its\nnormal \u2014 ideal as a slice selector through a volume or point cloud.  Add it\nwith ``plot.add_widget(\&quot;plane\&quot;, axis=..., position=...)``.\n\&quot;\&quot;\&quot;\nimport numpy as np\nimport anyplotlib as apl\n\n# %%\n# A point cloud to slice\n# ----------------------\n# A Gaussian blob of points; the plane widget will pick out a z-slab.\n\nrng = np.random.default_rng(0)\nn = 4000\npts = rng.normal(0, 8, size=(n, 3)) + 24    # centred in a 0..48 box\nxs, ys, zs = pts[:, 0], pts[:, 1], pts[:, 2]\n\nfig, ax = apl.subplots(1, 1, figsize=(520, 500))\ncloud = ax.scatter3d(xs, ys, zs, color=\&quot;#4fc3f7\&quot;, point_size=3,\n                     x_label=\&quot;x\&quot;, y_label=\&quot;y\&quot;, z_label=\&quot;z\&quot;)\n\nplane = cloud.add_widget(\&quot;plane\&quot;, axis=\&quot;z\&quot;, position=24,\n                         color=\&quot;#40c4ff\&quot;, alpha=0.15)\n\nfig\n\n# %%\n# Read the slice position on drag\n# -------------------------------\n# ``pointer_move`` fires as the plane slides; ``plane.position`` is the current\n# location along its normal.  You can also move it from Python with\n# ``plane.set(position=...)``.\n\n\n@plane.add_event_handler(\&quot;pointer_move\&quot;)\ndef _on_drag(event):\n    print(\&quot;z-slice at\&quot;, round(plane.position, 1))\n\n\nfig.set_help(\&quot;Drag the blue plane along z to move the slice.\&quot;)\n\nfig  # Interactive\n&quot;"></script>







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

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


.. _sphx_glr_download_auto_examples_Widgets_plot_widget3d_plane.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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