summaryrefslogtreecommitdiffstats
path: root/pdb/groups/selection_tools.pdb
blob: b71f86dac23d5baa3f977696644b9802bc3af5ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
# GIMP - The GNU Image Manipulation Program
# Copyright (C) 1995 Spencer Kimball and Peter Mattis

# 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/>.

# "Perlized" from C source by Manish Singh <yosh@gimp.org>

sub by_color_select {
    &std_pdb_deprecated ('gimp-image-select-color');

    @inargs = (
	{ name => 'drawable', type => 'drawable',
	  desc => 'The affected drawable' },
	{ name => 'color', type => 'color',
	  desc => 'The color to select' },
	{ name => 'threshold', type => '0 <= int32 <= 255',
	  desc => 'Threshold in intensity levels' },
	{ name => 'operation', type => 'enum GimpChannelOps',
	  desc => 'The selection operation' },
	{ name => 'antialias', type => 'boolean',
	  desc => 'Antialiasing' },
	{ name => 'feather', type => 'boolean',
	  desc => 'Feather option for selections' },
	{ name => 'feather_radius', type => '0 <= float',
	  desc => 'Radius for feather operation' },
	{ name => 'sample_merged', type => 'boolean',
	  desc => 'Use the composite image, not the drawable' }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpImage *image = gimp_item_get_image (GIMP_ITEM (drawable));

  gimp_channel_select_by_color (gimp_image_get_mask (image), drawable,
                                sample_merged,
                                &color,
                                threshold / 255.0,
                                FALSE /* don't select transparent */,
                                GIMP_SELECT_CRITERION_COMPOSITE,
                                operation,
                                antialias,
                                feather,
                                feather_radius,
                                feather_radius);
}
CODE
    );
}


sub by_color_select_full {
    &std_pdb_deprecated ('gimp-image-select-color');
    &david_pdb_misc('2006','2.4');

    @inargs = (
	{ name => 'drawable', type => 'drawable',
	  desc => 'The affected drawable' },
	{ name => 'color', type => 'color',
	  desc => 'The color to select' },
	{ name => 'threshold', type => '0 <= int32 <= 255',
	  desc => 'Threshold in intensity levels' },
	{ name => 'operation', type => 'enum GimpChannelOps',
	  desc => 'The selection operation' },
	{ name => 'antialias', type => 'boolean',
	  desc => 'Antialiasing' },
	{ name => 'feather', type => 'boolean',
	  desc => 'Feather option for selections' },
	{ name => 'feather_radius_x', type => '0 <= float',
	  desc => 'Radius for feather operation in X direction' },
	{ name => 'feather_radius_y', type => '0 <= float',
	  desc => 'Radius for feather operation in Y direction' },
	{ name => 'sample_merged', type => 'boolean',
	  desc => 'Use the composite image, not the drawable' },
        { name => 'select_transparent', type => 'boolean',
          desc => "Whether to consider transparent pixels for selection.
                   If TRUE, transparency is considered as a unique selectable
                   color." },
        { name => 'select_criterion', type => 'enum GimpSelectCriterion',
          desc => "The criterion used to determine color similarity.
                   SELECT_CRITERION_COMPOSITE is the standard choice.
		   " },
    );

    %invoke = (
	code => <<'CODE'
{
  GimpImage *image = gimp_item_get_image (GIMP_ITEM (drawable));

  gimp_channel_select_by_color (gimp_image_get_mask (image), drawable,
                                sample_merged,
                                &color,
                                threshold / 255.0,
				select_transparent,
                                select_criterion,
                                operation,
                                antialias,
                                feather,
                                feather_radius_x,
                                feather_radius_y);
}
CODE
    );
}


sub ellipse_select {
    &std_pdb_deprecated ('gimp-image-select-ellipse');

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' },
	{ name => 'x', type => 'float',
	  desc => 'x coordinate of upper-left corner of ellipse bounding box' },
	{ name => 'y', type => 'float',
	  desc => 'y coordinate of upper-left corner of ellipse bounding box' },
	{ name => 'width', type => '0 < float',
	  desc => 'The width of the ellipse' },
	{ name => 'height', type => '0 < float',
	  desc => 'The height of the ellipse' },
	{ name => 'operation', type => 'enum GimpChannelOps',
	  desc => 'The selection operation' },
	{ name => 'antialias', type => 'boolean',
	  desc => 'Antialiasing' },
	{ name => 'feather', type => 'boolean',
	  desc => 'Feather option for selections' },
	{ name => 'feather_radius', type => '0 <= float',
	  desc => 'Radius for feather operation' }
    );

    %invoke = (
	code => <<'CODE'
{
  gimp_channel_select_ellipse (gimp_image_get_mask (image),
                               (gint) x, (gint) y,
                               (gint) width, (gint) height,
                               operation,
                               antialias,
                               feather,
                               feather_radius,
                               feather_radius,
                               TRUE);
}
CODE
    );
}


sub free_select {
    &std_pdb_deprecated ('gimp-image-select-polygon');

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' },
        { name => 'segs', type => 'floatarray',
          desc => 'Array of points: { p1.x, p1.y, p2.x, p2.y, ...,
                   pn.x, pn.y}',
          array => { type => '2 <= int32',
                     desc => 'Number of points (count 1 coordinate as two
                              points)' } },
	{ name => 'operation', type => 'enum GimpChannelOps',
	  desc => 'The selection operation' },
	{ name => 'antialias', type => 'boolean',
	  desc => 'Antialiasing' },
	{ name => 'feather', type => 'boolean',
	  desc => 'Feather option for selections' },
	{ name => 'feather_radius', type => '0 <= float',
	  desc => 'Radius for feather operation' }
    );

    %invoke = (
        code => <<'CODE'
{
  gimp_channel_select_polygon (gimp_image_get_mask (image),
                               _("Free Select"),
                               num_segs / 2,
                               (GimpVector2 *) segs,
                               operation,
                               antialias,
                               feather,
                               feather_radius,
                               feather_radius,
                               TRUE);
}
CODE
    );
}


