SketchEllipse

class ansys.geometry.core.sketch.ellipse.SketchEllipse(center: ansys.geometry.core.math.point.Point2D, major_radius: beartype.typing.Union[pint.Quantity, ansys.geometry.core.misc.measurements.Distance, ansys.geometry.core.typing.Real], minor_radius: beartype.typing.Union[pint.Quantity, ansys.geometry.core.misc.measurements.Distance, ansys.geometry.core.typing.Real], angle: beartype.typing.Optional[beartype.typing.Union[pint.Quantity, ansys.geometry.core.misc.measurements.Angle, ansys.geometry.core.typing.Real]] = 0, plane: ansys.geometry.core.math.plane.Plane = Plane())

Bases: ansys.geometry.core.sketch.face.SketchFace, ansys.geometry.core.shapes.curves.ellipse.Ellipse

Provides for modeling an ellipse.

Parameters:

center: Point2D

Center point of the ellipse.

major_radiusUnion[Quantity, Distance, Real]

Major radius of the ellipse.

minor_radiusUnion[Quantity, Distance, Real]

Minor radius of the ellipse.

angleUnion[Quantity, Angle, Real], default: 0

Placement angle for orientation alignment.

planePlane, optional

Plane containing the sketched ellipse, which is the global XY plane by default.

Overview

Methods

plane_change

Redefine the plane containing SketchEllipse objects.

Properties

center	Center point of the ellipse.
angle	Orientation angle of the ellipse.
perimeter	Perimeter of the circle.
visualization_polydata	VTK polydata representation for PyVista visualization.

Import detail

from ansys.geometry.core.sketch.ellipse import SketchEllipse

Property detail

property SketchEllipse.center: ansys.geometry.core.math.point.Point2D

Center point of the ellipse.

property SketchEllipse.angle: pint.Quantity

Orientation angle of the ellipse.

property SketchEllipse.perimeter: pint.Quantity

Perimeter of the circle.

Notes

This property resolves the dilemma between using the SkethFace.perimeter property and the Ellipse.perimeter property.

property SketchEllipse.visualization_polydata: pyvista.PolyData

VTK polydata representation for PyVista visualization.

The representation lies in the X/Y plane within the standard global Cartesian coordinate system.

Returns:

pyvista.PolyData

VTK pyvista.Polydata configuration.

Method detail

SketchEllipse.plane_change(plane: ansys.geometry.core.math.plane.Plane) → None

Redefine the plane containing SketchEllipse objects.

Parameters:

planePlane

Desired new plane that is to contain the sketched ellipse.

Notes

This implies that their 3D definition might suffer changes.