Visual Components
/
/
/RenderingVolume
Last updated

API / geotoolkit3d / scene / volumetric / RenderingVolume / RenderingVolume

Namespace: RenderingVolume

volumetric.RenderingVolume.RenderingVolume

Table of contents

Namespaces
Type Aliases
OptionsOptionsBaseOptionsBaseOut

Contents

Type Aliases

Options

Ƭ Options: Object

The options

Type declaration

NameTypeDescription
alphacorrection?numberThe corrective factor for the alpha transparency.
This alpha factor affect the opacity of each raytraced samples, higher alpha means the volume becomes more opaque.
It might be necessary to adjust the alpha based on the number of steps, a higher step count should use a proportionally lower alpha value.
    Ex:
  • step 30 | alpha 0.3
  • step 100 | alpha 0.1
  • step 200 | alpha 0.05, etc
data?{ max?: number ; min?: number ; points?: Vector4[] ; rawdata?: Float32Array ; size?: Vector3 ; values?: number[] ; x?: number[] ; y?: number[] ; z?: number[] }The Volume data options.
The Volume Renderer accepts two types of data, 3D scalar fields and points sets.
  • 3D Scalar fields are given using the rawdata option, in a 1 dimension Float32Array.
    In this scenario, the size option must also be defined to specify the 3D data size on each axis.
  • Point sets are a collection of 3D points, each point consist of X,Y,Z coordinates, and a value.
    Points can be passed to the Volume Renderer in two way, either using the points option, or using the x,y,z, values options.
data.max?numberThe maximum value of the data.
data.min?numberThe minimum value of the data.
data.points?Vector4[]Define the voume data using points.
A Point is represented by a Vector4, where x,y,z are the respective coordinates, and w is the point value.
Alternatively, poitns can be specified using multiple arrays with the x, y, z and values options.
data.rawdata?Float32ArrayA Float32Array that contain the raw data with the order Z,Y,X (see description for more information)
data.size?Vector3The size of the data in 3D.
data.values?number[]Define the volume data points's values.
data.x?number[]Define the volume data points's x coordinates.
data.y?number[]Define the volume data points's y coordinates.
data.z?number[]Define the volume data points's z coordinates.
end?Vector3The end location of the grid in world coordinates.
flipz?booleanFlip the data with the Z axis
interpolator?AbstractInterpolatorInterpolator function, used to convert the PointSet data into a 3D scalar field data for rendering.
Users can define their own interpolation function if desired, but a default implementation is included.
start?Vector3The start location of the grid in world coordinates.
steps?numberThe number of steps for each ray in the volume raytracing.
Each step will perform an additional sample for each pixel of the final raytraced render.
Bear in mind that a large step count may be detrimental to performances, and a step count larger than the data resolution will have diminishing returns.
switchlights?booleantoggle the Lights in the volumetric render

OptionsBase

Ƭ OptionsBase: Options & Options

The options

OptionsBaseOut

Ƭ OptionsBaseOut: Required<Options> & OptionsOut

RenderingVolume

Namespace - Material