API / geotoolkit3d / scene / reservoir / IJKIndex / IJKIndex
A Reservoir IJK index
This object represents a cell index
Constructors
- [new IJKIndex(options, j, k)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.scene-3.reservoir-2.ijkindex.ijkindex.md#new ijkindex(options, j, k))
Methods
Methods
▸ add(ijk): IJKIndex
Add ijk index to this index
| Name | Type | Description |
|---|---|---|
ijk | IJKIndex | adds ijk to this index |
this
▸ fromArray(array): IJKIndex
Set the ijk coordinate from the given array ([i, j, k])
| Name | Type | Description |
|---|---|---|
array | number[] | The array containing the ijk values |
this
▸ fromJson(options): IJKIndex
Set the value of the object<br>
| Name | Type | Description |
|---|---|---|
options | Partial<Coordinates> | The input for IJK coordinates as an object |
this
▸ fromVector3(vector3): IJKIndex
Set the ijk coordinate from the given Vector3(i, j, k)
| Name | Type | Description |
|---|---|---|
vector3 | Vector3 | The Vector3 containing the ijk values |
this
▸ getClassName(): string
string
▸ getI(): number
Return I index
number
I
▸ getJ(): number
Return J index
number
J
▸ getK(): number
Return K index
number
K
▸ getOptions(): Coordinates
Get the ijk coordinates. (see IJKIndex.setOptions for more info)
options
▸ set(i, j, k): IJKIndex
Set the the ijk values
| Name | Type | Description |
|---|---|---|
i | number | The I coordinate |
j | number | The J coordinate |
k | number | The K coordinate |
this
▸ setOptions(options, j?, k?): IJKIndex
Set the ijk coordinates.
| Name | Type | Description |
|---|---|---|
options | Options | The input for IJK coordinates as an object or an array or the I coordinate |
Optional j | number | J coordinate |
Optional k | number | K coordinate |
this
▸ sub(ijk): IJKIndex
Subtract ijk index to this index
| Name | Type | Description |
|---|---|---|
ijk | IJKIndex | subtracts ijk to this index |
this
▸ toArray(): number[]
Get an array representation of the IJK
number[]
array
▸ toJson(): Coordinates
Get a json representation of the object<br>
▸ toVector3(): Vector3
Get a Vector3 representation of the IJK
Vector3
array
▸ Static getClassName(): string
string