phoenix_title wx.adv.GenericAnimationCtrl

Generic implementation of wx.adv.AnimationCtrl interface.

If the platform supports a native animation control (currently just wxGTK) then this class implements the same interface internally in wxWidgets. One advantage of using this class instead of the native version is that this version of the control is capable of using animations in other formats than the ones supported by the gdk-pixbuf library used by wxGTK, which typically only supports ANIMATION_TYPE_GIF .

Note that to use this class you need to explicitly include the generic header after including the main one before using it, i.e.


class_hierarchy Class Hierarchy

Inheritance diagram for class GenericAnimationCtrl:

method_summary Methods Summary

__init__

Initializes the object and calls Create with all the parameters.

Create

Creates the control with the given anim animation.

CreateAnimation

Create a new animation object compatible with this control.

CreateCompatibleAnimation

Create a new animation object compatible with this control.

DrawCurrentFrame

Draw the current frame of the animation into given DC.

GetAnimation

Returns the animation associated with this control.

GetBackingStore

Returns a wx.Bitmap with the current frame drawn in it.

GetClassDefaultAttributes

GetInactiveBitmap

Returns the inactive bitmap shown in this control when the; see SetInactiveBitmap for more info.

IsPlaying

Returns True if the animation is being played.

IsUsingWindowBackgroundColour

Returns true if the window’s background colour is being used.

Load

Loads the animation from the given stream and calls SetAnimation .

LoadFile

Loads the animation from the given file and calls SetAnimation .

Play

This overload of Play lets you specify if the animation must loop or not.

SetAnimation

Sets the animation to play in this control.

SetInactiveBitmap

Sets the bitmap to show on the control when it’s not playing an animation.

SetUseWindowBackgroundColour

Specify whether the animation’s background colour is to be shown (the default), or whether the window background should show through.

Stop

Stops playing the animation.


api Class API

class wx.adv.GenericAnimationCtrl(Control)

Possible constructors:

GenericAnimationCtrl(parent, id=ID_ANY, anim=NullAnimation,
                     pos=DefaultPosition, size=DefaultSize, style=AC_DEFAULT_STYLE,
                     name=AnimationCtrlNameStr)

Generic implementation of AnimationCtrl interface.


Methods

__init__(self, parent, id=ID_ANY, anim=NullAnimation, pos=DefaultPosition, size=DefaultSize, style=AC_DEFAULT_STYLE, name=AnimationCtrlNameStr)

Initializes the object and calls Create with all the parameters.

Parameters


Create(self, parent, id=ID_ANY, anim=NullAnimation, pos=DefaultPosition, size=DefaultSize, style=AC_DEFAULT_STYLE, name=AnimationCtrlNameStr)

Creates the control with the given anim animation.

After control creation you must explicitly call Play to start to play the animation. Until that function won’t be called, the first frame of the animation is displayed.

Parameters
  • parent (wx.Window) – Parent window, must be not None.

  • id (wx.WindowID) – The identifier for the control.

  • anim (wx.adv.Animation) – The initial animation shown in the control.

  • pos (wx.Point) – Initial position.

  • size (wx.Size) – Initial size.

  • style (long) – The window style, see AC_ flags.

  • name (string) – Control name.

Return type

bool

Returns

True if the control was successfully created or False if creation failed.



CreateAnimation(self)

Create a new animation object compatible with this control.

A wx.adv.Animation object created using this function is always compatible with controls of this type, see wx.adv.Animation.IsCompatibleWith .

Return type

wx.adv.Animation

New in version 4.1/wxWidgets-3.1.4.



static CreateCompatibleAnimation()

Create a new animation object compatible with this control.

This method does the same thing as CreateAnimation but is static, i.e. can be called without creating any wx.adv.AnimationCtrl objects.

Return type

wx.adv.Animation

New in version 4.1/wxWidgets-3.1.4.



DrawCurrentFrame(self, dc)

Draw the current frame of the animation into given DC.

This is fast as current frame is always cached.

Parameters

dc (wx.DC) –



GetAnimation(self)

Returns the animation associated with this control.

Return type

wx.adv.Animation



GetBackingStore(self)

Returns a wx.Bitmap with the current frame drawn in it.

Return type

Bitmap



static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
Parameters

variant (WindowVariant) –

Return type

VisualAttributes



GetInactiveBitmap(self)

Returns the inactive bitmap shown in this control when the; see SetInactiveBitmap for more info.

Return type

Bitmap



IsPlaying(self)

Returns True if the animation is being played.

Return type

bool



IsUsingWindowBackgroundColour(self)

Returns true if the window’s background colour is being used.

Return type

bool



Load(self, file, animType=ANIMATION_TYPE_ANY)

Loads the animation from the given stream and calls SetAnimation .

See wx.adv.Animation.Load for more info.

Parameters
Return type

bool



LoadFile(self, file, animType=ANIMATION_TYPE_ANY)

Loads the animation from the given file and calls SetAnimation .

See wx.adv.Animation.LoadFile for more info.

Parameters
Return type

bool



Play(self, *args, **kw)

overload Overloaded Implementations:



Play (self, looped)

This overload of Play lets you specify if the animation must loop or not.

Parameters

looped (bool) –

Return type

bool



Play (self)

Starts playing the animation.

The animation is always played in loop mode (unless the last frame of the animation has an infinite delay time) and always start from the first frame even if you stopped it while some other frame was displayed.

Return type

bool





SetAnimation(self, anim)

Sets the animation to play in this control.

If the previous animation is being played, it’s Stop stopped. Until Play isn’t called, a static image, the first frame of the given animation or the background colour will be shown (see SetInactiveBitmap for more info).

Parameters

anim (wx.adv.Animation) –



SetInactiveBitmap(self, bmp)

Sets the bitmap to show on the control when it’s not playing an animation.

If you set as inactive bitmap wx.NullBitmap (which is the default), then the first frame of the animation is instead shown when the control is inactive; in this case, if there’s no valid animation associated with the control (see SetAnimation ), then the background colour of the window is shown.

If the control is not playing the animation, the given bitmap will be immediately shown, otherwise it will be shown as soon as Stop is called.

Note that the inactive bitmap, if smaller than the control’s size, will be centered in the control; if bigger, it will be stretched to fit it.

Parameters

bmp (wx.Bitmap) –



SetUseWindowBackgroundColour(self, useWinBackground=True)

Specify whether the animation’s background colour is to be shown (the default), or whether the window background should show through.

Parameters

useWinBackground (bool) –



Stop(self)

Stops playing the animation.

The control will show the first frame of the animation, a custom static image or the window’s background colour as specified by the last SetInactiveBitmap call.


Properties

Animation

See GetAnimation and SetAnimation



BackingStore

See GetBackingStore



InactiveBitmap

See GetInactiveBitmap and SetInactiveBitmap