x_ite 8.4.3 → 8.5.3

package/docs/_posts/components/Shape/Material.md

@@ -0,0 +1,217 @@
+---
+title: Material
+date: 2022-01-07
+nav: components-Shape
+categories: [components, Shape]
+tags: [Material, Shape]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+Material specifies surface rendering properties for associated geometry nodes. Material attributes are used by the X3D lighting equations during rendering.
+
+The Material node belongs to the **Shape** component and its default container field is *material.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DAppearanceChildNode
+    + X3DMaterialNode
+      + X3DOneSidedMaterialNode
+        + Material
+```
+
+## Fields
+
+### 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] **ambientIntensity** 0.2 <small>[0,1]</small>
+
+How much ambient omnidirectional light is reflected from all light sources. Interchange profile hint: this field may be ignored, applying the default value regardless.
+
+### SFString [in, out] **ambientTextureMapping** ""
+
+The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.
+
+### SFNode [in, out] **ambientTexture** NULL <small>[X3DSingleTextureNode]</small>
+
+When applying ambientIntensity for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
+
+#### Hint
+
+- If texture node is NULL or unspecified, no effect is applied to material values.
+- Contained texture node must include containerField='ambientTexture'
+
+### SFColor [in, out] **diffuseColor** 0.8 0.8 0.8 <small>[0,1]</small>
+
+How much direct, angle-dependent light is reflected from all light sources.
+
+#### Hints
+
+- Only emissiveColor affects IndexedLineSet, LineSet and PointSet. If a texture is present the diffuseColor is always multiplied with the texture color, in contrast to the specification. Set diffuseColor to (1 1 1) to get maximum texture color intensity.
+
+### SFString [in, out] **diffuseTextureMapping** ""
+
+The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.
+
+### SFNode [in, out] **diffuseTexture** NULL <small>[X3DSingleTextureNode]</small>
+
+When applying diffuseColor for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
+
+#### Hints
+
+- If texture node is NULL or unspecified, no effect is applied to material values.
+- Contained texture node must include containerField='diffuseTexture'
+
+### SFColor [in, out] **specularColor** 0 0 0 <small>[0,1]</small>
+
+Specular highlights are brightness reflections (example: shiny spots on an apple). Interchange profile hint: this field may be ignored, applying the default value regardless.
+
+### SFString [in, out] **specularTextureMapping** ""
+
+The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.
+
+### SFNode [in, out] **specularTexture** NULL <small>[X3DSingleTextureNode]</small>
+
+When applying specularColor for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
+
+#### Hints
+
+- If texture node is NULL or unspecified, no effect is applied to material values.
+- Contained texture node must include containerField='specularTexture'
+
+### SFColor [in, out] **emissiveColor** 0 0 0 <small>[0,1]</small>
+
+How much glowing light is emitted from this object.
+
+#### Hints
+
+- EmissiveColors glow even when all lights are off. Reset diffuseColor from default (.8 .8 .8) to (0 0 0) to avoid washout. Only emissiveColor affects IndexedLineSet, LineSet and PointSet.
+
+#### Warning
+
+- Bright emissiveColor values can wash out other colors and some textures.
+
+### SFFloat [in, out] **emissiveStrength** 1 <small>[0,∞) <span class="yellow">non standard</span></small>
+
+A multiplier for emissiveColor and emissiveTexture values.
+
+#### Hint
+
+- [glTF version 2 KHR materials emissive strength](https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Khronos/KHR_materials_emissive_strength){:target="_blank"}
+
+### SFString [in, out] **emissiveTextureMapping** ""
+
+The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.
+
+### SFNode [in, out] **emissiveTexture** NULL <small>[X3DSingleTextureNode]</small>
+
+When applying emissiveColor for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
+
+#### Hints
+
+- If texture node is NULL or unspecified, no effect is applied to material values.
+- Contained texture node must include containerField='emissiveTexture'
+
+### SFFloat [in, out] **shininess** 0.2 <small>[0,1]</small>
+
+Lower shininess values provide soft specular glows, while higher values result in sharper, smaller highlights. Interchange profile hint: this field may be ignored, applying the default value regardless.
+
+### SFString [in, out] **shininessTextureMapping** ""
+
+The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.
+
+### SFNode [in, out] *shininessTexture** NULL <small>[X3DSingleTextureNode]</small>
+
+When applying shininess for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
+
+#### Hints
+
+- If texture node is NULL or unspecified, no effect is applied to material values.
+- Contained texture node must include containerField='shininessTexture'
+
+### SFFloat [in, out] **occlusionStrength** 1 <small>[0,1]</small>
+
+*occlusionStrength* indicates areas of indirect lighting, typically called ambient occlusion. Higher values indicate areas that should receive full indirect lighting and lower values indicate no indirect lighting.
+
+#### Hints
+
+- Only the Red channel of the texture is used for occlusion computations, other channels are ignored.
+- https://en.wikipedia.org/wiki/Ambient_occlusion
+
+### SFString [in, out] **occlusionTextureMapping** ""
+
+The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.
+
+### SFNode [in, out] **occlusionTexture** NULL <small>[X3DSingleTextureNode]</small>
+
+When applying occlusionStrength for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
+
+#### Hints
+
+- If texture node is NULL or unspecified, no effect is applied to material values.
+- Contained texture node must include containerField='occlusionTexture'
+
+### SFFloat [in, out] **normalScale** 1 <small>[0,∞)</small>
+
+*normalScale* controls the degree to which normalTexture RGB values apply XYZ-normal bump mapping to pixels in the parent material.
+
+#### Hints
+
+- normalScale only affects computation of normalTexture modulations that affect lighting of characteristics of the parent Material and has no relation to normal vectors defined by corresponding geometry.
+- normalTexture techniques apply Bump mapping https://en.wikipedia.org/wiki/Bump_mapping
+
+### SFString [in, out] **normalTextureMapping** ""
+
+The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.
+
+### SFNode [in, out] **normalTexture** NULL <small>[X3DSingleTextureNode]</small>
+
+When applying normalScale for this material node, the contained texture modulates the texture across the surface.
+
+#### Hints
+
+- normalTexture techniques apply Bump mapping https://en.wikipedia.org/wiki/Bump_mapping
+- If texture node is NULL or unspecified, no effect is applied to material values.
+- Contained texture node must include containerField='normalTexture'
+
+### SFFloat [in, out] **transparency** 0 <small>[0,1]</small>
+
+How "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque.
+
+#### Interchange profile hint:
+
+Transparency < .5 opaque, transparency > .5 transparent.
+
+#### Hint
+
+- If a texture is present the transparency is always multiplied with the texture's transparency, in contrast to the specification. Set transparency to (0) to get a full opaque texture color.
+
+## Description
+
+### Hints
+
+- Insert Shape and Appearance nodes before adding material.
+- DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Shape/Material/Material.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of Material](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shape.html#Material){:target="_blank"}
+- [X3D Scene Authoring Hints, Color](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color){:target="_blank"}
+- [X3D Example Archives, Basic, Universal Media Materials](https://www.web3d.org/x3d/content/examples/Basic/UniversalMediaMaterials){:target="_blank"}
+- [3D Architecture 17.2.2 Lighting model](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/lighting.html#Lightingmodel){:target="_blank"}
+- [Rendering](https://en.wikipedia.org/wiki/Rendering_(computer_graphics)){:target="_blank"}
+- [3D rendering](https://en.wikipedia.org/wiki/3D_rendering){:target="_blank"}
+- [Phong reflection model](https://en.wikipedia.org/wiki/Phong_reflection_model){:target="_blank"}

package/docs/_posts/components/Shape/PhysicalMaterial.md

@@ -0,0 +1,173 @@
+---
+title: PhysicalMaterial
+date: 2023-01-31
+nav: components-Shape
+categories: [components, Shape]
+tags: [PhysicalMaterial, Shape]
+---
+<style>
+.post h3 {
+   word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+PhysicalMaterial specifies surface rendering properties for associated geometry nodes. Material attributes are used by the X3D lighting equations during rendering.
+
+The PhysicalMaterial node belongs to the **Shape** component and its default container field is *material.* It is available since X3D version 4.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DAppearanceChildNode
+    + X3DMaterialNode
+      + X3DOneSidedMaterialNode
+        + PhysicalMaterial
+```
+
+## Fields
+
+### 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.
+
+### SFColor [in, out] **baseColor** 1 1 1 <small>[0,1]</small>
+
+Similar to diffuseColor from Material.
+
+### SFString [in, out] **baseTextureMapping** ""
+
+The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.
+
+### SFNode [in, out] **baseTexture** NULL <small>[X3DSingleTextureNode]</small>
+
+When applying baseColor for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
+
+#### Hints
+
+- If texture node is NULL or unspecified, no effect is applied to material values.
+- Contained texture node must include containerField='baseTexture'
+
+### SFColor [in, out] **emissiveColor** 0 0 0 <small>[0,1]</small>
+
+How much glowing light is emitted from this object.
+
+#### Hints
+
+- emissiveColors glow even when all lights are off.
+- Reset diffuseColor from default (0.8 0.8 0.8) to (0 0 0) to avoid washout.
+- Only emissiveColor affects IndexedLineSet, LineSet and PointSet.
+
+#### Warning
+
+- Bright emissiveColor values can wash out other colors and some textures.
+
+### SFFloat [in, out] **emissiveStrength** 1 <small>[0,∞) <span class="yellow">non standard</span></small>
+
+A multiplier for emissiveColor and emissiveTexture values.
+
+#### Hint
+
+- [glTF version 2 KHR materials emissive strength](https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Khronos/KHR_materials_emissive_strength){:target="_blank"}
+
+### SFString [in, out] **emissiveTextureMapping** ""
+
+The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.
+
+### SFNode [in, out] **emissiveTexture** NULL <small>[X3DSingleTextureNode]</small>
+
+When applying emissiveColor for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
+
+#### Hints
+
+- If texture node is NULL or unspecified, no effect is applied to material values.
+- Contained texture node must include containerField='emissiveTexture'
+
+### SFFloat [in, out] **metallic** 1 <small>[0,1]</small>
+
+How metallic is the material.
+
+### SFFloat [in, out] **roughness** 1 <small>[0,1]</small>
+
+How rough is the material.
+
+### SFString [in, out] **metallicRoughnessTextureMapping** ""
+
+The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.
+
+### SFNode [in, out] **metallicRoughnessTexture** NULL <small>[X3DSingleTextureNode]</small>
+
+When applying metallic for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
+
+#### Hints
+
+- If texture node is NULL or unspecified, no effect is applied to material values.
+- Contained texture node must include containerField='metallicRoughnessTexture'
+
+### SFFloat [in, out] **occlusionStrength** 1 <small>[0,1]</small>
+
+*occlusionStrength* indicates areas of indirect lighting, typically called ambient occlusion. Higher values indicate areas that should receive full indirect lighting and lower values indicate no indirect lighting.
+
+#### Hints
+
+- Only the Red channel of the texture is used for occlusion computations, other channels are ignored.
+- https://en.wikipedia.org/wiki/Ambient_occlusion
+
+### SFString [in, out] **occlusionTextureMapping** ""
+
+The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.
+
+### SFNode [in, out] **occlusionTexture** NULL <small>[X3DSingleTextureNode]</small>
+
+When applying occlusionStrength for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.
+
+#### Hints
+
+- If texture node is NULL or unspecified, no effect is applied to material values.
+- Contained texture node must include containerField='occlusionTexture'
+
+### SFFloat [in, out] **normalScale** 1 <small>[0,∞)</small>
+
+*normalScale* controls the degree to which normalTexture RGB values apply XYZ-normal bump mapping to pixels in the parent material.
+
+#### Hints
+
+- normalScale only affects computation of normalTexture modulations that affect lighting of characteristics of the parent Material and has no relation to normal vectors defined by corresponding geometry.
+- normalTexture techniques apply Bump mapping https://en.wikipedia.org/wiki/Bump_mapping
+
+### SFString [in, out] **normalTextureMapping** ""
+
+The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.
+
+### SFNode [in, out] **normalTexture** NULL <small>[X3DSingleTextureNode]</small>
+
+When applying normalScale for this material node, the contained texture modulates the texture across the surface.
+
+#### Hints
+
+- normalTexture techniques apply Bump mapping https://en.wikipedia.org/wiki/Bump_mapping
+- If texture node is NULL or unspecified, no effect is applied to material values.
+- Contained texture node must include containerField='normalTexture'
+
+### SFFloat [in, out] **transparency** 0 <small>[0,1]</small>
+
+How "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque.
+
+## Description
+
+### Hints
+
+- Insert Shape and Appearance nodes before adding material.
+- DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
+
+## External Links
+
+- [X3D Specification of PhysicalMaterial](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shape.html#PhysicalMaterial){:target="_blank"}
+- [X3D Scene Authoring Hints, Color](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color){:target="_blank"}
+- [X3D Example Archives, Basic, Universal Media Materials](https://www.web3d.org/x3d/content/examples/Basic/UniversalMediaMaterials){:target="_blank"}
+- [3D Architecture 17.2.2 Lighting model](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/lighting.html#Lightingmodel){:target="_blank"}
+- [Rendering](https://en.wikipedia.org/wiki/Rendering_(computer_graphics)){:target="_blank"}
+- [3D rendering](https://en.wikipedia.org/wiki/3D_rendering){:target="_blank"}
+- [Physically based rendering (PBR)](https://en.wikipedia.org/wiki/Physically_based_rendering){:target="_blank"}

package/docs/_posts/components/Shape/PointProperties.md

@@ -0,0 +1,84 @@
+---
+title: PointProperties
+date: 2022-01-07
+nav: components-Shape
+categories: [components, Shape]
+tags: [PointProperties, Shape]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+PointProperties allows precise fine-grained control over the rendering style of PointSet node points inside the same Shape.
+
+The PointProperties node belongs to the **Shape** component and its default container field is *pointProperties.* It is available since X3D version 4.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DAppearanceChildNode
+    + PointProperties
+```
+
+## Fields
+
+### 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] **pointSizeScaleFactor** 1 (1,∞)
+
+Nominal rendered point size is a browser-dependent minimum renderable point size, which is then multiplied by an additional (greater than or equal to 1.0) pointSizeScaleFactor.
+
+#### Hint
+
+- Additional sizing modifications are determined by pointSizeMinValue, pointSizeMaxValue, and pointSizeAttenuation array.
+
+### SFFloat [in, out] **pointSizeMinValue** 1 <small>[0,∞)</small>
+
+*pointSizeMinValue* is minimum allowed scaling factor on nominal browser point scaling.
+
+#### Warning
+
+- Maintain pointSizeMinValue\<= pointSizeMaxValue.
+
+### SFFloat [in, out] **pointSizeMaxValue** 1 <small>(0,∞)</small>
+
+*pointSizeMaxValue* is maximum allowed scaling factor on nominal browser point scaling
+
+#### Warning
+
+- Maintain pointSizeMinValue \<= pointSizeMaxValue.
+
+### MFFloat [in, out] **pointSizeAttenuation** 1 0 0 <small>(0,∞)</small>
+
+*pointSizeAttenuation* array values [a, b, c] are set to default values if undefined. Together these parameters define attenuation factor 1/(a + b×r + c×r^2) where r is the distance from observer position (current viewpoint) to each point.
+
+#### Hint
+
+- Nominal point size is multiplied by attenuation factor and then clipped to a minimum value of pointSizeMinValue × minimum renderable point size, then clipped to maximum size of pointSizeMaxValue × minimum renderable point size.
+
+### SFString [in, out] **colorMode** "TEXTURE_AND_POINT_COLOR" <small>["POINT_COLOR", "TEXTURE_COLOR", "TEXTURE_AND_POINT_COLOR"]</small>
+
+*colorMode* has blending effect on the rendering of point sprites, applying supplied color (Color node or Material emissiveColor) and texture color
+
+#### Hint
+
+- POINT_COLOR shall display the RGB channels of the color instance defined in X3DMaterialNode or X3DColorNode, and the A channel of the texture if any. If no color is associated to the point, the default RGB color (0, 0, 0) shall be used. TEXTURE_COLOR shall display the original texture with its RGBA channels and regardless to the X3DMaterialNode or X3DColorNode which might be associated to the point set. TEXTURE_AND_POINT_COLOR shall display the RGBA channels of a texture added to the RGB channels of the color defined in X3DMaterialNode or X3DColorNode node, and the A channel of the texture if any. If no color is associated to the point, the result shall be exactly the same as TEXTURE_COLOR.
+
+## Description
+
+### Hints
+
+- DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
+- When an X3DTextureNode is defined in the same Appearance instance as PointProperties node, the points of a PointSet shall be displayed as point sprites using the given texture(s).
+- Requires X3D profile='Full' or else include \<component name='Shape' level='5'/>`
+
+## External Links
+
+- [X3D Specification of PointProperties](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shape.html#LineProperties){:target="_blank"}

package/docs/_posts/components/Shape/Shape.md

@@ -0,0 +1,63 @@
+---
+title: Shape
+date: 2022-01-07
+nav: components-Shape
+categories: [components, Shape]
+tags: [Shape, Shape]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+Shape can appear under any grouping node. Shape can contain an Appearance node and a geometry node (Box Cone Cylinder ElevationGrid Extrusion IndexedFaceSet IndexedLineSet LineSet PointSet Sphere Text).
+
+The Shape node belongs to the **Shape** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DShapeNode
+      + Shape
+```
+
+## Fields
+
+### 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.
+
+### 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.
+
+### SFVec3f [ ] **bboxCenter** 0 0 0 <small>(-∞,∞)</small>
+
+Bounding box center: optional hint for position offset from origin of local coordinate system.
+
+### SFNode [in, out] **appearance** NULL <small>[X3DAppearanceNode]</small>
+
+Input/Output field appearance.
+
+### SFNode [in, out] **geometry** NULL <small>[X3DGeometryNode]</small>
+
+Input/Output field geometry.
+
+## Description
+
+### Hint
+
+- You can also substitute a type-matched ProtoInstance node for contained content.
+
+## External Links
+
+- [X3D Specification of Shape](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shape.html#Shape){:target="_blank"}