new PlaneHelper(spacing, orientation)
- Source:
Plane geometry helper.
Parameters:
| Name | Type | Description |
|---|---|---|
spacing |
dwv.image.Spacing | The spacing. |
orientation |
dwv.math.Matrix | The orientation. |
Methods
getDeOrientedVector3D(planeVector) → {dwv.math.Vector3D}
- Source:
De-orient an input vector.
Parameters:
| Name | Type | Description |
|---|---|---|
planeVector |
dwv.math.Vector3D | The input vector. |
Returns:
The de-orienteded vector.
- Type
- dwv.math.Vector3D
getDeOrientedXYZ(values) → {object}
- Source:
Reorder values to compensate for orientation.
Parameters:
| Name | Type | Description |
|---|---|---|
values |
object | Values as {x,y,z}. |
Returns:
'Deoriented' values as {x,y,z}.
- Type
- object
getOffset3DFromPlaneOffset(offset2D) → {dwv.math.Vector3D}
- Source:
Get a 3D offset from a plane one.
Parameters:
| Name | Type | Description |
|---|---|---|
offset2D |
object | The plane offset as {x,y}. |
Returns:
The 3D world offset.
- Type
- dwv.math.Vector3D
getOrientedIndex(index) → {dwv.math.Index}
- Source:
Orient an input index.
Parameters:
| Name | Type | Description |
|---|---|---|
index |
dwv.math.Index | The input index. |
Returns:
The oriented index.
- Type
- dwv.math.Index
getOrientedPoint(point) → {dwv.math.Point3D}
- Source:
Orient an input point.
Parameters:
| Name | Type | Description |
|---|---|---|
point |
dwv.math.Point3D | The input point. |
Returns:
The oriented point.
- Type
- dwv.math.Point3D
getOrientedVector3D(vector) → {dwv.math.Vector3D}
- Source:
Orient an input vector.
Parameters:
| Name | Type | Description |
|---|---|---|
vector |
dwv.math.Vector3D | The input vector. |
Returns:
The oriented vector.
- Type
- dwv.math.Vector3D
getOrientedXYZ(values) → {object}
- Source:
Reorder values to follow orientation.
Parameters:
| Name | Type | Description |
|---|---|---|
values |
object | Values as {x,y,z}. |
Returns:
Reoriented values as {x,y,z}.
- Type
- object
getPlaneOffsetFromOffset3D(offset3D) → {object}
- Source:
Get a plane offset from a 3D one.
Parameters:
| Name | Type | Description |
|---|---|---|
offset3D |
dwv.math.Point3D | The 3D offset. |
Returns:
The plane offset as {x,y}.
- Type
- object
getScrollIndex() → {number}
- Source:
Get the scroll dimension index.
Returns:
The index.
- Type
- number
(inner) offsetIndexToWorld(off) → {dwv.math.Vector3D}
- Source:
Apply spacing to an offset.
Parameters:
| Name | Type | Description |
|---|---|---|
off |
dwv.math.Point3D | The 3D offset. |
Returns:
The world offset.
- Type
- dwv.math.Vector3D
(inner) offsetWorldToIndex(off) → {dwv.math.Vector3D}
- Source:
Remove spacing from an offset.
Parameters:
| Name | Type | Description |
|---|---|---|
off |
object | The world offset object as {x,y,z}. |
Returns:
The 3D offset.
- Type
- dwv.math.Vector3D