Skip to content

gen_region_polygon_xldgen_region_polygon_xldGenRegionPolygonXldGenRegionPolygonXldgen_region_polygon_xldgen_region_polygon_xld🔗

Short description🔗

gen_region_polygon_xldgen_region_polygon_xldGenRegionPolygonXldGenRegionPolygonXldgen_region_polygon_xldgen_region_polygon_xld — Create a region from an XLD polygon.

Signature🔗

gen_region_polygon_xld( xld_poly Polygon, out region Region, string Mode )gen_region_polygon_xld( Polygon : Region : Mode : )void GenRegionPolygonXld( const HObject& Polygon, HObject* Region, const HTuple& Mode )static void HOperatorSet.GenRegionPolygonXld( HObject polygon, out HObject region, HTuple mode )def gen_region_polygon_xld( polygon: HObject, mode: str ) -> HObject

Herror gen_region_polygon_xld( const Hobject Polygon, Hobject* Region, const char* Mode )

Herror T_gen_region_polygon_xld( const Hobject Polygon, Hobject* Region, const Htuple Mode )

HRegion HXLDPoly::GenRegionPolygonXld( const HString& Mode ) const

HRegion HXLDPoly::GenRegionPolygonXld( const char* Mode ) const

HRegion HXLDPoly::GenRegionPolygonXld( const wchar_t* Mode ) const (Windows only)

HRegion HXLDPoly.GenRegionPolygonXld( string mode )

Description🔗

gen_region_polygon_xldGenRegionPolygonXld creates a region Regionregionregion from a subpixel XLD polygon Polygonpolygonpolygon. The polygon is sampled according to the Bresenham algorithm and influenced by the parameter 'neighborhood'"neighborhood" of the operator set_systemSetSystem. Open polygons are closed before converting them to regions. Finally, the parameter Modemodemode defines whether the region is filled up ('filled'"filled") or returned by its contour ('margin'"margin").

Execution information🔗

Execution information
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

Polygonpolygonpolygon (input_object) xld_poly(-array) → objectobjectHObjectHXLDPolyHObjectHobject

Input polygon(s).

Regionregionregion (output_object) region(-array) → objectobjectHObjectHRegionHObjectHobject *

Created region(s).

Modemodemode (input_control) string → (string)(string)HTuple (HString)HTuple (string)strHtuple (char*)

Fill mode of the region(s).

Default: 'filled'"filled"
Suggested values: 'filled', 'margin'"filled", "margin"

Result🔗

The clipping according to the global image size is set via the operator set_system('clip_region',<'true'/'false'>).

Combinations with other operators🔗

Combinations

Possible predecessors

gen_polygons_xldGenPolygonsXld

Alternatives

gen_region_polygonGenRegionPolygon, gen_region_contour_xldGenRegionContourXld

See also

set_systemSetSystem

Module🔗

Foundation