Header menu logo Euclid

PPlane Type

A struct containing one 3D point and three 3D unit vectors, representing an immutable parametrized plane or frame with unitized X, Y and Z Direction. This struct is called 'PPlane'; the other plane 'NPlane' refers to an un-oriented plane consisting only of an origin and a normal. Note: Never use the struct default constructor PPlane() as it will create an invalid zero length PPlane. Use PPlane.create or PPlane.createUnchecked instead.

Record fields

Record Field Description

Origin

Full Usage: Origin

Field type: Pnt

The field holding the Origin 3D point of this PPlane.

Field type: Pnt

Xaxis

Full Usage: Xaxis

Field type: UnitVec

The field holding the local X-axis of this PPlane.

Field type: UnitVec

Yaxis

Full Usage: Yaxis

Field type: UnitVec

The field holding the local Y-axis of this PPlane.

Field type: UnitVec

Zaxis

Full Usage: Zaxis

Field type: UnitVec

The field holding the local Z-axis of this PPlane.

Field type: UnitVec

Instance members

Instance member Description

this.AsFSharpCode

Full Usage: this.AsFSharpCode

Returns: string

Format PPlane into an F# code string that can be used to recreate the plane.

Returns: string

this.AsString

Full Usage: this.AsString

Returns: string

Format PPlane into string with nicely formatted floating point numbers. But without type name as in pl.ToString()

Returns: string

Static members

Static member Description

PPlane.createUnchecked (origin, axisX, axisY, axisZ)

Full Usage: PPlane.createUnchecked (origin, axisX, axisY, axisZ)

Parameters:
Returns: PPlane
Modifiers: inline

Unsafe internal constructor, doesn't check if the input is perpendicular. Requires correct input of unitized perpendicular vectors.

origin : Pnt
axisX : UnitVec
axisY : UnitVec
axisZ : UnitVec
Returns: PPlane

Type something to start searching.