3.4. Su primer código de Script-Fu

¿No necesita parar y tomar algo? ¿No? Bien, entonces procederemos con la cuarta lección, su primer código de Script-Fu.

Ahora, registremos la función con el GIMP. Esto se hace llamando a la función <code>script-fu-register</code>. Cuando el GIMP lee en un script, ejecutará esta función, que registrará el script en la base de datos de procedimientos. Puede situar esta llamada a función donde quiera en su script, pero, normalmente, se situa al final, después de las otras lineas de códigos.

Aquí está el listado de registro de esta función (explicaré todos estos parámetros en un minuto):

        (script-fu-register
          "script-fu-text-box"                        ;func name
          "Text Box"                                  ;menu label
          "Creates a simple text box, sized to fit\
            around the user's choice of text,\
            font, font size, and color."              ;description
          "Michael Terry"                             ;author
          "copyright 1997, Michael Terry"             ;copyright notice
          "October 27, 1997"                          ;date created
          ""                     ;image type that the script works on
          SF-STRING      "Text:"         "Text Box"   ;a string variable
          SF-FONT        "Font:"         "Charter"    ;a font variable
          SF-ADJUSTMENT  "Font size"     '(50 1 1000 1 10 0 1)
                                                      ;a spin-button
          SF-COLOR       "Color:"        '(0 0 0)     ;color variable
        )
        (script-fu-menu-register "script-fu-text-box" "<Toolbox>/Xtns/Script-Fu/Text")
      

Si guardas estas funciones en un archivo de texto con el sufijo .scm en su directorio de script, seleccione Exts->Script-Fu->Refresh Scripts, este nuevo script aparecerá como Exts->Script-Fu->Text->Text Box.

Si llama a este nuevo script, no hará nada, desde luego, pero puede ver los apuntes creados cuando se registra el script (más información de lo que hicimos, se descubrirá luego).

Finalmente, si abre el examinador de procedimientos Exts->Examinador de procedimientos), notará que nuestro script aparece en la base de datos.

Para registrar nuestro script en elGIMP, llamamos a la función <code>script-fu-register</code>, rellenamos los siete parámetros requeridos y añadimos los nuestros propios, junto con una descripción y valores predefinidos para cada parámetro.

Los parámetros requeridos

  • El nombre de la función que definimos. Esto es la llamada de función cuando nuestro script es invocado (el punto de entrada de nuestro script). Esto es necesario porque podriamos definir funciones adicionales bajo el mismo archivo, y GIMP necesita saber a cuales de estas funciones se llama. En nuestro ejemplo, solo definimos una función, text box, que registramos.

  • La localización en el menú donde el script será insertado. El lugar exacto de el script está especificado, como una ruta en Unix, con la raiz de la ruta estando entre la caja de herramientas o click derecho. The location in the menu where the script will be inserted. The exact location of the script is specified like a path in Unix, with the root of the path being either toolbox or right-click.

    Si su script no opera sobre una imagen existente (y crea una imagen nueva, como hará nuestro Text Box), querrá insertarlo en el menú de la caja de herramientas, este es el menu en la ventana principal del GIMP (donde se localizan todas las herramientas: herramientas de selección, lupa, etc.).

    Si u script está intentando trabajar sobre una imagen que está siendo editada, querrá insertarla en el menú que aparece cuando pulsa el botón derecho sobre una imagen abierta. El resto de la ruta apunta a la lista de menú, menús y sub-menús. Resgistramos nuestro script Text Box en el menú Text de el menú Script-Fu del menú Exts, en el menú de la caja de herramientas ( Exts->Script-Fu->Text->Text Box ).

    Si se fija, el sub-menú Text, en el menú Script-Fu, no estaba allí cuando empezamos, el GIMP crea, automaticamente, cualquier menú que todavia no exista.

  • Una descripción de su script, para ser mostrada en el Examinador de Procedimientos.

  • Su nombre (el autor del código).

  • Información del copyright.

  • La fecha en que se hizó el código, o la última revisión del mismo.

  • El tipo de imágenes con las trabaja el script. Puede ser uno de los siguientes: RGB, RGBA, GRAY, GRAYA, INDEXED, INDEXEDA. O podría no ser ninguno de ellos, en nuestro caso, estamos creando una imagen, y no necesitamos definir el tipo de imagen sobre la que trabajaremos.