Surface#

class ansys.geometry.core.shapes.surfaces.surface.Surface#

Bases: abc.ABC

Provides the abstract base class for a 3D surface.

Overview#

parameterization

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

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 surface.

__eq__

Determine if two surfaces are equal.

evaluate

Evaluate the surface at the given parameter.

project_point

Project a point to the surface.

trim

Trim this surface by bounding it with a BoxUV.

Import detail#

from ansys.geometry.core.shapes.surfaces.surface import Surface

Method detail#

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

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

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

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

abstract Surface.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.

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

Create a transformed copy of the surface.

abstract Surface.__eq__(other: Surface) bool#

Determine if two surfaces are equal.

abstract Surface.evaluate(parameter: ansys.geometry.core.shapes.parameterization.ParamUV) ansys.geometry.core.shapes.surfaces.surface_evaluation.SurfaceEvaluation#

Evaluate the surface at the given parameter.

abstract Surface.project_point(point: ansys.geometry.core.math.point.Point3D) ansys.geometry.core.shapes.surfaces.surface_evaluation.SurfaceEvaluation#

Project a point to the surface.

This method returns the evaluation at the closest point.

Surface.trim(box_uv: ansys.geometry.core.shapes.box_uv.BoxUV) ansys.geometry.core.shapes.surfaces.trimmed_surface.TrimmedSurface#

Trim this surface by bounding it with a BoxUV.

Returns:
TrimmedSurface

The resulting bounded surface.