API / geotoolkit3d / scene / pointset / PointCloud / PointCloud
pointset.PointCloud.PointCloud
PointCloud is a set of 3D coordinates rendered as symbols.
It's similar to a PointSet and share most of the same API with it (even if they don't share a common parent interface).
The main difference between PointSet and PointCloud is that a PointCloud can handle larger sets of data.
However it uses BumpMapping to emulate the symbols which lowers the quality of the rendering of each symbol.
For large datasets, it's recommended to use PointCloud.
↳
PointCloud
Constructors
Methods
Methods
▸ add(object): PointCloud
Adds object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ afterRender(scene, camera, plot, renderer): PointCloud
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): PointCloud
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 object
void
▸ getClassName(): string
string
▸ getOptions(): OptionsBaseOut
Get point cloud options (see PointCloud.setOptions for more info)
options
▸ getPointCloud(): Points<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
Gets point cloud
Points<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
pointcloud
▸ getPointOptions(index): PointOptionsOut
Get the attributes of a point at the given index, return null if index is not valid.
| Name | Type | Description |
|---|---|---|
index | number | index of point |
▸ getVisible(): boolean
Get visible
boolean
true, if object is visible
▸ invalidateObject<T>(event?): PointCloud
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 |
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSelectable(): boolean
Return if this object can be picked/selected (see RendererPicking).
boolean
▸ isValidIndex(index): boolean
Return if this point index is valid (belong to a point in this point cloud).
| Name | Type | Description |
|---|---|---|
index | number | the point index. |
boolean
▸ notify(type, source, args?): PointCloud
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?): PointCloud
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): PointCloud
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: PointCloud, args: EventMap[E]) => void |
▸ on(type, callback, options?): PointCloud
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?): PointCloud
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: PointCloud, args: EventMap[E]) => void |
Optional options | Options |
▸ onStatsUpdated(metrics): PointCloud
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
▸ remove(object): PointCloud
Removes object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ setOptions(options?): PointCloud
Set options, the given json will be merged with the object's state so that only the given options will be changed.
| Name | Type | Description |
|---|---|---|
Optional options | OptionsBase | The options |
this
▸ setPointOptions(index, options): PointCloud
Set per point options, note that it's more efficient to use setOptions() to modify large ensemble of points.
| Name | Type | Description |
|---|---|---|
index | number | The index of the point to edit |
options | PointOptions | The options |
this
▸ setPosition(position): PointCloud
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?): PointCloud
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?): PointCloud
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): PointCloud
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 estimateMemoryCapabilities(options): MemoryCapabilitiesInfo
Estimate the maximum number of points that can be created in one PointCloud visual, with the given RAM/VRAM informations.
With enough memory, the implementation limit for PointCloud 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
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