@oceanum/layers / index / OceanumContourLayer
Defined in: packages/layers/src/oceanum-contour-layer.ts:28
new OceanumContourLayer(…
propObjects):OceanumContourLayer
Defined in: node_modules/@deck.gl/core/dist/lifecycle/component.d.ts:17
…Partial<Required<CompositeLayerProps> & Required<LayerProps>>[]
OceanumContourLayer
context:
LayerContext
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:38
count:
number
Defined in: node_modules/@deck.gl/core/dist/lifecycle/component.d.ts:16
id:
string
Defined in: node_modules/@deck.gl/core/dist/lifecycle/component.d.ts:14
internalState:
LayerState<OceanumContourLayer> |null
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:36
OceanumBaseLayer.internalState
lifecycle:
Lifecycle
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:37
parent:
Layer<{ }> |null
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:40
props:
StatefulComponentProps<Required<CompositeLayerProps> &Required<LayerProps>>
Defined in: node_modules/@deck.gl/core/dist/lifecycle/component.d.ts:15
state:
SharedLayerState
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:39
staticdefaultProps:object
Defined in: packages/layers/src/oceanum-contour-layer.ts:30
color:
object
type:
string="array"
value:
number[]
labelColor:
object
type:
string="array"
value:
number[]
labelSize:
object
type:
string="number"
value:
number=12
levels:
object
type:
string="array"
value:
never[] =[]
numLabels:
object
type:
string="number"
value:
number=1
smoothing:
object
type:
string="boolean"
value:
boolean=false
staticlayerName:string="OceanumContourLayer"
Defined in: packages/layers/src/oceanum-contour-layer.ts:29
get isComposite():
boolean
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:11
true if this layer renders other layers
boolean
get isDrawable():
boolean
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:13
true if the layer renders to screen
boolean
get isLoaded():
boolean
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:15
Returns true if all async resources are loaded
boolean
get root():
Layer
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:41
Layer
get wrapLongitude():
boolean
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:76
Returns true if using shader-based WGS84 longitude wrapping
boolean
OceanumBaseLayer.wrapLongitude
get
staticcomponentName():string
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:35
string
OceanumBaseLayer.componentName
_buildDatakeys(
coordNames):ScalarDatakeys
Defined in: packages/layers/src/oceanum-contour-layer.ts:41
CoordNames
ScalarDatakeys
OceanumBaseLayer._buildDatakeys
_createInnerLayer(
slicedData,datakeys):ContourLayer
Defined in: packages/layers/src/oceanum-contour-layer.ts:45
SlicedData
ScalarDatakeys
ContourLayer
OceanumBaseLayer._createInnerLayer
protected_disablePickingIndex(objectIndex):void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:169
number
void
OceanumBaseLayer._disablePickingIndex
_drawLayer(
__namedParameters):void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:180
Parameters
RenderPass
any
any
void
_finalize():
void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:179
(Internal) Called by manager when layer is about to be disposed Note: not guaranteed to be called on application shutdown
void
protected_getAttributeManager():AttributeManager|null
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:50
Override base Layer method
AttributeManager | null
OceanumBaseLayer._getAttributeManager
_initialize():
void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:172
void
protected_postUpdate(updateParams,forceUpdate):void
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:52
(Internal) Called after an update to rerender sub layers
UpdateParameters<OceanumContourLayer>
boolean
void
protected_setModelAttributes(model,changedAttributes,bufferLayoutChanged?):void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:163
Apply changed attributes to model
Model
boolean
void
OceanumBaseLayer._setModelAttributes
_transferState(
oldLayer):void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:174
(Internal) Called by layer manager to transfer state from an old layer
Layer<Required<CompositeLayerProps>>
void
OceanumBaseLayer._transferState
_update():
void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:176
(Internal) Called by layer manager when a new layer is added or an existing layer is matched with a new instance
void
protected_updateAttributes():void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:153
Recalculate any attributes if needed
void
OceanumBaseLayer._updateAttributes
protected_updateAutoHighlight(info):void
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:48
Update sub layers to highlight the hovered object
Uint8Array<ArrayBufferLike> | null
number[]
[number, number]
number
Layer<{ }> | null
any
boolean
[number, number]
number
Layer<{ }> | null
Viewport
number
number
void
OceanumBaseLayer._updateAutoHighlight
_validateVariableProps(
props):string|null
Defined in: packages/layers/src/oceanum-contour-layer.ts:32
string | null
OceanumBaseLayer._validateVariableProps
_variablePropsChanged(
props,oldProps):boolean
Defined in: packages/layers/src/oceanum-base-layer.ts:245
boolean
OceanumBaseLayer._variablePropsChanged
activateViewport(
viewport):void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:145
Called when this layer is rendered into the given viewport
Viewport
void
OceanumBaseLayer.activateViewport
protectedcalculateInstancePickingColors(attribute,__namedParameters):void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:159
Updater for the automatically populated instancePickingColors attribute
Attribute
number
void
OceanumBaseLayer.calculateInstancePickingColors
clone(
newProps):any
Defined in: node_modules/@deck.gl/core/dist/lifecycle/component.d.ts:18
Partial<PropsT>
any
decodePickingColor(
color):number
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:95
any
number
OceanumBaseLayer.decodePickingColor
disablePickingIndex(
objectIndex):void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:168
(Internal) Sets the picking color at the specified index to null picking color. Used for multi-depth picking. This method may be overriden by layer implementations
number
void
OceanumBaseLayer.disablePickingIndex
draw(
opts):void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:117
DrawOptions
void
encodePickingColor(
i,target?): [number,number,number]
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:94
any
number[]
[number, number, number]
OceanumBaseLayer.encodePickingColor
filterSubLayer(
context):boolean
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:29
Filters sub layers at draw time. Return true if the sub layer should be drawn.
FilterContext
boolean
OceanumBaseLayer.filterSubLayer
finalizeState():
void
Defined in: packages/layers/src/oceanum-base-layer.ts:238
Called once when layer is no longer matched and state will be discarded. Layers can destroy WebGL resources here.
void
OceanumBaseLayer.finalizeState
getAttributeManager():
AttributeManager|null
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:84
Returns the attribute manager of this layer
AttributeManager | null
OceanumBaseLayer.getAttributeManager
getBounds(): [
number[],number[]] |null
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:107
[number[], number[]] | null
getChangeFlags():
ChangeFlags|undefined
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:187
Returns the current change flags
ChangeFlags | undefined
OceanumBaseLayer.getChangeFlags
getCurrentLayer():
Layer<Required<CompositeLayerProps>> |null
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:87
Returns the most recent layer that matched to this state (When reacting to an async event, this layer may no longer be the latest)
Layer<Required<CompositeLayerProps>> | null
OceanumBaseLayer.getCurrentLayer
getLoadOptions():
any
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:89
Returns the default parse options for async props
any
OceanumBaseLayer.getLoadOptions
getModels():
Model[]
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:80
Returns an array of models used by this layer, can be overriden by layer subclass
Model[]
getNeedsRedraw(
opts?):string|false
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:136
(Internal) Checks if this layer needs redraw
boolean
Reset redraw flags to false after the check
string | false
OceanumBaseLayer.getNeedsRedraw
getNumInstances():
number
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:101
Deduces number of instances. Intention is to support:
number
OceanumBaseLayer.getNumInstances
getPickingInfo(
__namedParameters):object
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:24
called to augment the info object that is bubbled up from a sublayer override Layer.getPickingInfo() because decoding / setting uniform do not apply to a composite layer.
GetPickingInfoParams
object
color:
Uint8Array<ArrayBufferLike> |null
optionalcoordinate:number[]
optionaldevicePixel: [number,number]
index:
number
layer:
Layer<{ }> |null
optionalobject:any
picked:
boolean
optionalpixel: [number,number]
pixelRatio:
number
optionalsourceLayer:Layer<{ }> |null
optionalviewport:Viewport
x:
number
y:
number
OceanumBaseLayer.getPickingInfo
getShaders(
shaders):any
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:110
any
any
getStartIndices():
NumericArray|null
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:106
Buffer layout describes how many attribute values are packed for each data object The default (null) is one value each object. Some data formats (e.g. paths, polygons) have various length. Their buffer layout is in the form of [L0, L1, L2, …]
NumericArray | null
OceanumBaseLayer.getStartIndices
protectedgetSubLayerAccessor<In,Out>(accessor):Accessor<In,Out>
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:40
Some composite layers cast user data into another format before passing to sublayers We need to unwrap them before calling the accessor so that they see the original data objects
In
Out
Accessor<In, Out>
Accessor<In, Out>
OceanumBaseLayer.getSubLayerAccessor
protectedgetSubLayerClass<T>(subLayerId,DefaultLayerClass):ConstructorOf<T>
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:33
Returns sub layer class for a specific sublayer
T extends Layer<{ }>
string
ConstructorOf<T>
ConstructorOf<T>
OceanumBaseLayer.getSubLayerClass
protectedgetSubLayerProps(sublayerProps?):any
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:42
Returns sub layer props for a specific sublayer
string
Record<string, any>
any
OceanumBaseLayer.getSubLayerProps
protectedgetSubLayerRow<T>(row,sourceObject,sourceObjectIndex):T
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:36
When casting user data into another format to pass to sublayers, add reference to the original object and object index
T
T
any
number
T
OceanumBaseLayer.getSubLayerRow
getSubLayers():
Layer<{ }>[]
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:17
Return last rendered sub layers
Layer<{ }>[]
hasUniformTransition():
boolean
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:143
Checks if this layer has ongoing uniform transition
boolean
OceanumBaseLayer.hasUniformTransition
initializeState():
void
Defined in: packages/layers/src/oceanum-base-layer.ts:146
void
OceanumBaseLayer.initializeState
protectedinvalidateAttribute(name?):void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:147
Default implementation of attribute invalidation, can be redefined
string
void
OceanumBaseLayer.invalidateAttribute
isPickable():
boolean
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:78
boolean
Returns true if the layer is visible in the picking pass
needsUpdate():
boolean
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:141
(Internal) Checks if this layer needs a deep update
boolean
nullPickingColor():
number[]
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:93
number[]
OceanumBaseLayer.nullPickingColor
onClick(
info,pickingEvent):boolean
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:92
Uint8Array<ArrayBufferLike> | null
number[]
[number, number]
number
Layer<{ }> | null
any
boolean
[number, number]
number
Layer<{ }> | null
Viewport
number
number
any
boolean
onHover(
info,pickingEvent):boolean
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:91
Uint8Array<ArrayBufferLike> | null
number[]
[number, number]
number
Layer<{ }> | null
any
boolean
[number, number]
number
Layer<{ }> | null
Viewport
number
number
any
boolean
project(
xyz):number[]
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:44
Projects a point with current view state from the current layer’s coordinate system to screen
number[]
number[]
projectPosition(
xyz,params?): [number,number,number]
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:49
Projects a point with current view state from the current layer’s coordinate system to the world space
number[]
boolean
Whether to apply offset mode automatically as does the project shader module.
Offset mode places the origin of the common space at the given viewport’s center. It is used in some use cases
to improve precision in the vertex shader due to the fp32 float limitation.
Use autoOffset:false if the returned position should not be dependent on the current viewport.
Default true
[number, number, number]
The coordinate origin that the supplied position is in. Default to the same as coordinateOrigin.
CoordinateSystem
The coordinate system that the supplied position is in. Default to the same as coordinateSystem.
Viewport
The viewport to use
[number, number, number]
OceanumBaseLayer.projectPosition
raiseError(
error,message):void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:134
(Internal) Propagate an error event through the system
Error
string
void
renderLayers():
any
Defined in: packages/layers/src/oceanum-base-layer.ts:505
any
restorePickingColors():
void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:171
(Internal) Re-enable all picking indices after multi-depth picking
void
OceanumBaseLayer.restorePickingColors
setChangeFlags(
flags):void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:189
Dirty some change flags, will be handled by updateLayer
Partial<ChangeFlags>
void
OceanumBaseLayer.setChangeFlags
setNeedsRedraw():
void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:70
Sets the redraw flag for this layer, will trigger a redraw next animation frame
void
OceanumBaseLayer.setNeedsRedraw
setNeedsUpdate():
void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:72
Mark this layer as needs a deep update
void
OceanumBaseLayer.setNeedsUpdate
setShaderModuleProps(…
props):void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:82
Update shader input parameters
…[Partial<{[key: string]: Partial<Record<string, unknown> | undefined>; }>]
void
OceanumBaseLayer.setShaderModuleProps
setState(
updateObject):void
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:20
Updates selected state members and marks the composite layer to need rerender
any
void
protectedshouldRenderSubLayer(subLayerId,data):boolean
Defined in: node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:31
Returns true if sub layer needs to be rendered
string
any
boolean
OceanumBaseLayer.shouldRenderSubLayer
shouldUpdateState(
__namedParameters):boolean
Defined in: packages/layers/src/oceanum-base-layer.ts:174
Controls if updateState should be called. By default returns true if any prop has changed
any
boolean
OceanumBaseLayer.shouldUpdateState
toString():
string
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:42
Returns a string representation of an object.
string
unproject(
xy):number[]
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:47
Unprojects a screen pixel to the current view’s default coordinate system
Note: this does not reverse project.
number[]
number[]
protectedupdateAttributes(changedAttributes):void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:149
Send updated attributes to the WebGL model
void
OceanumBaseLayer.updateAttributes
updateAutoHighlight(
info):void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:199
(Internal) Called by deck picker when the hovered object changes to update the auto highlight
Uint8Array<ArrayBufferLike> | null
number[]
[number, number]
number
Layer<{ }> | null
any
boolean
[number, number]
number
Layer<{ }> | null
Viewport
number
number
void
OceanumBaseLayer.updateAutoHighlight
updateState(
__namedParameters):void
Defined in: packages/layers/src/oceanum-base-layer.ts:178
Default implementation, all attributes will be invalidated and updated when data changes
any
void
use64bitPositions():
boolean
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:90
boolean
OceanumBaseLayer.use64bitPositions
validateProps():
void
Defined in: node_modules/@deck.gl/core/dist/lib/layer.d.ts:197
(Internal) called by layer manager to perform extra props validation (in development only)
void