@huukhanhnguyen/geometry / catalog/axis

catalog/axis#

Axis#

const Axis: { closestPoint: (axis, point) => Point; direction: (axis) => Vector; distanceToPoint: (axis, point) => number; fromNormal: (nx, ny, nz, origin_x, origin_y, origin_z) => Float64Array<ArrayBufferLike> | undefined; fromNormalAndRef: (nx, ny, nz, ref_x, ref_y, ref_z, origin_x, origin_y, origin_z) => Float64Array<ArrayBufferLike> | undefined; fromPointDirection: (origin, direction) => Axis; fromTangent: (origin_x, origin_y, origin_z, tx, ty, tz) => Float64Array; fromTransformation: (matrix) => Float64Array; fromTwoPoints: (from, to) => Axis; origin: (axis) => Point; pointAt: (axis, distance) => Point; rotate: (frame, axis_x, axis_y, axis_z, angle) => Float64Array; shortestSegment: (a, b) => [Point, Point] | undefined; toTransformation: (frame) => Float64Array; withOrigin: (frame, origin_x, origin_y, origin_z) => Float64Array; }

The generated wasm namespace plus the members that need a TS reshape. Re-exported from src/index.ts, where it shadows the generated Axis.

closestPoint#

closestPoint: (axis, point) => Point

Point on axis closest to point.

Parameters#

axis#

Axis

point#

Point

Returns#

Point

direction#

direction: (axis) => Vector

Parameters#

axis#

Axis

Returns#

Vector

distanceToPoint#

distanceToPoint: (axis, point) => number

Perpendicular distance from point to axis.

Parameters#

axis#

Axis

point#

Point

Returns#

number

fromNormal#

fromNormal: (nx, ny, nz, origin_x, origin_y, origin_z) => Float64Array<ArrayBufferLike> | undefined = wasm.axes_from_normal

undefined where the TS throws on a zero-length normal.

Parameters#

nx#

number

ny#

number

nz#

number

origin_x#

number

origin_y#

number

origin_z#

number

Returns#

Float64Array<ArrayBufferLike> | undefined

fromNormalAndRef#

fromNormalAndRef: (nx, ny, nz, ref_x, ref_y, ref_z, origin_x, origin_y, origin_z) => Float64Array<ArrayBufferLike> | undefined = wasm.axes_from_normal_and_ref

undefined where the TS throws on a zero-length normal.

Parameters#

nx#

number

ny#

number

nz#

number

ref_x#

number

ref_y#

number

ref_z#

number

origin_x#

number

origin_y#

number

origin_z#

number

Returns#

Float64Array<ArrayBufferLike> | undefined

fromPointDirection#

fromPointDirection: (origin, direction) => Axis

Parameters#

origin#

Point

direction#

Vector

Returns#

Axis

fromTangent#

fromTangent: (origin_x, origin_y, origin_z, tx, ty, tz) => Float64Array = wasm.axes_from_tangent

Parameters#

origin_x#

number

origin_y#

number

origin_z#

number

tx#

number

ty#

number

tz#

number

Returns#

Float64Array

fromTransformation#

fromTransformation: (matrix) => Float64Array = wasm.axes_from_transformation

Parameters#

matrix#

Float64Array

Returns#

Float64Array

fromTwoPoints#

fromTwoPoints: (from, to) => Axis

Parameters#

from#

Point

to#

Point

Returns#

Axis

origin#

origin: (axis) => Point

Parameters#

axis#

Axis

Returns#

Point

pointAt#

pointAt: (axis, distance) => Point

Parameters#

axis#

Axis

distance#

number

Returns#

Point

rotate#

rotate: (frame, axis_x, axis_y, axis_z, angle) => Float64Array = wasm.axes_rotate

Parameters#

frame#

Float64Array

axis_x#

number

axis_y#

number

axis_z#

number

angle#

number

Returns#

Float64Array

shortestSegment#

shortestSegment: (a, b) => [Point, Point] | undefined

The two closest points between skew axes as [onA, onB]; undefined when the axes are parallel (the crate hands back an empty table).

Parameters#

a#

Axis

b#

Axis

Returns#

[Point, Point] | undefined

toTransformation#

toTransformation: (frame) => Float64Array = wasm.axes_to_transformation

Parameters#

frame#

Float64Array

Returns#

Float64Array

withOrigin#

withOrigin: (frame, origin_x, origin_y, origin_z) => Float64Array = wasm.axes_with_origin

Parameters#

frame#

Float64Array

origin_x#

number

origin_y#

number

origin_z#

number

Returns#

Float64Array

closestPoint()#

closestPoint(axis, point): Point

Point on axis closest to point.

Parameters#

axis#

Axis

point#

Point

Returns#

Point

direction()#

direction(axis): Vector

Parameters#

axis#

Axis

Returns#

Vector

distanceToPoint()#

distanceToPoint(axis, point): number

Perpendicular distance from point to axis.

Parameters#

axis#

Axis

point#

Point

Returns#

number

fromPointDirection()#

fromPointDirection(origin, direction): Axis

Parameters#

origin#

Point

direction#

Vector

Returns#

Axis

fromTwoPoints()#

fromTwoPoints(from, to): Axis

Parameters#

from#

Point

to#

Point

Returns#

Axis

origin()#

origin(axis): Point

Parameters#

axis#

Axis

Returns#

Point

pointAt()#

pointAt(axis, distance): Point

Parameters#

axis#

Axis

distance#

number

Returns#

Point

shortestSegment()#

shortestSegment(a, b): [Point, Point] | undefined

The two closest points between skew axes as [onA, onB]; undefined when the axes are parallel (the crate hands back an empty table).

Parameters#

a#

Axis

b#

Axis

Returns#

[Point, Point] | undefined