PlaneSurface

class ansys.geometry.core.shapes.surfaces.plane.PlaneSurface(origin: beartype.typing.Union[numpy.ndarray, ansys.geometry.core.typing.RealSequence, ansys.geometry.core.math.point.Point3D], 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 plane surface representation.

Parameters:

originUnion[ndarray, RealSequence, Point3D],

Centered origin of the plane.

referenceUnion[ndarray, RealSequence, UnitVector3D, Vector3D]

X-axis direction.

axisUnion[ndarray, RealSequence, UnitVector3D, Vector3D]

X-axis direction.

Overview

Abstract methods

contains_param	Check a ParamUV is within the parametric range of the surface.
contains_point	Check whether a 3D point is in the domain of the plane.

Methods

parameterization	Parametrize the plane.
project_point	Evaluate the plane at a given 3D point.
transformed_copy	Get a transformed version of the plane given the transform.
evaluate	Evaluate the plane at a given u and v parameter.

Properties

origin	Origin of the cylinder.
dir_x	X-direction of the cylinder.
dir_y	Y-direction of the cylinder.
dir_z	Z-direction of the cylinder.

Special methods

__eq__

Check whether two planes are equal.

Import detail

from ansys.geometry.core.shapes.surfaces.plane import PlaneSurface

Property detail

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

Origin of the cylinder.

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

X-direction of the cylinder.

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

Y-direction of the cylinder.

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

Z-direction of the cylinder.

Method detail

PlaneSurface.__eq__(other: PlaneSurface) → bool

Check whether two planes are equal.

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

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

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

Check whether a 3D point is in the domain of the plane.

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

Parametrize the plane.

PlaneSurface.project_point(point: ansys.geometry.core.math.point.Point3D) → ansys.geometry.core.shapes.surfaces.surface_evaluation.SurfaceEvaluation

Evaluate the plane at a given 3D point.

PlaneSurface.transformed_copy(matrix: ansys.geometry.core.math.matrix.Matrix44) → ansys.geometry.core.shapes.surfaces.surface.Surface

Get a transformed version of the plane given the transform.

PlaneSurface.evaluate(parameter: ansys.geometry.core.shapes.parameterization.ParamUV) → PlaneEvaluation

Evaluate the plane at a given u and v parameter.