Companion

Properties

Link copied to clipboard

A constant initialized to the XY plane passing through the origin, with normal in positive Z.

Link copied to clipboard

A constant initialized to the YZ plane passing through the origin, with normal in positive X.

Link copied to clipboard

A constant initialized to the ZX plane passing through the origin, with normal in positive Y.

Functions

Link copied to clipboard
fun clone(plane: Plane, result: Plane? = definedExternally): Plane

Duplicates a Plane instance.

Link copied to clipboard
fun equals(left: Plane, right: Plane): Boolean

Compares the provided Planes by normal and distance and returns true if they are equal, false otherwise.

Link copied to clipboard
fun fromCartesian4(coefficients: Cartesian4, result: Plane? = definedExternally): Plane

Creates a plane from the general equation

Link copied to clipboard
fun fromPointNormal(point: Cartesian3, normal: Cartesian3, result: Plane? = definedExternally): Plane

Creates a plane from a normal and a point on the plane.

Link copied to clipboard

Computes the signed shortest distance of a point to a plane. The sign of the distance determines which side of the plane the point is on. If the distance is positive, the point is in the half-space in the direction of the normal; if negative, the point is in the half-space opposite to the normal; if zero, the plane passes through the point.

Link copied to clipboard
fun projectPointOntoPlane(plane: Plane, point: Cartesian3, result: Cartesian3? = definedExternally): Cartesian3

Projects a point onto the plane.

Link copied to clipboard
fun transform(plane: Plane, transform: Matrix4, result: Plane? = definedExternally): Plane

Transforms the plane by the given transformation matrix.