PlaneHelper

Plane geometry helper.

Constructor

new PlaneHelper(spacing, imageOrientation, viewOrientation)

Parameters:
NameTypeDescription
spacingSpacing

The spacing.

imageOrientationMatrix33

The image oientation.

viewOrientationMatrix33

The view orientation.

Classes

PlaneHelper

Methods

getImageDeOrientedPoint3D(point) → {Point3D}

De-orient an input point from image to target space.

Parameters:
NameTypeDescription
pointPoint3D

The input point.

Returns:

The de-orienteded point.

Type: 
Point3D

getImageDeOrientedVector3D(vector) → {Vector3D}

De-orient an input vector from image to target space.

Parameters:
NameTypeDescription
vectorVector3D

The input vector.

Returns:

The de-orienteded vector.

Type: 
Vector3D

getImageOrientedPoint3D(planePoint) → {Point3D}

Orient an input point from target to image space.

Parameters:
NameTypeDescription
planePointPoint3D

The input vector.

Returns:

The orienteded vector.

Type: 
Point3D

getImageOrientedVector3D(planeVector) → {Vector3D}

Orient an input vector from target to image space.

Parameters:
NameTypeDescription
planeVectorVector3D

The input vector.

Returns:

The orienteded vector.

Type: 
Vector3D

getNativeScrollIndex() → {number}

Get the native (image) scroll dimension index.

Returns:

The index.

Type: 
number

getOffset3DFromPlaneOffset(offset2D) → {Vector3D}

Get a 3D offset from a plane one.

Parameters:
NameTypeDescription
offset2DScalar2D

The plane offset as {x,y}.

Returns:

The 3D world offset.

Type: 
Vector3D

getPlaneOffsetFromOffset3D(offset3D) → {Scalar2D}

Get a plane offset from a 3D one.

Parameters:
NameTypeDescription
offset3DScalar3D

The 3D offset as {x,y,z}.

Returns:

The plane offset as {x,y}.

Type: 
Scalar2D

getScrollIndex() → {number}

Get the (view) scroll dimension index.

Returns:

The index.

Type: 
number

getTargetDeOrientedPoint3D(planePoint) → {Point3D}

De-orient an input point from target to real space.

Parameters:
NameTypeDescription
planePointPoint3D

The input point.

Returns:

The de-orienteded point.

Type: 
Point3D

getTargetDeOrientedVector3D(planeVector) → {Vector3D}

De-orient an input vector from target to real space.

Parameters:
NameTypeDescription
planeVectorVector3D

The input vector.

Returns:

The de-orienteded vector.

Type: 
Vector3D

getTargetOrientedPositiveXYZ(values) → {Scalar3D}

Reorder values to follow target orientation.

Parameters:
NameTypeDescription
valuesScalar3D

Values as {x,y,z}.

Returns:

Reoriented values as {x,y,z}.

Type: 
Scalar3D

getTargetOrientedVector3D(vector) → {Vector3D}

Orient an input vector from real to target space.

Parameters:
NameTypeDescription
vectorVector3D

The input vector.

Returns:

The oriented vector.

Type: 
Vector3D