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

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

.. _sphx_glr_auto_examples_07_ui_viz_spinbox.py:


===========
SpinBox UI
===========

This example shows how to use the UI API. We will demonstrate how to create
a SpinBox UI.

First, some imports.

.. GENERATED FROM PYTHON SOURCE LINES 12-18

.. code-block:: Python


    import numpy as np

    from fury import actor, ui, utils, window
    from fury.data import fetch_viz_icons


.. GENERATED FROM PYTHON SOURCE LINES 19-20

First we need to fetch some icons that are included in FURY.

.. GENERATED FROM PYTHON SOURCE LINES 20-23

.. code-block:: Python


    fetch_viz_icons()


.. GENERATED FROM PYTHON SOURCE LINES 24-25

Let's create a Cone.

.. GENERATED FROM PYTHON SOURCE LINES 25-33

.. code-block:: Python


    cone = actor.cone(
        centers=np.random.rand(1, 3),
        directions=np.random.rand(1, 3),
        colors=(1, 1, 1),
        heights=np.random.rand(1),
    )


.. GENERATED FROM PYTHON SOURCE LINES 34-35

Creating the SpinBox UI.

.. GENERATED FROM PYTHON SOURCE LINES 35-45

.. code-block:: Python


    spinbox = ui.SpinBox(
        position=(200, 100),
        size=(300, 100),
        min_val=0,
        max_val=360,
        initial_val=180,
        step=10,
    )


.. GENERATED FROM PYTHON SOURCE LINES 46-48

Now that all the elements have been initialised, we add them to the show
manager.

.. GENERATED FROM PYTHON SOURCE LINES 48-55

.. code-block:: Python


    current_size = (800, 800)
    show_manager = window.ShowManager(size=current_size, title="FURY SpinBox Example")

    show_manager.scene.add(cone)
    show_manager.scene.add(spinbox)


.. GENERATED FROM PYTHON SOURCE LINES 56-57

Using the on_change hook to rotate the cone.

.. GENERATED FROM PYTHON SOURCE LINES 57-71

.. code-block:: Python


    # Tracking previous value to check in/decrement.
    previous_value = spinbox.value


    def rotate_cone(spinbox):
        global previous_value
        change_in_value = spinbox.value - previous_value
        utils.rotate(cone, (change_in_value, 1, 0, 0))
        previous_value = spinbox.value


    spinbox.on_change = rotate_cone


.. GENERATED FROM PYTHON SOURCE LINES 72-73

Starting the ShowManager.

.. GENERATED FROM PYTHON SOURCE LINES 73-80

.. code-block:: Python


    interactive = False

    if interactive:
        show_manager.start()

    window.record(show_manager.scene, size=current_size, out_path="viz_spinbox.png")


.. _sphx_glr_download_auto_examples_07_ui_viz_spinbox.py:

.. only:: html

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

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

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

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

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


.. only:: html

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

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