Sphere

class ansys.geometry.core.shapes.surfaces.sphere.Sphere(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.surfaces.surface.Surface

Provides 3D sphere representation.

Parameters:

originUnion[ndarray, RealSequence, Point3D]

Origin of the sphere.

radiusUnion[Quantity, Distance, Real]

Radius of the sphere.

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 surface.
contains_point	Check a point is contained by the surface.

Methods

transformed_copy	Create a transformed copy of the sphere from a transformation matrix.
mirrored_copy	Create a mirrored copy of the sphere along the y-axis.
evaluate	Evaluate the sphere at the given parameters.
project_point	Project a point onto the sphere and evaluate the sphere.
parameterization	Parameterization of the sphere surface as a tuple (U, V).

Properties

origin	Origin of the sphere.
radius	Radius of the sphere.
dir_x	X-direction of the sphere.
dir_y	Y-direction of the sphere.
dir_z	Z-direction of the sphere.
surface_area	Surface area of the sphere.
volume	Volume of the sphere.

Special methods

__eq__

Equals operator for the Sphere class.

Import detail

from ansys.geometry.core.shapes.surfaces.sphere import Sphere

Property detail

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

Origin of the sphere.

property Sphere.radius: pint.Quantity

Radius of the sphere.

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

X-direction of the sphere.

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

Y-direction of the sphere.

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

Z-direction of the sphere.

property Sphere.surface_area: pint.Quantity

Surface area of the sphere.

property Sphere.volume: pint.Quantity

Volume of the sphere.

Method detail

Sphere.__eq__(other: Sphere) → bool

Equals operator for the Sphere class.

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

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

Parameters:

matrixMatrix44

4X4 transformation matrix to apply to the sphere.

Returns:

Sphere

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

Sphere.mirrored_copy() → Sphere

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

Returns:

Sphere

New sphere that is a mirrored copy of the original sphere.

Sphere.evaluate(parameter: ansys.geometry.core.shapes.parameterization.ParamUV) → SphereEvaluation

Evaluate the sphere at the given parameters.

Parameters:

parameterParamUV

Parameters (u,v) to evaluate the sphere at.

Returns:

SphereEvaluation

Resulting evaluation.

Sphere.project_point(point: ansys.geometry.core.math.point.Point3D) → SphereEvaluation

Project a point onto the sphere and evaluate the sphere.

Parameters:

pointPoint3D

Point to project onto the sphere.

Returns:

SphereEvaluation

Resulting evaluation.

Sphere.parameterization() → beartype.typing.Tuple[ansys.geometry.core.shapes.parameterization.Parameterization, ansys.geometry.core.shapes.parameterization.Parameterization]

Parameterization of the sphere surface as a tuple (U, V).

The U parameter specifies the longitude angle, increasing clockwise (east) about dir_z (right-hand corkscrew law). It has a zero parameter at dir_x and a period of 2*pi.

The V parameter specifies the latitude, increasing north, with a zero parameter at the equator and a range of [-pi/2, pi/2].

Returns:

Tuple[Parameterization, Parameterization]

Information about how a sphere’s u and v parameters are parameterized, respectively.

abstract Sphere.contains_param(param_uv: ansys.geometry.core.shapes.parameterization.ParamUV) → bool

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

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

Check a point is contained by the surface.

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