API / geotoolkit3d / scene / volumetric / RenderingVolume / RenderingVolume
volumetric.RenderingVolume.RenderingVolume
A 3D Object that represent a cube with a dynamic texture which display a volume rendering.
To display some data you must include a Float32Array of data and the size of the data within a THREE.Vector3.
The order in the Float32Array needs to be read each in this order Z Y X like :
____
//| <- Z
| | |
||/ <- Y
X
↳
RenderingVolume
Constructors
Methods
Methods
▸ add(object): RenderingVolume
Adds object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ addMoreData(data): RenderingVolume
Add Data to the Mesh RenderingVolume, and display it.
| Name | Type | Description |
|---|---|---|
data | Float32Array | Raw data, value mush be order like depth,Xline,Inline |
this
▸ afterRender(scene, camera, plot, renderer): RenderingVolume
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 |
▸ beforeRender(scene, camera, plot, renderer): RenderingVolume
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
▸ getAlphaCorrection(): number
Get the alpha factor used in the volume rendering.
number
Alpha value used to correct the volume rendering
▸ getClassName(): string
string
▸ getDataMax(): number
Get the dataMax in the volume rendering.
number
the value of dataMax used in the volume rendering
▸ getDataMin(): number
Get the dataMin in the volume rendering.
number
the value of dataMin used in the volume rendering
▸ getFlipZ(): boolean
Get if the shader will flip the Z axis
boolean
Boolean if flipZ axis or not
▸ getLightsOnOff(): boolean
Get if the shader display lights in the volumetric
boolean
Boolean if lights are on or off.
▸ getOptions(): OptionsBaseOut
Get the RenderingVolume options
options
▸ getSizeInScene(): Vector3
Get the size of the volume in scene
Vector3
sizeInScene - center position
▸ getSteps(): number
Get the number of steps used in the volume rendering.
number
Number of steps used in the volume rendering
▸ getVisible(): boolean
Get visible
boolean
true, if object is visible
▸ invalidateObject<T>(event?): RenderingVolume
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
▸ notify(type, source, args?): RenderingVolume
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?): RenderingVolume
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): RenderingVolume
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: RenderingVolume, args: EventMap[E]) => void |
▸ on(type, callback, options?): RenderingVolume
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?): RenderingVolume
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: RenderingVolume, args: EventMap[E]) => void |
Optional options | Options |
▸ onStatsUpdated(metrics): RenderingVolume
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): RenderingVolume
Removes object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ setFlipZ(flip): RenderingVolume
Set if the shader will flip the Z axis
| Name | Type | Description |
|---|---|---|
flip | boolean | Boolean if flipZ axis or not. |
this
▸ setOptions(options?): RenderingVolume
Set the RenderingVolume options
| Name | Type | Description |
|---|---|---|
Optional options | OptionsBase | The options |
this
▸ setPosition(position): RenderingVolume
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?): RenderingVolume
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
▸ setSizeInScene(sizeInScene): RenderingVolume
Set the size of the volume in scene
| Name | Type | Description |
|---|---|---|
sizeInScene | Vector3 | center position |
this
▸ setVisible(visible, silent?): RenderingVolume
Set visible
| Name | Type | Description |
|---|---|---|
visible | boolean | true, if object is visible |
Optional silent | boolean | true, if object shouldn't be invalidated |
this
▸ updateColorMap(color): void
Update the transfer function
| Name | Type | Description |
|---|---|---|
color | string[] | Array of CSS color (like "rgba(x,x,x,x)" or "#ff00fc" or "0xff00fc") |
void
▸ updateObject(scene, camera): RenderingVolume
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 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