disp_polygonDispPolygonDispPolygondisp_polygonT_disp_polygon🔗

Short description🔗

disp_polygonDispPolygonDispPolygondisp_polygonT_disp_polygon — Displays a polyline.

Signature🔗

disp_polygon( window WindowHandle, polygon.y Row, polygon.x Column )

Description🔗

disp_polygonDispPolygon displays a polyline with the row coordinates Rowrowrow and the column coordinates Columncolumncolumn in the output window. The parameters Rowrowrow and Columncolumncolumn have to be provided as tuples. Straight lines are drawn between the given points. The start and the end of the polyline are not connected.

The operators used to control the display of regions (e.g., set_colorSetColor, set_graySetGray, set_drawSetDraw, set_line_widthSetLineWidth) can also be used with polylines.

Attention🔗

The given coordinates must lie within the window.

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🔗

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Rowrowrow (input_control) polygon.y-array → (integer / real)HTuple (Hlong / double)HTuple (int / long / double)Sequence[Union[int, float]]Htuple (Hlong / double)

Row index

Default: [16, 80, 80][16, 80, 80]
Suggested values: 0, 64, 128, 256, 5110, 64, 128, 256, 511
Value range: 0 ≤ Row ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10

Columncolumncolumn (input_control) polygon.x-array → (integer / real)HTuple (Hlong / double)HTuple (int / long / double)Sequence[Union[int, float]]Htuple (Hlong / double)

Column index

Default: [48, 16, 80][48, 16, 80]
Suggested values: 0, 64, 128, 256, 5110, 64, 128, 256, 511
Value range: 0 ≤ Column ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10

Example🔗

(C)

/* display a rectangle */

disp_rectangle1_margin1(Htuple WindowHandle,
                        Hlong Row1, long Column1,
                        Hlong Row2, long Column2)
{
  Htuple Row, Col\;
  create_tuple(&Row,4)\;
  create_tuple(&Col,4)\;
 set_i(Row,Row1,0)\;
  set_i(Col,Column1,0)\;
 set_i(Row,Row1,1)\;
  set_i(Col,Column2,1)\;
 set_i(Row,Row2,2)\;
  set_i(Col,Column2,2)\;
 set_i(Row,Row2,3)\;
  set_i(Col,Column1,3)\;
 set_i(Row,Row1,4)\;
  set_i(Col,Column1,4)\;
 T_disp_polygon(WindowHandle,Row,Col)\;

}

Result🔗

disp_polygonDispPolygon returns 2 (H_MSG_TRUE).

Combinations with other operators🔗

Combinations

Possible predecessors

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

Alternatives

disp_lineDispLine, gen_region_polygonGenRegionPolygon, disp_regionDispRegion

Module🔗

Foundation