{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Namespace: RenderingVolume","description":"Accelerate E&P application development and protect your innovation by consuming our Data and Domain APIs / Platform APIs.","lang":"en-US","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":true,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/readme"},"children":["API"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d"},"children":["geotoolkit3d"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3"},"children":["scene"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.volumetric"},"children":["volumetric"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.volumetric.renderingvolume"},"children":["RenderingVolume"]}," / RenderingVolume"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"namespace-renderingvolume","__idx":0},"children":["Namespace: RenderingVolume"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.volumetric"},"children":["volumetric"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.volumetric.renderingvolume"},"children":["RenderingVolume"]},".RenderingVolume"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"table-of-contents","__idx":1},"children":["Table of contents"]},{"$$mdtype":"Tag","name":"details","attributes":{"open":"true"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"fontSize":"1.25em","fontWeight":"bold"}},"children":["Namespaces"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.volumetric.renderingvolume.renderingvolume.material"},"children":["Material"]}]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{"open":"true"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"fontSize":"1.25em","fontWeight":"bold"}},"children":["Type Aliases"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.volumetric.renderingvolume.renderingvolume#options"},"children":["Options"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.volumetric.renderingvolume.renderingvolume#optionsbase"},"children":["OptionsBase"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.volumetric.renderingvolume.renderingvolume#optionsbaseout"},"children":["OptionsBaseOut"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"contents","__idx":2},"children":["Contents"]},{"$$mdtype":"Tag","name":"details","attributes":{"open":"true"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"fontSize":"1.25em","fontWeight":"bold"}},"children":["Type Aliases"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"options","__idx":3},"children":["Options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Options"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The options"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"type-declaration","__idx":4},"children":["Type declaration"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["alphacorrection?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The corrective factor for the alpha transparency.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," This alpha factor affect the opacity of each raytraced samples, higher alpha means the volume becomes more opaque.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," 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.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[" Ex: ",{"$$mdtype":"Tag","name":"li","attributes":{},"children":["step 30 | alpha 0.3"]}," ",{"$$mdtype":"Tag","name":"li","attributes":{},"children":["step 100 | alpha 0.1"]}," ",{"$$mdtype":"Tag","name":"li","attributes":{},"children":["step 200 | alpha 0.05, etc"]}," "]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["{ ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["max?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["min?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["points?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Vector4"]},"[] ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rawdata?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Float32Array"]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["size?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Vector3"]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[] ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[] ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["y?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[] ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["z?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[]  }"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The Volume data options.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," The Volume Renderer accepts two types of data, 3D scalar fields and points sets. ",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[" ",{"$$mdtype":"Tag","name":"li","attributes":{},"children":[" 3D Scalar fields are given using the rawdata option, in a 1 dimension Float32Array.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," In this scenario, the size option must also be defined to specify the 3D data size on each axis."]}," ",{"$$mdtype":"Tag","name":"li","attributes":{},"children":[" Point sets are a collection of 3D points, each point consist of X,Y,Z coordinates, and a value.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Points can be passed to the Volume Renderer in two way, either using the points option, or using the x,y,z, values options. "]}," "]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.max?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The maximum value of the data."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.min?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The minimum value of the data."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.points?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Vector4"]},"[]"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Define the voume data using points.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," A Point is represented by a Vector4, where x,y,z are the respective coordinates, and w is the point value.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Alternatively, poitns can be specified using multiple arrays with the x, y, z and values options."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.rawdata?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Float32Array"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["A Float32Array that contain the raw data with the order Z,Y,X (see description for more information)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.size?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Vector3"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The size of the data in 3D."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.values?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[]"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Define the volume data points's values."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.x?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[]"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Define the volume data points's x coordinates."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.y?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[]"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Define the volume data points's y coordinates."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.z?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"[]"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Define the volume data points's z coordinates."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Vector3"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The end location of the grid in world coordinates."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flipz?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Flip the data with the Z axis"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["interpolator?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.util-5.interpolators.abstractinterpolator.abstractinterpolator"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AbstractInterpolator"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Interpolator function, used to convert the PointSet data into a 3D scalar field data for rendering.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Users can define their own interpolation function if desired, but a default implementation is included."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Vector3"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The start location of the grid in world coordinates."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["steps?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The number of steps for each ray in the volume raytracing.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Each step will perform an additional sample for each pixel of the final raytraced render.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," 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."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["switchlights?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["toggle the Lights in the volumetric render"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"optionsbase","__idx":5},"children":["OptionsBase"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OptionsBase"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.object3d.object3d#options"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]}," & ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.volumetric.renderingvolume.renderingvolume.material#options"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The options"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"optionsbaseout","__idx":6},"children":["OptionsBaseOut"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OptionsBaseOut"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Required"]},"<",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.object3d.object3d#options"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]},"> & ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.volumetric.renderingvolume.renderingvolume.material#optionsout"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OptionsOut"]}]}]}]}]},"headings":[{"value":"Namespace: RenderingVolume","id":"namespace-renderingvolume","depth":1},{"value":"Table of contents","id":"table-of-contents","depth":2},{"value":"Contents","id":"contents","depth":2},{"value":"Options","id":"options","depth":4},{"value":"Type declaration","id":"type-declaration","depth":4},{"value":"OptionsBase","id":"optionsbase","depth":4},{"value":"OptionsBaseOut","id":"optionsbaseout","depth":4}],"frontmatter":{"seo":{"title":"Namespace: RenderingVolume"}},"lastModified":"2026-02-11T19:54:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.volumetric.renderingvolume.renderingvolume","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}