Plane

class ansys.geometry.core.math.plane.Plane(origin: beartype.typing.Union[numpy.ndarray, ansys.geometry.core.typing.RealSequence, ansys.geometry.core.math.point.Point3D] = ZERO_POINT3D, direction_x: beartype.typing.Union[numpy.ndarray, ansys.geometry.core.typing.RealSequence, ansys.geometry.core.math.vector.UnitVector3D, ansys.geometry.core.math.vector.Vector3D] = UNITVECTOR3D_X, direction_y: beartype.typing.Union[numpy.ndarray, ansys.geometry.core.typing.RealSequence, ansys.geometry.core.math.vector.UnitVector3D, ansys.geometry.core.math.vector.Vector3D] = UNITVECTOR3D_Y)

Bases: ansys.geometry.core.math.frame.Frame

Provides primitive representation of a 2D plane in 3D space.

Parameters:

originUnion[ndarray, RealSequence, Point3D], default: ZERO_POINT3D

Centered origin of the frame. The default is ZERO_POINT3D, which is the Cartesian origin.

direction_xUnion[ndarray, RealSequence, UnitVector3D, Vector3D], default: UNITVECTOR3D_X

X-axis direction.

direction_yUnion[ndarray, RealSequence, UnitVector3D, Vector3D], default: UNITVECTOR3D_Y

Y-axis direction.

Overview

Methods

is_point_contained

Check if a 3D point is contained in the plane.

Properties

normal

Calculate the normal vector of the plane.

Special methods

__eq__	Equals operator for the Plane class.
__ne__	Not equals operator for the Plane class.

Import detail

from ansys.geometry.core.math.plane import Plane

Property detail

property Plane.normal: ansys.geometry.core.math.vector.UnitVector3D

Calculate the normal vector of the plane.

Returns:

UnitVector3D

Normal vector of the plane.

Method detail

Plane.is_point_contained(point: ansys.geometry.core.math.point.Point3D) → bool

Check if a 3D point is contained in the plane.

Parameters:

pointPoint3D

Point3D class to check.

Returns:

bool

True if the 3D point is contained in the plane, False otherwise.

Plane.__eq__(other: Plane) → bool

Equals operator for the Plane class.

Plane.__ne__(other: Plane) → bool

Not equals operator for the Plane class.