Difference between revisions of "FindColorSpiral"
From SCAR Divi Manual
| (6 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
==Definition== | ==Definition== | ||
<source lang="scar" lines="false"> | <source lang="scar" lines="false"> | ||
| − | function FindColorSpiral(var | + | function FindColorSpiral(var X, Y: Integer; const Color, XS, YS, XE, YE: Integer): Boolean; |
</source> | </source> | ||
==Availability== | ==Availability== | ||
SCAR Divi 3.00 > Current | SCAR Divi 3.00 > Current | ||
| + | |||
| + | *Before SCAR Divi 3.25, the search would not start in the middle of the search area if '''X''' or '''Y''' are smaller than 0. | ||
| + | *Before SCAR Divi 3.33, the search only start in the middle of the search area if '''X''' or '''Y''' are smaller than 0. | ||
==Description== | ==Description== | ||
| − | This function searches for a given color specified by '''Color | + | This function searches for a given color specified by '''Color''' using a spiral pattern. The search area is given as a set of upper-left ('''XS''', '''YS''') and lower-right ('''XE''', '''YE''') coordinates which are specified relative to the selected client window. If the given search area is invalid ('''XS''' > '''XE''' or '''YS''' > '''YE'''), an exception is thrown. |
| + | |||
| + | The search will start at the coordinates given by ('''X''', '''Y'''), if these coordinates are outside of the bounds of the search area, the function will start searching at the center of the search area. | ||
| + | |||
| + | The function returns [[false]] if the color was not found, if it was it returns [[true]] and the coordinates of the found color in ('''X''', '''Y'''). The search will stop after the first instance of the color was found. | ||
==Example== | ==Example== | ||
Latest revision as of 18:12, 19 April 2012
Definition
function FindColorSpiral(var X, Y: Integer; const Color, XS, YS, XE, YE: Integer): Boolean;
Availability
SCAR Divi 3.00 > Current
- Before SCAR Divi 3.25, the search would not start in the middle of the search area if X or Y are smaller than 0.
- Before SCAR Divi 3.33, the search only start in the middle of the search area if X or Y are smaller than 0.
Description
This function searches for a given color specified by Color using a spiral pattern. The search area is given as a set of upper-left (XS, YS) and lower-right (XE, YE) coordinates which are specified relative to the selected client window. If the given search area is invalid (XS > XE or YS > YE), an exception is thrown.
The search will start at the coordinates given by (X, Y), if these coordinates are outside of the bounds of the search area, the function will start searching at the center of the search area.
The function returns false if the color was not found, if it was it returns true and the coordinates of the found color in (X, Y). The search will stop after the first instance of the color was found.
Example
var
w, h: Integer;
x, y: Integer;
begin
GetClientDimensions(w, h);
x := -1; y := -1;
if FindColorSpiral(x, y, 0, 0, 0, w - 1, h - 1) then
WriteLn('Found color at ' + IntToStr(x) + ', ' + IntToStr(y));
end.
