Class: FencePanel

• new FencePanel(options)

• new FencePanel(options)

AbstractPanel.constructor

▸ add(object): FencePanel

Adds object as child of this object.

FencePanel

this

AbstractPanel.add

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

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

FencePanel

AbstractPanel.afterRender

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

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

FencePanel

AbstractPanel.beforeRender

▸ dispose(): void

Dispose method for FencePanel

void

AbstractPanel.dispose

▸ getClassName(): string

string

IOverlayableObject.getClassName

AbstractPanel.getClassName

▸ getCorner(index, target?): Vector3

Return the world position of a specific corner of this panel quad.
If this panel (or a parent object) has been moved/rotated since the last render, please call Fence.updateWorldMatrix(true, true), or FencePanel.updateWorldMatrix(true, true) first for correct results. (Updating the Fence will update all its children FencePanel at once.)
If the fence is made of several tiles, the corners will still represent the global panel.

Example

The indices represent the 4 corners of the quad like so:
0---1
|   |
2---3

Vector3

IOverlayableObject.getCorner

AbstractPanel.getCorner

▸ getFenceMaterial(): FenceMaterial

Get the Fences's material

FenceMaterial

This slice's material

▸ getHighlightedObjects(): FencePanel | FencePanel[]

Get the selected FencePanel object(s) that will generate a highlight

FencePanel | FencePanel[]

ICustomHighlight.getHighlightedObjects

▸ getLocalCorner(index, target?): Vector3

Return the local position of a specific corner of this panel quad. This method is mainly used for intersection purposes.
For coordinates calculation accuracy purpose, local panel coordinates might not match the provided coordinates at construction time.
For this reason, it is recommended to users to instead use getCorner, which apply all parent's matrix transformations.
If the fence is made of several tiles, the corners will still represent the global panel.

Example

The indices represent the 4 corners of the quad like so:
0---1
|   |
2---3

Vector3

IOverlayableObject.getLocalCorner

AbstractPanel.getLocalCorner

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

Returns the plane mesh, used in intersections

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

IOverlayableObject.getMesh

AbstractPanel.getMesh

▸ getOptions(): OptionsBaseOut

Get this FencePanel options

OptionsBaseOut

AbstractPanel.getOptions

▸ getOverlay(): Group<Node>

Returns the group used to render 2D shapes on top of the seismic Fence.
The coordinate system of the group is in trace/samples.

Group<Node>

IOverlayableObject.getOverlay

AbstractPanel.getOverlay

▸ getOverlayTextureBounds(): Rect

Return the overlay texture bounds of this panel unit, in pixels.
In fences, the first panel's x value is zero, then each consecutive panel adds the previous panels width.

Rect

IOverlayableObject.getOverlayTextureBounds

AbstractPanel.getOverlayTextureBounds

▸ getPipeline(): SeismicPipeline

Returns seismic pipeline

SeismicPipeline

ISeismicObject.getPipeline

▸ getSeismicModelPosition(worldPosition): Point

Get position in seismic model limits from 3d world position

Point

ISeismicObject.getSeismicModelPosition

▸ getVisible(): boolean

Get visible

boolean

true, if object is visible

AbstractPanel.getVisible

▸ invalidateObject<T>(event?): FencePanel

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.

FencePanel

AbstractPanel.invalidateObject

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractPanel.isDisposed

▸ isSelectable(): boolean

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

boolean

AbstractPanel.isSelectable

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

Notify listeners

FencePanel

this

AbstractPanel.notify

▸ off(type?, callback?): FencePanel

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.

FencePanel

this

AbstractPanel.off

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

FencePanel

AbstractPanel.off

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

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.

FencePanel

this

AbstractPanel.on

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

FencePanel

AbstractPanel.on

▸ onStatsUpdated(metrics): FencePanel

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.

FencePanel

AbstractPanel.onStatsUpdated

▸ Protected onVisibilityChanged(): void

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

void

AbstractPanel.onVisibilityChanged

▸ remove(object): FencePanel

Removes object as child of this object.

FencePanel

this

AbstractPanel.remove

▸ resetTiles(): void

Reset the tiles of this object. Depending on the object options, the tiles might be filled with a fill color.

void

ITiledSurface.resetTiles

▸ setOptions(options?): FencePanel

Set this FencePanel options

FencePanel

AbstractPanel.setOptions

▸ setOverlay(overlayGroup): FencePanel

Used for intersection API

FencePanel

IOverlayableObject.setOverlay

AbstractPanel.setOverlay

▸ setPosition(position): FencePanel

Set Object's local position.

FencePanel

this

AbstractPanel.setPosition

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

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

FencePanel

this

AbstractPanel.setRotation

▸ setSelectable(selectable): void

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

void

AbstractPanel.setSelectable

▸ setVisible(visible, silent?): FencePanel

Set visible

FencePanel

this

AbstractPanel.setVisible

▸ updateObject(scene, camera): FencePanel

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

FencePanel

AbstractPanel.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

AbstractPanel.useOwnHighlight

▸ Static getClassName(): string

string

AbstractPanel.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

AbstractPanel.register