.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.adv.AnimationBundle:

==========================================================================================================================================
|phoenix_title|  **wx.adv.AnimationBundle**
==========================================================================================================================================

Container for possible multiple versions of the same animation in different resolutions. 
         

This class is used to pass either one or multiple animations to use in :ref:`wx.adv.AnimationCtrl`. If it contains multiple elements, they must be added to it using its :meth:`~wx.adv.AnimationBundle.Add`  function in ascending size order and, in particular, the first element defines the size of the animation in standard ``DPI``, with the other elements containing versions of the animation to use in higher ``DPI``. 

Example of using this class to pass a normal and high ``DPI`` version of a "throbbing" animation to the control and let it choose the one most appropriate to the current resolution automatically: 




         



.. versionadded:: 4.3/wxWidgets-3.3.0  
     







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>AnimationBundle</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.adv.AnimationBundle_inheritance.svg" alt="Inheritance diagram of AnimationBundle" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.adv.AnimationBundle.html" title="Container for possible multiple versions of the same animation in different resolutions." alt="" coords="5,5,210,34"/> </map> 
   </p>
   </div>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.adv.AnimationBundle.__init__`                                         Default constructor creates an empty bundle.
:meth:`~wx.adv.AnimationBundle.Add`                                              Add an animation in another, bigger, size.
:meth:`~wx.adv.AnimationBundle.GetAll`                                           Get vector containing all animations in this bundle.
:meth:`~wx.adv.AnimationBundle.IsOk`                                             Return ``True`` if this animation bundle is not empty.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.adv.AnimationBundle.All`                                              See :meth:`~wx.adv.AnimationBundle.GetAll`
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.adv.AnimationBundle(object)

   **Possible constructors**::

       AnimationBundle() -> None
       
       AnimationBundle(anim) -> None
       
       AnimationBundle(filename, type=ANIMATION_TYPE_ANY) -> None
       
       AnimationBundle() -> None
       
   
   Container for possible multiple versions of the same animation in
   different resolutions.



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations:**

      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self)`
      
      Default constructor creates an empty bundle. 
                       
      
      Call :meth:`Add`   later. 
                       
      
      :rtype: `None`     
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self, anim)`
      
      Implicit constructor from :ref:`wx.adv.Animation`  for backwards compatibility. 
                       
      
      
      :param `anim`: 
      :type `anim`: wx.adv.Animation
      
      
      
      
      :rtype: `None`     
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self, filename, type=ANIMATION_TYPE_ANY)`
      
      Implicit constructor from animation file name for backwards compatibility. 
                       
      
      
      :param `filename`: 
      :type `filename`: string
      :param `type`: 
      :type `type`: wx.adv.AnimationType
      
      
      
      
      :rtype: `None`     
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self)`
      
      
      
      
      :param ``: 
      :type ``: wx.adv.AnimationBundle
      
      
      
      
      :rtype: `None`     
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`






   .. method:: Add(self, *args, **kw)



      |overload| **Overloaded Implementations:**

      :html:`<hr class="overloadsep" /><br />`

      
      **Add** `(self, anim)`
      
      Add an animation in another, bigger, size. 
                       
      
      
      :param `anim`: 
      :type `anim`: wx.adv.Animation
      
      
      
      
      :rtype: `None`     
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`

      
      **Add** `(self, filename, type=ANIMATION_TYPE_ANY)`
      
      This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. 
                       
      
      
      :param `filename`: 
      :type `filename`: string
      :param `type`: 
      :type `type`: wx.adv.AnimationType
      
      
      
      
      :rtype: `None`     
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`






   .. method:: GetAll(self)

      Get vector containing all animations in this bundle. 
                 

      The vector can be empty. 
                 

      :rtype: `std.vectorwxAnimation`     








   .. method:: IsOk(self)

      Return ``True`` if this animation bundle is not empty. 
                 

      Notice that any elements of the bundle are always valid animations. 
                 

      :rtype: `bool`








   .. attribute:: All

      See :meth:`~wx.adv.AnimationBundle.GetAll`