`Point3D`#

class ansys.geometry.core.math.point.Point3D(input: beartype.typing.Union[numpy.ndarray, ansys.geometry.core.typing.RealSequence] = DEFAULT_POINT3D_VALUES, unit: beartype.typing.Optional[pint.Unit] = None)#

Bases: numpy.ndarray, ansys.geometry.core.misc.units.PhysicalQuantity

Provides geometry primitive representation for a 3D point.

Parameters:

inputUnion[ndarray, RealSequence], default: DEFAULT_POINT3D_VALUES: Direction arguments, either as a numpy.ndarray class or as a RealSequence.
unitUnit, default: DEFAULT_UNITS.LENGTH: Units for defining 3D point values.

Overview#

Methods

`unit`	Get the unit of the object.
`base_unit`	Get the base unit of the object.
`transform`	Transform the 3D point with a transformation matrix.

Properties

`x`	X plane component value.
`y`	Y plane component value.
`z`	Z plane component value.

Special methods

`__eq__`	Equals operator for the `Point3D` class.
`__ne__`	Not equals operator for the `Point3D` class.
`__add__`	Add operation for the `Point3D` class.
`__sub__`	Subtraction operation for the `Point3D` class.

Import detail#

from ansys.geometry.core.math.point import Point3D

Property detail#

property Point3D.x: pint.Quantity#: X plane component value.

property Point3D.y: pint.Quantity#: Y plane component value.

property Point3D.z: pint.Quantity#: Z plane component value.

Method detail#

Point3D.__eq__(other: Point3D) → bool#: Equals operator for the Point3D class.

Point3D.__ne__(other: Point3D) → bool#: Not equals operator for the Point3D class.

Point3D.__add__(other: beartype.typing.Union[Point3D, ansys.geometry.core.math.vector.Vector3D]) → Point3D#: Add operation for the Point3D class.

Point3D.__sub__(other: beartype.typing.Union[Point3D, ansys.geometry.core.math.vector.Vector3D]) → Point3D#: Subtraction operation for the Point3D class.

Point3D.unit() → pint.Unit#: Get the unit of the object.

Point3D.base_unit() → pint.Unit#: Get the base unit of the object.

Point3D.transform(matrix: ansys.geometry.core.math.matrix.Matrix44) → Point3D#

Transform the 3D point with a transformation matrix.

Parameters:

matrixMatrix44: 4x4 transformation matrix to apply to the point.

Returns:

Point3D: New 3D point that is the transformed copy of the original 3D point after applying the transformation matrix.

Notes

Transform the Point3D object by applying the specified 4x4 transformation matrix and return a new Point3D object representing the transformed point.