Aardvark.Base


Plane2d

A line represented by a (possibly) normalized normal vector and the distance to the origin. Note that the plane does not enforce the normalized normal vector. Equation for points p on the plane: Normal dot p == Distance

Constructors

ConstructorDescription
new(normalizedNormal, distance)
Signature: (normalizedNormal:V2d * distance:float) -> unit

Creates plane from normal vector and constant. IMPORTANT: The supplied vector has to be normalized in order for all methods to work correctly, however if only relative height computations using the method are necessary, the normal vector need not be normalized.

new(normalizedNormal, point)
Signature: (normalizedNormal:V2d * point:V2d) -> unit

Creates plane from point and normal vector. IMPORTANT: The supplied vector has to be normalized in order for all methods to work correctly, however if only relative height computations using the method are necessary, the normal vector need not be normalized.

Instance members

Instance memberDescription
Coefficients
Signature: V3d

Returns the coefficients (a, b, c, d) of the normal equation.

Equals(other)
Signature: other:obj -> bool
Modifiers: abstract
GetHashCode()
Signature: unit -> int
Modifiers: abstract
Height(p)
Signature: p:V2d -> float

The signed height of the supplied point over the plane.

IsInvalid
Signature: bool
Modifiers: abstract

Returns true if the normal of the plane is the zero-vector.

IsValid
Signature: bool
Modifiers: abstract

Returns true if the normal of the plane is not the zero-vector.

NearestPoint(x)
Signature: x:V2d -> V2d

Projets the given point x perpendicular on the plane and returns the nearest point on the plane.

Normalize()
Signature: unit -> unit

Calculates the nomalized plane of this .

Normalized
Signature: Plane2d

Returns the normalized as new .

PlaneXY
Signature: Plane3d

Returns a Plane3d whose cutting-line with the XY-Plane is represented by the Plane2d

PlaneXZ
Signature: Plane3d

Returns a Plane3d whose cutting-line with the XZ-Plane is represented by the Plane2d

PlaneYZ
Signature: Plane3d

Returns a Plane3d whose cutting-line with the YZ-Plane is represented by the Plane2d

Point()
Signature: unit -> unit

The point on the plane which is closest to the origin.

Reverse()
Signature: unit -> unit

Changes sign of normal vector

Reversed
Signature: Plane2d

Returns with normal vector in opposing direction.

Sign(p)
Signature: p:V2d -> int

The sign of the height of the point over the plane.

ToString()
Signature: unit -> string
Modifiers: abstract

Static members

Static memberDescription
Parse(s)
Signature: s:string -> Plane2d
Fork me on GitHub