Package ecore :: Module c_ecore :: Class Animator
[hide private]
[frames] | no frames]

Class Animator

object --+
         |
        Animator

Creates an animator to tick off at every animaton tick during main loop execution.

This class represents an animator that will call the given func every N seconds where N is the frametime interval set by animator_frametime_set(). The function will be passed any extra parameters given to constructor.

When the animator func is called, it must return a value of either True or False (remember that Python returns None if no value is explicitly returned and None evaluates to False). If it returns True, it will be called again at the next tick, or if it returns False it will be deleted automatically making any references/handles for it invalid.

Animators should be stopped/deleted by means of delete() or returning False from func, otherwise they'll continue alive, even if the current python context delete it's reference to it.

func signature: func(*args, **kargs): bool

Instance Methods [hide private]
 
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
a new object with type S, a subtype of T
__new__(T, S, ...)
 
__repr__(...)
repr(x)
 
__str__(...)
str(x)
 
delete(...)
Stop callback emission and free internal resources.
 
stop(...)
Alias for delete().

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__

__new__(T, S, ...)

 
Returns: a new object with type S, a subtype of T
Overrides: object.__new__

__repr__(...)
(Representation operator)

 

repr(x)

Overrides: object.__repr__
(inherited documentation)

__str__(...)
(Informal representation operator)

 

str(x)

Overrides: object.__str__
(inherited documentation)