Script
Tutoriels

Le plugin de filtre

Nous avons utilisé un plug-in procedure pour le didacticiel Première étape. Ces types de plug-ins fonctionnent sans avoir besoin d’une image ou d’un dessin en entrée. Habituellement, nous utilisons un plug-in pour modifier une image et ses dessins. Les plug-ins comme ceux-ci sont appelés plug-ins filter.

Qu’est-ce qu’un Drawable ?

Un dessinable dans Lumi fait référence à un élément d’image sur lequel on peut dessiner, comme un calque ou un canal. Les plug-ins de filtre fonctionnent généralement sur ces éléments.

Un exemple simple de plug-in de filtre 

# !/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")

Copiez le texte et enregistrez-le sous simple-filter-plug-in.scm dans un dossier appelé simple-filter-plug-in dans l’un des dossiers de plug-ins Lumi. Un dossier de plug-ins Lumi est n’importe quel dossier répertorié sous : Lumi > Édition > Préférences > Dossiers > Plug-ins

Sous Linux, cliquez avec le bouton droit sur le fichier simple-filter-plug-in.scm, accédez à Propriétés > Autorisations et cochez Autoriser l’exécution du fichier en tant que programme. Une fois le fichier au bon endroit, exécutable et exempt d’erreurs de syntaxe, au redémarrage de Lumi, il apparaîtra dans la barre d’en-tête du menu supérieur, à l’intérieur d’un menu appelé Plug-in.

Exécution du plug-in

  1. Ouvrez une image (ce plug-in de filtre nécessite une image pour fonctionner).
  2. Ouvrez Windows > Boîtes de dialogue ancrables > Console d’erreurs pour voir un message.
  3. Sélectionnez Démo du plug-in de filtre simple dans le menu Plug-in.
  4. L’un des calques sélectionnés verra ses couleurs inversées et un message sera imprimé sur la console d’erreur.

Modification du plug-in

Vous pouvez personnaliser le plug-in en éditant son fichier .scm. Par exemple, pour modifier le message affiché :

  1. Ouvrez le fichier et localisez la ligne définissant message.
  2. Remplacez "hello, world" par votre texte personnalisé.
  3. Enregistrez le fichier.

Dans Lumi version 3, les plug-ins n’ont pas besoin d’être actualisés pour que les modifications enregistrées prennent effet. Réexécutez simplement le plug-in pour voir le message mis à jour.

Examen du plug-in

Ligne Shebang

La première ligne garantit que le script fonctionne comme un plug-in dans Lumi 3 :

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

Définition de la procédure

La procédure accepte deux arguments : l’image active et les drawables sélectionnés.

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

Logique de base

Une instruction let définit une variable et effectue des opérations sur le dessinable.

(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

Enregistrement du plug-in

Le plug-in est enregistré auprès de Lumi en tant que plug-in de filtre :

(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

Menu Inscription

Cette ligne spécifie l’emplacement du menu du plug-in :

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

Dépannage

Si un plug-in n’apparaît pas, vérifiez son emplacement, son nom et sa propriété exécutable.

L’emplacement doit se trouver dans un chemin de recherche de plug-in. Le nom du fichier doit correspondre au nom du dossier contenant. Le fichier doit être défini comme exécutable.

La Console d’erreurs est un outil précieux pour dépanner les plug-ins personnalisés. Si votre plug-in ne se comporte pas comme prévu, recherchez ici les messages d’erreur ou les journaux. La fenêtre Terminal peut également fournir des informations de débogage et signaler les problèmes de chargement.

Emballage