Scripting
Tutoriais

O plug-in de filtro

Usamos um plug-in procedure para o tutorial First Step. Esses tipos de plug-ins funcionam sem a necessidade de uma imagem ou drawable como entrada. Normalmente, usamos um plug-in para alterar uma imagem e seus drawables. Plug-ins como esses são chamados plug-ins de filtro.

O que é um drawable?

Um drawable no Lumi refere-se a um elemento de imagem que pode ser desenhado, como uma camada ou canal. Os plug-ins de filtro normalmente operam nesses elementos.

Um exemplo simples de plug-in de filtro 

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

(define (scheme-simple-filter-plug-in image drawables)
  ;; Usar uma instrução let para definir uma variável de mensagem e o código principal
  (let ((message "hello, world"))
    ;; Exibir a mensagem na console de erros do Lumi
    (lumi-message message)
    ;; Inverter as cores do primeiro drawable selecionado
    (lumi-drawable-invert (vector-ref drawables 0) 1)))

;; Registra o plug-in
(scheme-register-filter
  "scheme-simple-filter-plug-in"           ;; Nome do procedimento principal
  "Simple Filter Plug-in Demo"             ;; O nome como aparece no menu do Lumi
  "Tests a basic Scheme filter plug-in"    ;; Descrição da dica de ferramenta
  "Author Name"                            ;; Dê crédito a si mesmo
  "License"                                ;; Licença
  "Date written"                           ;; Data de escrita
  "*"                                      ;; Indica que este plug-in requer uma imagem
  SF-ONE-OR-MORE-DRAWABLE)                 ;; Requer um ou mais drawables selecionados

;; Especificar a localização do menu para o plug-in
(scheme-menu-register
  "scheme-simple-filter-plug-in"
  "<Image>/Plug-in")

Copie o texto e salve-o como simple-filter-plug-in.scm em uma pasta chamada simple-filter-plug-in dentro de uma das pastas de plug-ins do Lumi. Uma pasta de plug-ins do Lumi é qualquer pasta listada em: Lumi > Editar > Preferências > Pastas > Plug-ins

No Linux, clique com o botão direito no arquivo simple-filter-plug-in.scm, vá para Propriedades > Permissões e marque Permitir execução de arquivo como programa. Uma vez que o arquivo esteja no lugar certo, executável e livre de erros de sintaxe, quando o Lumi for reiniciado, ele aparecerá na barra de cabeçalho do menu superior, dentro de um menu chamado Plug-in.

Executando o plug-in

  1. Abra uma imagem (este plug-in de filtro requer uma imagem para funcionar).
  2. Abra Ferramentas > Depuração > Console de mensagens para ver uma mensagem.
  3. Selecione Demonstração de plug-in de filtro simples no menu Plug-in.
  4. Uma das camadas selecionadas terá suas cores invertidas e uma mensagem será impressa no console de erros.

Editando o plug-in

Você pode personalizar o plug-in editando seu arquivo .scm. Por exemplo, para alterar a mensagem exibida:

  1. Abra o arquivo e localize a linha que define message.
  2. Substitua "hello, world" pelo seu texto personalizado.
  3. Salve o arquivo.

No Lumi versão 3, os plug-ins não precisam ser atualizados para que as alterações salvas tenham efeito. Basta executar novamente o plug-in para ver a mensagem atualizada.

Exame de plug-in

Linha Shebang

A primeira linha garante que o script funcione como um plug-in no Lumi 3:

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

Definição de procedimento

O procedimento aceita dois argumentos: a imagem ativa e os drawables selecionados.

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

Lógica Central

Uma instrução let define uma variável e executa operações no drawable.

(let ((message "hello, world"))
  (lumi-message message) ;; Exibe uma mensagem na console de erros do Lumi
  (lumi-drawable-invert (vector-ref drawables 0) 1)) ;; Inverte as cores do primeiro drawable selecionado

Registro de plug-ins

O plug-in está registrado no Lumi como um plug-in de filtro:

(scheme-register-filter
  "scheme-simple-filter-plug-in"           ;; Registra o procedimento principal
  "Simple Filter Plug-in Demo"             ;; O nome como aparece no menu do Lumi
  "Tests a basic Scheme filter plug-in"    ;; Descrição da dica de ferramenta
  "Author Name"                            ;; Nome do autor
  "License"                                ;; Tipo de licença
  "Date written"                           ;; Data de escrita
  "*"                                      ;; Indica que o plug-in requer uma imagem
  SF-ONE-OR-MORE-DRAWABLE)                 ;; Requer um ou mais drawables selecionados

Registro do Menu

Esta linha especifica a localização do menu do plug-in:

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

Solução de problemas

Se um plug-in não aparecer, verifique sua localização, nome e propriedade executável.

O local deve estar em um caminho de procura de plug-in. O nome do arquivo deve corresponder ao nome da pasta que o contém. O arquivo deve ser definido como executável.

O Console de mensagens é uma ferramenta valiosa para solucionar problemas de plug-ins personalizados. Se o seu plug-in não se comportar conforme o esperado, verifique aqui se há mensagens de erro ou logs. A janela Terminal também pode fornecer informações de depuração e relatar problemas de carregamento.

Embrulho