==========================
AnimationToolbar (hwx.gui)
==========================

An AnimationToolbar Widget.

AnimationToolbar is a widget used to display the controls for the animation.

Inherits:
  - :ref:`Widget (hwx.gui)`

----------
Properties
----------

  +-----------------+-----------------+-----------------+
  | animatingState_ | frame_          | timeSteps_      |
  +-----------------+-----------------+-----------------+

--------------
Public Methods
--------------

  +--------------------------------------------------------+
  | addChildren_ (self)                                    |
  +--------------------------------------------------------+
  | addWidget_ (self, widget)                              |
  +--------------------------------------------------------+
  | onAnimRangeEnabled_ (self, enabled)                    |
  +--------------------------------------------------------+
  | onAnimationRangeChange_ (self, start_frame, end_frame) |
  +--------------------------------------------------------+
  | onFrameChange_ (self, frame, spontaneous)              |
  +--------------------------------------------------------+
  | onPause_ (self)                                        |
  +--------------------------------------------------------+
  | onResume_ (self)                                       |
  +--------------------------------------------------------+
  | onStart_ (self)                                        |
  +--------------------------------------------------------+
  | onStop_ (self)                                         |
  +--------------------------------------------------------+
  | resetRange_ (self)                                     |
  +--------------------------------------------------------+

----------------
Property Details
----------------

.. _animatingState:
.. method:: animatingState

The state of the animation.

Starts/Stops the animation.

.. _frame:
.. method:: frame

The current frame.

.. _timeSteps:
.. method:: timeSteps

The values for the animation time.

--------------
Method Details
--------------

.. _addChildren:
.. method:: addChildren(self)

Adds extra widgets.

You need to call the addWidget method.

.. _addWidget:
.. method:: addWidget(self, widget)

Adds a widget to the AnimationToolbar.

:param widget: The widget to be added to the layout.
:type widget: Widget

:returns: The added widget.
:rtype: Widget


.. _onAnimRangeEnabled:
.. method:: onAnimRangeEnabled(self, enabled)

Callback method when the animation range is enabled or disabled.

:param enabled: Animation range is enabled/disabled.
:type enabled: bool


.. _onAnimationRangeChange:
.. method:: onAnimationRangeChange(self, start_frame, end_frame)

Callback method when animation range has been changed.

:param start_frame: Starting frame number of the range.
:type start_frame: int
:param end_frame: Ending frame number of the range.
:type end_frame: int


.. _onFrameChange:
.. method:: onFrameChange(self, frame, spontaneous)

Callback method when animation frame changes.

:param frame: Frame number changed.
:type frame: int
:param spontaneous: Specifies if the frame change is spontaneous.
:type spontaneous: bool


.. _onPause:
.. method:: onPause(self)

Callback method when the animation pauses.

.. _onResume:
.. method:: onResume(self)

Callback method when the animation resumes.

.. _onStart:
.. method:: onStart(self)

Callback method when the animation starts.

.. _onStop:
.. method:: onStop(self)

Callback method when the animation stops.

.. _resetRange:
.. method:: resetRange(self)

Resets the animation range.