disp_ellipseT_disp_ellipseDispEllipseDispEllipse (Operator)

Name

disp_ellipseT_disp_ellipseDispEllipseDispEllipse — Displays ellipses.

Signature

disp_ellipse( : : WindowHandle, CenterRow, CenterCol, Phi, Radius1, Radius2 : )

Herror T_disp_ellipse(const Htuple WindowHandle, const Htuple CenterRow, const Htuple CenterCol, const Htuple Phi, const Htuple Radius1, const Htuple Radius2)

void DispEllipse(const HTuple& WindowHandle, const HTuple& CenterRow, const HTuple& CenterCol, const HTuple& Phi, const HTuple& Radius1, const HTuple& Radius2)

void HWindow::DispEllipse(const HTuple& CenterRow, const HTuple& CenterCol, const HTuple& Phi, const HTuple& Radius1, const HTuple& Radius2) const

void HWindow::DispEllipse(Hlong CenterRow, Hlong CenterCol, double Phi, double Radius1, double Radius2) const

static void HOperatorSet.DispEllipse(HTuple windowHandle, HTuple centerRow, HTuple centerCol, HTuple phi, HTuple radius1, HTuple radius2)

void HWindow.DispEllipse(HTuple centerRow, HTuple centerCol, HTuple phi, HTuple radius1, HTuple radius2)

void HWindow.DispEllipse(int centerRow, int centerCol, double phi, double radius1, double radius2)

Description

disp_ellipsedisp_ellipseDispEllipseDispEllipseDispEllipse displays one or several ellipses in the output window. An ellipse is described by the center (CenterRowCenterRowCenterRowCenterRowcenterRow, CenterColCenterColCenterColCenterColcenterCol), the orientation PhiPhiPhiPhiphi (in radians) and the radii of the major and the minor axis (Radius1Radius1Radius1Radius1radius1 and Radius2Radius2Radius2Radius2radius2).

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

Attention

The center of the ellipse must be within the window.

Execution Information

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

CenterRowCenterRowCenterRowCenterRowcenterRow (input_control)  ellipse.center.y(-array) HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Row index of center.

Default value: 64

Suggested values: 0, 64, 128, 256

Typical range of values: 0 ≤ CenterRow CenterRow CenterRow CenterRow centerRow ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 10

CenterColCenterColCenterColCenterColcenterCol (input_control)  ellipse.center.x(-array) HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Column index of center.

Default value: 64

Suggested values: 0, 64, 128, 256

Typical range of values: 0 ≤ CenterCol CenterCol CenterCol CenterCol centerCol ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 10

PhiPhiPhiPhiphi (input_control)  ellipse.angle.rad(-array) HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Orientation of the ellipse in radians

Default value: 0.0

Suggested values: 0.0, 0.785398, 1.570796, 3.1415926, 6.283185

Typical range of values: 0.0 ≤ Phi Phi Phi Phi phi ≤ 6.283185 (lin)

Minimum increment: 0.01

Recommended increment: 0.1

Radius1Radius1Radius1Radius1radius1 (input_control)  ellipse.radius1(-array) HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Radius of major axis.

Default value: 24.0

Suggested values: 0.0, 64.0, 128.0, 256.0

Typical range of values: 0.0 ≤ Radius1 Radius1 Radius1 Radius1 radius1 ≤ 511.0 (lin)

Minimum increment: 1.0

Recommended increment: 10.0

Radius2Radius2Radius2Radius2radius2 (input_control)  ellipse.radius2(-array) HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Radius of minor axis.

Default value: 14.0

Suggested values: 0.0, 64.0, 128.0, 256.0

Typical range of values: 0.0 ≤ Radius2 Radius2 Radius2 Radius2 radius2 ≤ 511.0 (lin)

Minimum increment: 1.0

Recommended increment: 10.0

Example (HDevelop)

set_color(WindowHandle,'red')
draw_region(MyRegion,WindowHandle)
elliptic_axis(MyRegion,Ra,Rb,Phi)
area_center(MyRegion,_,Row,Column)
disp_ellipse(WindowHandle,Row,Column,Phi,Ra,Rb)

Example (C)

set_color(WindowHandle,"red");
T_draw_region(&MyRegion,WindowHandle);
elliptic_axis(MyRegion,&Ra,&Rb,&Phi);
area_center(MyRegion,NULL,&Row,&Column);
T_disp_ellipse(WindowHandle,Row,Column,Phi,Ra,Rb);

Example (HDevelop)

set_color(WindowHandle,'red')
draw_region(MyRegion,WindowHandle)
elliptic_axis(MyRegion,Ra,Rb,Phi)
area_center(MyRegion,_,Row,Column)
disp_ellipse(WindowHandle,Row,Column,Phi,Ra,Rb)

Example (HDevelop)

set_color(WindowHandle,'red')
draw_region(MyRegion,WindowHandle)
elliptic_axis(MyRegion,Ra,Rb,Phi)
area_center(MyRegion,_,Row,Column)
disp_ellipse(WindowHandle,Row,Column,Phi,Ra,Rb)

Example (HDevelop)

set_color(WindowHandle,'red')
draw_region(MyRegion,WindowHandle)
elliptic_axis(MyRegion,Ra,Rb,Phi)
area_center(MyRegion,_,Row,Column)
disp_ellipse(WindowHandle,Row,Column,Phi,Ra,Rb)

Result

disp_ellipsedisp_ellipseDispEllipseDispEllipseDispEllipse returns 2 (H_MSG_TRUE), if the parameters are correct. Otherwise an exception is raised.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow, set_drawset_drawSetDrawSetDrawSetDraw, set_colorset_colorSetColorSetColorSetColor, set_coloredset_coloredSetColoredSetColoredSetColored, set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth, set_rgbset_rgbSetRgbSetRgbSetRgb, set_hsiset_hsiSetHsiSetHsiSetHsi, elliptic_axiselliptic_axisEllipticAxisEllipticAxisEllipticAxis, area_centerarea_centerAreaCenterAreaCenterAreaCenter

Alternatives

disp_circledisp_circleDispCircleDispCircleDispCircle, disp_regiondisp_regionDispRegionDispRegionDispRegion, gen_ellipsegen_ellipseGenEllipseGenEllipseGenEllipse, gen_circlegen_circleGenCircleGenCircleGenCircle

See also

open_windowopen_windowOpenWindowOpenWindowOpenWindow, set_colorset_colorSetColorSetColorSetColor, set_rgbset_rgbSetRgbSetRgbSetRgb, set_hsiset_hsiSetHsiSetHsiSetHsi, set_drawset_drawSetDrawSetDrawSetDraw, set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth

Module

Foundation