.. role:: ts-api-decorator

##########
IndexedSet
##########

.. js:module:: Animation
   :noindex:

.. container:: ts-api-section

   .. js:class:: IndexedSet

      Provides the functionality of a ``Set`` with the addition of a
      monotonically-increasing index associated with each element.



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~Animation.IndexedSet.constructor`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~Animation.IndexedSet.add`
   * :js:meth:`~Animation.IndexedSet.getIndex`
   * :js:meth:`~Animation.IndexedSet.isEmpty`
   * :js:meth:`~Animation.IndexedSet.toArray`





------------

Constructors
============

.. container:: ts-api-section

   .. js:function:: IndexedSet.constructor()



      :rtype: IndexedSet <T>



Methods
=======

.. rst-class:: ts-api-section

add
---

.. js:method:: IndexedSet.add( value)

   :param value: None
   :type value: T


   :rtype: void

.. rst-class:: ts-api-section

getIndex
--------

.. js:method:: IndexedSet.getIndex( value)

   :param value: None
   :type value: T


   :rtype: number

.. rst-class:: ts-api-section

isEmpty
-------

.. js:method:: IndexedSet.isEmpty()



   :rtype: boolean

.. rst-class:: ts-api-section

toArray
-------

.. js:method:: IndexedSet.toArray()



   Returns an array containing each element of the set placed at its
   assigned index.


   :rtype: [T]

