API / geotoolkit3d / scene / seismic / FenceMaterial / FenceMaterial
seismic.FenceMaterial.FenceMaterial
A seismic fence material.
The seismic fence material is supposed ot be used in conjunction with FencePanel.
It is responsible for creating and managing the textures required to render a seismic crossection.
To do so, it will create a SeismicPipeline using the given SeismicReader.
The specificity of the FenceMaterial compared to the SliceMaterial is to take into account that the given Reader is made of sections.
This material will render only the section it's supposed to render. (see fenceindex).
↳
FenceMaterial
Constructors
Methods
Methods
▸ dispose(): void
Dispose method for SliceMaterial. Specifically for disposing of pipeline memory reference
void
▸ disposeMaterials(): void
Dispose Materials
void
SliceMaterial.disposeMaterials
▸ disposeNewMaterials(): void
Dispose the Materials used for the next tile render. For internal use only.
void
SliceMaterial.disposeNewMaterials
▸ disposeOverlayDatas(): void
Dispose Overlay Datas
void
SliceMaterial.disposeOverlayDatas
▸ getClassName(): string
string
▸ getOpacity(): number
Get the opacity
number
The opacity
▸ getOptions(): OptionsBaseOut
Get the SliceMaterial options
Returns a group that can be used to render 2D shapes on top of the seismic slice.
The coordinate system of the group is in trace/samples.
The overlay group
▸ getPipeline(): SeismicPipeline
Get the internal pipeline
The internal pipeline
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
SliceMaterial.hasEventListener
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify(type, source, args?): FenceMaterial
Notify listeners
| Name | Type | Description |
|---|---|---|
type | string | event types |
source | any | of the event |
Optional args | any | arguments of the event |
this
▸ off<E>(type?, callback?): FenceMaterial
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 |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: FenceMaterial, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): FenceMaterial
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 |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: FenceMaterial, args: EventMap[E]) => void | to be called |
this
▸ resetTiles(): void
Resets the slice tiles, filling them by the loading color defined by the user. Usually used when updating the slice, such as moving the slice along its axis, thus requiring some time to fetch the new samples and redraw the seismic slice.
void
▸ setLOD(lod, minLod?, maxLod?): Promise<void>
Sets level of details if it is enabled
Deprecated
since 4.1, LOD is temporarily unavailable but will be back soon, with a different API.
| Name | Type | Description |
|---|---|---|
lod | number | level of details. if level is less then current level the current is used |
Optional minLod | number | minimum level of details |
Optional maxLod | number | maximum level of details |
Promise<void>
a new generic promise
▸ setOpacity(value): void
Set opacity property of the slice.
| Name | Type | Description |
|---|---|---|
value | number | the opacity value from 0 (transparent) to 1 (opaque). |
void
▸ setOptions(options): FenceMaterial
Set the FenceMaterial options. The main difference with SliceMaterial, is that once the Fence pipeline is generated, it cannot change its data source.
| Name | Type |
|---|---|
options | OptionsBase |
▸ setSilent(bool): FenceMaterial
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ updateLOD(lod): Promise<void>
Manually update this Slice level of detail. For internal use only.
| Name | Type |
|---|---|
lod | number |
Promise<void>
▸ Static getClassName(): string
string