The global XY plane, centered at the origin with a normal in the positive Z direction.

Plane3d.xy
--> Plane3d.through Point3d.origin Direction3d.z

The global YZ plane, centered at the origin with a normal in the positive X direction.

Plane3d.yz
--> Plane3d.through Point3d.origin Direction3d.x

The global ZX plane, centered at the origin with a normal in the positive Y direction.

Plane3d.zx
--> Plane3d.through Point3d.origin Direction3d.y

Construct a plane through the given point, with the given normal direction.

xyPlane =
    Plane3d.through Point3d.origin Direction3d.z

Construct a plane with the given normal direction, through the given point. Flipped version of through.

plane =
    Plane3d.withNormalDirection Direction3d.y
        (Point3d.meters 2 1 3)

Attempt to construct a plane passing through the three given points. The origin point of the resulting plane will be equal to the first given point, and the normal direction will be such that the three given points are in counterclockwise order around it according to the right-hand rule. If the three given points are collinear, returns Nothing.

Plane3d.throughPoints
    (Point3d.meters 2 0 0)
    (Point3d.meters 3 0 0)
    (Point3d.meters 4 1 1)
--> Just <|
-->     Plane3d.through (Point3d.meters 2 0 0)
-->         (Direction3d.yz (Angle.degrees 135))


Plane3d.throughPoints
    (Point3d.meters 2 0 0)
    (Point3d.meters 3 0 0)
    (Point3d.meters 4 0 0)
--> Nothing

Get the origin point of a plane.

Get the normal direction of a plane.

Construct an axis from the origin point and normal direction of a plane.

Plane3d.normalAxis Plane3d.zx
--> Axis3d.y

Shift a plane in its own normal direction by the given (signed) distance.

Plane3d.offsetBy (Length.meters 1) Plane3d.zx
--> Plane3d.withNormalDirection Direction3d.y
-->     (Point3d.meters 0 1 0)


Plane3d.offsetBy (Length.meters -2) Plane3d.xy
--> Plane3d.withNormalDirection Direction3d.z
-->     (Point3d.meters 0 0 -2)

Reverse a plane's normal direction while leaving its origin point unchanged.

Alias for flip, for consistency with Frame3d.reverseX etc.

Rotate a plane around an axis by a given angle.

Plane3d.xy
    |> Plane3d.rotateAround Axis3d.y (Angle.degrees 90)
--> Plane3d.yz

Translate a plane by a given displacement. Applies the given displacement to the plane's origin point and leaves its normal direction unchanged.

Translate a plane in a given direction by a given distance.

Move a plane so that it has the given origin point but unchanged normal direction.

Mirror one plane across another. The plane to mirror across is given first and the plane to mirror is given second.

plane =
    Plane3d.withNormalDirection Direction3d.z
        (Point3d.meters 1 2 3)


Plane3d.mirrorAcross Plane3d.xy plane
--> Plane3d.withNormalDirection Direction3d.negativeZ
-->     (Point3d.meters 1 2 -3)

Convert a plane from one units type to another, by providing a conversion factor given as a rate of change of destination units with respect to source units.

Convert a plane from one units type to another, by providing an 'inverse' conversion factor given as a rate of change of source units with respect to destination units.

Take a plane defined in global coordinates, and return it expressed in local coordinates relative to a given reference frame.

Take a plane defined in local coordinates relative to a given reference frame, and return that plane expressed in global coordinates.