API / geotoolkit3d / scene / reservoir / hexahedral / voxel / VoxelGridGroup / VoxelGridGroup
voxel.VoxelGridGroup.VoxelGridGroup
The Voxel grid group is a utility 3D visual that allow handling of multiple Voxel sub grids at the same time, providing convenience of use and performance improvements. (Soon with LOD support)
↳
VoxelGridGroup
Constructors
- [new VoxelGridGroup(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.scene-3.reservoir-2.hexahedral-1.voxel.voxelgridgroup.voxelgridgroup.md#new voxelgridgroup(options))
Methods
Constructors
• new VoxelGridGroup(options?)
| Name | Type |
|---|---|
Optional options | OptionsBase |
AbstractReservoirGrid.constructor
Methods
▸ add(object): VoxelGridGroup
Adds object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ afterRender(scene, camera, plot, renderer): VoxelGridGroup
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 |
AbstractReservoirGrid.afterRender
▸ beforeRender(scene, camera, plot, renderer): VoxelGridGroup
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 |
AbstractReservoirGrid.beforeRender
▸ deleteAdditionalCellData(name): void
Delete a previously defined additional cell data.<br>
| Name | Type | Description |
|---|---|---|
name | string | The name of the additional data to delete. |
void
▸ dispose(): void
Dispose this VoxelGridGroup, along its children.
void
▸ disposeVoxelGrid(id): VoxelGridGroup
Remove and dispose the voxel subgrid at the specified ID.
| Name | Type | Description |
|---|---|---|
id | string | the voxel subgrid ID |
▸ getClassName(): string
string
AbstractReservoirGrid.getClassName
▸ getColorProvider(): ColorProvider
Return the colorProvider for this Grid group, assuming the same colorprovider is used for all sub grids.
▸ getFilteredCellsCount(): number
Return the number of cells resulting from the user's filter.
number
▸ getMetadata(): MetaData
Return a copy of this VoxelGrid group metadata.
▸ getOptions(): OptionsBaseOut
Get this Voxel Grid group options.
AbstractReservoirGrid.getOptions
▸ getVisible(): boolean
Get visible
boolean
true, if object is visible
AbstractReservoirGrid.getVisible
▸ getVoxelGrid(id): VoxelGrid
Return the Voxel sub grid for the specified ID, or undefined if no grid exists at this ID.
| Name | Type | Description |
|---|---|---|
id | string | the subgrid ID. |
▸ getVoxelGridList(): VoxelGrid[]
Return all the current Voxel sub grids.
▸ invalidateObject<T>(event?): VoxelGridGroup
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 |
AbstractReservoirGrid.invalidateObject
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
AbstractReservoirGrid.isDisposed
▸ isSelectable(): boolean
Return if this object can be picked/selected (see RendererPicking).<br>
boolean
AbstractReservoirGrid.isSelectable
▸ notify<E>(type, source, args?): VoxelGridGroup
- 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 | VoxelGrid | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): VoxelGridGroup
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: VoxelGridGroup, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): VoxelGridGroup
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: VoxelGridGroup, args: EventMap[E]) => void | to be called |
this
▸ onStatsUpdated(metrics): VoxelGridGroup
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. |
AbstractReservoirGrid.onStatsUpdated
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
AbstractReservoirGrid.onVisibilityChanged
▸ remove(object): VoxelGridGroup
Removes object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ removeHighlightShape(): void
Remove the current cell highlight effects on this voxel grid group.
void
AbstractReservoirGrid.removeHighlightShape
▸ setColorProvider(colorProvider): VoxelGridGroup
Set the colorProvider for this Grid group.
| Name | Type | Description |
|---|---|---|
colorProvider | ColorProvider | the color provider |
▸ setOptions(options): VoxelGridGroup
Set this VoxelGrid group options.
| Name | Type |
|---|---|
options | OptionsBase |
AbstractReservoirGrid.setOptions
▸ setPosition(position): VoxelGridGroup
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
AbstractReservoirGrid.setPosition
▸ setRotation(x, y, z, order?): VoxelGridGroup
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
AbstractReservoirGrid.setRotation
▸ setSelectable(selectable): void
Set if this object can be picked/selected (see RendererPicking).<br>
| Name | Type | Description |
|---|---|---|
selectable | boolean | if can be selected |
void
AbstractReservoirGrid.setSelectable
▸ setVisible(visible, silent?): VoxelGridGroup
Set visible
| Name | Type | Description |
|---|---|---|
visible | boolean | true, if object is visible |
Optional silent | boolean | true, if object shouldn't be invalidated |
this
AbstractReservoirGrid.setVisible
▸ setVoxelGrid(voxelGrid, id): VoxelGridGroup
Register and add a voxel subGrid to this Voxel grid group.
| Name | Type | Description |
|---|---|---|
voxelGrid | VoxelGrid | the voxel sub grid to add. |
id | string | the ID of the voxel subgrid, for easy retrieval. |
▸ updateObject(scene, camera): VoxelGridGroup
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 |
AbstractReservoirGrid.updateObject
▸ 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
AbstractReservoirGrid.useOwnHighlight
▸ Static getClassName(): string
string
AbstractReservoirGrid.getClassName
▸ 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