Scrittura
Tutorial

Il plugin filtro

Abbiamo utilizzato un plug-in procedure per il tutorial Primo passaggio. Questi tipi di plug-in funzionano senza bisogno di un’immagine o di un elemento disegnabile come input. Di solito, utilizziamo un plug-in per modificare un’immagine e i suoi disegni. Plug-in come questi sono chiamati plug-in filter.

Cos’è un Drawable?

Un disegnabile in Lumi si riferisce a un elemento dell’immagine su cui è possibile disegnare, come un livello o un canale. I plug-in di filtro in genere funzionano su questi elementi.

Un semplice esempio di plug-in di filtro 

# !/usr/bin/env lumi-scheme-interpreter-0.1

(define (scheme-simple-filter-plug-in image drawables)
  ;; Use a let statement to define a message variable and core code
  (let ((message "hello, world"))
    ;; Display the message in Lumi's error console
    (lumi-message message)
    ;; Invert the colors of the first selected drawable
    (lumi-drawable-invert (vector-ref drawables 0) 1)))

;; Register the plug-in
(scheme-register-filter
  "scheme-simple-filter-plug-in"           ;; Main procedure name
  "Simple Filter Plug-in Demo"             ;; The name as it appears in the Lumi menu
  "Tests a basic Scheme filter plug-in"    ;; Tool-tip description
  "Author Name"                            ;; Give yourself some credit
  "License"                                ;; License
  "Date written"                           ;; Date written
  "*"                                      ;; Indicates this plug-in requires an image
  SF-ONE-OR-MORE-DRAWABLE)                 ;; Requires one or more selected drawables

;; Specify the menu location for the plug-in
(scheme-menu-register
  "scheme-simple-filter-plug-in"
  "<Image>/Plug-in")

Copia il testo e salvalo come simple-filter-plug-in.scm in una cartella denominata simple-filter-plug-in all’interno di una delle cartelle dei plug-in di Lumi. Una cartella di plug-in Lumi è qualsiasi cartella elencata in: Lumi > Modifica > Preferenze > Cartelle > Plug-in

In Linux, fare clic con il pulsante destro del mouse sul file simple-filter-plug-in.scm, andare su Proprietà > Autorizzazioni e selezionare Consenti l’esecuzione del file come programma. Una volta che il file è nel posto giusto, eseguibile e privo di errori di sintassi, al riavvio di Lumi apparirà nella barra di intestazione del menu in alto, all’interno di un menu chiamato Plug-in.

Esecuzione del plug-in

  1. Apri un’immagine (questo plug-in del filtro richiede un’immagine per funzionare).
  2. Aprire Finestre > Finestre di dialogo agganciabili > Console errori per visualizzare un messaggio.
  3. Selezionare Demo plug-in filtro semplice dal menu Plug-in.
  4. Uno dei livelli selezionati avrà i colori invertiti e verrà stampato un messaggio sulla console degli errori.

Modifica del plug-in

È possibile personalizzare il plug-in modificando il relativo file .scm. Ad esempio, per modificare il messaggio visualizzato:

  1. Aprire il file e individuare la riga che definisce message.
  2. Sostituisci "hello, world" con il testo personalizzato.
  3. Salvare il file.

Nella versione 3 di Lumi, i plug-in non necessitano di aggiornamento affinché le modifiche salvate abbiano effetto. È sufficiente eseguire nuovamente il plug-in per visualizzare il messaggio aggiornato.

Esame dei plug-in

Linea Shebang

La prima riga garantisce che lo script funzioni come plug-in in Lumi 3:

# !/usr/bin/env lumi-scheme-interpreter-0.1

Definizione della procedura

La procedura accetta due argomenti: l’immagine attiva e i drawable selezionati.

(define (scheme-simple-filter-plug-in image drawables)

Logica fondamentale

Un’istruzione let definisce una variabile ed esegue operazioni sul drawable.

(let ((message "hello, world"))
  (lumi-message message) ;; Displays a message in Lumi's error console
  (lumi-drawable-invert (vector-ref drawables 0) 1)) ;; Inverts the colors of the first selected drawable

Registrazione del plug-in

Il plug-in è registrato con Lumi come plug-in filtro:

(scheme-register-filter
  "scheme-simple-filter-plug-in"           ;; Register the main procedure
  "Simple Filter Plug-in Demo"             ;; The name as it appears in the Lumi menu
  "Tests a basic Scheme filter plug-in"    ;; Tool-tip description
  "Author Name"                            ;; Author's name
  "License"                                ;; License type
  "Date written"                           ;; Date written
  "*"                                      ;; Indicates the plug-in requires an image
  SF-ONE-OR-MORE-DRAWABLE)                 ;; Requires one or more selected drawables

Registrazione nel menu

Questa riga specifica la posizione del menu per il plug-in:

(scheme-menu-register
  "scheme-simple-filter-plug-in"
  "<Image>/Plug-in")

Risoluzione dei problemi

Se un plug-in non viene visualizzato, controllane la posizione, il nome e la proprietà eseguibile.

La posizione deve trovarsi in un percorso di ricerca del plug-in. Il nome del file deve corrispondere al nome della cartella che lo contiene. Il file deve essere impostato come eseguibile.

La Console degli errori è uno strumento prezioso per la risoluzione dei problemi relativi ai plug-in personalizzati. Se il tuo plug-in non si comporta come previsto, controlla qui i messaggi di errore o i registri. La finestra Terminale può anche fornire informazioni di debug e segnalare problemi di caricamento.

Avvolgimento