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 wx.adv.AnimationCtrl. If it contains multiple elements, they must be added to it using its 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:

Added in version 4.3/wxWidgets-3.3.0.

Class Hierarchy¶

Inheritance diagram for class AnimationBundle:

Methods Summary¶

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

Properties Summary¶

All

See GetAll

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.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

Default constructor creates an empty bundle.

Call Add later.

Return type:: None

__init__ (self, anim)

Implicit constructor from wx.adv.Animation for backwards compatibility.

Parameters:: anim (wx.adv.Animation)
Return type:: None

__init__ (self, filename, type=ANIMATION_TYPE_ANY)

Implicit constructor from animation file name for backwards compatibility.

Parameters:

filename (string)
type (AnimationType)

Return type:

None

__init__ (self)

Parameters:: `` (wx.adv.AnimationBundle)
Return type:: None

Add(self, *args, **kw)¶

Overloaded Implementations:

Add (self, anim)

Add an animation in another, bigger, size.

Parameters:: anim (wx.adv.Animation)
Return type:: None

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.

Parameters:

filename (string)
type (AnimationType)

Return type:

None

GetAll(self)¶

Get vector containing all animations in this bundle.

The vector can be empty.

Return type:: std.vectorwxAnimation

IsOk(self)¶

Return True if this animation bundle is not empty.

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

Return type:: bool

Properties¶

All¶: See GetAll