`Arc`#

class ansys.geometry.core.sketch.arc.Arc(start: ansys.geometry.core.math.point.Point2D, end: ansys.geometry.core.math.point.Point2D, center: ansys.geometry.core.math.point.Point2D, clockwise: beartype.typing.Optional[bool] = False)#

Bases: ansys.geometry.core.sketch.edge.SketchEdge

Provides for modeling an arc.

Parameters:

startPoint2D: Starting point of the arc.
endPoint2D: Ending point of the arc.
centerPoint2D: Center point of the arc.
clockwisebool, default: False: Whether the arc spans the clockwise angle between the start and end points. When False (default), the arc spans the counter-clockwise angle. When True, the arc spands the clockwise angle.

Overview#

Constructors

`from_three_points`	Create an arc from three given points.
`from_start_end_and_radius`	Create an arc from a starting point, an ending point, and a radius.
`from_start_center_and_angle`	Create an arc from a starting point, a center point, and an angle.

Properties

`start`	Starting point of the arc line.
`end`	Ending point of the arc line.
`center`	Center point of the arc.
`length`	Length of the arc.
`radius`	Radius of the arc.
`angle`	Angle of the arc.
`is_clockwise`	Flag indicating whether the rotation of the angle is clockwise.
`sector_area`	Area of the sector of the arc.
`visualization_polydata`	VTK polydata representation for PyVista visualization.

Special methods

`__eq__`	Equals operator for the `Arc` class.
`__ne__`	Not equals operator for the `Arc` class.

Import detail#

from ansys.geometry.core.sketch.arc import Arc

Property detail#

property Arc.start: ansys.geometry.core.math.point.Point2D#: Starting point of the arc line.

property Arc.end: ansys.geometry.core.math.point.Point2D#: Ending point of the arc line.

property Arc.center: ansys.geometry.core.math.point.Point2D#: Center point of the arc.

property Arc.length: pint.Quantity#: Length of the arc.

property Arc.radius: pint.Quantity#: Radius of the arc.

property Arc.angle: pint.Quantity#: Angle of the arc.

property Arc.is_clockwise: bool#

Flag indicating whether the rotation of the angle is clockwise.

Returns:

bool: True if the sense of rotation is clockwise. False if the sense of rotation is counter-clockwise.

property Arc.sector_area: pint.Quantity#: Area of the sector of the arc.

property Arc.visualization_polydata: pyvista.PolyData#

VTK polydata representation for PyVista visualization.

Returns:

pyvista.PolyData: VTK pyvista.Polydata configuration.

Notes

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

Method detail#

Arc.__eq__(other: Arc) → bool#: Equals operator for the Arc class.

Arc.__ne__(other: Arc) → bool#: Not equals operator for the Arc class.

classmethod Arc.from_three_points(start: ansys.geometry.core.math.point.Point2D, inter: ansys.geometry.core.math.point.Point2D, end: ansys.geometry.core.math.point.Point2D)#

Create an arc from three given points.

Parameters:

startPoint2D: Starting point of the arc.
interPoint2D: Intermediate point (location) of the arc.
endPoint2D: Ending point of the arc.

Returns:

Arc: Arc generated from the three points.

classmethod Arc.from_start_end_and_radius(start: ansys.geometry.core.math.point.Point2D, end: ansys.geometry.core.math.point.Point2D, radius: beartype.typing.Union[pint.Quantity, ansys.geometry.core.misc.measurements.Distance, ansys.geometry.core.typing.Real], convex_arc: beartype.typing.Optional[bool] = False, clockwise: beartype.typing.Optional[bool] = False)#

Create an arc from a starting point, an ending point, and a radius.

Parameters:

startPoint2D: Starting point of the arc.
endPoint2D: Ending point of the arc.
radiusUnion[Quantity, Distance, Real]: Radius of the arc.
convex_arcbool, default: False: Whether the arc is convex. The default is False. When False, the arc is concave. When True, the arc is convex.
clockwisebool, default: False: Whether the arc spans the clockwise angle between the start and end points. When False, the arc spans the counter-clockwise angle. When True, the arc spands the clockwise angle.

Returns:

Arc: Arc generated from the three points.

classmethod Arc.from_start_center_and_angle(start: ansys.geometry.core.math.point.Point2D, center: ansys.geometry.core.math.point.Point2D, angle: beartype.typing.Union[ansys.geometry.core.misc.measurements.Angle, pint.Quantity, ansys.geometry.core.typing.Real], clockwise: beartype.typing.Optional[bool] = False)#

Create an arc from a starting point, a center point, and an angle.

Parameters:

startPoint2D: Starting point of the arc.
centerPoint2D: Center point of the arc.
angleUnion[Angle, Quantity, Real]: Angle of the arc.
clockwisebool, default: False: Whether the provided angle should be considered clockwise. When False, the angle is considered counter-clockwise. When True, the angle is considered clockwise.

Returns:

Arc: Arc generated from the three points.

Arc#

Overview#

Import detail#

Property detail#

Method detail#

`Arc`#