Constructor
new PlaneHelper(spacing, imageOrientation, viewOrientation)
| Name | Type | Description |
|---|---|---|
spacing | Spacing | The spacing. |
imageOrientation | Matrix33 | The image oientation. |
viewOrientation | Matrix33 | The view orientation. |
- Source
Classes
Methods
getImageDeOrientedPoint3D(point) → {Point3D}
De-orient an input point from image to target space.
| Name | Type | Description |
|---|---|---|
point | Point3D | The input point. |
- Source
The de-orienteded point.
- Type:
- Point3D
getImageDeOrientedVector3D(vector) → {Vector3D}
De-orient an input vector from image to target space.
| Name | Type | Description |
|---|---|---|
vector | Vector3D | The input vector. |
- Source
The de-orienteded vector.
- Type:
- Vector3D
getImageOrientedPoint3D(planePoint) → {Point3D}
Orient an input point from target to image space.
| Name | Type | Description |
|---|---|---|
planePoint | Point3D | The input vector. |
- Source
The orienteded vector.
- Type:
- Point3D
getImageOrientedVector3D(planeVector) → {Vector3D}
Orient an input vector from target to image space.
| Name | Type | Description |
|---|---|---|
planeVector | Vector3D | The input vector. |
- Source
The orienteded vector.
- Type:
- Vector3D
getNativeScrollIndex() → {number}
Get the native (image) scroll dimension index.
- Source
The index.
- Type:
- number
getOffset3DFromPlaneOffset(offset2D) → {Vector3D}
Get a 3D offset from a plane one.
| Name | Type | Description |
|---|---|---|
offset2D | object | The plane offset as {x,y}. |
- Source
The 3D world offset.
- Type:
- Vector3D
getPlaneOffsetFromOffset3D(offset3D) → {object}
Get a plane offset from a 3D one.
| Name | Type | Description |
|---|---|---|
offset3D | object | The 3D offset as {x,y,z}. |
- Source
The plane offset as {x,y}.
- Type:
- object
getScrollIndex() → {number}
Get the (view) scroll dimension index.
- Source
The index.
- Type:
- number
getTargetDeOrientedPoint3D(planePoint) → {Point3D}
De-orient an input point from target to real space.
| Name | Type | Description |
|---|---|---|
planePoint | Point3D | The input point. |
- Source
The de-orienteded point.
- Type:
- Point3D
getTargetDeOrientedVector3D(planeVector) → {Vector3D}
De-orient an input vector from target to real space.
| Name | Type | Description |
|---|---|---|
planeVector | Vector3D | The input vector. |
- Source
The de-orienteded vector.
- Type:
- Vector3D
getTargetOrientedPositiveXYZ(values) → {object}
Reorder values to follow target orientation.
| Name | Type | Description |
|---|---|---|
values | object | Values as {x,y,z}. |
- Source
Reoriented values as {x,y,z}.
- Type:
- object
getTargetOrientedVector3D(vector) → {Vector3D}
Orient an input vector from real to target space.
| Name | Type | Description |
|---|---|---|
vector | Vector3D | The input vector. |
- Source
The oriented vector.
- Type:
- Vector3D