Om toegang te krijgen tot functies van GIMP, beginnen we met import gi. Deze module kan uitzoeken welke functies beschikbaar zijn in elke module die wordt gedefinieerd met “object introspectie”. Wat dat voor ons betekent is dat we alle GIMP gerelateerde modules importeren, die we nodig zouden kunnen hebben, met het aanroepen van gi.repository.

Voor basis functionaliteit zouden alleen de modules Gimp en GimpUi voldoende kunnen zijn. Als u uw plug-in vanaf de opdrachtregel wilt uitvoeren, heeft u zelfs GimpUi niet nodig. Laten we beginnen met een voorbeeld.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
#   GIMP - The GNU Image Manipulation Program
#   Copyright (C) 1995 Spencer Kimball and Peter Mattis
#
#   gimp-tutorial-plug-in.py
#   sample plug-in to illustrate the Python plug-in writing tutorial
#   Copyright (C) 2023 Jacob Boerema
#
#   This program is free software: you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation; either version 3 of the License, or
#   (at your option) any later version.
#
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with this program.  If not, see <https://www.gnu.org/licenses/>.

import sys

import gi
gi.require_version('Gimp', '3.0')
from gi.repository import Gimp
gi.require_version('GimpUi', '3.0')
from gi.repository import GimpUi
from gi.repository import GLib
      

We beginnen met het importeren van sys, dat we aan het einde nodig hebben voor toegang tot sys.argv, gevolgd door import gi die Python vertelt dat het de module gi moet laden. Deze module wordt gebruikt voor toegang tot specifieke functies van GIMP via “object introspectie”.

In de volgende regel vertellen we gi dat we eisen dat de API-versie van GIMP versie 3.0 moet zijn. (Deze plug-in zal niet werken met oudere versies van GIMP.) De volgende regel verzoekt om alle functies, klassen, etc. te importeren uit de module Gimp.

De volgende twee regels doen hetzelfde voor GimpUi. GimpUi bevat alle aan de interface gerelateerde elementen voor GIMP. Als u van plan bent een plug-in te maken die alleen vanaf de opdrachtregel gaat worden aangeroepen, dan heeft u dit niet nodig. We besluiten met het importeren van GLib, dat we later nodig hebben voor toegang tot GLib.Error.

Er zijn andere optionele modules die u ook kunt gebruiken, zoals Gegl en Glib naast vele andere, maar we gaan daar hier verder niet op in.

GIMP moet weten welke functies beschikbaar zijn, welke functionaliteit zij ondersteunen en welke locatie van het menu te gebruiken. Daarvoor definiëren we een klasse die is afgeleid van de klasse Gimp.PlugIn.

Een minimale plug-in moet ten minste de volgende functies hebben gedefinieerd in deze klasse:

We zullen nu iets meer in detail treden. Hieronder is niet het eerste gedeelte opgenomen van de code voor Python, dat hierboven werd weergegeven. Dit geeft alleen de basis lay-out voor uw klasse weer.

class MyFirstPlugin (Gimp.PlugIn):
    def do_query_procedures(self):
        return [ "jb-plug-in-first-try" ]

    def do_set_i18n (self, name):
        return False

    def do_create_procedure(self, name):
        procedure = Gimp.ImageProcedure.new(self, name,
                                            Gimp.PDBProcType.PLUGIN,
                                            self.run, None)

        procedure.set_image_types("*")

        procedure.set_menu_label("My first Python plug-in")
        procedure.add_menu_path('<Image>/Filters/Tutorial/')

        procedure.set_documentation("My first Python plug-in tryout",
                                    "My first Python 3 plug-in for GIMP 3",
                                    name)
        procedure.set_attribution("Your name", "Your name", "2023")

        return procedure

    def run(self, procedure, run_mode, image, drawables, config, run_data):
        Gimp.message("Hello world!")
        # do what you want to do, then, in case of success, return:
        return procedure.new_return_values(Gimp.PDBStatusType.SUCCESS, GLib.Error())
      

Laten we eens wat beter kijken naar do_create_procedures. In de regel return [ "jb-plug-in-first-try" ] vertellen we GIMP wat de naam is van onze procedure: we noemen het "jb-plug-in-first-try". Dat is de naam die zal worden weergegeven in de Procedureverkenner van GIMP.

U mag meer dan een procedure hebben gedefinieerd in een plug-in. In dat geval zou u alle namen vermelden, gescheiden door een komma.

Het is een goede werkwijze om al uw procedures te beginnen met uw initialen of een andere herkenbare en unieke tag. Op deze manier is het minder waarschijnlijk dat uw naam hetzelfde zal zijn als de plug-in van iemand anders, wat GIMP in verwarring zou kunnen brengen. Daarnaast bent u vrij om het te noemen zoals u dat wilt.

Vervolgens vertellen we GIMP dat we geen vertalingen ondersteunen door False terug te geven in de aanroep naar do_set_i18n. Wat te doen als u wilt dat uw plug-in wordt vertaald, ligt buiten het bereik van deze handleiding.

De methode do_create_procedure is waar het meeste initialiseren van GIMP wordt uitgevoerd.

Elke plug-in wordt gestart met een aanroep naar Gimp.main.

        Gimp.main(MyFirstPlugin.__gtype__, sys.argv)
      

Het enige dat u in deze regel moet veranderen voor uw plug-in, is de naam van de klasse van uw plug-in, hier “MyFirstPlugin” genoemd.

Hieronder presenteren we het gehele script voor Python, wat uitgevoerd zou moeten kunnen worden, vooropgesteld dat het de juiste naam heeft gekregen in een map met dezelfde naam op een locatie die bekend is bij GIMP. Het zal de boodschap “Hello world!” weergeven in de foutconsole of in een pop-updialoogvenster.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
#   GIMP - The GNU Image Manipulation Program
#   Copyright (C) 1995 Spencer Kimball and Peter Mattis
#
#   gimp-tutorial-plug-in.py
#   sample plug-in to illustrate the Python plug-in writing tutorial
#   Copyright (C) 2023 Jacob Boerema
#
#   This program is free software: you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation; either version 3 of the License, or
#   (at your option) any later version.
#
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with this program.  If not, see <https://www.gnu.org/licenses/>.

import sys

import gi
gi.require_version('Gimp', '3.0')
from gi.repository import Gimp
gi.require_version('GimpUi', '3.0')
from gi.repository import GimpUi

from gi.repository import GLib

class MyFirstPlugin (Gimp.PlugIn):
    def do_query_procedures(self):
        return [ "jb-plug-in-first-try" ]

    def do_set_i18n (self, name):
        return False

    def do_create_procedure(self, name):
        procedure = Gimp.ImageProcedure.new(self, name,
                                            Gimp.PDBProcType.PLUGIN,
                                            self.run, None)

        procedure.set_image_types("*")

        procedure.set_menu_label("My first Python plug-in")
        procedure.add_menu_path('<Image>/Filters/Tutorial/')

        procedure.set_documentation("My first Python plug-in tryout",
                                    "My first Python 3 plug-in for GIMP 3.0",
                                    name)
        procedure.set_attribution("Your name", "Your name", "2023")

        return procedure

    def run(self, procedure, run_mode, image, drawables, config, run_data):
        Gimp.message("Hello world!")
        # do what you want to do, then, in case of success, return:
        return procedure.new_return_values(Gimp.PDBStatusType.SUCCESS, GLib.Error())

Gimp.main(MyFirstPlugin.__gtype__, sys.argv)