API / geotoolkit3d / scene / reservoir / IJKValueFilter
Type Aliases
Type Aliases
Ƭ CellFilter: (cellProperties: CellProperties) => boolean
▸ (cellProperties): boolean
The Reservoir Cell filter function, to be defined by the user. Filter parameters include all the cell properties.
Should return true is the cell is to be filtered out (made invisible).
| Name | Type |
|---|---|
cellProperties | CellProperties |
boolean
Ƭ CellProperties: Object
| Name | Type | Description |
|---|---|---|
activevalue | number | The Cell currently displayed value. |
additionalcelldata | Record<string, any> | The additional data attributed to each cell by the user. Each additional data will be accessible under the property name given by the user. Example: if the user provided a "time" property for each cell, the cell time property will be available at additionalcelldata.time |
corners | [x: number, y: number, z: number][] | The Cell 8 corners coordinates. |
i | number | The cell I position. |
index | number | The cell index, ie the position of the cell when it was fed in the ReservoirData constructor. |
j | number | The cell J position. |
k | number | The cell K position. |
volume? | number | The cell volume, if it was computed (volume is computed lazily, please see ReservoirGrid.OptionsType). Undefined otherwise. |
Ƭ IJKValueFilter: Object
The options type used to define Reservoir filtering parameters.
| Name | Type | Description |
|---|---|---|
cellfilter? | CellFilter | null | Custom Reservoir filter to be implemented by user. Can make use of additional data, a user-defined value/data/object that can be defined per-cell. Should return true is the cell is to be filtered out (made invisible). |
excludemode? | boolean | set to true will turn to exclude mode for ijk filter (value filters are not affected). |
maxi? | number | If set, cells above this I index will not be rendered. |
maxj? | number | If set, cells above this J index will not be rendered. |
maxk? | number | If set, cells above this K index will not be rendered. |
maxvalue? | number | If set, cells above this value will not be rendered. |
mini? | number | If set, cells below this I index will not be rendered. |
minj? | number | If set, cells below this J index will not be rendered. |
mink? | number | If set, cells below this K index will not be rendered. |
minvalue? | number | If set, cells below this value will not be rendered. |
nullvalue? | number | The attribute nullvalue. If some values are provided for coloring and if one of those values is equal to this nullvalue. Then the cell won't be rendered. |