Class: ReservoirGrid

• new ReservoirGrid(options)

• new ReservoirGrid(options)

AbstractReservoirGrid.constructor

▪ Static ADDITIONAL_PROPERTY_SIZE: number

▪ Static ESTIMATE_RAM_PER_CELL: number

▪ Static ESTIMATE_RAM_PER_CELL_INTERSECTION: number

▪ Static ESTIMATE_VRAM_PER_CELL: number

▪ Static MAX_VALUES_PER_ELEMENT: number

▸ add(object): ReservoirGrid

Adds object as child of this object.

ReservoirGrid

this

AbstractReservoirGrid.add

▸ afterRender(scene, camera, plot, renderer): ReservoirGrid

This function is called after rendering and can update this object's content.

It should not trigger any invalidateObject though.
Note that it is not necessary nor recommended to explicitly call afterRender on this object's children as beforeRender will be called on all nodes present in the scene.

This will be executed after the transformations simplification.

See

Plot for more details on the render steps

ReservoirGrid

AbstractReservoirGrid.afterRender

▸ beforeRender(scene, camera, plot, renderer): ReservoirGrid

This function is called prior to rendering and can update this object's content.

It should not trigger any invalidateObject though.
Note that it is not necessary nor recommended to explicitly call beforeRender on this object's children as beforeRender will be called on all nodes present in the scene.

This will be executed after the transformations simplification.

See

Plot for more details on the render steps

ReservoirGrid

AbstractReservoirGrid.beforeRender

▸ deleteAdditionalCellData(name): void

Delete a previously defined additional cell data.

void

▸ dispose(): void

Dispose this reservoir visual, along its ReservoirData.

void

AbstractReservoirGrid.dispose

▸ getBoundingBox(): Box3

Get the bounding box of this Reservoir Grid (in local coordinates).

Box3

bbox

▸ getCellGeometry(ijk, scale, plot?): BufferGeometry<NormalBufferAttributes>

Build a cell geometry from an existing cell index ijk, that overlaps the aforesaid cell depending on the value entered for the scale parameter. Scale is the percentage of overlapping.
The ijk array is the index of the cell in the reservoir:
For example, if i=0, j= 4 and z=2, the array will be
[ 0, 4, 2 ]
If plot is specified, the Geometry will be adapted in "business" coordinates else it will be in local coordinates
Business coordinates are obtained using Helper.localToBusiness

BufferGeometry<NormalBufferAttributes>

▸ getClassName(): string

string

IIntersectablePolyhedron.getClassName

AbstractReservoirGrid.getClassName

▸ getColorProvider(): RgbaColor | ColorProvider

Return the color provider of the intersectable.

RgbaColor | ColorProvider

IIntersectablePolyhedron.getColorProvider

▸ getData(): ReservoirData

Get the reservoir data, holding the cells positions and values.

ReservoirData

data

▸ getFilteredCellsCount(): number

Return the number of cells resulting from the user's filter.

number

▸ getFilteredCellsVolume(): number

Return the volume occupied by the remaining cells resulting from the user's filter.
Each cell volume is computed based on the cell's xyz corner coordinates.
The unit of the volume measurement is based on the unit used in cells coordinates, to user discretion. (ex: if cells coordinates are in meters, then the volume will be in cubic meters. If feet, then cubic feet, and so on.)

number

the total filtered cells volume.

▸ getFilteredReservoirData(): ReservoirData

Return a new instance of ReservoirData resulting from the user's filter, the cells that are filtered in (are displayed), based on IJK filter, value filter, and the user filter. If no cell is currently visible, null will be returned instead as no ReservoirData can be created.

ReservoirData

