gimp/tools/pdbgen/pdb/selection_tools.pdb

# The GIMP -- an 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 2 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, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

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

# Selection Tools

# shortcuts

sub drawable_arg () {{
    name => 'drawable',
    type => 'drawable',
    desc => 'The affected drawable',
}}

sub drawable_out_arg {
    my $type = shift;
    my $arg = &drawable_arg;
    $arg->{desc} = "The $type drawable";
    $arg->{no_declare} = 1;
    $arg;
}

sub sample_merged_arg () {{
    name => 'sample_merged',
    type => 'boolean',
    desc => 'Use the composite image, not the drawable'
}}

sub operation_arg () {{
    name => 'operation',
    type => 'enum GimpChannelOps',
    desc => 'The selection operation: { %%desc%% }'
}}

sub threshold_arg () {{
    name => 'threshold',
    type => '0 <= int32 <= 255',
    desc => 'Threshold in intensity levels %%desc%%'
}}

sub feather_select_args () {(
    { name => 'feather', type => 'boolean',
      desc => 'Feather option for selections' },
    { name => 'feather_radius', type => 'float',
      desc => 'Radius for feather operation' }
)}


# The defs

sub by_color_select {
    $blurb = <<'BLURB';
Create a selection by selecting all pixels (in the specified drawable) with the
same (or similar) color to that specified.
BLURB

    $help = <<'HELP';
This tool creates a selection over the specified image. A by-color selection is
determined by the supplied color under the constraints of the specified
threshold. Essentially, all pixels (in the drawable) that have color
sufficiently close to the specified color (as determined by the threshold
value) are included in the selection. The antialiasing parameter allows the
final selection mask to contain intermediate values based on close misses to
the threshold bar. Feathering can be enabled optionally and is controlled with
the "feather_radius" parameter. If the sample_merged parameter is non-zero,
the data of the composite image will be used instead of that for the specified
drawable. This is equivalent to sampling for colors after merging all visible
layers. In the case of a merged sampling, the supplied drawable is ignored.
HELP

    &std_pdb_misc;

    @inargs = (
	&drawable_arg,
	{ name => 'color', type => 'color',
	  desc => 'The color to select' },
	&threshold_arg,
	&operation_arg,
	&std_antialias_arg,
	&feather_select_args,
	&sample_merged_arg
    );

    %invoke = (
	vars => [ 'GimpImage *gimage' ],
	code => <<'CODE'
{
  gimage = gimp_item_get_image (GIMP_ITEM (drawable));

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

sub ellipse_select {
    $blurb = 'Create an elliptical selection over the specified image.';

    $help = <<'HELP';
This tool creates an elliptical selection over the specified image. The
elliptical region can be either added to, subtracted from, or replace the
contents of the previous selection mask. If antialiasing is turned on, the
edges of the elliptical region will contain intermediate values which give the
appearance of a sharper, less pixelized edge. This should be set as TRUE most
of the time. If the feather option is enabled, the resulting selection is
blurred before combining. The blur is a gaussian blur with the specified
feather radius.
HELP

    &std_pdb_misc;

    @inargs = (
	&std_image_arg,
	{ 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: %%desc%%' },
	{ name => 'height', type => '0 < float',
	  desc => 'The height of the ellipse: %%desc%%' },
	&operation_arg,
	&std_antialias_arg,
	&feather_select_args
    );

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

sub free_select {
    $blurb = 'Create a polygonal selection over the specified image.';

    $help = <<'HELP';
This tool creates a polygonal selection over the specified image. The polygonal
region can be either added to, subtracted from, or replace the contents of the
previous selection mask. The polygon is specified through an array of floating
point numbers and its length. The length of array must be 2n, where n is the
number of points. Each point is defined by 2 floating point values which
correspond to the x and y coordinates. If the final point does not connect to
the starting point, a connecting segment is automatically added. If the feather
option is enabled, the resulting selection is blurred before combining. The
blur is a gaussian blur with the specified feather radius.
HELP

    &std_pdb_misc;

    @inargs = (
        &std_image_arg,
        { name => 'segs', type => 'floatarray',
          desc => 'Array of points: { p1.x, p1.y, p2.x, p2.y, ...,
                   pn.x, pn.y}',
          array => { type => '2 <= int32', on_success => 'num_segs /= 2;',
                     desc => 'Number of points (count 1 coordinate as two
                              points)' } },
        &operation_arg,
        &std_antialias_arg,
        &feather_select_args
    );

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

sub fuzzy_select {
    $blurb = <<'BLURB';
Create a fuzzy selection starting at the specified coordinates on the specified
drawable.
BLURB

    $help = <<'HELP';
This tool creates a fuzzy selection over the specified image. A fuzzy selection
is determined by a seed fill under the constraints of the specified threshold.
Essentially, the color at the specified coordinates (in the drawable) is
measured and the selection expands outwards from that point to any adjacent
pixels which are not significantly different (as determined by the threshold
value). This process continues until no more expansion is possible. The
antialiasing parameter allows the final selection mask to contain intermediate
values based on close misses to the threshold bar at pixels along the seed fill
boundary. Feathering can be enabled optionally and is controlled with the
"feather_radius" paramter. If the sample_merged parameter is non-zero, the data
of the composite image will be used instead of that for the specified drawable.
This is equivalent to sampling for colors after merging all visible layers. In
the case of a merged sampling, the supplied drawable is ignored. If the sample
is merged, the specified coordinates are relative to the image origin;
otherwise, they are relative to the drawable's origin.
HELP

    &std_pdb_misc;

    @inargs = (
	&drawable_arg,
	{ 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)' },
	&threshold_arg,
	&operation_arg,
	&std_antialias_arg,
	&feather_select_args,
	&sample_merged_arg
    );

    %invoke = (
	vars => [ 'GimpImage *gimage' ],
	code => <<'CODE'
{
  gimage = gimp_item_get_image (GIMP_ITEM (drawable));

  gimp_channel_select_fuzzy (gimp_image_get_mask (gimage),
                             drawable,
                             sample_merged,
                             x, y, 
                             threshold,
                             FALSE /* don't select transparent */,
                             operation,
                             antialias,
                             feather,
                             feather_radius,
                             feather_radius);
}
CODE
    );
}

sub rect_select {
    $blurb = 'Create a rectangular selection over the specified image;';

    $help = <<'HELP';
This tool creates a rectangular selection over the specified image. The
rectangular region can be either added to, subtracted from, or replace the
contents of the previous selection mask. If the feather option is enabled, the
resulting selection is blurred before combining. The blur is a gaussian blur
with the specified feather radius.
HELP

    &std_pdb_misc;

    @inargs = (
	&std_image_arg,
	{ 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: %%desc%%' },
	{ name => 'height', type => '0 < float',
	  desc => 'The height of the rectangle: %%desc%%' },
	&operation_arg,
	&feather_select_args,
    );

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

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

@procs = qw(by_color_select ellipse_select free_select fuzzy_select
	    rect_select);
%exports = (app => [@procs], lib => [@procs]);

$desc = 'Selection Tool procedures';

1;