Circle

class ansys.geometry.core.shapes.curves.circle.Circle(origin: beartype.typing.Union[numpy.ndarray, ansys.geometry.core.typing.RealSequence, ansys.geometry.core.math.point.Point3D], radius: beartype.typing.Union[pint.Quantity, ansys.geometry.core.misc.measurements.Distance, ansys.geometry.core.typing.Real], reference: beartype.typing.Union[numpy.ndarray, ansys.geometry.core.typing.RealSequence, ansys.geometry.core.math.vector.UnitVector3D, ansys.geometry.core.math.vector.Vector3D] = UNITVECTOR3D_X, axis: beartype.typing.Union[numpy.ndarray, ansys.geometry.core.typing.RealSequence, ansys.geometry.core.math.vector.UnitVector3D, ansys.geometry.core.math.vector.Vector3D] = UNITVECTOR3D_Z)

Bases: ansys.geometry.core.shapes.curves.curve.Curve

Provides 3D circle representation.

Parameters:

originUnion[ndarray, RealSequence, Point3D]

Origin of the circle.

radiusUnion[Quantity, Distance, Real]

Radius of the circle.

referenceUnion[ndarray, RealSequence, UnitVector3D, Vector3D]

X-axis direction.

axisUnion[ndarray, RealSequence, UnitVector3D, Vector3D]

Z-axis direction.

Overview

Abstract methods

contains_param	Check a parameter is within the parametric range of the curve.
contains_point	Check a point is contained by the curve.

Methods

evaluate	Evaluate the circle at a given parameter.
transformed_copy	Create a transformed copy of the circle from a transformation matrix.
mirrored_copy	Create a mirrored copy of the circle along the y-axis.
project_point	Project a point onto the circle and evauate the circle.
is_coincident_circle	Determine if the circle is coincident with another.
parameterization	Get the parametrization of the circle.

Properties

origin	Origin of the circle.
radius	Radius of the circle.
diameter	Diameter of the circle.
perimeter	Perimeter of the circle.
area	Area of the circle.
dir_x	X-direction of the circle.
dir_y	Y-direction of the circle.
dir_z	Z-direction of the circle.

Special methods

__eq__

Equals operator for the Circle class.

Import detail

from ansys.geometry.core.shapes.curves.circle import Circle

Property detail

property Circle.origin: ansys.geometry.core.math.point.Point3D

Origin of the circle.

property Circle.radius: pint.Quantity

Radius of the circle.

property Circle.diameter: pint.Quantity

Diameter of the circle.

property Circle.perimeter: pint.Quantity

Perimeter of the circle.

property Circle.area: pint.Quantity

Area of the circle.

property Circle.dir_x: ansys.geometry.core.math.vector.UnitVector3D

X-direction of the circle.

property Circle.dir_y: ansys.geometry.core.math.vector.UnitVector3D

Y-direction of the circle.

property Circle.dir_z: ansys.geometry.core.math.vector.UnitVector3D

Z-direction of the circle.

Method detail

Circle.__eq__(other: Circle) → bool

Equals operator for the Circle class.

Circle.evaluate(parameter: ansys.geometry.core.typing.Real) → CircleEvaluation

Evaluate the circle at a given parameter.

Parameters:

parameterReal

Parameter to evaluate the circle at.

Returns:

CircleEvaluation

Resulting evaluation.

Circle.transformed_copy(matrix: ansys.geometry.core.math.matrix.Matrix44) → Circle

Create a transformed copy of the circle from a transformation matrix.

Parameters:

matrixMatrix44

4x4 transformation matrix to apply to the circle.

Returns:

Circle

New circle that is the transformed copy of the original circle.

Circle.mirrored_copy() → Circle

Create a mirrored copy of the circle along the y-axis.

Returns:

Circle

A new circle that is a mirrored copy of the original circle.

Circle.project_point(point: ansys.geometry.core.math.point.Point3D) → CircleEvaluation

Project a point onto the circle and evauate the circle.

Parameters:

pointPoint3D

Point to project onto the circle.

Returns:

CircleEvaluation

Resulting evaluation.

Circle.is_coincident_circle(other: Circle) → bool

Determine if the circle is coincident with another.

Parameters:

otherCircle

Circle to determine coincidence with.

Returns:

bool

True if this circle is coincident with the other, False otherwise.

Circle.parameterization() → ansys.geometry.core.shapes.parameterization.Parameterization

Get the parametrization of the circle.

The parameter of a circle specifies the clockwise angle around the axis (right-hand corkscrew law), with a zero parameter at dir_x and a period of 2*pi.

Returns:

Parameterization

Information about how the circle is parameterized.

abstract Circle.contains_param(param: ansys.geometry.core.typing.Real) → bool

Check a parameter is within the parametric range of the curve.

abstract Circle.contains_point(point: ansys.geometry.core.math.point.Point3D) → bool

Check a point is contained by the curve.

The point can either lie within the curve or on its boundary.