create_ellipse#
- Modeler3D.create_ellipse(cs_plane, position, major_radius, ratio, is_covered=True, name=None, matname=None)[source]#
Create an ellipse.
- Parameters:
- cs_plane
str
orint
Coordinate system plane for orienting the ellipse.
pyaedt.constants.PLANE
Enumerator can be used as input.- position
list
List of
[x, y, z]
coordinates for the center point of the ellipse.- major_radius
float
Base radius of the ellipse.
- ratio
float
Aspect ratio of the secondary radius to the base radius.
- is_coveredbool,
optional
Whether the ellipse is covered. The default is
True
, in which case the result is a 2D sheet object. IfFalse,
the result is a closed 1D polyline object.- name
str
,optional
Name of the ellipse. The default is
None
, in which case the default name is assigned.- matname
str
,optional
Name of the material. The default is
None
, in which case the default material is assigned.
- cs_plane
- Returns:
pyaedt.modeler.cad.object3d.Object3d
3D object.
References
>>> oEditor.CreateEllipse