control module
==============

LavaVu python interface

Interactive HTML UI controls library
These functions can be called from the ControlFactory provided on

- lavavu.Viewer()
- lavavu.Object()
- lavavu.Properties()

Some work only on the viewer and some only to objects and some to both.
Each will provide a control that allows modifying visualisation properties or executing commands interactively
in an IPython notebook environment

Example
-------

Create a Button control to execute a rotation command:

>>> lv = lavavu.Viewer()
>>> lv.control.Button('rotate x 1')

Create a Range control to adjust the pointsize property:

>>> lv = lavavu.Viewer()
>>> pts = lv.points()
>>> pts.control.Range('pointsize', range=[1, 10])

For convenience, controls to set visualisation properties can often be created by calling control directly with the property name
This will create a control of the default type for for that property if one is defined, e.g.

>>> lv = lavavu.Viewer()
>>> pts = lv.points()
>>> pts.control('pointsize')


Module Summary
--------------
classes:
~~~~~~~~

.. autosummary::
    :nosignatures:

    control.Button
    control.Checkbox
    control.Colour
    control.ColourMapList
    control.ColourMaps
    control.Command
    control.Divider
    control.DualRange
    control.Entry
    control.File
    control.Filter
    control.Gradient
    control.List
    control.Number
    control.Number2D
    control.Number3D
    control.ObjectList
    control.ObjectSelect
    control.Panel
    control.Range
    control.Range2D
    control.Range3D
    control.Rotation
    control.Tabs
    control.TimeStepper
    control.Window

Module Details
--------------
classes:
~~~~~~~~
.. autoclass:: control.Button
    :members:
    :show-inheritance:
.. autoclass:: control.Checkbox
    :members:
    :show-inheritance:
.. autoclass:: control.Colour
    :members:
    :show-inheritance:
.. autoclass:: control.ColourMapList
    :members:
    :show-inheritance:
.. autoclass:: control.ColourMaps
    :members:
    :show-inheritance:
.. autoclass:: control.Command
    :members:
    :show-inheritance:
.. autoclass:: control.Divider
    :members:
    :show-inheritance:
.. autoclass:: control.DualRange
    :members:
    :show-inheritance:
.. autoclass:: control.Entry
    :members:
    :show-inheritance:
.. autoclass:: control.File
    :members:
    :show-inheritance:
.. autoclass:: control.Filter
    :members:
    :show-inheritance:
.. autoclass:: control.Gradient
    :members:
    :show-inheritance:
.. autoclass:: control.List
    :members:
    :show-inheritance:
.. autoclass:: control.Number
    :members:
    :show-inheritance:
.. autoclass:: control.Number2D
    :members:
    :show-inheritance:
.. autoclass:: control.Number3D
    :members:
    :show-inheritance:
.. autoclass:: control.ObjectList
    :members:
    :show-inheritance:
.. autoclass:: control.ObjectSelect
    :members:
    :show-inheritance:
.. autoclass:: control.Panel
    :members:
    :show-inheritance:
.. autoclass:: control.Range
    :members:
    :show-inheritance:
.. autoclass:: control.Range2D
    :members:
    :show-inheritance:
.. autoclass:: control.Range3D
    :members:
    :show-inheritance:
.. autoclass:: control.Rotation
    :members:
    :show-inheritance:
.. autoclass:: control.Tabs
    :members:
    :show-inheritance:
.. autoclass:: control.TimeStepper
    :members:
    :show-inheritance:
.. autoclass:: control.Window
    :members:
    :show-inheritance: