SketchCircle

class ansys.geometry.core.sketch.circle.SketchCircle(center: ansys.geometry.core.math.point.Point2D, radius: beartype.typing.Union[pint.Quantity, ansys.geometry.core.misc.measurements.Distance, ansys.geometry.core.typing.Real], plane: ansys.geometry.core.math.plane.Plane = Plane())

Bases: ansys.geometry.core.sketch.face.SketchFace, ansys.geometry.core.shapes.curves.circle.Circle

Provides for modeling a circle.

Parameters:

center: Point2D

Center point of the circle.

radiusUnion[Quantity, Distance, Real]

Radius of the circle.

planePlane, optional

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

Overview

Methods

plane_change

Redefine the plane containing the SketchCircle objects.

Properties

center	Center of the circle.
perimeter	Perimeter of the circle.
visualization_polydata	VTK polydata representation for PyVista visualization.

Import detail

from ansys.geometry.core.sketch.circle import SketchCircle

Property detail

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

Center of the circle.

property SketchCircle.perimeter: pint.Quantity

Perimeter of the circle.

Notes

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

property SketchCircle.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

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

Redefine the plane containing the SketchCircle objects.

Parameters:

planePlane

Desired new plane that is to contain the sketched circle.

Notes

This implies that their 3D definition might suffer changes.