sub fuzzy_select {
    &std_pdb_deprecated ('gimp-image-select-contiguous-color');

    @inargs = (
	{ name => 'drawable', type => 'drawable',
	  desc => 'The affected drawable' },
	{ name => 'x', type => 'float',
	  desc => 'x coordinate of initial seed fill point: (image
	  	   coordinates)' },
	{ name => 'y', type => 'float',
	  desc => 'y coordinate of initial seed fill point: (image
	  	   coordinates)' },
	{ name => 'threshold', type => '0 <= int32 <= 255',
	  desc => 'Threshold in intensity levels' },
	{ name => 'operation', type => 'enum GimpChannelOps',
	  desc => 'The selection operation' },
	{ name => 'antialias', type => 'boolean',
	  desc => 'Antialiasing' },
	{ name => 'feather', type => 'boolean',
	  desc => 'Feather option for selections' },
	{ name => 'feather_radius', type => '0 <= float',
	  desc => 'Radius for feather operation' },
	{ name => 'sample_merged', type => 'boolean',
	  desc => 'Use the composite image, not the drawable' }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpImage *image = gimp_item_get_image (GIMP_ITEM (drawable));

  gimp_channel_select_fuzzy (gimp_image_get_mask (image),
                             drawable,
                             sample_merged,
                             x, y,
                             threshold / 255.0,
                             FALSE /* don't select transparent */,
                             GIMP_SELECT_CRITERION_COMPOSITE,
                             FALSE /* no diagonal neighbors */,
                             operation,
                             antialias,
                             feather,
                             feather_radius,
                             feather_radius);
}
CODE
    );
}


