Class: PlaneHelper

new PlaneHelper(spacing, imageOrientation, viewOrientation)

Plane geometry helper.

Parameters:

Name	Type	Description
`spacing`	dwv.image.Spacing	The spacing.
`imageOrientation`	dwv.math.Matrix	The image oientation.
`viewOrientation`	dwv.math.Matrix	The view orientation.

Source: src/image/planeHelper.js, line 13

Methods

getImageDeOrientedVector3D(vector) → {dwv.math.Vector3D}

De-orient an input vector from image to target space. WARN: returns absolute values... TODO: check why abs is needed...

Parameters:

Name	Type	Description
`vector`	dwv.math.Vector3D	The input vector.

Source: src/image/planeHelper.js, line 122

Returns:

The de-orienteded vector.

Type:: dwv.math.Vector3D

getImageOrientedVector3D(planeVector) → {dwv.math.Vector3D}

Orient an input vector from target to image space. WARN: returns absolute values... TODO: check why abs is needed...

Parameters:

Name	Type	Description
`planeVector`	dwv.math.Vector3D	The input vector.

Source: src/image/planeHelper.js, line 94

Returns:

The orienteded vector.

Type:: dwv.math.Vector3D

getNativeScrollIndex() → {number}

Get the native (image) scroll dimension index.

Source: src/image/planeHelper.js, line 185

Returns:

The index.

Type:: number

getOffset3DFromPlaneOffset(offset2D) → {dwv.math.Vector3D}

Get a 3D offset from a plane one.

Parameters:

Name	Type	Description
`offset2D`	object	The plane offset as {x,y}.

Source: src/image/planeHelper.js, line 24

Returns:

The 3D world offset.

Type:: dwv.math.Vector3D

getPlaneOffsetFromOffset3D(offset3D) → {object}

Get a plane offset from a 3D one.

Parameters:

Name	Type	Description
`offset3D`	object	The 3D offset as {x,y,z}.

Source: src/image/planeHelper.js, line 43

Returns:

The plane offset as {x,y}.

Type:: object

getScrollIndex() → {number}

Get the (view) scroll dimension index.

Source: src/image/planeHelper.js, line 170

Returns:

The index.

Type:: number

getTargetDeOrientedVector3D(planeVector) → {dwv.math.Vector3D}

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

Parameters:

Name	Type	Description
`planeVector`	dwv.math.Vector3D	The input vector.

Source: src/image/planeHelper.js, line 78

Returns:

The de-orienteded vector.

Type:: dwv.math.Vector3D

getTargetOrientedPositiveXYZ(values) → {object}

Reorder values to follow target orientation. WARN: returns absolute values... TODO: check why abs is needed...

Parameters:

Name	Type	Description
`values`	object	Values as {x,y,z}.

Source: src/image/planeHelper.js, line 150

Returns:

Reoriented values as {x,y,z}.

Type:: object

getTargetOrientedVector3D(vector) → {dwv.math.Vector3D}

Orient an input vector from real to target space.

Parameters:

Name	Type	Description
`vector`	dwv.math.Vector3D	The input vector.

Source: src/image/planeHelper.js, line 64

Returns:

The oriented vector.

Type:: dwv.math.Vector3D