API / geotoolkit3d / scene / seismic / Slice / Slice
A seismic slice object.
A seismic slice is a 2D seismic cross-section following one dimension of a seismic volume (inline, xline or time/depth slice).
The actual seismic to be displayed is provided by the given SliceMaterial.
The resulting shape is a 2D plane displaying seismic.
It is generally added to a Volume that will handle the IJ-to-XY conversion.
↳
Slice
Constructors
Methods
Methods
▸ add(object): Slice
Adds object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ afterRender(scene, camera, plot, renderer): Slice
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
| Name | Type | Description |
|---|---|---|
scene | Scene | The scene |
camera | Camera | The camera used for this render phase. |
plot | Plot | The 3D plot |
renderer | WebGLRenderer | The renderer |
▸ beforeRender(scene, camera, plot, renderer): Slice
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
| Name | Type | Description |
|---|---|---|
scene | Scene | The scene |
camera | Camera | The camera used for this render phase. |
plot | Plot | The 3D plot |
renderer | WebGLRenderer | The renderer |
▸ dispose(): void
Dispose method for Slice material
void
▸ getClassName(): string
string
IOverlayableObject.getClassName
▸ getCorner(index, target?): Vector3
Return the world position of a specific corner of this slice quad.
If this slice (or a parent object) has been moved/rotated since the last render, please call Volume.updateWorldMatrix(true, true), or Slice.updateWorldMatrix(true, true) first for correct results. (Updating the Volume will update all its children Slices at once.)
If the slice is made of several tiles, the corners will still represent the global slice.
Example
The indices represent the 4 corners of the quad like so:
0---1
| |
2---3| Name | Type | Description |
|---|---|---|
index | number | Index of the slice quad, from 0 to 3. |
Optional target | Vector3 | Optional point Vector3, will be updated and returned if provided. |
Vector3
▸ getIndexCoordinates(): IndexCoordinates
Get the index coordinates
▸ getLocalCorner(index, target?): Vector3
Return the local position of a specific corner of this slice quad. This method is mainly used for intersection purposes.
If the slice is made of several tiles, the corners will still represent the global slice.
Example
The indices represent the 4 corners of the quad like so:
0---1
| |
2---3| Name | Type | Description |
|---|---|---|
index | number | Index of the slice quad, from 0 to 3. |
Optional target | Vector3 | Optional point Vector3, will be updated and returned if provided. |
Vector3
IOverlayableObject.getLocalCorner
▸ getMesh(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
Returns the plane mesh, used in intersections
Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
▸ getOptions(): OptionsBaseOut
Get the Slice options
Get the overlay Group of this slice, if any
▸ getOverlayTextureBounds(): Rect
Returns the overlay texture boundaries of this Slice, in pixels.
IOverlayableObject.getOverlayTextureBounds
AbstractPanel.getOverlayTextureBounds
▸ getPipeline(): SeismicPipeline
Returns seismic pipeline
▸ getSeismicModelPosition(worldPosition): Point
Get position in seismic model limits from 3d world position
| Name | Type | Description |
|---|---|---|
worldPosition | Vector3 | position in 3d world coordinates |
ISeismicObject.getSeismicModelPosition
▸ getSliceLocation(): Location
Get the slice location in I, J or Z
▸ getSliceMaterial(): SliceMaterial
Get the slice's material
▸ getVisible(): boolean
Get visible
boolean
true, if object is visible
▸ invalidateObject<T>(event?): Slice
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.
| Name |
|---|
T |
| Name | Type | Description |
|---|---|---|
Optional event | Event<T> | The event to fire |
AbstractPanel.invalidateObject
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSelectable(): boolean
Return if this object can be picked/selected (see RendererPicking).
boolean
▸ notify(type, source, args?): Slice
Notify listeners
| Name | Type | Description |
|---|---|---|
type | string | event types |
source | any | of the event |
Optional args | any | arguments of the event |
this
▸ off(type?, callback?): Slice
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.
| Name | Type | Description |
|---|---|---|
Optional type | string | type of the event |
Optional callback | EventListener | function to be called |
this
▸ off<E>(type, callback): Slice
| Name | Type |
|---|---|
E | extends string |
▸ on(type, callback, options?): Slice
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.
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
callback | EventListener | to be called |
Optional options | Options | options of subscription |
this
▸ on<E>(type, callback, options?): Slice
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: Slice, args: EventMap[E]) => void |
Optional options | Options |
▸ onStatsUpdated(metrics): Slice
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.
| Name | Type | Description |
|---|---|---|
metrics | PerformanceMetrics | The performance metrics. |
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
AbstractPanel.onVisibilityChanged
▸ remove(object): Slice
Removes object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ resetTiles(): void
Reset the tiles of this object. Depending on the object options, the tiles might be filled with a fill color.
void
▸ setOptions(options?): Slice
Set this slice options
Throws
Error if Slice location is not set
| Name | Type |
|---|---|
Optional options | OptionsBase |
this
▸ setOverlay(overlayGroup): void
Used for intersection API
void
▸ setPosition(position): Slice
Set Object's local position.
| Name | Type | Description |
|---|---|---|
position | Object | local position |
Optional position.x | number | |
Optional position.y | number | |
Optional position.z | number |
this
▸ setRotation(x, y, z, order?): Slice
Set Object's local rotation (Euler angles), in radians.
| Name | Type | Description |
|---|---|---|
x | number | x angle |
y | number | y angle |
z | number | z angle |
Optional order | EulerOrder | euler order |
this
▸ setSelectable(selectable): void
Set if this object can be picked/selected (see RendererPicking).
| Name | Type | Description |
|---|---|---|
selectable | boolean | if can be selected |
void
▸ setVisible(visible, silent?): Slice
Set visible
| Name | Type | Description |
|---|---|---|
visible | boolean | true, if object is visible |
Optional silent | boolean | true, if object shouldn't be invalidated |
this
▸ updateObject(scene, camera): Slice
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
| Name | Type | Description |
|---|---|---|
scene | Scene | The scene |
camera | Camera | The camera |
▸ 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
▸ Static getClassName(): string
string
▸ 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