hugoruscitti/pilas

# -*- encoding: utf-8 -*-
# pilas engine: un motor para hacer videojuegos
#
# Copyright 2010-2014 - Hugo Ruscitti
# License: LGPLv3 (see http://www.gnu.org/licenses/lgpl.html)
#
# Website - http://www.pilas-engine.com.ar


from pilasengine.actores.animado import Animado
import copy


class Animacion(Animado):
    """Representa una animacion de una grilla de imagenes.

    Este actor toma una grilla de cuadros de animacion
    y los reproduce hasta que la animacion termina. Cuando
    la animacion termina se elimina a si mismo.

    El constructor tiene algunos parámetros de utilidad:

        - El parámetro ``ciclica`` permite hacer animaciones infinitas,
         que se repiten siempre, por defecto vale ``False`` que significa que
         la animación terminará y no se repetirá.
        - El parámetro ``velocidad`` tiene que ser un número que indicará la
        cantidad de cuadros por segundo que se tienen que mostrar
        en la animación.

        Por ejemplo, para mostrar una explosión infinita podrías escribir:

        >>> grilla = pilas.imagenes.cargar_grilla("explosion.png", 7)
        >>> animacion = pilas.actores.Animacion(grilla, ciclica=True,
                                                velocidad=1)

        .. image:: ../../pilas/data/manual/imagenes/actores/explosion.png
    """

    def __init__(self, pilas, *k, **kv):
        Animado.__init__(self, pilas, *k, **kv)

    def pre_iniciar(self, grilla=None, ciclica=False, x=0, y=0, velocidad=10):
        """ Constructor de la Animación.

        :param grilla: Grilla de imagenes obtenida mediante
                       pilas.imagenes.cargar_grilla()
        :type grilla: `Grilla`
        :param ciclica: Indica si la animación se realizará de forma infinita.
        :type ciclica: boolean
        :param x: Posicion horizontal del Actor.
        :type x: int
        :param y: Posicion vertical del Actor.
        :type y: int
        :param velocidad: Indica la cantidad de cuadros por segundo
                          que se monstrarán.
        :type velocidad: int
        """

        if not grilla:
            grilla = self.pilas.imagenes.cargar_grilla('sin_imagen.png', 1)

        self.tick = 0
        self.x = x
        self.y = y
        self.imagen = copy.copy(grilla)
        self.definir_cuadro(0)
        self.ciclica = ciclica
        self.definir_velocidad_de_animacion(velocidad)

    def definir_velocidad_de_animacion(self, velocidad_de_animacion):
        """ Define la cantidad de frames por segundo que se mostrarán.

            :param velocidad_de_animacion: Cantidad de cuadros por segundo.
            :type velocidad_de_animacion: int
        """
        self._velocidad_de_animacion = (1000.0 / 60) * velocidad_de_animacion

    def obtener_velocidad_de_animacion(self):
        """ Obtiene la cantidad de cuadros por segundo de la animacion.

        :return: int
        """
        return self._velocidad_de_animacion

    velocidad_de_animacion = property(obtener_velocidad_de_animacion,
                                      definir_velocidad_de_animacion,
                                      doc="Es la cantidad de cuadros por \
                                      segundo a mostrar")

    def actualizar(self):
        """ Hace avanzar la animacion. """
        self.tick += self.velocidad_de_animacion

        if self.tick > 1000.0:
            self.tick -= 1000.0
            ha_avanzado = self.imagen.avanzar()

            # Si la animacion ha terminado se elimina de la pantalla.
            if not ha_avanzado and not self.ciclica:
                self.eliminar()