Operator Reference

disp_circleT_disp_circleDispCircleDispCircledisp_circle (Operator)

disp_circleT_disp_circleDispCircleDispCircledisp_circle — Displays circles in a window.

Signature

disp_circle( : : WindowHandle, Row, Column, Radius : )

Herror T_disp_circle(const Htuple WindowHandle, const Htuple Row, const Htuple Column, const Htuple Radius)

void DispCircle(const HTuple& WindowHandle, const HTuple& Row, const HTuple& Column, const HTuple& Radius)

void HWindow::DispCircle(const HTuple& Row, const HTuple& Column, const HTuple& Radius) const

void HWindow::DispCircle(double Row, double Column, double Radius) const

static void HOperatorSet.DispCircle(HTuple windowHandle, HTuple row, HTuple column, HTuple radius)

void HWindow.DispCircle(HTuple row, HTuple column, HTuple radius)

void HWindow.DispCircle(double row, double column, double radius)

def disp_circle(window_handle: HHandle, row: MaybeSequence[Union[int, float]], column: MaybeSequence[Union[int, float]], radius: MaybeSequence[Union[int, float]]) -> None

Description

disp_circledisp_circleDispCircleDispCircledisp_circle displays one or several circles in the output window. A circle is described by the center (RowRowRowrowrow, ColumnColumnColumncolumncolumn) and the radius RadiusRadiusRadiusradiusradius. If the used coordinates are not within the window the circle is clipped accordingly.

The operators used to control the display of regions (e.g., set_drawset_drawSetDrawSetDrawset_draw, set_grayset_graySetGraySetGrayset_gray, set_drawset_drawSetDrawSetDrawset_draw) can also be used with circles. Several circles can be displayed with one call by using tuple parameters. For the use of colors with several circles, see set_colorset_colorSetColorSetColorset_color.

Attention

The center of the circle must be 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)  circle.center.y(-array) HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Row index of the center.

Default: 64

Suggested values: 0, 64, 128, 256

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

Minimum increment: 1

Recommended increment: 1

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

Column index of the center.

Default: 64

Suggested values: 0, 64, 128, 256

Value range: 0 ≤ Column Column Column column column ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 1

RadiusRadiusRadiusradiusradius (input_control)  circle.radius(-array) HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Radius of the circle.

Default: 64

Suggested values: 0, 64, 128, 256

Value range: 0 ≤ Radius Radius Radius radius radius ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 1

Restriction: Radius > 0.0

Example (HDevelop)

open_window(0,0,-1,-1,'root','visible','',WindowHandle)
set_draw(WindowHandle,'fill')
set_color(WindowHandle,'white')
repeat
  get_mbutton(WindowHandle,Row,Column,Button)
  disp_circle(WindowHandle,Row,Column,(Row + Column) % 50)
until(Button == 1)
close_window(WindowHandle)

Result

disp_circledisp_circleDispCircleDispCircledisp_circle returns 2 ( H_MSG_TRUE) .

Possible Predecessors

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

Alternatives

disp_ellipsedisp_ellipseDispEllipseDispEllipsedisp_ellipse, disp_regiondisp_regionDispRegionDispRegiondisp_region, gen_circlegen_circleGenCircleGenCirclegen_circle, gen_ellipsegen_ellipseGenEllipseGenEllipsegen_ellipse

See also

open_windowopen_windowOpenWindowOpenWindowopen_window, set_colorset_colorSetColorSetColorset_color, set_drawset_drawSetDrawSetDrawset_draw, set_rgbset_rgbSetRgbSetRgbset_rgb, set_hsiset_hsiSetHsiSetHsiset_hsi

Module

Foundation