Skip to content

disp_regionDispRegionDispRegiondisp_regionT_disp_region🔗

Short description🔗

disp_regionDispRegionDispRegiondisp_regionT_disp_region — Displays regions in a window.

Signature🔗

disp_region( region DispRegions, window WindowHandle )void DispRegion( const HObject& DispRegions, const HTuple& WindowHandle )static void HOperatorSet.DispRegion( HObject dispRegions, HTuple windowHandle )def disp_region( disp_regions: HObject, window_handle: HHandle ) -> None

Herror T_disp_region( const Hobject DispRegions, const Htuple WindowHandle )

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

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

void HRegion.DispRegion( HWindow windowHandle )

void HWindow.DispRegion( HRegion dispRegions )

Description🔗

disp_regionDispRegion displays the regions in DispRegionsdispRegionsdisp_regions in the output window. The parameters for output can be set with the operators set_colorSetColor, set_graySetGray, set_drawSetDraw, set_line_widthSetLineWidth, etc.

The color(s) for the display of the regions are determined with set_colorSetColor, set_rgbSetRgb, set_graySetGray or set_coloredSetColored. 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_paintSetPaint (e.g., encompassing circle, convex hull). The command set_drawSetDraw 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_widthSetLineWidth and the style by set_line_styleSetLineStyle.

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🔗

DispRegionsdispRegionsdisp_regions (input_object) region(-array) → objectHObjectHRegionHObjectHobject

Regions to display.

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (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_regionDispRegion returns 2 (H_MSG_TRUE).

Combinations with other operators🔗

Combinations

Possible predecessors

open_windowOpenWindow, set_rgbSetRgb, set_lutSetLut, set_hsiSetHsi, set_shapeSetShape, set_line_styleSetLineStyle, set_drawSetDraw, set_colorSetColor, set_coloredSetColored, set_line_widthSetLineWidth

Alternatives

disp_objDispObj, disp_arrowDispArrow, disp_lineDispLine, disp_circleDispCircle, disp_rectangle1DispRectangle1, disp_rectangle2DispRectangle2, disp_ellipseDispEllipse

See also

open_windowOpenWindow, set_colorSetColor, set_coloredSetColored, set_drawSetDraw, set_shapeSetShape, set_paintSetPaint, set_graySetGray, set_rgbSetRgb, set_hsiSetHsi, set_line_widthSetLineWidth, set_line_styleSetLineStyle, paint_regionPaintRegion, dump_windowDumpWindow

Module🔗

Foundation