disp_polygonT_disp_polygonDispPolygonDispPolygondisp_polygon (Operator)

Name

disp_polygonT_disp_polygonDispPolygonDispPolygondisp_polygon — Displays a polyline.

Signature

disp_polygon( : : WindowHandle, Row, Column : )

Description

disp_polygondisp_polygonDispPolygonDispPolygonDispPolygondisp_polygon displays a polyline with the row coordinates RowRowRowRowrowrow and the column coordinates ColumnColumnColumnColumncolumncolumn in the output window. The parameters RowRowRowRowrowrow and ColumnColumnColumnColumncolumncolumn 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_colorset_colorSetColorSetColorSetColorset_color, set_grayset_graySetGraySetGraySetGrayset_gray, set_drawset_drawSetDrawSetDrawSetDrawset_draw, set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidthset_line_width) can also be used with polylines.

Attention

The given coordinates must lie within the window.

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

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → (handle)

Window handle.

RowRowRowRowrowrow (input_control) polygon.y-array → (integer / real)

Row index

Default value: [16,80,80]

Suggested values: 0, 64, 128, 256, 511

Typical range of values: 0 ≤ Row Row Row Row row row ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 10

ColumnColumnColumnColumncolumncolumn (input_control) polygon.x-array → (integer / real)

Column index

Default value: [48,16,80]

Suggested values: 0, 64, 128, 256, 511

Typical range of values: 0 ≤ Column Column Column Column column 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_polygondisp_polygonDispPolygonDispPolygonDispPolygondisp_polygon returns 2 (H_MSG_TRUE).

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window, set_rgbset_rgbSetRgbSetRgbSetRgbset_rgb, set_lutset_lutSetLutSetLutSetLutset_lut, set_hsiset_hsiSetHsiSetHsiSetHsiset_hsi, set_drawset_drawSetDrawSetDrawSetDrawset_draw, set_colorset_colorSetColorSetColorSetColorset_color, set_coloredset_coloredSetColoredSetColoredSetColoredset_colored, set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidthset_line_width

Alternatives

disp_linedisp_lineDispLineDispLineDispLinedisp_line, gen_region_polygongen_region_polygonGenRegionPolygonGenRegionPolygonGenRegionPolygongen_region_polygon, disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region

Module

Foundation

Operators