disp_ellipseT_disp_ellipseDispEllipseDispEllipsedisp_ellipse (Operator)
Name
disp_ellipseT_disp_ellipseDispEllipseDispEllipsedisp_ellipse — Displays ellipses.
Signature
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_ellipseDispEllipseDispEllipsedisp_ellipse displays one or several ellipses in the
output window. An ellipse is described by the center (CenterRowCenterRowCenterRowcenterRowcenter_row,
CenterColCenterColCenterColcenterColcenter_col), the orientation PhiPhiPhiphiphi (in radians) and the
radii of the major and the minor axis (Radius1Radius1Radius1radius1radius_1 and
Radius2Radius2Radius2radius2radius_2).
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 ellipses. Several ellipses can be displayed
with one call by using tuple parameters. For the use of colors with
several ellipses, see set_colorset_colorSetColorSetColorset_color.
Attention
The center of the ellipse 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.
CenterRowCenterRowCenterRowcenterRowcenter_row (input_control) ellipse.center.y(-array) → HTupleMaybeSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Row index of center.
Default:
64
Suggested values:
0, 64, 128, 256
Value range:
0
≤
CenterRow
CenterRow
CenterRow
centerRow
center_row
≤
511 (lin)
Minimum increment:
1
Recommended increment:
10
CenterColCenterColCenterColcenterColcenter_col (input_control) ellipse.center.x(-array) → HTupleMaybeSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Column index of center.
Default:
64
Suggested values:
0, 64, 128, 256
Value range:
0
≤
CenterCol
CenterCol
CenterCol
centerCol
center_col
≤
511 (lin)
Minimum increment:
1
Recommended increment:
10
PhiPhiPhiphiphi (input_control) ellipse.angle.rad(-array) → HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Orientation of the ellipse in radians
Default:
0.0
Suggested values:
0.0, 0.785398, 1.570796, 3.1415926, 6.283185
Value range:
0.0
≤
Phi
Phi
Phi
phi
phi
≤
6.283185 (lin)
Minimum increment:
0.01
Recommended increment:
0.1
Radius1Radius1Radius1radius1radius_1 (input_control) ellipse.radius1(-array) → HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Radius of major axis.
Default:
24.0
Suggested values:
0.0, 64.0, 128.0, 256.0
Value range:
0.0
≤
Radius1
Radius1
Radius1
radius1
radius_1
≤
511.0 (lin)
Minimum increment:
1.0
Recommended increment:
10.0
Radius2Radius2Radius2radius2radius_2 (input_control) ellipse.radius2(-array) → HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Radius of minor axis.
Default:
14.0
Suggested values:
0.0, 64.0, 128.0, 256.0
Value range:
0.0
≤
Radius2
Radius2
Radius2
radius2
radius_2
≤
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)
Result
disp_ellipsedisp_ellipseDispEllipseDispEllipsedisp_ellipse returns 2 (
H_MSG_TRUE)
, if the
parameters are correct. Otherwise an exception is raised.
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,
elliptic_axiselliptic_axisEllipticAxisEllipticAxiselliptic_axis,
area_centerarea_centerAreaCenterAreaCenterarea_center
Alternatives
disp_circledisp_circleDispCircleDispCircledisp_circle,
disp_regiondisp_regionDispRegionDispRegiondisp_region,
gen_ellipsegen_ellipseGenEllipseGenEllipsegen_ellipse,
gen_circlegen_circleGenCircleGenCirclegen_circle
See also
open_windowopen_windowOpenWindowOpenWindowopen_window,
set_colorset_colorSetColorSetColorset_color,
set_rgbset_rgbSetRgbSetRgbset_rgb,
set_hsiset_hsiSetHsiSetHsiset_hsi,
set_drawset_drawSetDrawSetDrawset_draw,
set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width
Module
Foundation