disp_regionT_disp_regionDispRegionDispRegion (Operator)

Name

disp_regionT_disp_regionDispRegionDispRegion — 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)

Description

disp_regiondisp_regionDispRegionDispRegionDispRegion displays the regions in DispRegionsDispRegionsDispRegionsDispRegionsdispRegions in the output window. The parameters for output can be set with the operators set_colorset_colorSetColorSetColorSetColor, set_grayset_graySetGraySetGraySetGray, set_drawset_drawSetDrawSetDrawSetDraw, set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth, etc.

The color(s) for the display of the regions are determined with set_colorset_colorSetColorSetColorSetColor, set_rgbset_rgbSetRgbSetRgbSetRgb, set_grayset_graySetGraySetGraySetGray or set_coloredset_coloredSetColoredSetColoredSetColored. 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_paintSetPaintSetPaintSetPaint (e.g. encompassing circle, convex hull). The command set_drawset_drawSetDrawSetDrawSetDraw 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_widthSetLineWidthSetLineWidthSetLineWidth and the style by set_line_styleset_line_styleSetLineStyleSetLineStyleSetLineStyle.

Execution Information

Parameters

DispRegionsDispRegionsDispRegionsDispRegionsdispRegions (input_object)  region(-array) objectHRegionHRegionHobject

Regions to display.

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHtuple (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_regionDispRegionDispRegionDispRegion returns 2 (H_MSG_TRUE).

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow, set_rgbset_rgbSetRgbSetRgbSetRgb, set_lutset_lutSetLutSetLutSetLut, set_hsiset_hsiSetHsiSetHsiSetHsi, set_shapeset_shapeSetShapeSetShapeSetShape, set_line_styleset_line_styleSetLineStyleSetLineStyleSetLineStyle, set_insertset_insertSetInsertSetInsertSetInsert, set_drawset_drawSetDrawSetDrawSetDraw, set_colorset_colorSetColorSetColorSetColor, set_coloredset_coloredSetColoredSetColoredSetColored, set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth

Alternatives

disp_objdisp_objDispObjDispObjDispObj, disp_arrowdisp_arrowDispArrowDispArrowDispArrow, disp_linedisp_lineDispLineDispLineDispLine, disp_circledisp_circleDispCircleDispCircleDispCircle, disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1DispRectangle1, disp_rectangle2disp_rectangle2DispRectangle2DispRectangle2DispRectangle2, disp_ellipsedisp_ellipseDispEllipseDispEllipseDispEllipse

See also

open_windowopen_windowOpenWindowOpenWindowOpenWindow, set_colorset_colorSetColorSetColorSetColor, set_coloredset_coloredSetColoredSetColoredSetColored, set_drawset_drawSetDrawSetDrawSetDraw, set_shapeset_shapeSetShapeSetShapeSetShape, set_paintset_paintSetPaintSetPaintSetPaint, set_grayset_graySetGraySetGraySetGray, set_rgbset_rgbSetRgbSetRgbSetRgb, set_hsiset_hsiSetHsiSetHsiSetHsi, set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth, set_line_styleset_line_styleSetLineStyleSetLineStyleSetLineStyle, set_insertset_insertSetInsertSetInsertSetInsert, paint_regionpaint_regionPaintRegionPaintRegionPaintRegion, dump_windowdump_windowDumpWindowDumpWindowDumpWindow

Module

Foundation