create_circle#

Modeler2D.create_circle(origin, radius, num_sides: int = 0, is_covered: bool = True, name: str | None = None, material: str | None = None, non_model: bool = False, **kwargs)#

Create a circle.

Parameters:

originlist

ApplicationName.modeler.Position(x,y,z) object

radiusfloat or str

Radius of the object.

num_sidesint, optional

Number of sides. The default is 0, which is correct for a circle.

is_coveredbool

Specify whether the ellipse is a sheet (covered) or a line object

namestr, optional

Name of the object. The default is None. If None , a unique name "NewObject_xxxxxx" will be assigned)

materialstr, optional

Name of the material. The default is None. If None, the default material is assigned.

non_modelbool, optional

Either to create the new object as model or non-model. The default is False.

**kwargsoptional: Additional keyword arguments may be passed when creating the primitive to set properties. See ansys.aedt.core.modeler.cad.object_3d.Object3d for more details.

Returns:

ansys.aedt.core.modeler.cad.object_3d.Object3d: 3D object.

References

>>> oEditor.CreateCircle

Examples

>>> circle1 = aedtapp.modeler.create_circle([0, -2, -2], 3)
>>> circle2 = aedtapp.modeler.create_circle(
...     origin=[0, -2, -2],
...     radius=3,
...     num_sides=6,
...     name="MyCircle",
...     material="Copper",
... )