gen_rectangle2_contour_xldgen_rectangle2_contour_xldGenRectangle2ContourXldGenRectangle2ContourXldgen_rectangle2_contour_xld (Operator)
Name
gen_rectangle2_contour_xldgen_rectangle2_contour_xldGenRectangle2ContourXldGenRectangle2ContourXldgen_rectangle2_contour_xld — Create an XLD contour in the shape of a rectangle.
Signature
Herror gen_rectangle2_contour_xld(Hobject* Rectangle, double Row, double Column, double Phi, double Length1, double Length2)
Herror T_gen_rectangle2_contour_xld(Hobject* Rectangle, const Htuple Row, const Htuple Column, const Htuple Phi, const Htuple Length1, const Htuple Length2)
void GenRectangle2ContourXld(HObject* Rectangle, const HTuple& Row, const HTuple& Column, const HTuple& Phi, const HTuple& Length1, const HTuple& Length2)
void HXLDCont::GenRectangle2ContourXld(const HTuple& Row, const HTuple& Column, const HTuple& Phi, const HTuple& Length1, const HTuple& Length2)
void HXLDCont::GenRectangle2ContourXld(double Row, double Column, double Phi, double Length1, double Length2)
static void HOperatorSet.GenRectangle2ContourXld(out HObject rectangle, HTuple row, HTuple column, HTuple phi, HTuple length1, HTuple length2)
void HXLDCont.GenRectangle2ContourXld(HTuple row, HTuple column, HTuple phi, HTuple length1, HTuple length2)
void HXLDCont.GenRectangle2ContourXld(double row, double column, double phi, double length1, double length2)
def gen_rectangle2_contour_xld(row: MaybeSequence[float], column: MaybeSequence[float], phi: MaybeSequence[float], length_1: MaybeSequence[float], length_2: MaybeSequence[float]) -> HObject
Description
gen_rectangle2_contour_xldgen_rectangle2_contour_xldGenRectangle2ContourXldGenRectangle2ContourXldgen_rectangle2_contour_xld creates one or more XLD contours
in the shape of a rectangle with arbitrary orientation. The
rectangle has the center (RowRowRowrowrow, ColumnColumnColumncolumncolumn), the
orientation PhiPhiPhiphiphi, and the half edge lengths Length1Length1Length1length1length_1
and Length2Length2Length2length2length_2. The angle PhiPhiPhiphiphi must be given in
radians and specifies the angle between the horizontal axis and the
edge with the half length Length1Length1Length1length1length_1 in the mathematically
positive direction (counterclockwise).
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
RectangleRectangleRectanglerectanglerectangle (output_object) xld_cont(-array) → objectHXLDContHObjectHObjectHobject *
Rectangle contour.
RowRowRowrowrow (input_control) rectangle2.center.y(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
Row coordinate of the center of the rectangle.
Default:
300.0
ColumnColumnColumncolumncolumn (input_control) rectangle2.center.x(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
Column coordinate of the center of the rectangle.
Default:
200.0
PhiPhiPhiphiphi (input_control) rectangle2.angle.rad(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
Orientation of the main axis of the rectangle [rad].
Default:
0.0
Restriction:
- pi / 2 < Phi && Phi <= pi / 2
Length1Length1Length1length1length_1 (input_control) rectangle2.hwidth(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
First radius (half length) of the rectangle.
Default:
100.5
Length2Length2Length2length2length_2 (input_control) rectangle2.hheight(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
Second radius (half width) of the rectangle.
Default:
20.5
Result
gen_rectangle2_contour_xldgen_rectangle2_contour_xldGenRectangle2ContourXldGenRectangle2ContourXldgen_rectangle2_contour_xld returns 2 (
H_MSG_TRUE)
if all parameter
values are correct. If necessary, an exception is raised.
Possible Predecessors
fit_rectangle2_contour_xldfit_rectangle2_contour_xldFitRectangle2ContourXldFitRectangle2ContourXldfit_rectangle2_contour_xld
Alternatives
gen_rectangle2gen_rectangle2GenRectangle2GenRectangle2gen_rectangle2
See also
gen_contour_polygon_xldgen_contour_polygon_xldGenContourPolygonXldGenContourPolygonXldgen_contour_polygon_xld
Module
Foundation