sub fuzzy_select_full {
    &std_pdb_deprecated ('gimp-image-select-contiguous-color');
    &david_pdb_misc("2006","2.4");

    @inargs = (
	{ name => 'drawable', type => 'drawable',
	  desc => 'The affected drawable' },
	{ name => 'x', type => 'float',
	  desc => 'x coordinate of initial seed fill point: (image
	  	   coordinates)' },
	{ name => 'y', type => 'float',
	  desc => 'y coordinate of initial seed fill point: (image
	  	   coordinates)' },
	{ name => 'threshold', type => '0 <= int32 <= 255',
	  desc => 'Threshold in intensity levels' },
	{ name => 'operation', type => 'enum GimpChannelOps',
	  desc => 'The selection operation' },
	{ name => 'antialias', type => 'boolean',
	  desc => 'Antialiasing' },
	{ name => 'feather', type => 'boolean',
	  desc => 'Feather option for selections' },
	{ name => 'feather_radius_x', type => '0 <= float',
	  desc => 'Radius for feather operation in X direction' },
	{ name => 'feather_radius_y', type => '0 <= float',
	  desc => 'Radius for feather operation in Y direction' },
	{ name => 'sample_merged', type => 'boolean',
	  desc => 'Use the composite image, not the drawable' },
	{ name => 'select_transparent', type => 'boolean',
          desc => "Whether to consider transparent pixels for selection.
                   If TRUE, transparency is considered as a unique selectable
                   color." },
        { name => 'select_criterion', type => 'enum GimpSelectCriterion',
          desc => "The criterion used to determine color similarity.
                   SELECT_CRITERION_COMPOSITE is the standard choice.
		   " },
    );

    %invoke = (
	code => <<'CODE'
{
  GimpImage *image = gimp_item_get_image (GIMP_ITEM (drawable));

  gimp_channel_select_fuzzy (gimp_image_get_mask (image),
                             drawable,
                             sample_merged,
                             x, y,
                             threshold / 255.0,
                             select_transparent,
                             select_criterion,
                             FALSE /* no diagonal neighbors */,
                             operation,
                             antialias,
                             feather,
                             feather_radius_x,
                             feather_radius_y);
}
CODE
    );
}


sub rect_select {
    &std_pdb_deprecated ('gimp-image-select-rectangle');

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' },
	{ name => 'x', type => 'float',
	  desc => 'x coordinate of upper-left corner of rectangle' },
	{ name => 'y', type => 'float',
	  desc => 'y coordinate of upper-left corner of rectangle' },
	{ name => 'width', type => '0 < float',
	  desc => 'The width of the rectangle' },
	{ name => 'height', type => '0 < float',
	  desc => 'The height of the rectangle' },
	{ name => 'operation', type => 'enum GimpChannelOps',
	  desc => 'The selection operation' },
	{ name => 'feather', type => 'boolean',
	  desc => 'Feather option for selections' },
	{ name => 'feather_radius', type => '0 <= float',
	  desc => 'Radius for feather operation' }
    );

    %invoke = (
	code => <<'CODE'
{
  gimp_channel_select_rectangle (gimp_image_get_mask (image),
                                 (gint) x, (gint) y,
                                 (gint) width, (gint) height,
                                 operation,
                                 feather,
                                 feather_radius,
                                 feather_radius,
                                 TRUE);
}
CODE
    );
}


sub round_rect_select {
    &std_pdb_deprecated ('gimp-image-select-round-rectangle');
    &martin_pdb_misc("2006","2.4");

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image' },
	{ name => 'x', type => 'float',
	  desc => 'x coordinate of upper-left corner of rectangle' },
	{ name => 'y', type => 'float',
	  desc => 'y coordinate of upper-left corner of rectangle' },
	{ name => 'width', type => '0 < float',
	  desc => 'The width of the rectangle' },
	{ name => 'height', type => '0 < float',
	  desc => 'The height of the rectangle' },
        { name => 'corner_radius_x', type => '0 < float < GIMP_MAX_IMAGE_SIZE',
          desc => 'The corner radius in X direction' },
        { name => 'corner_radius_y', type => '0 < float < GIMP_MAX_IMAGE_SIZE',
          desc => 'The corner radius in Y direction' },
	{ name => 'operation', type => 'enum GimpChannelOps',
	  desc => 'The selection operation' },
	{ name => 'antialias', type => 'boolean',
	  desc => 'Antialiasing' },
	{ name => 'feather', type => 'boolean',
	  desc => 'Feather option for selections' },
	{ name => 'feather_radius_x', type => '0 <= float',
	  desc => 'Radius for feather operation in X direction' },
	{ name => 'feather_radius_y', type => '0 <= float',
	  desc => 'Radius for feather operation in Y direction' }
    );

    %invoke = (
	code => <<'CODE'
{
  gimp_channel_select_round_rect (gimp_image_get_mask (image),
                                  (gint) x, (gint) y,
                                  (gint) width, (gint) height,
                                  corner_radius_x,
                                  corner_radius_y,
                                  operation,
                                  antialias,
                                  feather,
                                  feather_radius_x,
                                  feather_radius_y,
                                  TRUE);
}
CODE
    );
}


@headers = qw("libgimpbase/gimpbase.h"
              "core/gimpchannel-select.h"
              "gimp-intl.h");

@procs = qw(by_color_select by_color_select_full
            ellipse_select
            free_select 
	    fuzzy_select fuzzy_select_full
	    rect_select round_rect_select);

%exports = (app => [@procs], lib => [@procs]);

$desc = 'Selection Tool procedures';
$doc_title = 'gimpselectiontools';
$doc_short_desc = 'Access to toolbox selection tools.';
$doc_long_desc = 'Functions giving access to toolbox selection tools.';

1;