▸ getHighlightedObjects(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

Get the selected cell geometry. Used in highlighting logic.

Deprecated

since 5.0, was not meant to be public. To retrieve the currently selected cell, please use getCellGeometry instead.

Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

▸ getMesh(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

Return the mesh representing the polyhderons to be intersected.

Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

IIntersectablePolyhedron.getMesh

▸ getOptions(): OptionsBaseOut

Get this Reservoir Grid options.

OptionsBaseOut

AbstractReservoirGrid.getOptions

▸ getPolyhedron(polyhedronIndex, target): void

Return the polyhedron data at given index.
Vertices coordinates must be in the local coordinate space of the mesh returned by getMesh method.

void

IIntersectablePolyhedron.getPolyhedron

▸ getPolyhedronCount(): number

Return the total number of Polyhedrons contained by this object.

number

IIntersectablePolyhedron.getPolyhedronCount

▸ getPolyhedronsBoundingBox(target): void

Return the bounding box of the polyhedrons.
The bounding box should be calculated directly from the polyhedrons' geometry vertex positions, representing the bounding box in the polyhedrons' local space.
The box coordinates must be in the local coordinate space of the mesh returned by getMesh method.

void

IIntersectablePolyhedron.getPolyhedronsBoundingBox

▸ getReservoirFullVolume(): number

Returns the total volume of this reservoir.
Computed by the sum of the volume of every cell, filters are ignored.
The unit of the volume measurement is based on the unit used in cells coordinates, to user discretion. (ex: if cells coordinates are in meters, then the volume will be in cubic meters. If feet, then cubic feet, and so on.)

number

▸ getSelectedIJKIndex(): IJKIndex

Get IJK info of selected/highlighted cell.

IJKIndex

▸ getVisible(): boolean

Get visible

boolean

true, if object is visible

AbstractReservoirGrid.getVisible

▸ highlightCellByIJK(ijk?): boolean

Highlight the designated cell ijk in the format [i, j, k].
Set the argument to null to remove the current cell highlight.
Only one cell can be highlighted at the same time. Cells highlighted using this method will not be automatically removed by selection tools, unless another cell from this reservoir is selected.

boolean

true if the cell ijk is valid, false if the given ijk match no cell. Null/no value is valid and returns true.

▸ highlightCellByIndex(index?): boolean

Highlight the designated cell index. Set the index to null to remove the current cell highlight. Return true on success, false if the index is not valid.
Only one cell can be highlighted at the same time. Cells highlighted using this method will not be automatically removed by selection tools, unless another cell from this reservoir is selected.

boolean

true if the cell index is valid, false if the index is out of bounds. Null/no value is valid and returns true.

▸ invalidateObject<T>(event?): ReservoirGrid

Notifies this object and its parent that this object has been invalidated.
If this object is in a Plot, it will be marked as dirty and will trigger a rendering cycle.

ReservoirGrid

AbstractReservoirGrid.invalidateObject

▸ isCellIndexFilteredOut(index): boolean

Return true if the cell of the given index is filtered out (is not displayed), based on both IJK filter, value filter, and the user filter.

boolean

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractReservoirGrid.isDisposed

▸ isIJKValidInFilter(ijk): boolean

Return true if the given IJK is valid by the IJK filter of ReservoirGrid, false if is filtered out.

boolean

▸ isPolyhedronIndexFilteredOut(polyhedronIndex): boolean

Return if the polyhedron at given index is filtered out.
Polyhedron objects like ReservoirGrid can contain multiple polyhedrons, which can be filtered out by user settings.
This method allow to express whether this specific polyhedron is filtered out (and should be excluded from intersection).

boolean

true if filtered out, otherwise false

IIntersectablePolyhedron.isPolyhedronIndexFilteredOut

▸ isSelectable(): boolean

Return if this object can be picked/selected (see RendererPicking).

boolean

AbstractReservoirGrid.isSelectable

▸ isValueValidInFilter(value): boolean

Return true if the given value is bounded by the value filter of this ReservoirGrid, false if the value is filtered out.
Also return false if the value is not a number or equal to the defined nullvalue.

boolean

▸ notify(type, source, args?): ReservoirGrid

Notify listeners

ReservoirGrid

this

AbstractReservoirGrid.notify

▸ off(type?, callback?): ReservoirGrid

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

ReservoirGrid

this

AbstractReservoirGrid.off

▸ off<E>(type, callback): ReservoirGrid

ReservoirGrid

AbstractReservoirGrid.off

▸ on(type, callback, options?): ReservoirGrid

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.

ReservoirGrid

this

AbstractReservoirGrid.on

▸ on<E>(type, callback, options?): ReservoirGrid

ReservoirGrid

AbstractReservoirGrid.on

▸ onStatsUpdated(metrics): ReservoirGrid

This function is called when the plot has updated performance metric.
It will be called every set number of frames.
The number of frame is customizable in the plot options advancedrendering.performancemetrics.updateframeperiod and is 100 by default.

ReservoirGrid

AbstractReservoirGrid.onStatsUpdated

▸ Protected onVisibilityChanged(): void

This method is called if visibility is changed. Send event Events.VisibilityChanged

void

AbstractReservoirGrid.onVisibilityChanged

▸ remove(object): ReservoirGrid

Removes object as child of this object.

ReservoirGrid

this

AbstractReservoirGrid.remove

▸ removeHighlightShape(): void

Remove the highlight effect on the selected shape.

void

AbstractReservoirGrid.removeHighlightShape

▸ setCellsValues(cellsValues): ReservoirGrid

Change the cells values, and/or define additional cell data.
Changing cell values will change the active cells properties used with the colormap, and reset the "value" filter.
Additional cell data are named properties that can be then used in a custom filter function.
To remove additional cell data, please use ReservoirGrid.deleteAdditionalCellData.

ReservoirGrid

▸ setOptions(options): ReservoirGrid

Set this Reservoir Grid options.
Changing position data using setOptions is not allowed, as it is more expensive than creating a new Reservoir Grid.

ReservoirGrid

AbstractReservoirGrid.setOptions

▸ setPosition(position): ReservoirGrid

Set Object's local position.

ReservoirGrid

this

AbstractReservoirGrid.setPosition

▸ setRotation(x, y, z, order?): ReservoirGrid

Set Object's local rotation (Euler angles), in radians.

ReservoirGrid

this

AbstractReservoirGrid.setRotation

▸ setSelectable(selectable): void

Set if this object can be picked/selected (see RendererPicking).

void

AbstractReservoirGrid.setSelectable

▸ setVisible(visible, silent?): ReservoirGrid

Set visible

ReservoirGrid

this

AbstractReservoirGrid.setVisible

▸ updateCellFilter(): ReservoirGrid

Rebuild reservoir geometry depending on filters.
Calling ReservoirGrid.setOptions() also rebuilds the reservoir.
The main use of this updateCellFilter() function is to update the reservoir when the custom filter is updated via closure variables when setOptions() is not called.

ReservoirGrid

▸ updateObject(scene, camera): ReservoirGrid

This function is called prior to rendering and can update this object's content.

It should not trigger any invalidateObject though.
Note that it is not necessary nor recommended to explicitly call updateObject on this object's children as updateObject will be called on all nodes present in the scene.

This will be executed before the transformations simplification.

See

Plot for more details on the render steps

ReservoirGrid

AbstractReservoirGrid.updateObject

▸ useOwnHighlight(): boolean

Used by the rendering pass to know whether this object have its won highlight mechanism, or should the pass itself generate a generic one.

boolean

AbstractReservoirGrid.useOwnHighlight

▸ Static estimateMemoryCapabilities(options): MemoryCapabilitiesInfo

Estimate the maximum number of cells that can be created in one ReservoirGrid visual, with the given RAM/VRAM information.
With enough memory, the implementation limit for ReservoirGrid is eventually tied to Typed array allocation. This test will perform a one-time array allocation test on your device, to accurately estimate the maximum array size your browser/device is capable of. It is important to have enough memory available for this test to be accurate.

MemoryCapabilitiesInfo

▸ Static getClassName(): string

string

AbstractReservoirGrid.getClassName

▸ Static register(): void

Register object for special processing through a callback function

Example

geotoolkit3d.util.ObjectProcessor.getDefaultInstance().registerObject(this.getClassName(), callback);

Deprecated

since 5.0, to allow custom object highlighting, please instead make your Object implement the interface geotoolkit3d/scene/ICustomHighlight.

void

AbstractReservoirGrid.register