Operator Reference

disp_regionT_disp_regionDispRegionDispRegiondisp_region (Operator)

disp_regionT_disp_regionDispRegionDispRegiondisp_region — Displays regions in a window.

Signature

disp_region(DispRegions : : WindowHandle : )

Herror T_disp_region(const Hobject DispRegions, const Htuple WindowHandle)

void DispRegion(const HObject& DispRegions, const HTuple& WindowHandle)

void HRegion::DispRegion(const HWindow& WindowHandle) const

void HWindow::DispRegion(const HRegion& DispRegions) const

static void HOperatorSet.DispRegion(HObject dispRegions, HTuple windowHandle)

void HRegion.DispRegion(HWindow windowHandle)

void HWindow.DispRegion(HRegion dispRegions)

def disp_region(disp_regions: HObject, window_handle: HHandle) -> None

Description

disp_regiondisp_regionDispRegionDispRegiondisp_region displays the regions in DispRegionsDispRegionsDispRegionsdispRegionsdisp_regions in the output window. The parameters for output can be set with the operators set_colorset_colorSetColorSetColorset_color, set_grayset_graySetGraySetGrayset_gray, set_drawset_drawSetDrawSetDrawset_draw, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width, etc.

The color(s) for the display of the regions are determined with set_colorset_colorSetColorSetColorset_color, set_rgbset_rgbSetRgbSetRgbset_rgb, set_grayset_graySetGraySetGrayset_gray or set_coloredset_coloredSetColoredSetColoredset_colored. If more than one region is displayed and more than one color is set, the colors are assigned in a cyclic way to the regions.

The form of the region for output can be modified by set_paintset_paintSetPaintSetPaintset_paint (e.g., encompassing circle, convex hull). The command set_drawset_drawSetDrawSetDrawset_draw determines if the region is filled or only the boundary is drawn. If only the boundary is drawn, the thickness of the boundary will be determined by set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width and the style by set_line_styleset_line_styleSetLineStyleSetLineStyleset_line_style.

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

DispRegionsDispRegionsDispRegionsdispRegionsdisp_regions (input_object)  region(-array) objectHRegionHObjectHObjectHobject

Regions to display.

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

Example (HDevelop)

* Output with 12 colors:
set_colored(WindowHandle,12)
disp_region(SomeSegments,WindowHandle)

* Symbolic representation:
set_draw(WindowHandle,'margin')
set_color(WindowHandle,'red')
set_shape(WindowHandle,'ellipse')
disp_region(SomeSegments,WindowHandle)

* Representation of a margin with pattern:
set_draw(WindowHandle,'margin')
set_color(WindowHandle,'blue')
set_line_style(WindowHandle,[12,3])
disp_region(Segments,WindowHandle)

Result

disp_regiondisp_regionDispRegionDispRegiondisp_region returns 2 ( H_MSG_TRUE) .

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window, set_rgbset_rgbSetRgbSetRgbset_rgb, set_lutset_lutSetLutSetLutset_lut, set_hsiset_hsiSetHsiSetHsiset_hsi, set_shapeset_shapeSetShapeSetShapeset_shape, set_line_styleset_line_styleSetLineStyleSetLineStyleset_line_style, set_insertset_insertSetInsertSetInsertset_insert, set_drawset_drawSetDrawSetDrawset_draw, set_colorset_colorSetColorSetColorset_color, set_coloredset_coloredSetColoredSetColoredset_colored, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width

Alternatives

disp_objdisp_objDispObjDispObjdisp_obj, disp_arrowdisp_arrowDispArrowDispArrowdisp_arrow, disp_linedisp_lineDispLineDispLinedisp_line, disp_circledisp_circleDispCircleDispCircledisp_circle, disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1disp_rectangle1, disp_rectangle2disp_rectangle2DispRectangle2DispRectangle2disp_rectangle2, disp_ellipsedisp_ellipseDispEllipseDispEllipsedisp_ellipse

See also

open_windowopen_windowOpenWindowOpenWindowopen_window, set_colorset_colorSetColorSetColorset_color, set_coloredset_coloredSetColoredSetColoredset_colored, set_drawset_drawSetDrawSetDrawset_draw, set_shapeset_shapeSetShapeSetShapeset_shape, set_paintset_paintSetPaintSetPaintset_paint, set_grayset_graySetGraySetGrayset_gray, set_rgbset_rgbSetRgbSetRgbset_rgb, set_hsiset_hsiSetHsiSetHsiset_hsi, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width, set_line_styleset_line_styleSetLineStyleSetLineStyleset_line_style, set_insertset_insertSetInsertSetInsertset_insert, paint_regionpaint_regionPaintRegionPaintRegionpaint_region, dump_windowdump_windowDumpWindowDumpWindowdump_window

Module

Foundation