ClassesClassesClassesClasses | | | | Operators

gen_checker_regiongen_checker_regionGenCheckerRegiongen_checker_regionGenCheckerRegionGenCheckerRegion (Operator)

Name

gen_checker_regiongen_checker_regionGenCheckerRegiongen_checker_regionGenCheckerRegionGenCheckerRegion — Create a checkered region.

Signature

gen_checker_region( : RegionChecker : WidthRegion, HeightRegion, WidthPattern, HeightPattern : )

Herror gen_checker_region(Hobject* RegionChecker, const Hlong WidthRegion, const Hlong HeightRegion, const Hlong WidthPattern, const Hlong HeightPattern)

Herror T_gen_checker_region(Hobject* RegionChecker, const Htuple WidthRegion, const Htuple HeightRegion, const Htuple WidthPattern, const Htuple HeightPattern)

Herror gen_checker_region(Hobject* RegionChecker, const HTuple& WidthRegion, const HTuple& HeightRegion, const HTuple& WidthPattern, const HTuple& HeightPattern)

HRegion HRegion::GenCheckerRegion(const HTuple& WidthRegion, const HTuple& HeightRegion, const HTuple& WidthPattern, const HTuple& HeightPattern)

void GenCheckerRegion(HObject* RegionChecker, const HTuple& WidthRegion, const HTuple& HeightRegion, const HTuple& WidthPattern, const HTuple& HeightPattern)

void HRegion::GenCheckerRegion(Hlong WidthRegion, Hlong HeightRegion, Hlong WidthPattern, Hlong HeightPattern)

void HOperatorSetX.GenCheckerRegion(
[out] IHUntypedObjectX*RegionChecker, [in] VARIANT WidthRegion, [in] VARIANT HeightRegion, [in] VARIANT WidthPattern, [in] VARIANT HeightPattern)

void HRegionX.GenCheckerRegion(
[in] Hlong WidthRegion, [in] Hlong HeightRegion, [in] Hlong WidthPattern, [in] Hlong HeightPattern)

static void HOperatorSet.GenCheckerRegion(out HObject regionChecker, HTuple widthRegion, HTuple heightRegion, HTuple widthPattern, HTuple heightPattern)

void HRegion.GenCheckerRegion(int widthRegion, int heightRegion, int widthPattern, int heightPattern)

Description

The operator gen_checker_regiongen_checker_regionGenCheckerRegiongen_checker_regionGenCheckerRegionGenCheckerRegion returns a checkered region. Every black field of the checkerboard belongs to the region. The horizontal and vertical expansion of the region is limited by WidthRegionWidthRegionWidthRegionWidthRegionWidthRegionwidthRegion, HeightRegionHeightRegionHeightRegionHeightRegionHeightRegionheightRegion respectively, the size of the fields of the checkerboard by WidthPatternWidthPatternWidthPatternWidthPatternWidthPatternwidthPattern * HeightPatternHeightPatternHeightPatternHeightPatternHeightPatternheightPattern.

Attention

If a very small pattern is chosen (WidthPatternWidthPatternWidthPatternWidthPatternWidthPatternwidthPattern < 4) the created region requires much storage.

Parallelization

Parameters

RegionCheckerRegionCheckerRegionCheckerRegionCheckerRegionCheckerregionChecker (output_object)  region objectHRegionHRegionHRegionHRegionXHobject *

Created checkerboard region.

WidthRegionWidthRegionWidthRegionWidthRegionWidthRegionwidthRegion (input_control)  extent.x HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Largest occurring x value of the region.

Default value: 511

Suggested values: 10, 20, 31, 63, 127, 255, 300, 400, 511

Typical range of values: 1 ≤ WidthRegion WidthRegion WidthRegion WidthRegion WidthRegion widthRegion ≤ 1024 (lin)

Minimum increment: 1

Recommended increment: 10

Restriction: WidthRegion >= 1

HeightRegionHeightRegionHeightRegionHeightRegionHeightRegionheightRegion (input_control)  extent.y HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Largest occurring y value of the region.

Default value: 511

Suggested values: 10, 20, 31, 63, 127, 255, 300, 400, 511

Typical range of values: 1 ≤ HeightRegion HeightRegion HeightRegion HeightRegion HeightRegion heightRegion ≤ 1024 (lin)

Minimum increment: 1

Recommended increment: 10

Restriction: HeightRegion >= 1

WidthPatternWidthPatternWidthPatternWidthPatternWidthPatternwidthPattern (input_control)  extent.x HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Width of a field of the checkerboard.

Default value: 64

