gen_circle_contour_xldgen_circle_contour_xldGenCircleContourXldGenCircleContourXldgen_circle_contour_xld (Operator)
Name
gen_circle_contour_xldgen_circle_contour_xldGenCircleContourXldGenCircleContourXldgen_circle_contour_xld
— Create XLD contours corresponding to circles or circular arcs.
Signature
Herror gen_circle_contour_xld(Hobject* ContCircle, double Row, double Column, double Radius, double StartPhi, double EndPhi, const char* PointOrder, double Resolution)
Herror T_gen_circle_contour_xld(Hobject* ContCircle, const Htuple Row, const Htuple Column, const Htuple Radius, const Htuple StartPhi, const Htuple EndPhi, const Htuple PointOrder, const Htuple Resolution)
void GenCircleContourXld(HObject* ContCircle, const HTuple& Row, const HTuple& Column, const HTuple& Radius, const HTuple& StartPhi, const HTuple& EndPhi, const HTuple& PointOrder, const HTuple& Resolution)
void HXLDCont::GenCircleContourXld(const HTuple& Row, const HTuple& Column, const HTuple& Radius, const HTuple& StartPhi, const HTuple& EndPhi, const HTuple& PointOrder, double Resolution)
void HXLDCont::GenCircleContourXld(double Row, double Column, double Radius, double StartPhi, double EndPhi, const HString& PointOrder, double Resolution)
void HXLDCont::GenCircleContourXld(double Row, double Column, double Radius, double StartPhi, double EndPhi, const char* PointOrder, double Resolution)
void HXLDCont::GenCircleContourXld(double Row, double Column, double Radius, double StartPhi, double EndPhi, const wchar_t* PointOrder, double Resolution)
(
Windows only)
static void HOperatorSet.GenCircleContourXld(out HObject contCircle, HTuple row, HTuple column, HTuple radius, HTuple startPhi, HTuple endPhi, HTuple pointOrder, HTuple resolution)
void HXLDCont.GenCircleContourXld(HTuple row, HTuple column, HTuple radius, HTuple startPhi, HTuple endPhi, HTuple pointOrder, double resolution)
void HXLDCont.GenCircleContourXld(double row, double column, double radius, double startPhi, double endPhi, string pointOrder, double resolution)
Description
gen_circle_contour_xldgen_circle_contour_xldGenCircleContourXldGenCircleContourXldgen_circle_contour_xld
creates one or more circular arcs or
closed circles. Circles are specified by their center
(RowRowRowrowrow
, ColumnColumnColumncolumncolumn
) and their RadiusRadiusRadiusradiusradius
.
In addition to that, circular arcs are characterized by the angle
of the start point StartPhiStartPhiStartPhistartPhistart_phi
, the angle of the end point
EndPhiEndPhiEndPhiendPhiend_phi
, and the PointOrderPointOrderPointOrderpointOrderpoint_order
along the
boundary.
The resolution of the resulting contours ContCircleContCircleContCirclecontCirclecont_circle
is
controlled via ResolutionResolutionResolutionresolutionresolution
containing the Euclidean
distance in pixel between neighboring contour points. In general,
the distance between the second to last and the last point is smaller
than ResolutionResolutionResolutionresolutionresolution
.
Parameter Broadcasting
This operator supports parameter broadcasting.
This means that each parameter can be given as a tuple of length
1 or 'N'"N""N""N""N".
Parameters with tuple length 1 will be repeated internally
such that the number of created items is always 'N'"N""N""N""N".
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
ContCircleContCircleContCirclecontCirclecont_circle
(output_object) xld_cont(-array) →
objectHXLDContHObjectHObjectHobject *
Resulting contours.
RowRowRowrowrow
(input_control) circle.center.y(-array) →
HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
Row coordinate of the center of the circles or
circular arcs.
Default:
200.0
ColumnColumnColumncolumncolumn
(input_control) circle.center.x(-array) →
HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
Column coordinate of the center of the circles or
circular arcs.
Default:
200.0
RadiusRadiusRadiusradiusradius
(input_control) circle.radius(-array) →
HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
Radius of the circles or circular arcs.
Default:
100.0
Restriction:
Radius > 0
StartPhiStartPhiStartPhistartPhistart_phi
(input_control) angle.rad(-array) →
HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
Angle of the start points of the circles
or circular arcs [rad].
Default:
0.0
EndPhiEndPhiEndPhiendPhiend_phi
(input_control) angle.rad(-array) →
HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
Angle of the end points of the circles
or circular arcs [rad].
Default:
6.28318
PointOrderPointOrderPointOrderpointOrderpoint_order
(input_control) string(-array) →
HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Point order along the circles or circular arcs.
Default:
'positive'
"positive"
"positive"
"positive"
"positive"
List of values:
'negative'"negative""negative""negative""negative", 'positive'"positive""positive""positive""positive"
ResolutionResolutionResolutionresolutionresolution
(input_control) real →
HTuplefloatHTupleHtuple (real) (double) (double) (double)
Distance between neighboring contour points.
Default:
1.0
Restriction:
Resolution >= 0.00001
Example (HDevelop)
draw_circle (WindowHandle, Row, Column, Radius)
gen_circle_contour_xld (ContCircle, Row, Column, Radius, 0, \
rad(360) , 'positive', 1.0)
gen_region_contour_xld (ContCircle, Region, 'filled')
Result
gen_circle_contour_xldgen_circle_contour_xldGenCircleContourXldGenCircleContourXldgen_circle_contour_xld
returns 2 (
H_MSG_TRUE)
if all parameter values
are correct. If necessary, an exception is raised.
Possible Predecessors
draw_circledraw_circleDrawCircleDrawCircledraw_circle
Possible Successors
disp_xlddisp_xldDispXldDispXlddisp_xld
Alternatives
gen_ellipse_contour_xldgen_ellipse_contour_xldGenEllipseContourXldGenEllipseContourXldgen_ellipse_contour_xld
Module
Foundation