Cone#

class ansys.geometry.core.shapes.surfaces.cone.Cone(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], half_angle: beartype.typing.Union[pint.Quantity, ansys.geometry.core.misc.measurements.Angle, 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 cone representation.

Parameters:
originUnion[ndarray, RealSequence, Point3D]

Origin of the cone.

radiusUnion[Quantity, Distance, Real]

Radius of the cone.

half_angleUnion[Quantity, Angle, Real]

Half angle of the apex, determining the upward angle.

referenceUnion[ndarray, RealSequence, UnitVector3D, Vector3D]

X-axis direction.

axisUnion[ndarray, RealSequence, UnitVector3D, Vector3D]

Z-axis direction.

Overview#

contains_param

Test whether a parameter is within the parametric range of the surface.

contains_point

Test whether the point is contained by the surface.

transformed_copy

Create a transformed copy of the cone based on a transformation matrix.

mirrored_copy

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

evaluate

Evaluate the cone at given parameters.

project_point

Project a point onto the cone and evaluate the cone.

parameterization

Parameterize the cone surface as a tuple (U and V respectively).

origin

Origin of the cone.

radius

Radius of the cone.

half_angle

Half angle of the apex.

dir_x

X-direction of the cone.

dir_y

Y-direction of the cone.

dir_z

Z-direction of the cone.

height

Height of the cone.

surface_area

Surface area of the cone.

volume

Volume of the cone.

apex

Apex point of the cone.

apex_param

Apex parameter of the cone.

__eq__

Equals operator for the Cone class.

Import detail#

from ansys.geometry.core.shapes.surfaces.cone import Cone

Property detail#

property Cone.origin: ansys.geometry.core.math.point.Point3D#

Origin of the cone.

property Cone.radius: pint.Quantity#

Radius of the cone.

property Cone.half_angle: pint.Quantity#

Half angle of the apex.

property Cone.dir_x: ansys.geometry.core.math.vector.UnitVector3D#

X-direction of the cone.

property Cone.dir_y: ansys.geometry.core.math.vector.UnitVector3D#

Y-direction of the cone.

property Cone.dir_z: ansys.geometry.core.math.vector.UnitVector3D#

Z-direction of the cone.

property Cone.height: pint.Quantity#

Height of the cone.

property Cone.surface_area: pint.Quantity#

Surface area of the cone.

property Cone.volume: pint.Quantity#

Volume of the cone.

property Cone.apex: ansys.geometry.core.math.point.Point3D#

Apex point of the cone.

property Cone.apex_param: ansys.geometry.core.typing.Real#

Apex parameter of the cone.

Method detail#

Cone.transformed_copy(matrix: ansys.geometry.core.math.matrix.Matrix44) Cone#

Create a transformed copy of the cone based on a transformation matrix.

Parameters:
matrixMatrix44

4x4 transformation matrix to apply to the cone.

Returns:
Cone

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

Cone.mirrored_copy() Cone#

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

Returns:
Cone

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

Cone.__eq__(other: Cone) bool#

Equals operator for the Cone class.

Cone.evaluate(parameter: ansys.geometry.core.shapes.parameterization.ParamUV) ConeEvaluation#

Evaluate the cone at given parameters.

Parameters:
parameterParamUV

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

Returns:
ConeEvaluation

Resulting evaluation.

Cone.project_point(point: ansys.geometry.core.math.point.Point3D) ConeEvaluation#

Project a point onto the cone and evaluate the cone.

Parameters:
pointPoint3D

Point to project onto the cone.

Returns:
ConeEvaluation

Resulting evaluation.

Cone.parameterization() beartype.typing.Tuple[ansys.geometry.core.shapes.parameterization.Parameterization, ansys.geometry.core.shapes.parameterization.Parameterization]#

Parameterize the cone surface as a tuple (U and V respectively).

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

The V parameter specifies the distance along the axis, with a zero parameter at the XY plane of the cone.

Returns:
Tuple[Parameterization, Parameterization]

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

abstract Cone.contains_param(param_uv: ansys.geometry.core.shapes.parameterization.ParamUV) bool#

Test whether a parameter is within the parametric range of the surface.

abstract Cone.contains_point(point: ansys.geometry.core.math.point.Point3D) bool#

Test whether the point is contained by the surface.

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