x_ite 8.4.3 → 8.5.3

package/docs/_posts/components/VolumeRendering/EdgeEnhancementVolumeStyle.md

@@ -0,0 +1,67 @@
+---
+title: EdgeEnhancementVolumeStyle
+date: 2022-01-07
+nav: components-VolumeRendering
+categories: [components, VolumeRendering]
+tags: [EdgeEnhancementVolumeStyle, VolumeRendering]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+EdgeEnhancementVolumeStyle specifies edge enhancement for the volume rendering style.
+
+The EdgeEnhancementVolumeStyle node belongs to the **VolumeRendering** component and its default container field is *renderStyle.* It is available since X3D version 3.3 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DVolumeRenderStyleNode
+    + X3DComposableVolumeRenderStyleNode
+      + EdgeEnhancementVolumeStyle
+```
+
+## Fields
+
+### SFColorRGBA [in, out] **edgeColor** 0 0 0 1 <small>[0,1]</small>
+
+Color used to highlight edges.
+
+#### See Also
+
+- [X3D Scene Authoring Hints, Color](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color){:target="_blank"}
+
+### SFBool [in, out] **enabled** TRUE
+
+Enables/disables node operation.
+
+### SFFloat [in, out] **gradientThreshold** 0.4 <small>[0,π]</small>
+
+Minimum angle (in radians) away from view-direction vector for surface normal before applying enhancement
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### SFNode [in, out] **surfaceNormals** NULL <small>[X3DTexture3DNode]</small>
+
+Input/Output field surfaceNormals.
+
+## Description
+
+### Hint
+
+- SurfaceNormals can be provided in a single ComposedTexture3D, ImageTexture3D or PixelTexture3D node.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/VolumeRendering/EdgeEnhancementVolumeStyle/EdgeEnhancementVolumeStyle.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of EdgeEnhancementVolumeStyle](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/volume.html#EdgeEnhancementVolumeStyle){:target="_blank"}

package/docs/_posts/components/VolumeRendering/IsoSurfaceVolumeData.md

@@ -0,0 +1,99 @@
+---
+title: IsoSurfaceVolumeData
+date: 2022-01-07
+nav: components-VolumeRendering
+categories: [components, VolumeRendering]
+tags: [IsoSurfaceVolumeData, VolumeRendering]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+IsoSurfaceVolumeData displays one or more surfaces extracted from a voxel dataset. A surface is defined as the boundary between regions in the volume where the voxel values are larger than a given value (the iso value) on one side of the boundary and smaller on the other side, and the gradient magnitude is larger than surfaceTolerance.
+
+The IsoSurfaceVolumeData node belongs to the **VolumeRendering** component and its default container field is *children.* It is available since X3D version 3.3 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DVolumeDataNode (X3DBoundedObject)*
+      + IsoSurfaceVolumeData
+```
+
+<small>\* Derived from multiple interfaces.</small>
+
+## Fields
+
+### SFFloat [in, out] **contourStepSize** 0 <small>(-∞,∞)</small>
+
+If contourStepSize is non-zero, also render all isosurfaces that are multiples of that step size from initial surface value.
+
+#### Hint
+
+- ContourStepSize can be negative so that steppping can proceed in a negative direction.
+
+### SFVec3f [in, out] **dimensions** 1 1 1 <small>(0,∞)</small>
+
+Actual-size X-Y-Z dimensions of volume data in local coordinate system.
+
+### SFNode [in, out] **gradients** NULL <small>[X3DTexture3DNode]</small>
+
+Input/Output field gradients.
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### MFNode [in, out] **renderStyle** [ ] <small>[X3DVolumeRenderStyleNode]</small>
+
+Input/Output field renderStyle.
+
+### SFFloat [in, out] **surfaceTolerance** 0 <small>[0,∞)</small>
+
+Threshold for gradient magnitude for voxel inolusion in isosurface.
+
+#### Hint
+
+- Contained Texture3D node with containerField='gradients' can provide explicit per-voxel gradient direction information for determining surface boundaries.
+
+### MFFloat [in, out] **surfaceValues** [ ] <small>(-∞,∞)</small>
+
+If surfaceValues has one value defined, render corresponding isosurface plus any isosurfaces based on contourStepSize. If surfaceValues has more than one value defined, ignore contourStepSize and render surfaces corresponding to listed surfaceValues.
+
+### SFNode [in, out] **voxels** NULL <small>[X3DTexture3DNode]</small>
+
+Input/Output field voxels.
+
+### SFVec3f [ ] **bboxCenter** 0 0 0 <small>(-∞,∞)</small>
+
+Bounding box center: optional hint for position offset from origin of local coordinate system.
+
+### SFVec3f [ ] **bboxSize** -1 -1 -1 <small>[0,∞) or -1 -1 -1</small>
+
+Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
+
+#### Hint
+
+- Can be useful for collision computations or inverse-kinematics (IK) engines.
+
+## Description
+
+### Hints
+
+- IsoSurfaceVolumeData can contain a single Texture3D node with containerField='gradients' that is used to provide explicit per-voxel gradient direction information for determining surface boundaries, rather than having values implicitly calculated by the implementation.
+- IsoSurfaceVolumeData can contain another Texture3D node with containerField='voxels' containing voxel data.
+- IsoSurfaceVolumeData can contain multiple VolumeStyle nodes.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/VolumeRendering/IsoSurfaceVolumeData/IsoSurfaceVolumeData.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of IsoSurfaceVolumeData](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/volume.html#IsoSurfaceVolumeData){:target="_blank"}

package/docs/_posts/components/VolumeRendering/OpacityMapVolumeStyle.md

@@ -0,0 +1,51 @@
+---
+title: OpacityMapVolumeStyle
+date: 2022-01-07
+nav: components-VolumeRendering
+categories: [components, VolumeRendering]
+tags: [OpacityMapVolumeStyle, VolumeRendering]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+OpacityMapVolumeStyle specifies that volumetric data is rendered using opacity mapped to a transfer function texture.
+
+The OpacityMapVolumeStyle node belongs to the **VolumeRendering** component and its default container field is *renderStyle.* It is available since X3D version 3.3 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DVolumeRenderStyleNode
+    + X3DComposableVolumeRenderStyleNode
+      + OpacityMapVolumeStyle
+```
+
+## Fields
+
+### SFBool [in, out] **enabled** TRUE
+
+Enables/disables node operation.
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### SFNode [in, out] **transferFunction** NULL <small>[X3DTexture2DNode,X3DTexture3DNode]</small>
+
+Input/Output field transferFunction.
+
+## Description
+
+### Hint
+
+- Contains a single ImageTexture2D or ImageTexture3D node with containerField='transferFunction'. Voxel values are used as lookup coordinates into the transfer function texture, where the texel value represents the output color.
+
+## External Links
+
+- [X3D Specification of OpacityMapVolumeStyle](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/volume.html#OpacityMapVolumeStyle){:target="_blank"}

package/docs/_posts/components/VolumeRendering/ProjectionVolumeStyle.md

@@ -0,0 +1,48 @@
+---
+title: ProjectionVolumeStyle
+date: 2022-01-07
+nav: components-VolumeRendering
+categories: [components, VolumeRendering]
+tags: [ProjectionVolumeStyle, VolumeRendering]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+ProjectionVolumeStyle uses voxel data to directly generate output color.
+
+The ProjectionVolumeStyle node belongs to the **VolumeRendering** component and its default container field is *renderStyle.* It is available since X3D version 3.3 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DVolumeRenderStyleNode
+    + ProjectionVolumeStyle
+```
+
+## Fields
+
+### SFBool [in, out] **enabled** TRUE
+
+Enables/disables node operation.
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### SFFloat [in, out] **intensityThreshold** 0 <small>[0,1]</small>
+
+Threshold value used when type=MIN (LMIP) or type=MAX (MIP).
+
+#### Hint
+
+- Ignored if type=AVERAGE (no thresholding).
+
+## External Links
+
+- [X3D Specification of ProjectionVolumeStyle](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/volume.html#ProjectionVolumeStyle){:target="_blank"}

package/docs/_posts/components/VolumeRendering/SegmentedVolumeData.md

@@ -0,0 +1,80 @@
+---
+title: SegmentedVolumeData
+date: 2022-01-07
+nav: components-VolumeRendering
+categories: [components, VolumeRendering]
+tags: [SegmentedVolumeData, VolumeRendering]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+SegmentedVolumeData displays a segmented voxel dataset with different RenderStyle nodes.
+
+The SegmentedVolumeData node belongs to the **VolumeRendering** component and its default container field is *children.* It is available since X3D version 3.3 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DVolumeDataNode
+      + SegmentedVolumeData
+```
+
+## Fields
+
+### SFVec3f [in, out] **dimensions** 1 1 1 <small>(0,∞)</small>
+
+Actual-size X-Y-Z dimensions of volume data in local coordinate system.
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### MFNode [in, out] **renderStyle** [ ] <small>[X3DVolumeRenderStyleNode]</small>
+
+Input/Output field renderStyle.
+
+### MFBool [in, out] **segmentEnabled** [ ]
+
+Input/Output field segmentEnabled.
+
+### SFNode [in, out] **segmentIdentifiers** NULL <small>[X3DTexture3DNode]</small>
+
+Input/Output field segmentIdentifiers.
+
+### SFNode [in, out] **voxels** NULL <small>[X3DTexture3DNode]</small>
+
+Input/Output field voxels.
+
+### SFVec3f [ ] **bboxCenter** 0 0 0 <small>(-∞,∞)</small>
+
+Bounding box center: optional hint for position offset from origin of local coordinate system.
+
+### SFVec3f [ ] **bboxSize** -1 -1 -1 <small>[0,∞) or -1 -1 -1</small>
+
+Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
+
+#### Hint
+
+- Can be useful for collision computations or inverse-kinematics (IK) engines.
+
+## Description
+
+### Hints
+
+- SegmentedVolumeData can contain a single ComposedTexture3D, ImageTexture3D or PixelTexture3D node with containerField='segmentIdentifiers' and another with containerField='voxels'.
+- SegmentedVolumeData can contain multiple RenderStyle nodes.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/VolumeRendering/SegmentedVolumeData/SegmentedVolumeData.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of SegmentedVolumeData](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/volume.html#SegmentedVolumeData){:target="_blank"}

package/docs/_posts/components/VolumeRendering/ShadedVolumeStyle.md

@@ -0,0 +1,75 @@
+---
+title: ShadedVolumeStyle
+date: 2022-01-07
+nav: components-VolumeRendering
+categories: [components, VolumeRendering]
+tags: [ShadedVolumeStyle, VolumeRendering]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+ShadedVolumeStyle applies Blinn-Phong illumination model to volume rendering.
+
+The ShadedVolumeStyle node belongs to the **VolumeRendering** component and its default container field is *renderStyle.* It is available since X3D version 3.3 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DVolumeRenderStyleNode
+    + X3DComposableVolumeRenderStyleNode
+      + ShadedVolumeStyle
+```
+
+## Fields
+
+### SFBool [in, out] **enabled** TRUE
+
+Enables/disables node operation.
+
+### SFBool [in, out] **lighting** FALSE
+
+Whether rendering calculates and applies shading effects to visual output.
+
+### SFNode [in, out] **material** NULL <small>[X3DMaterialNode]</small>
+
+Input/Output field material.
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### SFBool [in, out] **shadows** FALSE
+
+Whether rendering calculates and applies shadows to visual output (using global illumination model).
+
+### SFNode [in, out] **surfaceNormals** NULL <small>[X3DTexture3DNode]</small>
+
+Input/Output field surfaceNormals.
+
+### SFString [ ] **phaseFunction** "Henyey-Greenstein" <small>["Henyey-Greenstein","NONE",...]</small>
+
+Define scattering model for implementations using global illumination (NONE or Henyey-Greenstein phase function).#10;
+
+#### Warning
+
+- Do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
+
+## Description
+
+### Hint
+
+- ShadedVolumeStyle can contain a single Texture3D node with containerField='surfaceNormals' and a single Material node.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/VolumeRendering/ShadedVolumeStyle/ShadedVolumeStyle.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of ShadedVolumeStyle](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/volume.html#ShadedVolumeStyle){:target="_blank"}

package/docs/_posts/components/VolumeRendering/SilhouetteEnhancementVolumeStyle.md

@@ -0,0 +1,63 @@
+---
+title: SilhouetteEnhancementVolumeStyle
+date: 2022-01-07
+nav: components-VolumeRendering
+categories: [components, VolumeRendering]
+tags: [SilhouetteEnhancementVolumeStyle, VolumeRendering]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+SilhouetteEnhancementVolumeStyle specifies that volumetric data is rendered with silhouette enhancement.
+
+The SilhouetteEnhancementVolumeStyle node belongs to the **VolumeRendering** component and its default container field is *renderStyle.* It is available since X3D version 3.3 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DVolumeRenderStyleNode
+    + X3DComposableVolumeRenderStyleNode
+      + SilhouetteEnhancementVolumeStyle
+```
+
+## Fields
+
+### SFBool [in, out] **enabled** TRUE
+
+Enables/disables node operation.
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### SFFloat [in, out] **silhouetteBoundaryOpacity** 0 <small>[0,1]</small>
+
+Amount of the silhouette enhancement to use.
+
+### SFFloat [in, out] **silhouetteRetainedOpacity** 1 <small>[0,1]</small>
+
+Scaling of non-silhouette regions.
+
+### SFFloat [in, out] **silhouetteSharpness** 0.5 <small>[0,∞)</small>
+
+Power function to control sharpness of the silhouette.
+
+### SFNode [in, out] **surfaceNormals** NULL <small>[X3DTexture3DNode]</small>
+
+Input/Output field surfaceNormals.
+
+## Description
+
+### Hint
+
+- SilhouetteEnhancementVolumeStyle can contain a single Texture3D node with containerField='surfaceNormals'
+
+## External Links
+
+- [X3D Specification of SilhouetteEnhancementVolumeStyle](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/volume.html#SilhouetteEnhancementVolumeStyle){:target="_blank"}

package/docs/_posts/components/VolumeRendering/ToneMappedVolumeStyle.md

@@ -0,0 +1,71 @@
+---
+title: ToneMappedVolumeStyle
+date: 2022-01-07
+nav: components-VolumeRendering
+categories: [components, VolumeRendering]
+tags: [ToneMappedVolumeStyle, VolumeRendering]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+ToneMappedVolumeStyle specifies that volumetric data is rendered with Gooch shading model of two-toned warm/cool coloring.
+
+The ToneMappedVolumeStyle node belongs to the **VolumeRendering** component and its default container field is *renderStyle.* It is available since X3D version 3.3 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DVolumeRenderStyleNode
+    + X3DComposableVolumeRenderStyleNode
+      + ToneMappedVolumeStyle
+```
+
+## Fields
+
+### SFColorRGBA [in, out] **coolColor** 0 0 1 0 <small>[0,1]</small>
+
+*coolColor* is used for surfaces facing away from the light direction.
+
+#### See Also
+
+- [X3D Scene Authoring Hints, Color](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color){:target="_blank"}
+
+### SFBool [in, out] **enabled** TRUE
+
+Enables/disables node operation.
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### SFNode [in, out] **surfaceNormals** NULL <small>[X3DTexture3DNode]</small>
+
+Input/Output field surfaceNormals.
+
+### SFColorRGBA [in, out] **warmColor** 1 1 0 0 <small>[0,1]</small>
+
+*warmColor* is used for surfaces facing towards the light.
+
+#### See Also
+
+- [X3D Scene Authoring Hints, Color](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color){:target="_blank"}
+
+## Description
+
+### Hint
+
+- ToneMappedVolumeStyle can contain a single Texture3D node with containerField='surfaceNormals'
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/VolumeRendering/ToneMappedVolumeStyle/ToneMappedVolumeStyle.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of ToneMappedVolumeStyle](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/volume.html#ToneMappedVolumeStyle){:target="_blank"}

package/docs/_posts/components/VolumeRendering/VolumeData.md

@@ -0,0 +1,71 @@
+---
+title: VolumeData
+date: 2022-01-07
+nav: components-VolumeRendering
+categories: [components, VolumeRendering]
+tags: [VolumeData, VolumeRendering]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+VolumeData displays a simple non-segmented voxel dataset with a single RenderStyle node.
+
+The VolumeData node belongs to the **VolumeRendering** component and its default container field is *children.* It is available since X3D version 3.3 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DVolumeDataNode
+      + VolumeData
+```
+
+## Fields
+
+### SFVec3f [in, out] **dimensions** 1 1 1 <small>(0,∞)</small>
+
+Actual-size X-Y-Z dimensions of volume data in local coordinate system.
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### SFNode [in, out] **renderStyle** NULL <small>[X3DVolumeRenderStyleNode]</small>
+
+Input/Output field renderStyle.
+
+### SFNode [in, out] **voxels** NULL <small>[X3DTexture3DNode]</small>
+
+Input/Output field voxels.
+
+### SFVec3f [ ] **bboxCenter** 0 0 0 <small>(-∞,∞)</small>
+
+Bounding box center: optional hint for position offset from origin of local coordinate system.
+
+### SFVec3f [ ] **bboxSize** -1 -1 -1 <small>[0,∞) or -1 -1 -1</small>
+
+Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
+
+#### Hint
+
+- Can be useful for collision computations or inverse-kinematics (IK) engines.
+
+## Description
+
+### Hint
+
+- VolumeData can contain a single Texture3D node with containerField='voxels' and a single RenderStyle node.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/VolumeRendering/VolumeData/VolumeData.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of VolumeData](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/volume.html#VolumeData){:target="_blank"}