Suggested values: 1, 2, 4, 8, 16, 20, 32, 64, 100, 128, 200, 300, 500

Typical range of values: 1 ≤ WidthPattern WidthPattern WidthPattern WidthPattern WidthPattern widthPattern ≤ 1024 (lin)

Minimum increment: 1

Recommended increment: 10

Restriction: WidthPattern > 0 && WidthPattern < WidthRegion

HeightPatternHeightPatternHeightPatternHeightPatternHeightPatternheightPattern (input_control)  extent.y HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Height of a field of the checkerboard.

Default value: 64

Suggested values: 1, 2, 4, 8, 16, 20, 32, 64, 100, 128, 200, 300, 500

Typical range of values: 1 ≤ HeightPattern HeightPattern HeightPattern HeightPattern HeightPattern heightPattern ≤ 1024 (lin)

Minimum increment: 1

Recommended increment: 10

Restriction: HeightPattern > 0 && HeightPattern < HeightRegion

Example (HDevelop)

gen_checker_region(Checker,512,512,32,64)
set_draw(WindowHandle,'fill')
set_part(WindowHandle,0,0,511,511)
disp_region(Checker,WindowHandle)

Example (C)

gen_checker_region(&Checker,512,512,32,64);
set_draw(WindowHandle,"fill");
set_part(WindowHandle,0,0,511,511);
disp_region(Checker,WindowHandle);

Example (HDevelop)

gen_checker_region(Checker,512,512,32,64)
set_draw(WindowHandle,'fill')
set_part(WindowHandle,0,0,511,511)
disp_region(Checker,WindowHandle)

Example (HDevelop)

gen_checker_region(Checker,512,512,32,64)
set_draw(WindowHandle,'fill')
set_part(WindowHandle,0,0,511,511)
disp_region(Checker,WindowHandle)

Example (HDevelop)

gen_checker_region(Checker,512,512,32,64)
set_draw(WindowHandle,'fill')
set_part(WindowHandle,0,0,511,511)
disp_region(Checker,WindowHandle)

Example (HDevelop)

gen_checker_region(Checker,512,512,32,64)
set_draw(WindowHandle,'fill')
set_part(WindowHandle,0,0,511,511)
disp_region(Checker,WindowHandle)

Complexity

The required storage (in bytes) for the region is:

O((WidthRegionWidthRegionWidthRegionWidthRegionWidthRegionwidthRegion * HeightRegionHeightRegionHeightRegionHeightRegionHeightRegionheightRegion) / WidthPatternWidthPatternWidthPatternWidthPatternWidthPatternwidthPattern)

Result

The operator gen_checker_regiongen_checker_regionGenCheckerRegiongen_checker_regionGenCheckerRegionGenCheckerRegion returns the value 2 (H_MSG_TRUE) if the parameter values are correct. Otherwise an exception is raised. The clipping according to the current image format is set via the operator set_system('clip_region',<'true'/'false'>)set_system("clip_region",<"true"/"false">)SetSystem("clip_region",<"true"/"false">)set_system("clip_region",<"true"/"false">)SetSystem("clip_region",<"true"/"false">)SetSystem("clip_region",<"true"/"false">).

Possible Successors

paint_regionpaint_regionPaintRegionpaint_regionPaintRegionPaintRegion

Alternatives

gen_grid_regiongen_grid_regionGenGridRegiongen_grid_regionGenGridRegionGenGridRegion, gen_region_polygon_filledgen_region_polygon_filledGenRegionPolygonFilledgen_region_polygon_filledGenRegionPolygonFilledGenRegionPolygonFilled, gen_region_pointsgen_region_pointsGenRegionPointsgen_region_pointsGenRegionPointsGenRegionPoints, gen_region_runsgen_region_runsGenRegionRunsgen_region_runsGenRegionRunsGenRegionRuns, gen_rectangle1gen_rectangle1GenRectangle1gen_rectangle1GenRectangle1GenRectangle1, concat_objconcat_objConcatObjconcat_objConcatObjConcatObj, gen_random_regiongen_random_regionGenRandomRegiongen_random_regionGenRandomRegionGenRandomRegion, gen_random_regionsgen_random_regionsGenRandomRegionsgen_random_regionsGenRandomRegionsGenRandomRegions

See also

hamming_change_regionhamming_change_regionHammingChangeRegionhamming_change_regionHammingChangeRegionHammingChangeRegion, reduce_domainreduce_domainReduceDomainreduce_domainReduceDomainReduceDomain

Module

Foundation


ClassesClassesClassesClasses | | | | Operators