Operator Reference

disp_polygonT_disp_polygonDispPolygonDispPolygondisp_polygon (Operator)

disp_polygonT_disp_polygonDispPolygonDispPolygondisp_polygon — Displays a polyline.

Signature

disp_polygon( : : WindowHandle, Row, Column : )

Herror T_disp_polygon(const Htuple WindowHandle, const Htuple Row, const Htuple Column)

void DispPolygon(const HTuple& WindowHandle, const HTuple& Row, const HTuple& Column)

void HWindow::DispPolygon(const HTuple& Row, const HTuple& Column) const

static void HOperatorSet.DispPolygon(HTuple windowHandle, HTuple row, HTuple column)

void HWindow.DispPolygon(HTuple row, HTuple column)

def disp_polygon(window_handle: HHandle, row: Sequence[Union[int, float]], column: Sequence[Union[int, float]]) -> None

Description

disp_polygondisp_polygonDispPolygonDispPolygondisp_polygon displays a polyline with the row coordinates RowRowRowrowrow and the column coordinates ColumnColumnColumncolumncolumn in the output window. The parameters RowRowRowrowrow and ColumnColumnColumncolumncolumn 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_colorSetColorSetColorset_color, set_grayset_graySetGraySetGrayset_gray, set_drawset_drawSetDrawSetDrawset_draw, set_line_widthset_line_widthSetLineWidthSetLineWidthset_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

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

Window handle.

RowRowRowrowrow (input_control)  polygon.y-array HTupleSequence[Union[int, float]]HTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Row index

Default: [16,80,80]

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

Value range: 0 ≤ Row Row Row row row ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 10

ColumnColumnColumncolumncolumn (input_control)  polygon.x-array HTupleSequence[Union[int, float]]HTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Column index

Default: [48,16,80]

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

Value range: 0 ≤ 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_polygonDispPolygonDispPolygondisp_polygon returns 2 ( H_MSG_TRUE) .

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window, set_rgbset_rgbSetRgbSetRgbset_rgb, set_lutset_lutSetLutSetLutset_lut, set_hsiset_hsiSetHsiSetHsiset_hsi, set_drawset_drawSetDrawSetDrawset_draw, set_colorset_colorSetColorSetColorset_color, set_coloredset_coloredSetColoredSetColoredset_colored, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width

Alternatives

disp_linedisp_lineDispLineDispLinedisp_line, gen_region_polygongen_region_polygonGenRegionPolygonGenRegionPolygongen_region_polygon, disp_regiondisp_regionDispRegionDispRegiondisp_region

See also

open_windowopen_windowOpenWindowOpenWindowopen_window, set_colorset_colorSetColorSetColorset_color, set_rgbset_rgbSetRgbSetRgbset_rgb, set_hsiset_hsiSetHsiSetHsiset_hsi, set_insertset_insertSetInsertSetInsertset_insert, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width

Module

Foundation