# -*- encoding: utf-8 -*-
# Pilas engine - A video game framework.
#
# Copyright 2010 - Hugo Ruscitti
# License: LGPLv3 (see http://www.gnu.org/licenses/lgpl.html)
#
# Website - http://www.pilas-engine.com.ar

import pilas

def cargar(ruta):
    """Intenta cargar la imagen indicada por el argumento ``ruta``.

    Por ejemplo::

        import pilas

        imagen = pilas.imagenes.cargar("mi_archivo.png")

    En caso de éxito retorna el objeto Image, que se puede asignar
    a un Actor.

    El directorio de búsqueda de la imagen sigue el siguiente orden:

        * primero busca en el directorio actual.
        * luego en 'data'.
        * por último en el directorio estándar de la biblioteca.

    En caso de error genera una excepción de tipo IOError.
    """

    if not pilas.mundo:
        mensaje = "Tiene que invocar a la funcion ``pilas.iniciar()`` para comenzar."
        print mensaje
        raise Exception(mensaje)

    ruta = pilas.utils.obtener_ruta_al_recurso(ruta)
    return pilas.mundo.motor.cargar_imagen(ruta)

def cargar_grilla(ruta, columnas=1, filas=1):
    """Representa una grilla de imagenes con varios cuadros de animación.

    Una grilla es un objeto que se tiene que inicializar con la ruta
    a una imagen, la cantidad de columnas y filas.

    Por ejemplo, si tenemos una grilla con 2 columnas y 3 filas
    podemos asociarla a un actor de la siguiente manera::

        grilla = pilas.imagenes.cargar_grilla("animacion.png", 2, 3)
        grilla.asignar(actor)

    Entonces, a partir de ahora nuestro actor muestra solamente un
    cuadro de toda la grilla.

    Si quieres avanzar la animacion tienes que modificar el objeto
    grilla y asignarlo nuevamente al actor::

        grilla.avanzar()
        grilla.asignar(actor)
    """
    if not pilas.mundo:
        mensaje = "Tiene que invocar a la funcion ``pilas.iniciar()`` para comenzar."
        print mensaje
        raise Exception(mensaje)

    ruta = pilas.utils.obtener_ruta_al_recurso(ruta)
    return pilas.mundo.motor.obtener_grilla(ruta, columnas, filas)

def cargar_lienzo():
    """Representa un rectangulo (inicialmente transparente) para dibujar."""
    return pilas.mundo.motor.obtener_lienzo()

def cargar_superficie(ancho, alto):
    return pilas.mundo.motor.obtener_superficie(ancho, alto)

cargar_imagen = cargar
