official documentation

  1. x3dom.org
  2. documentation
  3. Developer API

Class: BlendedVolumeStyle

X3DOM
Component: VolumeRendering

Quick Links

➨ Fields
➨ Properties

.nodeTypes. BlendedVolumeStyle

The BlendedVolumeStyle node allows to blend the parent volume data with a second specified volume data using a weight function.

HTML Encoding and Default Values⤴

<BlendedVolumeStyle enabled='true' metadata='X3DMetadataObject' renderStyle='x3dom.nodeTypes.X3DComposableVolumeRenderStyleNode' surfaceNormals='x3dom.nodeTypes.Texture' voxels='x3dom.nodeTypes.X3DVolumeDataNode' weightConstant1='0.5' weightConstant2='0.5' weightFunction1='"CONSTANT"' weightFunction2='"CONSTANT"' weightTransferFunction1='x3dom.nodeTypes.X3DTexture2DNode' weightTransferFunction2='x3dom.nodeTypes.X3DTexture2DNode' ></BlendedVolumeStyle>

Inheritance⤴


Constructor⤴

BlendedVolumeStyle(ctx)⤴

Constructor for BlendedVolumeStyle

Parameters:
Name Type Argument Default Description
ctx Object <optional>
 null context object, containing initial settings like namespace

Fields⤴

These are the X3D / X3DOM fields of this node. Values should usually be received / set as strings via DOM functions (i.e., using setAttribute("myFieldName", "myFieldValue") and getAttribute("myFieldName")).
Name Type Default Value Range Inheritance Standard Description
enabled SFBool true X3DVolumeRenderStyleNode Specifies whether the render style is enabled or disabled.
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
renderStyle SFNode X3DComposableVolumeRenderStyleNode Specifies the render style to be applied on the volume data to be blended.
surfaceNormals SFNode Texture X3DComposableVolumeRenderStyleNode The surfaceNormals field allows to provide the normals of the volume data. It takes an ImageTextureAtlas of the same dimensions of the volume data. If it is not provided, it is computed on the fly.
voxels SFNode X3DVolumeDataNode The voxels field is an ImageTextureAtlas node containing the volume data to be blended.
weightConstant1 SFFloat 0.5 The weightConstant1 field specifies a constant weight value to be use on the parent volume data.
weightConstant2 SFFloat 0.5 The weightConstant2 field specifies a constant weight value to be use on the volume data to be blended.
weightFunction1 SFString "CONSTANT" The weightFunction1 field specifies the type of the weight function to be use on the parent volume data.
weightFunction2 SFString "CONSTANT" The weightFunction2 field specifies the type of weight function to be use on the volume data to be blended.
weightTransferFunction1 SFNode X3DTexture2DNode The weightTransferFunction1 field is a 2D texture that maps each opacity value to a weight value, that will be used on the parent volume data.
weightTransferFunction2 SFNode X3DTexture2DNode The weightTransferFunction2 field is a 2D texture that maps each opacity value to a weight value, that will be used on the volume data to be blended.