The utils.py module#

Summary#

create_elliptical_polydata

Create PyVista PolyData for an ellipse or circle.

Description#

Utility functions for plotting and visualization.

Module detail#

ansys.geometry.core.plotting.utils.create_elliptical_polydata(origin: ansys.geometry.core.math.point.Point3D, dir_x: ansys.geometry.core.math.vector.Vector3D, dir_y: ansys.geometry.core.math.vector.Vector3D, dir_z: ansys.geometry.core.math.vector.Vector3D, major_radius: ansys.geometry.core.typing.Real, minor_radius: Real | None = None, num_points: int = 100) → pyvista.PolyData#

Create PyVista PolyData for an ellipse or circle.

This function creates a discretized representation of an ellipse (or circle) as a closed loop of line segments for visualization purposes.

Parameters:
originPoint3D

Center point of the ellipse/circle.

dir_xVector3D

Direction vector for the major axis (or X axis for circles).

dir_yVector3D

Direction vector for the minor axis (or Y axis for circles).

dir_zVector3D

Normal direction vector.

major_radiusReal

Major radius of the ellipse. For circles, this is the radius.

minor_radiusReal, optional

Minor radius of the ellipse. If None, defaults to major_radius (creating a circle).

num_pointsint, default: 100

Number of points to use for discretization.

Returns:
pyvista.PolyData

VTK PolyData representation with line segments forming a closed loop.

Notes

For a circle, either pass the same value for both radii or only provide major_radius (minor_radius will default to major_radius).