Class: ReservoirGrid

• new ReservoirGrid(options)

• new ReservoirGrid(options)

AbstractReservoirGrid.constructor

▸ 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

▸ dispose(): void

Dispose all event listeners, Object3D, cache

void

AbstractReservoirGrid.dispose

▸ getClassName(): string

string

AbstractReservoirGrid.getClassName

▸ getCurrentCellCount(): number

Get the current number of cells

number

cellcount

▸ getGridResult(): GigaGridResult

Get grid overall information

GigaGridResult

Grid

▸ getIJKFilter(): IJKFilter

Get IJK range filter

IJKFilter

filter

▸ getLoadingProgress(): number

Get loading progress percentage.

number

percentage

▸ getOptions(): Required<Options> & Omit<Options, "colorprovider" | "skeleton" | "cachelimit" | "highlightmode"> & { cachelimit: number ; colorprovider?: ColorProvider ; highlightmode: HighlightMode ; skeleton: { color: string ; linewidth: number } }

Get the ReservoirGrid options, returned as an object

Required<Options> & Omit<Options, "colorprovider" | "skeleton" | "cachelimit" | "highlightmode"> & { cachelimit: number ; colorprovider?: ColorProvider ; highlightmode: HighlightMode ; skeleton: { color: string ; linewidth: number } }

AbstractReservoirGrid.getOptions

▸ getPropertyFilter(): PropertyFilter

Get property filter

PropertyFilter

filter

▸ getPropertyKey(): PropertyKey

Get property key

PropertyKey

key

▸ getSelectedIJKIndex(): IJKIndex

Get IJK info of selected cell
Needs to have highlighting enabled in Plot

IJKIndex

ijkindex

▸ getTotalCellCount(): number

Get total number of cells available in the gigagrid

number

total cells in the the grid

▸ getVisible(): boolean

Get visible

boolean

true, if object is visible

AbstractReservoirGrid.getVisible

▸ 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

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractReservoirGrid.isDisposed

▸ isSelectable(): boolean

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

boolean

AbstractReservoirGrid.isSelectable

▸ 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

▸ redraw(): void

Trigger the redraw of GigaGrid.
This method will be automatically called if options have changed

void

▸ remove(object): ReservoirGrid

Removes object as child of this object.

ReservoirGrid

this

AbstractReservoirGrid.remove

▸ removeHighlightShape(): void

Remove the helper shape representing the selected cell from being displayed.

void

AbstractReservoirGrid.removeHighlightShape

▸ setOptions(options?): ReservoirGrid

Set options, the given json will be merged with the object's state so that only the given options will be changes.

ReservoirGrid

this

AbstractReservoirGrid.setOptions

▸ setPosition(position): ReservoirGrid

Set Object's local position.

ReservoirGrid

this

AbstractReservoirGrid.setPosition

▸ setPropertyKey(propertyKey): void

Set colormap based on property key for gigagrid

void

▸ 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

▸ 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

Returns true if this object make its own highlight effect (like geotoolkit3d.scene.reservoir.hexahedral.ReservoirGrid) This is to prevent unnecessary executions of the costly highlight passes.

boolean

AbstractReservoirGrid.useOwnHighlight

▸ 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