API / geotoolkit3d / scene / surface / Surface / Surface
A Surface 3D object.<br> <br> This object represents a 3D surface with an optional attribute used for coloring.<br> The surface's geometry is defined by the given SurfaceData.<br> <br> The surface will contains holes whenever the given attribute or elevation is equals to nullvalue.<br> Note that the current implementation still generates the vertices for those points but abstain itself from rendering them.<br> <br>
Throws
if options object has no AbstractSurfaceData inside
↳
Surface
Constructors
- [new Surface(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.scene-3.surface-1.surface.surface.md#new surface(options))
Properties
Methods
Properties
▪ Static ESTIMATE_RAM_PER_VERTEX: number
▪ Static ESTIMATE_RAM_PER_VERTEX_INTERSECTION: number
▪ Static ESTIMATE_VRAM_PER_VERTEX: number
▪ Static MAX_VALUES_PER_ELEMENT: number
Methods
▸ add(object): Surface
Adds object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ afterRender(scene, camera, plot, renderer): Surface
This function is called after rendering and can update this object's content.<br> <br> It should not trigger any invalidateObject though.<br> 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.<br> <br> This will be executed after the transformations simplification.<br> <br>
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): Surface
This function is called prior to rendering and can update this object's content.<br> <br> It should not trigger any invalidateObject though.<br> 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.<br> <br> This will be executed after the transformations simplification.<br> <br>
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 |
▸ clear(): Surface
AbstractSurface.clear
▸ dispose(): void
Dispose object
void
▸ getClassName(): string
string
IIntersectableMesh.getClassName
▸ getColorProvider(): RgbaColor | ColorProvider
Return the color provider of the intersectable.
IIntersectableMesh.getColorProvider
▸ getData(): DataOut
Return this object's data (geometry, values) when available. Because data can be large, they are returned by reference (no copies).
▸ getMesh(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
Returns the surface mesh
Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
▸ getMeshBoundingBox(target): void
Return the bounding box of the mesh.<br> The bounding box should be calculated directly from the mesh's geometry vertex positions, representing the bounding box. The box coordinates must be in the local coordinate space of the mesh returned by getMesh method.
| Name | Type | Description |
|---|---|---|
target | Box3 | result |
void
IIntersectableMesh.getMeshBoundingBox
▸ getOptions(): OptionsBaseOut
Get surface options
▸ getTriangle(triangleIndex, target): void
Return the triangle data at given index.<br> Vertices coordinates must be in the local coordinate space of the mesh returned by getMesh method.
| Name | Type | Description |
|---|---|---|
triangleIndex | number | the index of the triangle |
target | TriangleData | result |
void
IIntersectableMesh.getTriangle
▸ getTriangleCount(): number
Return the number of triangle.
number
IIntersectableMesh.getTriangleCount
▸ getVisible(): boolean
Get visible
boolean
true, if object is visible
▸ invalidateObject<T>(event?): Surface
Notifies this object and its parent that this object has been invalidated.<br> If this object is in a Plot, it will be marked as dirty and will trigger a rendering cycle.<br>
| Name |
|---|
T |
| Name | Type | Description |
|---|---|---|
Optional event | Event<T> | The event to fire |
AbstractSurface.invalidateObject
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSelectable(): boolean
Return if this object can be picked/selected (see RendererPicking).<br>
boolean
▸ notify<E>(type, source, args?): Surface
- Notify listeners. Parent nodes will also be notified if they are instances of geotoolkit3d.scene.Object3D
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | Surface | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): Surface
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: Surface, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): Surface
Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: Surface, args: EventMap[E]) => void | to be called |
this
▸ onStatsUpdated(metrics): Surface
This function is called when the plot has updated performance metric.<br> It will be called every set number of frames.<br> 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. |
AbstractSurface.onStatsUpdated
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
AbstractSurface.onVisibilityChanged
▸ remove(object): Surface
Removes object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ setData(data): Surface
Set this Surface data.
| Name | Type |
|---|---|
data | Data |
▸ setOptions(options?): Surface
Set options, the given json will be merged with the object's state so that only the given options will be changed.<br>
| Name | Type | Description |
|---|---|---|
Optional options | OptionsBase | The options to change |
this
▸ setPosition(position): Surface
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?): Surface
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).<br>
| Name | Type | Description |
|---|---|---|
selectable | boolean | if can be selected |
void
▸ setVisible(visible, silent?): Surface
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): Surface
This function is called prior to rendering and can update this object's content.<br> <br> It should not trigger any invalidateObject though.<br> 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.<br> <br> This will be executed before the transformations simplification.<br> <br>
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
AbstractSurface.useOwnHighlight
▸ Static estimateMemoryCapabilities(options): MemoryCapabilitiesInfo
Estimate the maximum number of vertices that can be created in one Surface visual, with the given RAM/VRAM information.<br> With enough memory, the implementation limit for Surface is eventually tied to Typed array allocation. This test will perform a one-time array allocation test on your device, to accurately estimate the maximum array size your browser/device is capable of. It is important to have enough memory available for this test to be accurate.
| Name | Type |
|---|---|
options | MemoryEstimationOptions |
▸ Static getClassName(): string
string
▸ Static register(): void
Register object for special processing through a callback function<br>
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